includes | /src/actions/index.ts | valibot@v1.0.0-beta.4

The modular and type safe schema library for validating structural data 🤖

args await base64 bic brand bytes check checkItems creditCard cuid2 decimal description digits email emoji empty endsWith everyItem excludes filterItems findItem finite graphemes hash hexColor hexadecimal imei includes integer ip ipv4 ipv6 isoDate isoDateTime isoTime isoTimeSecond isoTimestamp isoWeek length mac mac48 mac64 mapItems maxBytes maxGraphemes maxLength maxSize maxValue maxWords metadata mimeType minBytes minGraphemes minLength minSize minValue minWords multipleOf nanoid nonEmpty normalize notBytes notGraphemes notLength notSize notValue notWords octal partialCheck rawCheck rawTransform readonly reduceItems regex returns safeInteger size someItem sortItems startsWith title toLowerCase toMaxValue toMinValue toUpperCase transform trim trimEnd trimStart ulid url uuid value words

index.ts (default module)

ArgsAction

CheckItemsActionAsync

PartialCheckActionAsync

RawTransformActionAsync

ArrayRequirementAsync

bic

mac

url

ArrayRequirementAsync

function includes

import { includes } from "https://deno.land/x/valibot@v1.0.0-beta.4/src/actions/index.ts";

includes<TInput extends ContentInput, TRequirement extends ContentRequirement<TInput>>(requirement: TRequirement): IncludesAction<TInput, TRequirement, undefined>

Creates an includes validation action.

includes<TInput extends ContentInput, TRequirement extends ContentRequirement<TInput>, TMessage extends ErrorMessage<IncludesIssue<TInput, TRequirement>> | undefined>(requirement: TRequirement, message: TMessage): IncludesAction<TInput, TRequirement, TMessage>

Creates an includes validation action.

Type Parameters

TInput extends ContentInput

TRequirement extends ContentRequirement<TInput>

Parameters

requirement: TRequirement

The content to be included.

Returns

IncludesAction<TInput, TRequirement, undefined>

An includes action.

Creates an includes validation action.

Type Parameters

TInput extends ContentInput

TRequirement extends ContentRequirement<TInput>

TMessage extends ErrorMessage<IncludesIssue<TInput, TRequirement>> | undefined

Parameters

requirement: TRequirement

The content to be included.

message: TMessage

The error message.

Returns

IncludesAction<TInput, TRequirement, TMessage>

An includes action.