Class RecordHandler<T>

Type parameters

T: Handler

Hierarchy

BaseHandler
- RecordHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RecordHandler<T>(schema: T): RecordHandler<T>

Overrides BaseHandler.constructor
- Defined in handlers/record.ts:10
Type parameters
- T: Handler<any, T>
Parameters
- schema: T
Returns RecordHandler<T>

Properties

Protected _rules

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

Private _schema

_schema: Handler<any>

_type

_type: Record<string, Infer<T>>

Methods

all

all(pred: (v: Infer<T>, k: string, obj: any) => boolean): RecordHandler<T>

- Defined in handlers/record.ts:22
Parameters
- pred: (v: Infer<T>, k: string, obj: any) => boolean
  - - (v: Infer<T>, k: string, obj: any): boolean
    - Parameters
      - v: Infer<T>
      - k: string
      - obj: any
      Returns boolean
Returns RecordHandler<T>

any

any(pred: (v: Infer<T>, k: string, obj: any) => boolean): RecordHandler<T>

- Defined in handlers/record.ts:18
Parameters
- pred: (v: Infer<T>, k: string, obj: any) => boolean
  - - (v: Infer<T>, k: string, obj: any): boolean
    - Parameters
      - v: Infer<T>
      - k: string
      - obj: any
      Returns boolean
Returns RecordHandler<T>

check

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

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

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

custom

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

every

every(pred: (v: Infer<T>, k: string, obj: any) => boolean): RecordHandler<T>

- Defined in handlers/record.ts:31
Parameters
- pred: (v: Infer<T>, k: string, obj: any) => boolean
  - - (v: Infer<T>, k: string, obj: any): boolean
    - Parameters
      - v: Infer<T>
      - k: string
      - obj: any
      Returns boolean
Returns RecordHandler<T>

nullable

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

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

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

numKeys

numKeys(num: number): RecordHandler<T>

- Defined in handlers/record.ts:36
Parameters
- num: number
Returns RecordHandler<T>

optional

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

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

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

rule

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

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

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

some

some(pred: (v: Infer<T>, k: string, obj: any) => boolean): RecordHandler<T>

- Defined in handlers/record.ts:26
Parameters
- pred: (v: Infer<T>, k: string, obj: any) => boolean
  - - (v: Infer<T>, k: string, obj: any): boolean
    - Parameters
      - v: Infer<T>
      - k: string
      - obj: any
      Returns boolean
Returns RecordHandler<T>

test

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

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

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

use

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

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

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

validate

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

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

Generated using TypeDoc