Skip to content

Commit

Permalink
chore(release): 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
thetutlage committed Nov 18, 2019
1 parent 70dcfc5 commit 1080521
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 28 deletions.
13 changes: 3 additions & 10 deletions docs/classes/_src_builder_.builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)*
Expand All @@ -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*
22 changes: 17 additions & 5 deletions docs/classes/_src_typescriptcompiler_.typescriptcompiler.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)*

Expand All @@ -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)‹›*

___
Expand Down Expand Up @@ -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)‹›*
21 changes: 10 additions & 11 deletions docs/classes/_src_watcher_.watcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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*
Expand All @@ -100,12 +106,6 @@ ___

**program**: *tsStatic.Program*

___

### watcher

**watcher**: *FSWatcher*

## Methods

### anyEvent
Expand Down Expand Up @@ -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

Expand All @@ -573,7 +573,6 @@ Name | Type | Default |
------ | ------ | ------ |
`watchPattern` | string | string[] | ['.'] |
`watcherOptions?` | chokidar.WatchOptions | - |
`optionsToExtend?` | tsStatic.CompilerOptions | - |

**Returns:** *object*

Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 1080521

Please sign in to comment.