A little utility to get info about installed and remote npm packages.
npm install npm-node-utilsstringstringArray.string | Array.ObjectBoolean | ObjectObjectPromise.Array.Objectstring| Param | Type |
| --- | --- |
| options | Object |
Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| client | string | "yarn" | npm or yarn |
Example
``js
getGlobalDir();
// returns
'/Users/foo/.config/yarn/global'
`
string| Param | Type |
| --- | --- |
| options | Object |
Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| name | string | | Package name. |
| client | string | "yarn" | npm or yarn |
Example
`js
getGlobalPackagePath({ name: 'jest' });
// returns
'/Users/foo/.config/yarn/global/node_modules/jest'
`
Array.string \| Array.Object| Param | Type |
| --- | --- |
| options | Object |
Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| scope | string | | Get packages by @scope. |
| filter | function | | A custom filter callback. |
| extended | boolean | | Get extended info, such as name, version and description. |
| client | string | "yarn" | Preferred client, npm or yarn. |
Example
`js
getGlobalPackages();
// returns
['jest', 'vue-cli']
``
Example js
getGlobalPackages({ extended: true });
// returns
[
{
name: 'jest',
version: '23.6.0',
description: 'Delightful JavaScript Testing'.
},
{
name: 'vue-cli',
version: '2.9.6',
description: 'A simple CLI for scaffolding Vue.js projects.'
}
]
`
Boolean \| Object| Param | Type |
| --- | --- |
| options | Object |
Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| extended | boolean | | Get extended info, such as name, version and description. |
| client | string | "yarn" | Preferred client, npm or yarn. |
Example
`js
checkIfPackageIsGloballyInstalled({ name: 'vue-cli' });
// returns true
``
Example js
getGlobalPackages({
extended: true,
name: 'vue-cli'
});
// returns
{
name: 'vue-cli',
version: '2.9.6',
description: 'A simple CLI for scaffolding Vue.js projects.'
}
`
Object| Param | Type |
| --- | --- |
| options | Object |
Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| name | string | | Package name. |
| key | string | | Request specific key, example: version. |
| client | string | "yarn" | Preferred client, npm or yarn. |
Example
`js
getRemotePackageInfo({
name: 'vue-cli',
key: 'version'
})
//returns
'2.9.6'
``
Example js
getRemotePackageInfo( name: 'vue-cli' })
//returns
{
name: 'vue-cli',
version: '2.9.6',
description: 'A simple CLI for scaffolding Vue.js projects.'
}
`
Promise.Array.Object| Param | Type | Description |
| --- | --- | --- |
| options | Object | Read here for params documentation https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#get-v1search |
Example
`js
getRemotePackages({ search: 'react' }).then((response) => {
console.log(response);
})
// returns
[
{
name: 'react',
version: '16.6.0',
description: 'React is a JavaScript library for building user interfaces.'.
},
{
name: 'react-router',
version: '4.3.1',
description: 'Declarative routing for React'.
},
...
]
``