stacktrace.js/stacktrace-js.d.ts at master · stacktracejs/stacktrace.js · GitHub

History

134 lines (110 loc) · 3.92 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

// Type definitions for stacktrace.js v2.0.0

// Project: https://github.com/stacktracejs/stacktrace.js

// Definitions by: Eric Wendelin <https://github.com/exceptionless>

// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

declare namespace StackTrace {

export interface SourceCache {

[key: string]: string | Promise<string>;

}

export interface StackTraceOptions {

filter?: (stackFrame: StackFrame) => boolean;

sourceCache?: SourceCache;

offline?: boolean;

}

export interface StackFrame {

constructor(object: StackFrame): StackFrame;

isConstructor?: boolean;

getIsConstructor(): boolean;

setIsConstructor(): void;

isEval?: boolean;

getIsEval(): boolean;

setIsEval(): void;

isNative?: boolean;

getIsNative(): boolean;

setIsNative(): void;

isTopLevel?: boolean;

getIsTopLevel(): boolean;

setIsTopLevel(): void;

columnNumber?: number;

getColumnNumber(): number;

setColumnNumber(): void;

lineNumber?: number;

getLineNumber(): number;

setLineNumber(): void;

fileName?: string;

getFileName(): string;

setFileName(): void;

functionName?: string;

getFunctionName(): string;

setFunctionName(): void;

source?: string;

getSource(): string;

setSource(): void;

args?: any[];

getArgs(): any[];

setArgs(): void;

evalOrigin?: StackFrame;

getEvalOrigin(): StackFrame;

setEvalOrigin(): void;

toString(): string;

}

/**

* Get a backtrace from invocation point.

* @param options Options Object

* @return Array[StackFrame]

export function get(options?: StackTraceOptions): Promise<StackFrame[]>;

/**

* Get a backtrace from invocation point, synchronously. Does not

* attempt to map sources.

* @param options Options Object

* @return Array[StackFrame]

export function getSync(options?: StackTraceOptions): StackFrame[];

/**

* Given an error object, parse it.

* @param error Error object

* @param options Object for options

* @return Array[StackFrame]

export function fromError(error: Error, options?: StackTraceOptions): Promise<StackFrame[]>;

/**

* Use StackGenerator to generate a backtrace.

* @param options Object options

* @returns Array[StackFrame]

export function generateArtificially(options?: StackTraceOptions): Promise<StackFrame[]>;

/**

* Given a function, wrap it such that invocations trigger a callback that

* is called with a stack trace.

* @param {Function} fn to be instrumented

* @param {Function} callback function to call with a stack trace on invocation

* @param {Function} errback optional function to call with error if unable to get stack trace.

* @param {Object} thisArg optional context object (e.g. window)

export function instrument<TFunc extends Function>(fn: TFunc, callback: (stackFrames: StackFrame[]) => void, errback?: (error: Error) => void, thisArg?: any): TFunc;

/**

* Given a function that has been instrumented,

* revert the function to it's original (non-instrumented) state.

* @param fn {Function}

export function deinstrument<TFunc extends Function>(fn: TFunc): TFunc;

/**

* Given an Array of StackFrames, serialize and POST to given URL.

* @param stackframes - Array[StackFrame]

* @param url - URL as String

* @param errorMsg - Error message as String

* @param requestOptions - Object with headers information

* @return Promise<any>

export function report(stackframes: StackFrame[], url: string, errorMsg?: string, requestOptions?: object): Promise<any>;

}

declare module "stacktrace-js" {

export = StackTrace;

}

stacktrace.js/stacktrace-js.d.ts at master · stacktracejs/stacktrace.js · GitHub

Uh oh!

Expand file tree

Breadcrumbs

stacktrace-js.d.ts

Latest commit

History

Breadcrumbs

stacktrace-js.d.ts

File metadata and controls