lite.d.cts 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. interface StackFrame {
  2. args?: any[];
  3. columnNumber?: number;
  4. lineNumber?: number;
  5. fileName?: string;
  6. functionName?: string;
  7. source?: string;
  8. }
  9. /**
  10. * Simplified representation of a stack frame.
  11. */
  12. interface StackFrameLite {
  13. function?: string;
  14. args?: any[];
  15. file?: string;
  16. col?: number;
  17. line?: number;
  18. raw?: string;
  19. }
  20. interface ParseOptions {
  21. /**
  22. * Slice the stack from the given index.
  23. * This could save some computation to avoid parsing unneeded stack frames.
  24. */
  25. slice?: number | [number, number];
  26. /**
  27. * Whether to return empty stack or throw an error when `stack` not found.
  28. *
  29. * By default, `parse` will throw an error when `stack` not found.
  30. *
  31. * @default false
  32. */
  33. allowEmpty?: boolean;
  34. }
  35. /**
  36. * Port from https://github.com/stacktracejs/error-stack-parser
  37. */
  38. /**
  39. * Given an Error object, extract the most information from it.
  40. *
  41. * @param {Error} error object
  42. * @param {ParseOptions} options
  43. * @return {Array} of StackFrames
  44. */
  45. declare function parse(error: Error, options?: ParseOptions): StackFrameLite[];
  46. /**
  47. * Parse stack string from V8, Firefox, or IE into an array of StackFrames.
  48. */
  49. declare function parseStack(stackString: string, options?: ParseOptions): StackFrameLite[];
  50. /**
  51. * Separate line and column numbers from a string of the form: (URI:Line:Column)
  52. */
  53. declare function extractLocation(urlLike: string): [string, string | undefined, string | undefined];
  54. declare function parseV8OrIE(error: Error, options?: ParseOptions): StackFrameLite[];
  55. declare function parseV8OrIeString(stack: string, options?: ParseOptions): StackFrameLite[];
  56. declare function parseFFOrSafari(error: Error, options?: ParseOptions): StackFrameLite[];
  57. declare function parseFFOrSafariString(stack: string, options?: ParseOptions): StackFrameLite[];
  58. declare function parseOpera(e: Error, options?: ParseOptions): StackFrameLite[];
  59. declare function parseOpera9(e: Error, options?: ParseOptions): StackFrameLite[];
  60. declare function parseOpera10(e: Error, options?: ParseOptions): StackFrameLite[];
  61. declare function parseOpera11(error: Error, options?: ParseOptions): StackFrameLite[];
  62. export { type ParseOptions, type StackFrame, type StackFrameLite, extractLocation, parse, parseFFOrSafari, parseFFOrSafariString, parseOpera, parseOpera10, parseOpera11, parseOpera9, parseStack, parseV8OrIE, parseV8OrIeString };