Class ArrayHandler<T>

Type parameters

T: Handler

Hierarchy

BaseHandler
- ArrayHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ArrayHandler<T>(handler: T): ArrayHandler<T>

Overrides BaseHandler.constructor
- Defined in handlers/array.ts:11
Type parameters
- T: Handler<any, T>
Parameters
- handler: T
Returns ArrayHandler<T>

Properties

_handler

_handler: Handler<any>

Protected _rules

_rules: Rule<any>[] = ...

_type

_type: Infer<T>[]

Methods

all

all(pred: (v: Infer<T>, i: number, arr: Infer<T>[]) => boolean): ArrayHandler<T>

- Defined in handlers/array.ts:23
Parameters
- pred: (v: Infer<T>, i: number, arr: Infer<T>[]) => boolean
  - - (v: Infer<T>, i: number, arr: Infer<T>[]): boolean
    - Parameters
      - v: Infer<T>
      - i: number
      - arr: Infer<T>[]
      Returns boolean
Returns ArrayHandler<T>

any

any(pred: (v: Infer<T>, i: number, arr: Infer<T>[]) => boolean): ArrayHandler<T>

- Defined in handlers/array.ts:19
Parameters
- pred: (v: Infer<T>, i: number, arr: Infer<T>[]) => boolean
  - - (v: Infer<T>, i: number, arr: Infer<T>[]): boolean
    - Parameters
      - v: Infer<T>
      - i: number
      - arr: Infer<T>[]
      Returns boolean
Returns ArrayHandler<T>

between

between(min: number, max: number): ArrayHandler<T>

- Defined in handlers/array.ts:54
Parameters
- min: number
- max: number
Returns ArrayHandler<T>

check

check(rule: Rule<any>): ArrayHandler<T>

Inherited from BaseHandler.check
- Defined in handlers/index.ts:38
Alias for custom

Parameters
- rule: Rule<any>
Returns ArrayHandler<T>

custom

custom(rule: Rule<any>): ArrayHandler<T>

Inherited from BaseHandler.custom
- Defined in handlers/index.ts:68
Add a custom function to test the value with
```
import yxc from "@dotvirus/yxc"

yxc.string().test()
```
Parameters
- rule: Rule<any>
Returns ArrayHandler<T>

every

every(pred: (v: Infer<T>, i: number, arr: Infer<T>[]) => boolean): ArrayHandler<T>

- Defined in handlers/array.ts:32
Parameters
- pred: (v: Infer<T>, i: number, arr: Infer<T>[]) => boolean
  - - (v: Infer<T>, i: number, arr: Infer<T>[]): boolean
    - Parameters
      - v: Infer<T>
      - i: number
      - arr: Infer<T>[]
      Returns boolean
Returns ArrayHandler<T>

len

len(num: number): ArrayHandler<T>

- Defined in handlers/array.ts:44
Parameters
- num: number
Returns ArrayHandler<T>

length

length(num: number): ArrayHandler<T>

- Defined in handlers/array.ts:37
Parameters
- num: number
Returns ArrayHandler<T>

max

max(max: number): ArrayHandler<T>

- Defined in handlers/array.ts:66
Parameters
- max: number
Returns ArrayHandler<T>

min

min(min: number): ArrayHandler<T>

- Defined in handlers/array.ts:58
Parameters
- min: number
Returns ArrayHandler<T>

notEmpty

notEmpty(): ArrayHandler<T>

- Defined in handlers/array.ts:49
Returns ArrayHandler<T>

nullable

nullable(): UnionHandler<[ArrayHandler<T>, NullHandler]>

Inherited from BaseHandler.nullable
- Defined in handlers/base.ts:13
Allows null value

Returns UnionHandler<[ArrayHandler<T>, NullHandler]>

optional

optional(): UnionHandler<[ArrayHandler<T>, OptionalHandler]>

Inherited from BaseHandler.optional
- Defined in handlers/base.ts:20
Allows undefined value

Returns UnionHandler<[ArrayHandler<T>, OptionalHandler]>

rule

rule(rule: Rule<any>): ArrayHandler<T>

Inherited from BaseHandler.rule
- Defined in handlers/index.ts:54
Alias for custom

Parameters
- rule: Rule<any>
Returns ArrayHandler<T>

some

some(pred: (v: Infer<T>, i: number, arr: Infer<T>[]) => boolean): ArrayHandler<T>

- Defined in handlers/array.ts:27
Parameters
- pred: (v: Infer<T>, i: number, arr: Infer<T>[]) => boolean
  - - (v: Infer<T>, i: number, arr: Infer<T>[]): boolean
    - Parameters
      - v: Infer<T>
      - i: number
      - arr: Infer<T>[]
      Returns boolean
Returns ArrayHandler<T>

test

test(rule: Rule<any>): ArrayHandler<T>

Inherited from BaseHandler.test
- Defined in handlers/index.ts:30
Alias for custom

Parameters
- rule: Rule<any>
Returns ArrayHandler<T>

use

use(rule: Rule<any>): ArrayHandler<T>

Inherited from BaseHandler.use
- Defined in handlers/index.ts:46
Alias for custom

Parameters
- rule: Rule<any>
Returns ArrayHandler<T>

validate

validate(value: unknown, key?: string[], root?: unknown): IValidationResult[]

Overrides BaseHandler.validate
- Defined in handlers/array.ts:74
Parameters
- value: unknown
- key: string[] = ...
- Optional root: unknown
Returns IValidationResult[]

Generated using TypeDoc