# jxdl-core

> jxdl-core

Latest version **0.1.11-beta.3** (published 2020-11-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install jxdl-core
pnpm add jxdl-core
yarn add jxdl-core
bun add jxdl-core
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.11-beta.3 |
| Published | 2020-11-27 |
| First published | 2019-03-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 17.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | johobalboa |
| Maintainers | joho.balboa |
| Keywords | jxdl |

## Links

- npm: https://www.npmjs.com/package/jxdl-core
- npm.io page: https://npm.io/package/jxdl-core

## Dependencies (3)

- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.2
- [request](https://npm.io/package/request.md) ^2.88.0
- [crypto-js](https://npm.io/package/crypto-js.md) ^4.0.0

## Recent versions

- 0.1.11-beta.3 (latest) — 2020-11-27
- 0.1.11-beta.2 — 2020-08-15
- 0.1.11-beta.1 — 2020-08-15
- 0.1.10 — 2020-08-15
- 0.1.9 — 2020-08-15
- 0.1.8-beta.2 — 2020-08-15
- 0.1.8-beta.1 — 2019-06-21
- 0.1.7 — 2019-06-21
- 0.1.6 — 2019-04-16
- 0.1.5 — 2019-04-16
- 0.1.4 — 2019-03-10
- 0.1.3 — 2019-03-10
- 0.1.2 — 2019-03-09
- 0.1.1 — 2019-03-09
- 0.1.0 — 2019-03-09

## README

# jxdl-core

Joox downloading module.

For a CLI version of this, check out [jxdl](https://www.npmjs.com/package/jxdl).

## Usage

```js
const fs = require('fs');
const jxdl = require('jxdl-core');

jxdl('SrVre6FiKpG6g_XwljQDgg==')
  .pipe(fs.createWriteStream('The Cranberries - Zombie.mp3'));
```

## API

### jxdl(id, uid, usk)

Attempts to download a song from the given id. Returns a [readable stream](https://nodejs.org/api/stream.html#stream_class_stream_readable).

* `id` - can be found in `.getInfo` or the following url ex: '[http://www.joox.com/id/en/single/SrVre6FiKpG6g_XwljQDgg==](http://www.joox.com/id/en/single/SrVre6FiKpG6g_XwljQDgg==)', here `SrVre6FiKpG6g_XwljQDgg==` is the `id`
* `uid` - If request is error find the value in your browser when request joox website. Optional.
* `usk` - If request is error find the value in your browser when request joox website. Optional.

### jxdl.getInfo(url, options, callback(err, info))

Gets metainfo from a song. This is what the `jxdl()` function uses internally.
`options` can be

* `skip` - Used to decide what number of skip song to download.
* `name` - Used to overide the name of the trending chart, playlist, album or artist name.

## Install

```bash
npm install jxdl-core
```

---
_Source: https://npm.io/package/jxdl-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._