diff --git a/README.md b/README.md index 56f50c8..eafda42 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ stack-generator [![module format](https://img.shields.io/badge/module%20format-umd-lightgrey.svg?style=flat-square&colorB=ff69b4)](https://github.com/stacktracejs/stack-generator/releases) [![code of conduct](https://img.shields.io/badge/code%20of-conduct-lightgrey.svg?style=flat-square&colorB=ff69b4)](http://todogroup.org/opencodeofconduct/#stacktrace.js/me@eriwen.com) -Generate artificial backtrace by walking arguments.callee.caller chain. **Works everywhere except [strict-mode](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Strict_mode)**. +Generate artificial stacktrace by walking `arguments.callee.caller` chain. **Works everywhere except [strict-mode](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Strict_mode)**. ## Usage ``` diff --git a/package-lock.json b/package-lock.json index 51f9a42..558f5c2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,15 +1,15 @@ { "name": "stack-generator", - "version": "2.0.6", + "version": "2.0.10", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "stack-generator", - "version": "2.0.6", + "version": "2.0.10", "license": "MIT", "dependencies": { - "stackframe": "^1.3.0" + "stackframe": "^1.3.4" }, "devDependencies": { "eslint": "^8.17.0", @@ -6495,9 +6495,9 @@ } }, "node_modules/stackframe": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/stackframe/-/stackframe-1.3.0.tgz", - "integrity": "sha512-rJJgXNyqd+BVrWJEcDoRoJJL0VqCYhCtBJAKeKkRbUSzWwnwfuY8FTUD0u9HPpZlZfbvOIHnV8AhBbspFTex0g==" + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/stackframe/-/stackframe-1.3.4.tgz", + "integrity": "sha512-oeVtt7eWQS+Na6F//S4kJ2K2VbRlS9D43mAlMyVpVWovy9o+jfgH8O9agzANzaiLjclA0oYzUXEM4PurhSUChw==" }, "node_modules/statuses": { "version": "1.5.0", @@ -12674,9 +12674,9 @@ } }, "stackframe": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/stackframe/-/stackframe-1.3.0.tgz", - "integrity": "sha512-rJJgXNyqd+BVrWJEcDoRoJJL0VqCYhCtBJAKeKkRbUSzWwnwfuY8FTUD0u9HPpZlZfbvOIHnV8AhBbspFTex0g==" + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/stackframe/-/stackframe-1.3.4.tgz", + "integrity": "sha512-oeVtt7eWQS+Na6F//S4kJ2K2VbRlS9D43mAlMyVpVWovy9o+jfgH8O9agzANzaiLjclA0oYzUXEM4PurhSUChw==" }, "statuses": { "version": "1.5.0", diff --git a/package.json b/package.json index 0f1426a..ba41465 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "Oliver Salzburg (https://github.com/oliversalzburg)", "Ben Gourley (https://github.com/bengourley)" ], - "version": "2.0.6", + "version": "2.0.10", "license": "MIT", "keywords": [ "stacktrace", @@ -19,7 +19,7 @@ "url": "git://github.com/stacktracejs/stack-generator.git" }, "dependencies": { - "stackframe": "^1.3.0" + "stackframe": "^1.3.4" }, "devDependencies": { "eslint": "^8.17.0", @@ -43,6 +43,14 @@ "url": "https://github.com/stacktracejs/stack-generator/issues" }, "main": "./stack-generator.js", + "typings": "./stack-generator.d.js", + "files": [ + "LICENSE", + "README.md", + "stack-generator.js", + "stack-generator.d.ts", + "dist/" + ], "scripts": { "lint": "eslint --fix stack-generator.js spec/", "test": "karma start karma.conf.js --single-run", diff --git a/stack-generator.d.ts b/stack-generator.d.ts new file mode 100644 index 0000000..170131a --- /dev/null +++ b/stack-generator.d.ts @@ -0,0 +1,25 @@ +// Type definitions for StackGenerator v2.0 +// Project: https://github.com/stacktracejs/stack-generator +// Definitions by: Eric Wendelin +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +import StackFrame = require("stackframe"); + +declare namespace StackGenerator { + export type {StackFrame}; + + interface StackGeneratorOptions { + /** Maximum number of StackFrames to return. Default is 10 */ + maxStackSize: number + } + + /** + * Generate artificial backtrace by walking arguments.callee.caller chain. + * + * @param {Object} opts object + * @return {Array} of StackFrames + */ + export function backtrace(opts: StackGeneratorOptions): StackFrame[]; +} + +export = StackGenerator;