cordova-fetch
Version:
Apache Cordova fetch module. Fetches from git and npm.
94 lines (70 loc) • 2.92 kB
Markdown
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
-->
# cordova-fetch
[](https://www.npmjs.com/package/cordova-fetch)
[](https://github.com/apache/cordova-fetch/actions/workflows/ci.yml?query=branch%3Amaster)
[](https://github.com/apache/cordova-fetch/actions/workflows/release-audit.yml?query=branch%3Amaster)
[](https://codecov.io/github/apache/cordova-fetch?branch=master)
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`