# idaman-engine

> Idaman Engine

Latest version **0.0.1-dev** (published 2019-02-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install idaman-engine
pnpm add idaman-engine
yarn add idaman-engine
bun add idaman-engine
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-dev |
| Published | 2019-02-09 |
| First published | 2019-02-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 87.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Muhamad Visat Sutarno |
| Maintainers | mvisat |
| Keywords | parallel, downloader, accelerator |

## Links

- npm: https://www.npmjs.com/package/idaman-engine
- Repository: https://github.com/mvisat/idaman-engine
- Homepage: https://github.com/mvisat/idaman-engine#readme
- Issues: https://github.com/mvisat/idaman-engine/issues
- npm.io page: https://npm.io/package/idaman-engine

## Dependencies (8)

- [keyv](https://npm.io/package/keyv.md) ^3.1.0
- [request](https://npm.io/package/request.md) ^2.88.0
- [emittery](https://npm.io/package/emittery.md) ^0.4.1
- [@keyv/sqlite](https://npm.io/package/@keyv/sqlite.md) ^2.0.0
- [async-rwlock](https://npm.io/package/async-rwlock.md) ^1.1.1
- [lodash.throttle](https://npm.io/package/lodash.throttle.md) ^4.1.1
- [concurrent-streams](https://npm.io/package/concurrent-streams.md) ^0.0.1-dev
- [content-disposition](https://npm.io/package/content-disposition.md) ^0.5.3

## Recent versions

- 0.0.1-dev (latest) — 2019-02-09
- 0.0.5-dev (dev) — 2019-02-10
- 0.0.4-dev — 2019-02-10
- 0.0.3-dev — 2019-02-09
- 0.0.2-dev — 2019-02-09

## README

# idaman-engine
Idaman Engine

## API

### new Download(url: string, options?: DownloadOptions): Download
Creates a new download.

#### DownloadOptions
- `outDir?: string` Default: current working directory.
- `outFile?: string` Default: parsed from URL.
- `maxConnection?: number` Default: 4.
- `overwrite?: boolean` Default: `true`.
- `sessionPath?: string` Default: `outDir/outFile.idmn`
- `useServerFileName?: boolean` Default: `true`.

### start(): void
Starts download.

### abort(): void
Aborts download.

### on(event: string, listener: function)
Registers a listener to an event.

#### on('error', (Error) => {})
Emitted if error occured.

#### on('change', (DownloadChange) => {})
Emitted if there are changes in download options.

#### on('finish', () => {})
Emitted if download has been finished.

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