fix: add changeset with example

vitalics · Sep 13, 2024 · 57bff56 · 57bff56
1 parent 1a0f989
commit 57bff56
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/.changeset/flat-rice-smile.md b/.changeset/flat-rice-smile.md
@@ -0,0 +1,14 @@
+---
+"ajv-ts": minor
+---
+
+Add `example` for every schema.
+
+Example:
+
+```ts
+s.string().examples(["str1", 'string 2']) // OK
+s.number().examples(["str1", 'string 2']) // Error in typescript, but OK
+s.number().examples([1, 2, 3]) // OK
+s.number().examples(1, 2, 3) // OK
+```
diff --git a/src/builder.ts b/src/builder.ts
@@ -237,7 +237,7 @@ export class SchemaBuilder<
    * @see {@link https://www.learnjsonschema.com/2020-12/meta-data/examples JSON-schema examples definition}
    * @example
    * s.string().examples(["str1", 'string 2']) // OK
-   * s.number().examples(["str1", 'string 2']) // Error
+   * s.number().examples(["str1", 'string 2']) // Error in Typescript, schema is OK
    * s.number().examples([1, 2, 3]) // OK
    * s.number().examples(1, 2, 3) // OK
    */