# dts-bundle-proxyjs

> Generates JS proxies from bundled dts.

Latest version **0.4.0** (published 2016-08-18) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install dts-bundle-proxyjs
pnpm add dts-bundle-proxyjs
yarn add dts-bundle-proxyjs
bun add dts-bundle-proxyjs
```

Provides the command `dts-bundle-proxyjs`.

## 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.4.0 |
| Published | 2016-08-18 |
| First published | 2016-08-09 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | quatrodev |

## Links

- npm: https://www.npmjs.com/package/dts-bundle-proxyjs
- Repository: https://github.com/QuatroCode/dts-bundle-proxyjs
- Homepage: https://github.com/QuatroCode/dts-bundle-proxyjs#readme
- Issues: https://github.com/QuatroCode/dts-bundle-proxyjs/issues
- npm.io page: https://npm.io/package/dts-bundle-proxyjs

## Dependencies (3)

- [yargs](https://npm.io/package/yargs.md) ^4.8.1
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [cli-color](https://npm.io/package/cli-color.md) ^1.1.0

## Recent versions

- 0.4.0 (latest) — 2016-08-18
- 0.3.0 — 2016-08-10
- 0.2.0 — 2016-08-10
- 0.1.1 — 2016-08-09
- 0.1.0 — 2016-08-09

## README

# dts-bundle-proxyjs
[![NPM version](http://img.shields.io/npm/v/dts-bundle-proxyjs.svg)](https://www.npmjs.com/package/dts-bundle-proxyjs) 
[![dependencies Status](https://david-dm.org/quatrocode/dts-bundle-proxyjs/status.svg)](https://david-dm.org/quatrocode/dts-bundle-proxyjs) 
[![devDependencies Status](https://david-dm.org/quatrocode/dts-bundle-proxyjs/dev-status.svg)](https://david-dm.org/quatrocode/dts-bundle-proxyjs?type=dev)

Generate js proxy files from dts-bundle file

## Get started
## Usage

1) Install from npm:
```cmd
$ npm install dts-bundle-proxyjs
```
2) Run `dts-bundle`.

3) After `d.ts` file bundled, run `dts-bundle-proxyjs`.

## Features
- Creates JS proxy from bundled dts.

## Usage
```sh
$ dts-bundle-proxyjs --help
```

### Examples
_Using config:_
Default config is `dts-bundle.js`.
```sh
$ dts-bundle-proxy -c dts-bundle.json
```

## Config

### Example JSON
```json
{
    "name": "example-lib",
    "main": "./dist/index.d.ts",
    "out": "./dist/example-lib.d.ts",
    "removeSource": true,
    "proxyjs": {
      "default": "Hello",
      "generateDir": "./dist",
      "requireFile": "./dist/build.js",
      "exportAsDefault": true
    }
}
```

### Explanation
`proxyjs` part:

| Argument        | Type   | Default | Description                                    |
|-----------------|--------|---------|------------------------------------------------|
| default         | string | none    | Parts that must be included.                   |
| generateDir `*` | string | none    | Parts that will be generated js files.         |
| requireFile `*` | string | none    | Bundled js file from where proxy will be made. |
| exportAsDefault | bool   | true    | Generated js files exported as default.        |

`*` - Required.

## License
Released under the [PGL-3.0 license](LICENSE).

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