Class UnionHandler<T>

Type parameters

T: [Handler, Handler, ...Handler[]]

Hierarchy

Handler
- UnionHandler

Index

Constructors

constructor

Properties

_rules
_type

Methods

Constructors

constructor

new UnionHandler<T>(handlers: T): UnionHandler<T>

Overrides Handler.constructor
- Defined in handlers/union.ts:22
Type parameters
- T: [Handler<any>, Handler<any>, ...Handler<any>[]]
Parameters
- handlers: T
Returns UnionHandler<T>

Properties

Protected _rules

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

_type

_type: T[number]["_type"]

Methods

check

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

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

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

custom

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

Inherited from Handler.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 UnionHandler<T>

nullable

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

- Defined in handlers/union.ts:13
Allows null value

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

optional

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

- Defined in handlers/union.ts:20
Allows undefined value

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

rule

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

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

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

test

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

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

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

use

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

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

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

validate

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

Inherited from Handler.validate
- Defined in handlers/index.ts:83
Validate a value Returns a IValidationResult array
```
import yxc from "@dotvirus/yxc"

yxc.string().validate(myValue)
```
Parameters
- value: unknown
- Optional key: string[]
- Optional root: unknown
Returns IValidationResult[]

Generated using TypeDoc