Class ObjectHandler<T>

Type parameters

T: Record<string, Handler>

Hierarchy

BaseHandler
- ObjectHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ObjectHandler<T>(keys?: T): ObjectHandler<T>

Overrides BaseHandler.constructor
- Defined in handlers/object.ts:17
Type parameters
- T: Record<string, Handler<any>>
Parameters
- Optional keys: T
Returns ObjectHandler<T>

Properties

Private _arbitrary

_arbitrary: boolean = false

Private _keys

_keys: ISchemaDefinition = ...

Private _partial

_partial: boolean = false

Protected _rules

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

_type

_type: {[ K in string | number | symbol]: Infer<T[K]> }

Methods

all

all(pred: (v: unknown, k: string, obj: {[ K in string | number | symbol]: Infer<T[K]> }) => boolean): ObjectHandler<T>

- Defined in handlers/object.ts:39
Parameters
- pred: (v: unknown, k: string, obj: {[ K in string | number | symbol]: Infer<T[K]> }) => boolean
  - - (v: unknown, k: string, obj: {[ K in string | number | symbol]: Infer<T[K]> }): boolean
    - Parameters
      - v: unknown
      - k: string
      - obj: {[ K in string | number | symbol]: Infer<T[K]> }
      Returns boolean
Returns ObjectHandler<T>

any

any(pred: (v: unknown, k: string, obj: {[ K in string | number | symbol]: Infer<T[K]> }) => boolean): ObjectHandler<T>

- Defined in handlers/object.ts:27
Parameters
- pred: (v: unknown, k: string, obj: {[ K in string | number | symbol]: Infer<T[K]> }) => boolean
  - - (v: unknown, k: string, obj: {[ K in string | number | symbol]: Infer<T[K]> }): boolean
    - Parameters
      - v: unknown
      - k: string
      - obj: {[ K in string | number | symbol]: Infer<T[K]> }
      Returns boolean
Returns ObjectHandler<T>

arbitrary

arbitrary(): ObjectHandler<T>

- Defined in handlers/object.ts:82
Returns ObjectHandler<T>

check

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

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

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

custom

custom(rule: Rule<any>): ObjectHandler<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 ObjectHandler<T>

every

every(pred: (v: unknown, k: string, obj: {[ K in string | number | symbol]: Infer<T[K]> }) => boolean): ObjectHandler<T>

- Defined in handlers/object.ts:64
Parameters
- pred: (v: unknown, k: string, obj: {[ K in string | number | symbol]: Infer<T[K]> }) => boolean
  - - (v: unknown, k: string, obj: {[ K in string | number | symbol]: Infer<T[K]> }): boolean
    - Parameters
      - v: unknown
      - k: string
      - obj: {[ K in string | number | symbol]: Infer<T[K]> }
      Returns boolean
Returns ObjectHandler<T>

nullable

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

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

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

numKeys

numKeys(num: number): ObjectHandler<T>

- Defined in handlers/object.ts:87
Parameters
- num: number
Returns ObjectHandler<T>

optional

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

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

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

partial

partial(): ObjectHandler<T>

- Defined in handlers/object.ts:77
Returns ObjectHandler<T>

rule

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

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

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

some

some(pred: (v: unknown, k: string, obj: {[ K in string | number | symbol]: Infer<T[K]> }) => boolean): ObjectHandler<T>

- Defined in handlers/object.ts:51
Parameters
- pred: (v: unknown, k: string, obj: {[ K in string | number | symbol]: Infer<T[K]> }) => boolean
  - - (v: unknown, k: string, obj: {[ K in string | number | symbol]: Infer<T[K]> }): boolean
    - Parameters
      - v: unknown
      - k: string
      - obj: {[ K in string | number | symbol]: Infer<T[K]> }
      Returns boolean
Returns ObjectHandler<T>

test

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

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

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

use

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

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

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

validate

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

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

Generated using TypeDoc