Skip to main content
Module

x/abstruct/mod.ts>PropertiesValidator

Abstract structure for JavaScript data validation
TomokiMiyauci/abstruct
Latest
class PropertiesValidator
extends BasicValidator<Required<In>, Required<RIn>>
import { PropertiesValidator } from "https://deno.land/x/abstruct@1.0.0/mod.ts";

Object properties validator.

Examples

Example 1

import { PropertiesValidator } from "https://deno.land/x/abstruct@$VERSION/validators/object/properties.ts";
import { type Validator } from "https://deno.land/x/abstruct@$VERSION/types.ts";
declare const validator: Validator<string>;
const propertiesValidator = new PropertiesValidator({ key: validator, [Symbol()]: validator });

Constructors

new
PropertiesValidator(validators: readonly [k in keyof In]-?: Readonly<Validator<In[k], RIn[k]>> & readonly [k in keyof RIn]-?: Readonly<Validator<RIn[k]>>)

Type Parameters

In extends object
optional
RIn extends In = In

Properties

validators: [k in keyof In]: Validator<In[k], RIn[k]> & [k in keyof RIn]: Validator<RIn[k]>

Methods

toString(): string
validate(input: Readonly<Required<In>>): Iterable<ValidationFailure>