get-installed-path

What is get-installed-path?

The get-installed-path npm package is used to find the path where an npm package is installed. This can be useful for various tasks such as debugging, custom module loading, or verifying installations.

What are get-installed-path's main functionalities?

Get the installed path of a package

This feature allows you to get the installed path of a specified npm package. In this example, it retrieves the path for the 'express' package.

const getInstalledPath = require('get-installed-path');

getInstalledPath('express').then((path) => {
  console.log(path);
}).catch((err) => {
  console.error(err);
});

Get the installed path of a package with options

This feature allows you to get the installed path of a specified npm package with additional options. In this example, the 'local' option is set to true to find the package in the local node_modules directory.

const getInstalledPath = require('get-installed-path');

getInstalledPath('express', { local: true }).then((path) => {
  console.log(path);
}).catch((err) => {
  console.error(err);
});

Get the installed path of a package synchronously

This feature allows you to get the installed path of a specified npm package synchronously. In this example, it retrieves the path for the 'express' package synchronously.

const getInstalledPath = require('get-installed-path');

try {
  const path = getInstalledPath.sync('express');
  console.log(path);
} catch (err) {
  console.error(err);
}

Other packages similar to get-installed-path

resolve

The 'resolve' package is used to resolve the path of a module as per the Node.js module resolution algorithm. It can be used to find the path of a module, but it is more general-purpose compared to get-installed-path.

pkg-dir

The 'pkg-dir' package finds the root directory of a Node.js project or a specific package. While it can help locate the root directory of a package, it does not specifically find the installation path of a package like get-installed-path.

find-up

The 'find-up' package is used to find a file or directory by walking up parent directories. It can be used to locate package.json files or other configuration files, but it is not specifically designed to find the installation path of npm packages.

README

get-installed-path

Get locally or globally installation path of given package name

You might also be interested in detect-installed.

Table of Contents

• Install
• Usage
• API
  • getInstalledPath
  • .sync
• Related
• Contributing
• Building docs
• Running tests
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install get-installed-path --save

or install using yarn

$ yarn add get-installed-path

Usage

For more use-cases see the tests

const getInstalledPath = require('get-installed-path')

API

getInstalledPath

Get installed path of globally or locally name package. By default it checks if name exists as directory in global-modules directory of the system. Pass opts.local to get path of name package from local directory or from opts.cwd. Returns rejected promise if module not found in global/local node_modules folder or if it exist but is not a directory.

Params

• name {String}: package name
• opts {Object}: pass opts.local to check locally
• returns {Promise}: rejected promise if name not a string or is empty string

Example

const getInstalledPath = require('get-installed-path')

getInstalledPath('npm').then((path) => {
  console.log(path)
  // => '/home/charlike/.nvm/path/to/lib/node_modules/npm'
})

getInstalledPath('foo-bar-barwerwlekrjw').catch((err) => {
  console.log(err.message)
  // => 'module not found "foo-bar-barwerwlekrjw" in path ...'
})

getInstalledPath('npm', {
  local: true
}).catch((err) => {
  console.log(err.message)
  // => 'module not found "foo-bar-barwerwlekrjw" in path ...'
})

getInstalledPath('global-modules', {
  local: true
}).then((path) => {
  console.log(path)
  // => '~/code/get-installed-path/node_modules/global-modules'
})

// If you are using it for some sub-directory
// pass `opts.cwd` to be where the `node_modules`
// folder is.
process.chidr('foo-bar-baz')
getInstalledPath('global-modules', {
  local: true,
  cwd: '../'
}).then((path) => {
  console.log(path)
  // => '~/code/get-installed-path/node_modules/global-modules'
})

.sync

Get installed path of a name package synchronous.

Params

• name {String}: package name
• opts {Object}: pass opts.local to check locally
• returns {Boolean}: or throw TypeError if name not a string or is empty string

Example

const getInstalledPath = require('get-installed-path')

const npmPath = getInstalledPath.sync('npm')
console.log(npmPath)
// => '/home/charlike/.nvm/path/to/lib/node_modules/npm'

const gmPath = getInstalledPath.sync('global-modules', { local: true })
console.log(gmPath)
// => '~/code/get-installed-path/node_modules/global-modules'

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
• detect-installed: Checks that given package is installed globally or locally. | homepage
• global-modules: The directory used by npm for globally installed npm modules. | homepage
• global-paths: Returns an array of unique "global" directories based on the user's platform and environment. The resulting paths can be used… more | [homepage](https://github.com/jonschlinkert/global-paths "Returns an array of unique "global" directories based on the user's platform and environment. The resulting paths can be used for doing lookups for generators or other globally installed npm packages. Node.js / JavaScript.")
• global-prefix: Get the npm global path prefix. | homepage
• is-installed: Checks that given package is installed on the system - globally or locally. | homepage
• minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | 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 © 2016, Charlike Mike Reagent. Released under the MIT license.

---

This file was generated by verb-generate-readme, v0.2.0, on December 11, 2016.
Project scaffolded using charlike cli.

Changelog

2.0.2 (2016-12-11)

Bug Fixes

• err: fix to return rejected promise if exists but not a directory (80a2b1e)

<a name="2.0.1"></a>