Skip to content

Commit 5d24faa

Browse files
authoredJun 2, 2024
Update README.md: fix definition of customName (#596)
Added escape chars to avoid the `|` in type definition being interpreted as cell separator
1 parent 49fb14d commit 5d24faa

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed
 

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ See [server demo](example) and [browser demo](https://github.com/bcherny/json-sc
134134
|-|-|-|-|
135135
| additionalProperties | boolean | `true` | Default value for `additionalProperties`, when it is not explicitly set |
136136
| bannerComment | string | `"/* eslint-disable */\n/**\n* This file was automatically generated by json-schema-to-typescript.\n* DO NOT MODIFY IT BY HAND. Instead, modify the source JSON Schema file,\n* and run json-schema-to-typescript to regenerate this file.\n*/"` | Disclaimer comment prepended to the top of each generated file |
137-
| customName | `(LinkedJSONSchema, string | undefined) => string | undefined` | `undefined` | Custom function to provide a type name for a given schema
137+
| customName | `(LinkedJSONSchema, string \| undefined) => string \| undefined` | `undefined` | Custom function to provide a type name for a given schema
138138
| cwd | string | `process.cwd()` | Root directory for resolving [`$ref`](https://tools.ietf.org/id/draft-pbryan-zyp-json-ref-03.html)s |
139139
| declareExternallyReferenced | boolean | `true` | Declare external schemas referenced via `$ref`? |
140140
| enableConstEnums | boolean | `true` | Prepend enums with [`const`](https://www.typescriptlang.org/docs/handbook/enums.html#computed-and-constant-members)? |

0 commit comments

Comments
 (0)
Failed to load comments.