Improve and update docs (#42)
* Improve docs and bring them up to date with the latest changes.
* Moves badges into headline.
Note that there are more supported options than documented. As they've not been documented before, they are considered private for now.
2 files changed
tree: fb5d78d74a275153e85466f9ba6df6e4a4ae568d
- spec/
- .eslintrc.yml
- .gitignore
- .ratignore
- .travis.yml
- appveyor.yml
- index.js
- package.json
- README.md
- RELEASENOTES.md
README.md
cordova-fetch 
This package can be used to install and uninstall Node.js packages using npm.
Usage
fetch
Installs a module from npm, a git url or the local file system. Returns a Promise resolving to the absolute path to the installed package.
const fetch = require('cordova-fetch');
fetch(spec, dest, opts).then(pathToInstalledPackage => {
// Do something
});
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) |
Options
| Option | Default | Description |
|---|
save | false | Adds the package as dependency to package.json iff true |
uninstall
Uninstalls a package from given directory. Returns a Promise that resolves when removal has finished
const { uninstall } = require('cordova-fetch');
uninstall(packageName, dest, opts).then(() => {
// Do something
});
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 |
Options
| Option | Default | Description |
|---|
save | false | Removes dependency from package.json iff true |
