download-chakracore/readme.md

Download a Node-ChakraCore binary.

# download-chakracore

**Deprecated. The [Node-ChakraCore](https://github.com/nodejs/node-chakracore) project has been archived.**

---

**Download a [Node-ChakraCore](https://github.com/nodejs/node-chakracore#installing-prebuilt-node-chakracore-binaries) binary.**

[![npm version](https://img.shields.io/npm/v/download-chakracore.svg)](https://www.npmjs.com/package/download-chakracore)
[![build status](https://img.shields.io/travis/derhuerst/download-chakracore.svg)](https://travis-ci.org/derhuerst/download-chakracore)
![ISC-licensed](https://img.shields.io/github/license/derhuerst/download-chakracore.svg)
[![chat on gitter](https://badges.gitter.im/derhuerst.svg)](https://gitter.im/derhuerst)
[![support me on Patreon](https://img.shields.io/badge/support%20me-on%20patreon-fa7664.svg)](https://patreon.com/derhuerst)


## Installing

```shell
npm install download-chakracore
```


## Requirements

In order to use this, you need `unzip` or `tar`. `download-chakracore` will prefer `.zip` over `.tar.gz` when downloading from [the releases](https://github.com/nodejs/node-chakracore/releases).


## Usage from the command line

```shell
download-chakracore <destination>
```

`destination` must be the final path of the `node` executable.


## Usage from JS

```js
const download = require('download-chakracore')

download(dest, {log: console.log})
```

`dest` must be the final path of the `node` executable. `opt` partially overrides the following defaults:

```js
{
	version: 'latest',
	arch: process.arch,
	platform: process.platform,
	cache: require('env-paths')('download-chakracore').cache,
	githubToken: null,
	log: () => {} // to log messages
}
```

Returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises) that rejects if an error occurs.


## Contributing

If you have a question or have difficulties using `download-chakracore`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to [the issues page](https://github.com/derhuerst/download-chakracore/issues).