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 installation path where the given package is installed. Works for globally and locally installed packages

You might also be interested in detect-installed.

Quality Assurance :100:

If you have any how-to kind of questions, please read Code of Conduct and join the chat room or open an issue.
You may also read the Contributing Guide. There, beside "How to contribute?", we describe everything stated by the badges.

Table of Contents

• Install
• API
  • getInstalledPath
  • getInstalledPathSync
• Related
• Contributing
• Author
• License

(TOC generated by verb using markdown-toc)

Install

This project requires Node.js v6 and above. Use yarn v1 / npm v5 or above to install it.

$ yarn add get-installed-path

API

Review carefully the provided examples and the working tests.

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'
})

// When searching for the path of a package that is required
// by several other packages, its path may not be in the
// closest node_modules. In this case, to search recursively,
// you can use the following:
getInstalledPath('npm', {
 paths: process.mainModule.paths
}).then((path) => {
 // ...
})
// `process.mainModule` refers to the location of the current
// entry script.

getInstalledPathSync

Get installed path of a name package synchronous. Returns boolean when paths option is used and filepath is directory, otherwise returns a full filepath OR throws error.

Params

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

Example

const { getInstalledPathSync } = require('get-installed-path')

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

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

back to top

Related

• always-done: Handle completion and errors with elegance! Support for streams, callbacks, promises, child… 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… 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 locally or globally. Useful for robust… more | homepage
• minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins… more | homepage
• try-catch-core: Low-level package to handle completion and errors of sync or asynchronous functions… more | homepage

back to top

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the Contributing Guide and Code of Conduct documents for advices.

Author

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

License

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

---

This file was generated by verb-generate-readme, v0.6.0, on October 12, 2017.
Project scaffolded and managed with hela.