Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

call-id

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

call-id

📞 Get the location from where you're called from.

  • 0.1.0
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
9
increased by125%
Maintainers
1
Weekly downloads
 
Created
Source

CI

Call ID

Get the location from where you're called from; a minimalist approach.

Supports both V8 (Chrome, Edge, Opera, NodeJS) and SpiderMonkey (FireFox).

🗺 Install

Install with npm or yarn:

npm i call-id
# OR
yarn add call-id

This package comes with its TypeScript type declarations included.

🎁 Example

// file.js
import { getCallId } from 'call-id';

function it(title, fn) {
  const { file, line, column } = getCallId();
  // file: file.js, line: 9, column: 0
}

it('should work', () => {}); // <-- this is line 9

The getCallId function is available in 3 ways:

  • An es module: import { getCallId } from 'call-id'
  • A cjs module: const { getCallId } = require('call-id')
  • A browser script bundle: <script src="node_modules/call-id/dist/browser/index.js"> and use const { getCallId } = window.callId;

🤯 Why?

Test frameworks might be interested in where you're tests get declared. They can provide a richer user experience. For example, point you to the exact location where your failing tests can be found.

📖 API reference

getCallId(distance: number = 1): CallId | null

Gets the location from where you're called. This returns null if the provided distance exceeds the call stack, or couldn't be found otherwise.

You can provide a distance (default is 1) of larger then 1 if you want to go even further back on the call stack. Use 0 to receive the exact location from where you called getCallId.

CallId

A CallId object is returned from getCallId.

/**
 * Represents a call location
 */
interface CallId {
  /**
   * The file name or URL of the call location.
   */
  file: string;
  /**
   * The column number of the call location (or `0` if couldn't be determined).
   */
  column: number;
  /**
   * The line number of the call location (starts at `1`)
   */
  line: number;
}

Keywords

FAQs

Package last updated on 19 Feb 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc