@tbdc-agro-softwares/validation-helper v1.0.2

Installation

npm install @tbdc-agro-softwares/validation-helper
## or
yarn add @tbdc-agro-softwares/validation-helper
## or
pnpm add @tbdc-agro-softwares/validation-helper

Usage

Relative import

import { ensureBoolean, ensureString } from '@tbdc-agro-softwares/validation-helper';

ensureBoolean(true, 'field') // returns true
ensureBoolean('true', 'field') // throws ValidationError
ensureString('valid string', 'field') // returns 'valid string'
ensureString(Symbol('not a string'), 'field') // throws ValidationError

Absolute import

import ensureBoolean from '@tbdc-agro-softwares/ensure-boolean';
import ensureString from '@tbdc-agro-softwares/ensure-string';

ensureBoolean(true, 'field') // returns true
ensureBoolean('true', 'field') // throws ValidationError
ensureString('valid string', 'field') // returns 'valid string'
ensureString(Symbol('not a string'), 'field') // throws ValidationError

Available Methods

🚧 Documentation in progress... (Help is needed)

function ensureString(string: string, field: string): string;

function ensureNullableString(string: string | null, field: string): string | null;

function ensureNumber(number: number, field: string): number;

function ensureNullableNumber(number: number | null, field: string): number | null;

function ensureBoolean(boolean: boolean, field: string): boolean;

function ensureClass<T extends { id: number; }, K>(relation: T, constructor: { new (...args: K[]): T; }, field: string): T;

function ensureNullableClass<T extends { id: number; } | null, K>(relation: T, constructor: { new (...args: K[]): T; }, field: string): T;

function ensureDate(date: Date | string, field: string): Date

function ensureNullableDate(date: Date | string | null, field: string): Date | null;

function ensureEnum<T extends string>(value: T, options: readonly T[], field: string): T;

function ensureNullableEnum<T extends string>(value: T | null, options: readonly T[], field: string): T | null;

function ensureObject<T extends object>(objectValue: T, validationSchema: ZodSchema<T>, field: string): T;

function ensureEmail(email: string, field: string): string;

function ensureUrl(url: string, field: string): string;

For more information see zod documentation

Contributors