feat(validathor): Rename args to modifiers (#17)

* feat(lib): rename args to modifiers This better indicates the expected intent to the end user * feat(lib): bump version * chore(lib): remove nonexistent schema export
nordic-ui · Jul 30, 2024 · 51d34a6 · 51d34a6
1 parent 962eca8
commit 51d34a6
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 16 deletions.
diff --git a/packages/validathor/CHANGELOG.md b/packages/validathor/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @nordic-ui/validathor
 
+## 0.0.4
+
+### Patch Changes
+
+- Rename schema `args` to `modifiers` to better indicate intent to end user
+
 ## 0.0.3
 
 ### Patch Changes

diff --git a/packages/validathor/package.json b/packages/validathor/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nordic-ui/validathor",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "A simple validation library",
   "author": "Kevin Østerkilde <[email protected]>",
   "main": "dist/index.cjs.js",

diff --git a/packages/validathor/src/schemas/boolean.ts b/packages/validathor/src/schemas/boolean.ts
@@ -4,10 +4,10 @@ import type { Parser } from '@/types'
 import { assert, TypeError } from '@/utils'
 import { ERROR_CODES } from '@/utils/errors/errorCodes'
 
-export type BooleanSchemaArgs = Array<Custom<boolean>>
+export type BooleanSchemaModifiers = Array<Custom<boolean>>
 
 export const boolean = (
-  args?: BooleanSchemaArgs,
+  modifiers?: BooleanSchemaModifiers,
   message?: {
     type_error?: string
   },
@@ -19,7 +19,7 @@ export const boolean = (
       new TypeError(message?.type_error || ERROR_CODES.ERR_TYP_7000.message()),
     )
 
-    validateModifiers(value, args)
+    validateModifiers(value, modifiers)
 
     return value
   },

diff --git a/packages/validathor/src/schemas/date.ts b/packages/validathor/src/schemas/date.ts
@@ -4,17 +4,20 @@ import type { Parser } from '@/types'
 import { assert, TypeError } from '@/utils'
 import { ERROR_CODES } from '@/utils/errors/errorCodes'
 
-export type DateSchemaArgs = Array<Min<Date> | Max<Date> | Custom<Date>>
+export type DateSchemaModifiers = Array<Min<Date> | Max<Date> | Custom<Date>>
 
-export const date = (args?: DateSchemaArgs, message?: { type_error?: string }): Parser<Date> => ({
+export const date = (
+  modifiers?: DateSchemaModifiers,
+  message?: { type_error?: string },
+): Parser<Date> => ({
   name: 'date' as const,
   parse: (value: unknown) => {
     assert(
       value instanceof Date,
       new TypeError(message?.type_error || ERROR_CODES.ERR_TYP_3000.message()),
     )
 
-    validateModifiers(value, args)
+    validateModifiers(value, modifiers)
 
     return value
   },

diff --git a/packages/validathor/src/schemas/enum.ts b/packages/validathor/src/schemas/enum.ts
@@ -2,10 +2,10 @@ import type { Parser } from '@/types'
 import { assert, TypeError, ValidationError } from '@/utils'
 import { ERROR_CODES } from '@/utils/errors/errorCodes'
 
-export type EnumSchemaArgs = Array<string | number>
+export type EnumSchemaModifiers = Array<string | number>
 
 export const enum_ = (
-  args?: EnumSchemaArgs,
+  modifiers?: EnumSchemaModifiers,
   message?: {
     type_error?: string
     error?: string | ((value: string | number) => string)
@@ -19,7 +19,7 @@ export const enum_ = (
     )
 
     assert(
-      (args ?? []).includes(value),
+      (modifiers ?? []).includes(value),
       new ValidationError(
         typeof message?.error === 'function'
           ? message?.error(value)

diff --git a/packages/validathor/src/schemas/number.ts b/packages/validathor/src/schemas/number.ts
@@ -4,12 +4,12 @@ import type { Parser } from '@/types'
 import { assert, TypeError } from '@/utils'
 import { ERROR_CODES } from '@/utils/errors/errorCodes'
 
-export type NumberSchemaArgs = Array<
+export type NumberSchemaModifiers = Array<
   Min<number> | Max<number> | Enumerator<number> | Custom<number>
 >
 
 export const number = (
-  args?: NumberSchemaArgs,
+  modifiers?: NumberSchemaModifiers,
   message?: {
     type_error?: string
   },
@@ -25,7 +25,7 @@ export const number = (
       new TypeError(message?.type_error || ERROR_CODES.ERR_TYP_1001.message()),
     )
 
-    validateModifiers(value, args)
+    validateModifiers(value, modifiers)
 
     return value
   },

diff --git a/packages/validathor/src/schemas/string.ts b/packages/validathor/src/schemas/string.ts
@@ -6,12 +6,12 @@ import { assert, TypeError } from '@/utils'
 import { ERROR_CODES } from '@/utils/errors/errorCodes'
 
 /** An array of the accepted modifier types */
-export type StringSchemaArgs = Array<
+export type StringSchemaModifiers = Array<
   Min<string> | Max<string> | Email | Enumerator<string> | Custom<string>
 >
 
 export const string = (
-  args?: StringSchemaArgs,
+  modifiers?: StringSchemaModifiers,
   message?: {
     type_error?: string
   },
@@ -24,7 +24,7 @@ export const string = (
     )
     assert(value !== '', new TypeError(message?.type_error || ERROR_CODES.ERR_VAL_2000.message()))
 
-    validateModifiers(value, args)
+    validateModifiers(value, modifiers)
 
     return value
   },