From 1080521f3b4fbb35b36b06c385265042831a2483 Mon Sep 17 00:00:00 2001 From: Harminder virk Date: Mon, 18 Nov 2019 14:37:08 +0530 Subject: [PATCH] chore(release): 2.0.0 --- docs/classes/_src_builder_.builder.md | 13 +++-------- ..._typescriptcompiler_.typescriptcompiler.md | 22 ++++++++++++++----- docs/classes/_src_watcher_.watcher.md | 21 +++++++++--------- package-lock.json | 2 +- package.json | 2 +- 5 files changed, 32 insertions(+), 28 deletions(-) diff --git a/docs/classes/_src_builder_.builder.md b/docs/classes/_src_builder_.builder.md index a2a18f1..913464a 100644 --- a/docs/classes/_src_builder_.builder.md +++ b/docs/classes/_src_builder_.builder.md @@ -28,15 +28,14 @@ Exposes the API to build the project similar to `tsc` command. ### constructor -\+ **new Builder**(`_cwd`: string, `_configFileName`: string, `_ts`: ts, `_pluginManager`: [PluginManager](_src_pluginmanager_.pluginmanager.md)): *[Builder](_src_builder_.builder.md)* +\+ **new Builder**(`_ts`: ts, `_config`: tsStatic.ParsedCommandLine, `_pluginManager`: [PluginManager](_src_pluginmanager_.pluginmanager.md)): *[Builder](_src_builder_.builder.md)* **Parameters:** Name | Type | ------ | ------ | -`_cwd` | string | -`_configFileName` | string | `_ts` | ts | +`_config` | tsStatic.ParsedCommandLine | `_pluginManager` | [PluginManager](_src_pluginmanager_.pluginmanager.md) | **Returns:** *[Builder](_src_builder_.builder.md)* @@ -63,14 +62,8 @@ ___ ### build -▸ **build**(`optionsToExtend?`: tsStatic.CompilerOptions): *object* +▸ **build**(): *object* Build the project using the Typescript compiler API -**Parameters:** - -Name | Type | ------- | ------ | -`optionsToExtend?` | tsStatic.CompilerOptions | - **Returns:** *object* diff --git a/docs/classes/_src_typescriptcompiler_.typescriptcompiler.md b/docs/classes/_src_typescriptcompiler_.typescriptcompiler.md index 32d460c..4606ef3 100644 --- a/docs/classes/_src_typescriptcompiler_.typescriptcompiler.md +++ b/docs/classes/_src_typescriptcompiler_.typescriptcompiler.md @@ -30,15 +30,15 @@ the typescript config file. ### constructor -\+ **new TypescriptCompiler**(`ts`: ts, `_configFileName`: string, `_cwd`: string): *[TypescriptCompiler](_src_typescriptcompiler_.typescriptcompiler.md)* +\+ **new TypescriptCompiler**(`_cwd`: string, `_configFileName`: string, `ts`: ts): *[TypescriptCompiler](_src_typescriptcompiler_.typescriptcompiler.md)* **Parameters:** Name | Type | ------ | ------ | -`ts` | ts | -`_configFileName` | string | `_cwd` | string | +`_configFileName` | string | +`ts` | ts | **Returns:** *[TypescriptCompiler](_src_typescriptcompiler_.typescriptcompiler.md)* @@ -52,10 +52,16 @@ Name | Type | ### builder -▸ **builder**(): *[Builder](_src_builder_.builder.md)‹›* +▸ **builder**(`options`: tsStatic.ParsedCommandLine): *[Builder](_src_builder_.builder.md)‹›* Get builder instance +**Parameters:** + +Name | Type | +------ | ------ | +`options` | tsStatic.ParsedCommandLine | + **Returns:** *[Builder](_src_builder_.builder.md)‹›* ___ @@ -89,8 +95,14 @@ ___ ### watcher -▸ **watcher**(): *[Watcher](_src_watcher_.watcher.md)‹›* +▸ **watcher**(`options`: tsStatic.ParsedCommandLine): *[Watcher](_src_watcher_.watcher.md)‹›* Get watcher instance +**Parameters:** + +Name | Type | +------ | ------ | +`options` | tsStatic.ParsedCommandLine | + **Returns:** *[Watcher](_src_watcher_.watcher.md)‹›* diff --git a/docs/classes/_src_watcher_.watcher.md b/docs/classes/_src_watcher_.watcher.md index eaac93d..159961e 100644 --- a/docs/classes/_src_watcher_.watcher.md +++ b/docs/classes/_src_watcher_.watcher.md @@ -31,10 +31,10 @@ for changes. ### Properties +* [chokidar](_src_watcher_.watcher.md#chokidar) * [compilerOptions](_src_watcher_.watcher.md#optional-compileroptions) * [host](_src_watcher_.watcher.md#host) * [program](_src_watcher_.watcher.md#program) -* [watcher](_src_watcher_.watcher.md#watcher) ### Methods @@ -69,21 +69,27 @@ Removes an event subscription. ### constructor -\+ **new Watcher**(`_cwd`: string, `_configFileName`: string, `_ts`: ts, `_pluginManager`: [PluginManager](_src_pluginmanager_.pluginmanager.md)): *[Watcher](_src_watcher_.watcher.md)* +\+ **new Watcher**(`_cwd`: string, `_ts`: ts, `_config`: tsStatic.ParsedCommandLine, `_pluginManager`: [PluginManager](_src_pluginmanager_.pluginmanager.md)): *[Watcher](_src_watcher_.watcher.md)* **Parameters:** Name | Type | ------ | ------ | `_cwd` | string | -`_configFileName` | string | `_ts` | ts | +`_config` | tsStatic.ParsedCommandLine | `_pluginManager` | [PluginManager](_src_pluginmanager_.pluginmanager.md) | **Returns:** *[Watcher](_src_watcher_.watcher.md)* ## Properties +### chokidar + +• **chokidar**: *FSWatcher* + +___ + ### `Optional` compilerOptions • **compilerOptions**? : *tsStatic.CompilerOptions* @@ -100,12 +106,6 @@ ___ • **program**: *tsStatic.Program* -___ - -### watcher - -• **watcher**: *FSWatcher* - ## Methods ### anyEvent @@ -563,7 +563,7 @@ ___ ### watch -▸ **watch**(`watchPattern`: string | string[], `watcherOptions?`: chokidar.WatchOptions, `optionsToExtend?`: tsStatic.CompilerOptions): *object* +▸ **watch**(`watchPattern`: string | string[], `watcherOptions?`: chokidar.WatchOptions): *object* Build and watch project for changes @@ -573,7 +573,6 @@ Name | Type | Default | ------ | ------ | ------ | `watchPattern` | string | string[] | ['.'] | `watcherOptions?` | chokidar.WatchOptions | - | -`optionsToExtend?` | tsStatic.CompilerOptions | - | **Returns:** *object* diff --git a/package-lock.json b/package-lock.json index 1f6c330..e597063 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@poppinss/chokidar-ts", - "version": "1.0.7", + "version": "2.0.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 8bb78a9..4ec210f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@poppinss/chokidar-ts", - "version": "1.0.7", + "version": "2.0.0", "description": "Simple typescript compiler using chokidar file watcher instead of tsc-watch", "scripts": { "mrm": "mrm --preset=@adonisjs/mrm-preset",