Skip to content
This repository was archived by the owner on Oct 30, 2018. It is now read-only.

Commit 6952e45

Browse files
committed
Change docs to match new parameters
1 parent dcfc832 commit 6952e45

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1-
elixir-typescript (forked from laravel-elixir-typescript by [MikeyAlder](https://github.com/MikeyAlder/laravel-elixir-typescript))
1+
elixir-typescript
22
========================
33

4+
**(forked from laravel-elixir-typescript by [MikeyAlder](https://github.com/MikeyAlder/laravel-elixir-typescript))**
5+
46
## Prerequirement
57
You have to install [Laravel's Elixir](http://laravel.com/docs/master/elixir)(Version 3.0 or higher) and its dependencies first.
68

9+
## Upgrade
10+
The signature was changed to the following:
11+
```
12+
mix.typescript(outputFileName, outputFolder, search, options);
13+
```
14+
715
## Installation
816
Install with Node.js
917
```
@@ -32,4 +40,13 @@ If you'd like to output to a different directory than the default `public/js`, t
3240

3341
```
3442
mix.typescript('app.js', 'public/js/foo/bar');
35-
```
43+
```
44+
45+
## Parameters
46+
47+
Bellow is the list of the available parameters:
48+
49+
- **outputFileName**: Filename for output
50+
- **outputFolder**(optional): Where to place the output file. Default: `public/js/`
51+
- **search** (optional): filter for input files, can also be a direct path to one file like `app.ts`. Defaults: `/**/*.ts`
52+
- **options** (optional): Options to forward to the `gulp-typescript` used for compiling. All options under https://github.com/ivogabe/gulp-typescript#options

0 commit comments

Comments
 (0)