Skip to content

Commit

Permalink
doc(readme): add renderJsonSchema function to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KaiSaba committed Feb 8, 2024
1 parent cb4a5f2 commit ea7db63
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,6 @@ The implemented functions are:
- `getLocalizedDescription`:
- takes in parameters a schema with localized descriptions, the locale for which we want the description and optionnaly the locale of the default description (default value is `'en'`)
- returns the description for the wanted locale, or `undefined` if not found
- `renderJsonSchema`:
- takes in parameters a schema with localized descriptions, the locale for which we want the description and optionnaly the locale of the default description (default value is `'en'`)
- returns the `JSONSchema6` equivalent with the selected locale

0 comments on commit ea7db63

Please sign in to comment.