gtavjs-ts-bundler/README.md

Bundle GTAVJS mod declaration files into a multi-modules index.d.ts file.

# GTAVJS TS Bundler
Bundle **GTAVJS** mod declaration files into a multi-modules index.d.ts file.

[![npm version](https://badge.fury.io/js/gtavjs-ts-bundler.svg)](https://badge.fury.io/js/gtavjs-ts-bundler)

[GTAVJS](https://github.com/GTAVJS/GTAVJS/)|[Typing](https://github.com/GTAVJS/gtavjs-typing)|[Template](https://github.com/GTAVJS/gtavjs-template-mod/)|[Wiki](https://github.com/GTAVJS/GTAVJS/wiki)
---|---|---|---

> About **GTAVJS**  
> - Create single-player mods using Typescript.  
> - Add your own DLL Assemblies and generate typing directly in-game.  
> - Reload mods faster using F9, it doesn't need to reload the AppDomain.  
> - Quick project setup, simply use this template and you are good to go.  
> - Complete typing for ScriptHookVDotNet3 and LemonUI included.  
> - Generate typing for your mods and share them using npm.  

<br>

# Module Usage

Install in mod project
```bash
npm install gtavjs-ts-bundler
```

Use from the root of the mod directory
```bash
node node_modules/gtavjs-ts-bundler --declarationDir scripts/ --outputFile index.d.ts
```

<br>

# Global Usage

Install Globally
```bash
npm install -g gtavjs-ts-bundler
```

Use from the root of the mod directory
```bash
gtavjs-ts-bundler --declarationDir scripts/ --outputFile index.d.ts
```

<br>

# Parameters

## declarationDir
```yml
name: --declarationDir 
alias: -i 
type: String 
defaultValue: scripts/
```

## outputFile
```yml
name: --outputFile 
alias: -o 
type: String 
defaultValue: index.d.ts
```

<br>