find-callsite

Finds the correct place where the stack trace was started, not the place where error was thrown

You might also be interested in stacktrace-metadata.

Table of Contents

• Install
• Usage
• API
  • findCallsite
• Related
• Contributing
• Building docs
• Running tests
• Author
• License

Install

Install with npm

$ npm install find-callsite --save

or install using yarn

$ yarn add find-callsite

Usage

For more use-cases see the tests

const findCallsite = require('find-callsite')

API

findCallsite

Find correct callsite where error is started. All that stuff is because you not always need the first line of the stack to understand where and what happened.

In below example we use rimraf.sync to throw some error. That’s
the case when we need to be informed where is the rimraf.sync call
not where it throws. In that case it is on line 6, column 12.

Params

• error {Error|Object|String}: plain or Error object with stack property, or string stack
• opts {Object}: optional options object
• opts.cwd {String}: give current working directory, default to process.cwd()
• opts.relativePaths {Boolean}: make path relative to opts.cwd, default false
• returns {String}: single callsite from whole stack trace, e.g. at foo (/home/bar/baz.js4)

Example

var findCallsite = require('find-callsite')
var rimraf = require('rimraf')
function fixture () {
  try {
    rimraf.sync(5555)
  } catch (err) {
    var callsiteLine = findCallsite(err)
    console.log(callsiteLine)
    // => 'at fixture (/home/charlike/apps/find-callsite/example.js:6:12)'
    var relativeCallsiteLine = findCallsite(err, {
      relativePaths: true
    })
    console.log(relativeCallsiteLine)
    // => 'at fixture (example.js:6:12)'
  }
}
fixture()

Related

• always-done: Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… more | homepage
• assert-kindof: Check native type of value and throw AssertionError if not okey. Clean stack traces. Simplicity. Built on is-kindof. | homepage
• clean-stacktrace-metadata: Plugin for clean-stacktrace lib. Parse each line to get additional info like filename, column and line of the error. | homepage
• clean-stacktrace-relative-paths: Meant to be used with clean-stacktrace as mapper function. Makes absolute paths inside stack traces to relative paths. | homepage
• clean-stacktrace: Clean up error stack traces from node internals | homepage
• error-format: Allows you to customize the toString method of passed err. Also adds useful properties like line, filename and column to… more | homepage
• is-async-function: Is function really asynchronous function? Trying to guess that based on check if common-callback-names exists as function arguments names or… more | homepage
• minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | homepage
• parse-function: Parse a function into an object that has its name, body, args and a few more useful properties. | homepage
• stacktrace-metadata: Modify given err object to be more useful - adds line, column and filename properties and also cleans stack traces. | homepage
• try-catch-core: Low-level package to handle completion and errors of sync or asynchronous functions, using once and dezalgo libs. Useful for and… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

In short: If you want to contribute to that project, please follow these things

1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See “Building docs” section.
2. Ensure anything is okey by installing the dependencies and run the tests. See “Running tests” section.
3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy.
4. Do NOT bump the version in package.json. For that we use npm run release, which is standard-version and follows Conventional Changelog idealogy.

Thanks a lot! :)

Building docs

Documentation and that readme is generated using verb-generate-readme, which is a verb generator, so you need to install both of them and then run verb command like that

$ npm install verbose/verb#dev verb-generate-readme --global && verb

Please don’t edit the README directly. Any changes to the readme must be made in .verb.md.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

Charlike Mike Reagent

• github/tunnckoCore
• twitter/tunnckoCore
• codementor/tunnckoCore

License

Copyright © 2017, Charlike Mike Reagent. Released under the MIT License.

This file was generated by verb-generate-readme, v0.4.3, on March 15, 2017.
Project scaffolded using charlike cli.