https://github.com/apache/cordova-fetch
Apache Cordova Fetch Library
https://github.com/apache/cordova-fetch
cordova hacktoberfest javascript mobile nodejs
Last synced: about 1 year ago
JSON representation
Apache Cordova Fetch Library
- Host: GitHub
- URL: https://github.com/apache/cordova-fetch
- Owner: apache
- License: apache-2.0
- Created: 2016-11-28T08:00:09.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-19T06:33:20.000Z (over 1 year ago)
- Last Synced: 2025-05-10T17:16:19.747Z (about 1 year ago)
- Topics: cordova, hacktoberfest, javascript, mobile, nodejs
- Language: JavaScript
- Homepage: https://cordova.apache.org/
- Size: 593 KB
- Stars: 27
- Watchers: 20
- Forks: 28
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# cordova-fetch
[](https://nodei.co/npm/cordova-fetch/)
[](https://github.com/apache/cordova-fetch/actions?query=branch%3Amaster)
This package can be used to install and uninstall Node.js packages using npm.
## Usage
### `fetch`
Installs a module from:
* `npm` registry
* `git` url
* `tarball`
* url
* file on local file system
* `folder` path on local system
Returns a `Promise` resolving to the absolute path of the installed package.
```js
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.
```js
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`