Skip to content

Commit

Permalink
docs(configuration-output): add custom generator and mock baseUrl exp…
Browse files Browse the repository at this point in the history
…lanation
  • Loading branch information
anymaniax committed May 24, 2021
1 parent 1b9e047 commit 1af0058
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/src/pages/reference/configuration/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ module.exports = {

### client

Type: `String`.
Type: `String | Function`.

Valid values: `axios`, `axios-functions`, `angular`, `react-query`, `svelte-query`.

Expand All @@ -37,6 +37,8 @@ module.exports = {
};
```

if you want you can provide a function to extend or create you custom client generator and this function receive a [GeneratorClients](https://github.com/anymaniax/orval/blob/master/src/types/generator.ts#L148) in argument and should return a [ClientGeneratorsBuilder](https://github.com/anymaniax/orval/blob/master/src/types/generator.ts#L140).

### schemas

Type: `String`.
Expand Down Expand Up @@ -206,7 +208,7 @@ module.exports = {

### mock

Type: `Boolean`.
Type: `Boolean | Function`.

Default Value: `false`.

Expand All @@ -222,6 +224,8 @@ module.exports = {
};
```

If you want you can provide a function to extend or create you custom mock generator and check [here](https://github.com/anymaniax/orval/blob/master/src/types/generator.ts#L132) the type

### override

Type: `Object`.
Expand Down Expand Up @@ -424,6 +428,12 @@ Type: `Boolean`.

Give you the possibility to set every property required.

#### baseUrl

Type: `String`.

Give you the possibility to set base url to your mock handlers.

#### operations

Type: `Object`.
Expand Down

0 comments on commit 1af0058

Please sign in to comment.