Added options doc

axe-api · Dec 23, 2023 · 79b25f1 · 79b25f1
1 parent 03c8c3f
commit 79b25f1
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -37,6 +37,7 @@ export default defineConfig({
         items: [
           { text: "Rules", link: "/rules" },
           { text: "i18n", link: "/i18n" },
+          { text: "Options", link: "/options" },
         ],
       },
     ],

diff --git a/docs/options.md b/docs/options.md
@@ -0,0 +1,41 @@
+# Options
+
+## Default options
+
+You can set options for the validator.
+
+```ts
+import { validate, setLocales, setOptions } from "robust-validator";
+import en from "robust-validator/dist/i18n/en.json";
+
+setLocales(en);
+
+// Setting the default options
+setOptions({
+  stopOnFail: true,
+  language: "en",
+});
+```
+
+## Active options
+
+You can override the default options for a validate action like the following example:
+
+```ts
+import { validate, setLocales, setOptions } from "robust-validator";
+import en from "robust-validator/dist/i18n/en.json";
+
+setLocales(en);
+
+// Setting the default options
+setOptions({
+  stopOnFail: true,
+  language: "en",
+});
+
+await validate(
+  data,
+  { email: "required" },
+  { stopOnFail: false, language: "de" }, // Override
+);
+```