Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 224 Commits
.github		.github
dist		dist
spec		spec
.editorconfig		.editorconfig
.eslintrc.yml		.eslintrc.yml
.gitignore		.gitignore
.npmignore		.npmignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
bower.json		bower.json
component.json		component.json
karma.conf.ci.js		karma.conf.ci.js
karma.conf.js		karma.conf.js
package-lock.json		package-lock.json
package.json		package.json
polyfills.js		polyfills.js
stacktrace-gps.d.ts		stacktrace-gps.d.ts
stacktrace-gps.js		stacktrace-gps.js
webpack.config.js		webpack.config.js

Repository files navigation

stacktrace-gps - Turn partial code location into precise code location

This library accepts a code location (in the form of aStackFrame) andreturns a new StackFrame with a more accurate location (usingsource maps) and guessed function names.

This is primarily a browser-centric library, but can be used with node.js. See theOffline Usage section below.

Usage

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)

Offline Usage

With a bit of preparation, you can use this library offline in any environment. Any encountered fileNames not in the cache return resolvedPromises with the original StackFrame. StackTraceGPS will make a best effort to provide as good of response with what is given and willfallback 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}));});

Installation

npm install stacktrace-gpsbower install stacktrace-gpshttps://raw.githubusercontent.com/stacktracejs/stacktrace-gps/master/dist/stacktrace-gps.min.js

API

`new StackTraceGPS(/optional/ options)` => StackTraceGPS

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 totrue to 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