From 2fa0e810bf7acc1e1a4f0ff7e10aacb682d756cc Mon Sep 17 00:00:00 2001 From: William Cheng Date: Tue, 22 Jan 2019 16:23:16 +0800 Subject: [PATCH] update samples and docs --- docs/generators.md | 1 + docs/generators/typescript-rxjs.md | 53 ++++++++++-------------------- 2 files changed, 19 insertions(+), 35 deletions(-) diff --git a/docs/generators.md b/docs/generators.md index 02d94d403f6..588bf946ca5 100644 --- a/docs/generators.md +++ b/docs/generators.md @@ -60,6 +60,7 @@ The following generators are available: - [typescript-inversify](generators/typescript-inversify.md) - [typescript-jquery](generators/typescript-jquery.md) - [typescript-node](generators/typescript-node.md) + - [typescript-rxjs](generators/typescript-rxjs.md) * SERVER generators: diff --git a/docs/generators/typescript-rxjs.md b/docs/generators/typescript-rxjs.md index 9a2fa940761..2fd435e3122 100644 --- a/docs/generators/typescript-rxjs.md +++ b/docs/generators/typescript-rxjs.md @@ -1,37 +1,20 @@ -CONFIG OPTIONS for typescript-rxjs +--- +id: generator-opts-client-typescript-rxjs +title: Config Options for typescript-rxjs +sidebar_label: typescript-rxjs +--- - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - - supportsES6 - Generate code that conforms to ES6. (Default: false) - - npmName - The name under which you want to publish generated npm package - - npmVersion - The version of your npm package - - npmRepository - Use this property to set an url your private npmRepo in the package.json - - snapshot - When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false) - - withInterfaces - Setting this property to true will generate interfaces next to the default class implementations. (Default: false) - -Back to the [generators list](README.md) +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| +|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true| +|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| +|supportsES6|Generate code that conforms to ES6.| |false| +|npmName|The name under which you want to publish generated npm package| |null| +|npmVersion|The version of your npm package| |null| +|npmRepository|Use this property to set an url your private npmRepo in the package.json| |null| +|snapshot|When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false| +|withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false|