This library accepts a code location (in the form of a StackFrame) and returns a new StackFrame with a more accurate location (using source maps) and guessed function names.
This is primarily a browser-centric library, but can be used with node.js. See the Offline Usage section below.
varstackframe=newStackFrame({fileName: 'http://localhost:3000/file.min.js',lineNumber: 1,columnNumber: 3284});varcallback=functionmyCallback(foundFunctionName){console.log(foundFunctionName);};// Such meta. Wowvarerrback=functionmyErrback(error){console.log(StackTrace.fromError(error));};vargps=newStackTraceGPS();// Pinpoint actual function name and source-mapped locationgps.pinpoint(stackframe).then(callback,errback);//===> Promise(StackFrame({functionName: 'fun', fileName: 'file.js', lineNumber: 203, columnNumber: 9}), Error)// Better location/name information from source mapsgps.getMappedLocation(stackframe).then(callback,errback);//===> Promise(StackFrame({fileName: 'file.js', lineNumber: 203, columnNumber: 9}), Error)// Get function name from location informationgps.findFunctionName(stackframe).then(callback,errback);//===> Promise(StackFrame({functionName: 'fun', fileName: 'http://localhost:3000/file.min.js', lineNumber: 1, columnNumber: 3284}), Error)With a bit of preparation, you can use this library offline in any environment. Any encountered fileNames not in the cache return resolved Promises with the original StackFrame. StackTraceGPS will make a best effort to provide as good of response with what is given and will fallback to the original StackFrame if nothing better could be found.
varstack=ErrorStackParser.parse(newError('boom'));console.assert(stack[0]==newStackFrame({fileName: 'http://localhost:9999/file.min.js',lineNumber: 1,columnNumber: 32}));varsourceCache={'http://localhost:9999/file.min.js': 'var foo=function(){};function bar(){}var baz=eval("XXX");\n//# sourceMappingURL=file.js.map'};varsourceMap='{"version":3,"sources":["./file.js"],"sourceRoot":"http://localhost:4000/","names":["foo","bar","baz","eval"],"mappings":"AAAA,GAAIA,KAAM,YACV,SAASC,QACT,GAAIC,KAAMC,KAAK","file":"file.min.js"}';varsourceMapConsumerCache={'http://localhost:4000/file.js.map': newSourceMap.SourceMapConsumer(sourceMap)};vargps=newStackTraceGPS({offline: true,sourceCache: sourceCache,sourceMapConsumerCache: sourceMapConsumerCache});gps.pinpoint(stack[0]).then(function(betterStackFrame){console.assert(betterStackFrame===newStackFrame({functionName: 'bar',fileName: 'http://localhost:9999/file.js',lineNumber: 2,columnNumber: 9}));});npm install stacktrace-gps bower install stacktrace-gps https://raw.githubusercontent.com/stacktracejs/stacktrace-gps/master/dist/stacktrace-gps.min.js options: Object
- sourceCache: Object (String URL : String Source) - Pre-populate source cache to avoid network requests
- sourceMapConsumerCache: Object (Source Mapping URL : SourceMap.SourceMapConsumer) - Pre-populate source cache to avoid network requests
- offline: Boolean (default false) - Set to
trueto prevent all network requests - ajax: Function (String URL => Promise(responseText)) - Function to be used for making X-Domain requests
- atob: Function (String => String) - Function to convert base64-encoded strings to their original representation
Enhance function name and use source maps to produce a better StackFrame.
- stackframe - StackFrame or like object e.g.{fileName: 'path/to/file.js', lineNumber: 100, columnNumber: 5}
Enhance function name and use source maps to produce a better StackFrame.
- stackframe - StackFrame or like object
Enhance function name and use source maps to produce a better StackFrame.
- stackframe - StackFrame or like object
Functions that rely on Source Maps (pinpoint and getMappedLocation) require recent browsers.
Want to be listed as a Contributor? Start with the Contributing Guide!