Skip to content

Num string

numString validates that a string contains only ASCII digits (0-9).

It enforces strict structural string validation and rejects any non-string value or string containing non-digit characters. If the value is not a string or contains invalid characters, the rule emits a single validation event. Otherwise, it produces no validation output.

Signature

Through the API:

.numString()

And internally:

export const numString: ValidationRule
(value: unknown, path: FieldPath) => Promise<ReadonlyArray<JaneEvent>>

Events

Event code Description
type.not.valid Value is not structurally a string
string.not.numeric String contains non-digit characters

Design rationale

  • Provides a strict, predictable numeric string validation.
  • Rejects non-string values with a clear structural-type diagnostic.
  • Uses ASCII-only digit characters for consistency and predictability.
  • Never coerces or normalizes — validation is explicit and opt-in.
  • Emits exactly one event per failure for clarity and composability.
  • Async-compatible and returns a readonly array of JaneEvent objects.

Invoke

numString runs only when explicitly included in a boundary or pipeline. It does not run automatically.

The rule activates when:

  • The value is any JavaScript value.
  • If the value is not a string, emits type.not.valid.
  • If the value is a string but contains non-digit characters, emits string.not.numeric.
  • If the value is a string containing only digits → returns an empty result set.

Examples

Valid numeric string

await numString("12345", "$");
// → []

String with letters

await numString("123abc", "$");
// → [
//     JaneEvent{
//       kind: "error",
//       code: "string.not.numeric",
//       path: "$",
//       ...
//     }
//   ]

Non-string value

await numString(42, "$");
// → [
//     JaneEvent{
//       kind: "error",
//       code: "type.not.valid",
//       path: "$",
//       ...
//     }
//   ]