veryfront/schemas - Veryfront

Import

import {
  defineSchema,
  lazySchema,
  schemaIsOptional,
  schemaToJsonSchema,
  CommonSchemas,
  getAbsolutePathSchema,
} from "veryfront/schemas";

Examples

import { CommonSchemas, defineSchema } from "veryfront/schemas";

const email = CommonSchemas.email.parse("user@example.com");

const getUserSchema = defineSchema((v) =>
  v.object({
    id: v.string().uuid(),
    name: v.string().min(1),
  })
);

Exports

Components

Name	Description	Source
`CommonSchemas`	Lazy-getter object that preserves the `CommonSchemas.email` call shape. Each access returns the cached `Schema<T>` (memoized inside `defineSchema`), so chained calls like `CommonSchemas.email.parse(x)` work as before.	source

Functions

Name	Description	Source
`defineSchema`	Wrap a schema factory so that it is built lazily on first call.	source
`lazySchema`		source
`schemaIsOptional`	Returns `true` when the schema permits `undefined`.	source
`schemaToJsonSchema`	Convert an opaque `Schema<T>` to a JSON Schema document.	source

Types

Name	Description	Source
`AbsolutePath`		source
`DateRange`		source
`Email`		source
`FilePath`		source
`HexColor`		source
`JsonSchema`	Minimal JSON Schema type used by the `SchemaValidator` contract for `toJsonSchema()`. Kept in the extensions/schema category so the contract can reference it without depending on any non-leaf module.	source
`JsonValue`	Recursive JSON value type - a string, number, boolean, null, array of JsonValue, or object with string keys and JsonValue values.	source
`NonEmptyString`		source
`NonNegativeInt`		source
`Pagination`		source
`PhoneNumber`		source
`PortNumber`		source
`PositiveInt`		source
`Semver`		source
`Slug`		source
`StrongPassword`		source
`Timestamp`		source
`Url`		source
`Uuid`		source

Constants

Name	Description	Source
`getAbsolutePathSchema`		source
`getDateRangeSchema`		source
`getEmailSchema`		source
`getFilePathSchema`		source
`getHexColorSchema`		source
`getJsonValueSchema`		source
`getNonEmptyStringSchema`		source
`getNonNegativeIntSchema`		source
`getPaginationSchema`		source
`getPhoneNumberSchema`		source
`getPortNumberSchema`		source
`getPositiveIntSchema`		source
`getSemverSchema`		source
`getSlugSchema`		source
`getStrongPasswordSchema`		source
`getTimestampSchema`		source
`getUrlSchema`		source
`getUuidSchema`		source

​Import

​Examples

​Exports

​Components

​Functions

​Types

​Constants

Import

Examples

Exports

Components

Functions

Types

Constants