Get global Packages
A little utility to find installed global packages with npm or yarn.
Functions
-
getGlobalDir(options) ⇒
string
-
getGlobalPackagePath(options) ⇒
string
-
getGlobalPackages(options) ⇒
Array.string
|Array.Object
-
checkIfPackageIsGloballyInstalled(options) ⇒
Boolean
|Object
-
getRemotePackageInfo(options) ⇒
Object
-
getRemotePackages(options) ⇒
Promise.Array.Object
string
getGlobalDir(options) ⇒ Kind: global function
Param | Type |
---|---|
options | Object |
Properties
Name | Type | Default | Description |
---|---|---|---|
client | string |
"yarn" |
npm or yarn |
Example
getGlobalDir();
// returns
'/Users/foo/.config/yarn/global'
string
getGlobalPackagePath(options) ⇒ Kind: global function
Param | Type |
---|---|
options | Object |
Properties
Name | Type | Default | Description |
---|---|---|---|
name | string |
Package name. | |
client | string |
"yarn" |
npm or yarn |
Example
getGlobalPackagePath({ name: 'jest' });
// returns
'/Users/foo/.config/yarn/global/node_modules/jest'
Array.string
| Array.Object
getGlobalPackages(options) ⇒ Kind: global function
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
getGlobalPackages();
// returns
['jest', 'vue-cli']
Example
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
checkIfPackageIsGloballyInstalled(options) ⇒ Kind: global function
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
checkIfPackageIsGloballyInstalled({ name: 'vue-cli' });
// returns true
Example
getGlobalPackages({
extended: true,
name: 'vue-cli'
});
// returns
{
name: 'vue-cli',
version: '2.9.6',
description: 'A simple CLI for scaffolding Vue.js projects.'
}
Object
getRemotePackageInfo(options) ⇒ Kind: global function
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
getRemotePackageInfo({
name: 'vue-cli',
key: 'version'
})
//returns
'2.9.6'
Example
getRemotePackageInfo( name: 'vue-cli' })
//returns
{
name: 'vue-cli',
version: '2.9.6',
description: 'A simple CLI for scaffolding Vue.js projects.'
}
Promise.Array.Object
getRemotePackages(options) ⇒ Kind: global function
Param | Type | Description |
---|---|---|
options | Object |
Read here for params documentation https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#get-v1search |
Example
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'.
},
...
]