chore: bump version 4.0.0-dev (#103)
2 files changed
tree: 789d45fc9be133ceeef1ce38983323c5fe709f96
- .github/
- spec/
- .asf.yaml
- .eslintrc.yml
- .gitignore
- .npmignore
- .ratignore
- CONTRIBUTING.md
- index.js
- LICENSE
- NOTICE
- package-lock.json
- package.json
- README.md
- RELEASENOTES.md
README.md
cordova-fetch
![NPM](https://nodei.co/npm/cordova-fetch.png)
![Node CI](https://github.com/apache/cordova-fetch/workflows/Node%20CI/badge.svg?branch=master)
This package can be used to install and uninstall Node.js packages using npm.
Usage
fetch
Installs a module from:
npm
registrygit
urltarball
- url
- file on local file system
folder
path on local system
Returns a Promise
resolving to the absolute path of the installed package.
const fetch = require('cordova-fetch');
fetch(spec, dest, opts).then(pathToInstalledPackage => {
// Do something
});
Fetch Parameters
Parameter | Description |
---|
spec | A spec for the package to be installed (anything supported by npm install ) |
dest | Location where to install the package |
opts | Additional options (optional) |
Fetch Options
Option | Default | Description |
---|
save | false | Adds the package as dependency to package.json iff true |
uninstall
Uninstalls a package from the given directory. Returns a Promise
that resolves when removal has finished.
const { uninstall } = require('cordova-fetch');
uninstall(packageName, dest, opts).then(() => {
// Do something
});
Uninstall Parameters
Parameter | Description |
---|
packageName | Name of the package to be uninstalled |
dest | Location from where to uninstall the package |
opts | An Object with additional options |
Uninstall Options
Option | Default | Description |
---|
save | false | Removes dependency from package.json iff true |