Skip to content

Commit dff4f9c

Browse files
Updated configuration documentation
1 parent 2275f37 commit dff4f9c

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,16 @@ In Maven build you can use `typescript-generator-maven-plugin` like this:
5555
<goals>
5656
<goal>generate</goal>
5757
</goals>
58-
<configuration>
59-
<jsonLibrary>jackson2</jsonLibrary>
60-
<classes>
61-
<class>cz.habarta.typescript.generator.Person</class>
62-
</classes>
63-
<outputFile>target/rest.d.ts</outputFile>
64-
<outputKind>global</outputKind>
65-
<namespace>Rest</namespace>
66-
</configuration>
58+
<phase>process-classes</phase>
6759
</execution>
6860
</executions>
61+
<configuration>
62+
<jsonLibrary>jackson2</jsonLibrary>
63+
<classes>
64+
<class>cz.habarta.typescript.generator.Person</class>
65+
</classes>
66+
<outputKind>module</outputKind>
67+
</configuration>
6968
</plugin>
7069
```
7170

@@ -123,10 +122,12 @@ For more details see [Class Names Glob Patterns](../../wiki/Class-Names-Glob-Pat
123122

124123
Output parameters
125124
-----------------
126-
Output is configured using several parameters, two of them are mandatory:
127-
- `outputFile` - specifies path and name of output file
128-
- `outputKind` - determines if and how module will be generated
125+
Output is configured using several parameters:
126+
- `outputKind` (required parameter) - determines if and how module will be generated
129127
- values are: `global`, `module`, `ambientModule`
128+
- `outputFileType` - specifies TypeScript file type
129+
- values are: `declarationFile` (.d.ts) or `implementationFile` (.ts)
130+
- `outputFile` - specifies path and name of output file
130131

131132
For more details see [Modules and Namespaces](http://vojtechhabarta.github.io/typescript-generator/doc/ModulesAndNamespaces.html) page.
132133

0 commit comments

Comments
 (0)