This release is 3 versions behind 0.4.4 — the latest version of @oridune/validator. Jump to latest

@oridune/validator@0.4.1

Oridune/validator

Oridune validator is a TypeScript-first schema declaration and validation library like Zod.

JSR Score

41%

Published

a week ago (0.4.1)

@oridune/validator

BaseValidator

class BaseValidator

Constructors

new



BaseValidator(Type: ValidatorType,
ID: string,
ValidatorOptions?: TBaseValidatorOptions,
)

Type Parameters



Shape = any



Input = any



Output = any

Properties



input: Input



output: Output



shape: Shape

protected



CustomValidators: TCustomValidator<unknown, unknown, unknown>[]

protected

abstract



Description: string

protected

abstract



Sample: any

protected

abstract



_memory: Record<string, any>

Methods

protected



_cast(_ctx: IValidatorContext<unknown, unknown>): Promise<void> | void

protected



_custom<Return>(validator: TCustomValidator<any, any, Return>,
isDefault?: boolean,
)

protected



_isPlainObject(value: any)

protected



_memo<T>(keys: string | string[],
callback: () => T,
): T

protected



_toJSON(_ctx?: IJSONSchemaContext): IValidatorJSONSchema

protected



_toSample(_ctx?: ISampleDataContext): Input | Value<Input>

protected



_toStatic(_ctx?: IStaticContext): BaseValidator<Shape, Input, Output>

protected



_validate(ctx: IValidatorContext): Promise<IValidatorContext>



checkpoint()

Adds a stop point to the validation if there was an error occured on the current validator.



custom<Return>(validator: TCustomValidator<Input, Output, Return>)

Provide a custom method for validation.



describe(description: string)

Add a description for the JSON schema.



getOptions()

Get default validator options



sample(sample: any)

Add a sample for the Sample data.



setOptions(options: Partial<TBaseValidatorOptions>)

Change the validator's default options



test(input?: any,
ctx?: IValidationContext,
)

Tries to execute the validation chain and returns a boolean value based on the result.



throwsFatal()

Adds a stop point to the validation if there was an error occured on the current validator.



toJSON(options?: IJSONSchemaOptions)

Generates a JSON schema based on your validation schema.



toSample(options?: ISampleDataOptions)

Generates a Sample data based on your validation schema.



toStatic(options?: IStaticOptions)

Converts the runtime context into a static validator.



try(input?: any,
ctx?: IValidationContext,
)

Tries to execute the validation chain and if there is an error, it will not be thrown but instead will be returned.



validate(input?: any,
ctx?: IValidationContext,
): Promise<Output>

Executes the validation chain.

Static Methods



createFactory<T,
A extends unknown[],
>(cls: new (...args: A) => T): (...args: A) => T



resolveErrorMessage(message: TErrorMessage | undefined,
defaultMessage: string,
)



resolveValidator<V extends BaseValidator>(validator: any): V



resolveValidator<V extends BaseValidator>(validator: any,
silent: false,
): V



resolveValidator<V extends BaseValidator>(validator: any,
silent: true,
): V | null

Add Package

deno add jsr:@oridune/validator

Import symbol

import { BaseValidator } from "@oridune/validator";

---- OR ----

Import directly with a jsr specifier

import { BaseValidator } from "jsr:@oridune/validator";

Add Package

npx jsr add @oridune/validator

Import symbol

import { BaseValidator } from "@oridune/validator";

Add Package

yarn dlx jsr add @oridune/validator

Import symbol

import { BaseValidator } from "@oridune/validator";

Add Package

pnpm dlx jsr add @oridune/validator

Import symbol

import { BaseValidator } from "@oridune/validator";

Add Package

bunx jsr add @oridune/validator

Import symbol

import { BaseValidator } from "@oridune/validator";