Sha256: 2c7e443349bbaae23fe9ee62397129ca30a4118184d9908babdc514d260ea322

Contents?: true

Size: 1.43 KB

Versions: 97

Compression:

Stored size: 1.43 KB

Contents

# parent-module [![Build Status](https://travis-ci.org/sindresorhus/parent-module.svg?branch=master)](https://travis-ci.org/sindresorhus/parent-module)

> Get the path of the parent module

Node.js exposes `module.parent`, but it only gives you the first cached parent, which is not necessarily the actual parent.


## Install

```
$ npm install parent-module
```


## Usage

```js
// bar.js
const parentModule = require('parent-module');

module.exports = () => {
	console.log(parentModule());
	//=> '/Users/sindresorhus/dev/unicorn/foo.js'
};
```

```js
// foo.js
const bar = require('./bar');

bar();
```


## API

### parentModule([filepath])

By default, it will return the path of the immediate parent.

#### filepath

Type: `string`<br>
Default: [`__filename`](https://nodejs.org/api/globals.html#globals_filename)

Filepath of the module of which to get the parent path.

Useful if you want it to work [multiple module levels down](https://github.com/sindresorhus/parent-module/tree/master/fixtures/filepath).


## Tip

Combine it with [`read-pkg-up`](https://github.com/sindresorhus/read-pkg-up) to read the package.json of the parent module.

```js
const path = require('path');
const readPkgUp = require('read-pkg-up');
const parentModule = require('parent-module');

console.log(readPkgUp.sync({cwd: path.dirname(parentModule())}).pkg);
//=> {name: 'chalk', version: '1.0.0', …}
```


## License

MIT © [Sindre Sorhus](https://sindresorhus.com)

Version data entries

97 entries across 96 versions & 11 rubygems

Version Path
rapid_stack-0.1.1 templates/FrontEnd/node_modules/parent-module/readme.md
rapid_stack-0.1.0 templates/FrontEnd/node_modules/parent-module/readme.md
immosquare-cleaner-0.1.62 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.61 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.60 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.59 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.58 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.57 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.56 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.55 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.54 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.53 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.52 node_modules/parent-module/readme.md
trusty-cms-6.3.1 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.51 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.50 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.49 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.48 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.47 node_modules/parent-module/readme.md
immosquare-cleaner-0.1.46 node_modules/parent-module/readme.md