GitXplorerGitXplorer
d

caller-dirname

public
0 stars
0 forks
0 issues

Commits

List of commits on branch master.
Verified
8b1b06de4fad05747aaf10989c282d258a976b9f

Add missing types field to package.json

ddetrohutt committed 7 years ago
Verified
d32abaa8fb38facf0c358304c7d5c419683d9ef1

Initial implementation

ddetrohutt committed 7 years ago
Verified
ed3eea91886660590c339d9ad3d58ff99d045519

Initial commit

ddetrohutt committed 7 years ago

README

The README file for this repository.

caller-dirname

Get the directory name of a caller function's containing file.


Installation

$ npm i caller-dirname

Usage

/home/detrohutt/test/caller-dirname/callee.js

import { callerDirname } from 'caller-dirname';

export default () => callerDirname();

/home/detrohutt/test/caller-dirname/deeper/caller.js

import thisDirname from '../callee.js';

console.log(thisDirname()); /* /home/detrohutt/test/caller-dirname/deeper */

Options

Option Default Description
depth 1 Depth sets the position in the call stack at which you want to retrieve the directory name. With the default depth of 1 (1st caller) you get the dirname of the function that directly calls callerDirname() (we'll call it fn1). With a depth of 2 (2nd caller), you'd instead get the dirname of the function that called fn1, etc.
Example
import { callerDirname } from 'caller-dirname';

export const thirdCallerDir = () => callerDirname({ depth: 3 });

Motivation

I needed this for another repo I'm working on. Most of the code is taken from caller-path. The main difference is this returns the dirname only, rather than the full path with filename and extension. Also, it's published both as a CommonJS module and as an ES Module and includes TypeScript typings.