Class PayloadValidator<T>

Type Parameters

T extends Payload = Payload

Hierarchy (View Summary)

ValidatorBase<T>
- PayloadValidator

Implements

Validator<T>

Index

Constructors

Properties

obj payload schemaNameValidatorFactory

Accessors

schemaValidator stringKeyObj

Methods

schemaName validate setSchemaNameValidatorFactory

Constructors

constructor

new PayloadValidator<
    T extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
>(
    payload: T,
): PayloadValidator<T>
Type Parameters
- T extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
Parameters
- payload: T
Returns PayloadValidator<T>
Overrides ValidatorBase.constructor
- Defined in packages/protocol/packages/payload/packages/validator/dist/neutral/index.d.ts:13

Properties

`Readonly`obj

obj: Partial<T>

`Protected`payload

payload: DeepRestrictToStringKeys<{ schema: string }>

`Protected` `Static`schemaNameValidatorFactory

schemaNameValidatorFactory: AllValidatorFactory

Accessors

schemaValidator

get schemaValidator(): AllValidator
Returns AllValidator
- Defined in packages/protocol/packages/payload/packages/validator/dist/neutral/index.d.ts:14

`Protected`stringKeyObj

get stringKeyObj(): StringKeyObject
Returns StringKeyObject
Inherited from ValidatorBase.stringKeyObj
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/ObjectWrapper.d.ts:6

Methods

schemaName

schemaName(): Error[]
Returns Error[]
- Defined in packages/protocol/packages/payload/packages/validator/dist/neutral/index.d.ts:16

validate

validate(): Promisable<Error[]>
Returns Promisable<Error[]>
Implementation of Validator.validate
Overrides ValidatorBase.validate
- Defined in packages/protocol/packages/payload/packages/validator/dist/neutral/index.d.ts:17

`Static`setSchemaNameValidatorFactory

setSchemaNameValidatorFactory(factory: AllValidatorFactory): void
Parameters
- factory: AllValidatorFactory
Returns void
- Defined in packages/protocol/packages/payload/packages/validator/dist/neutral/index.d.ts:15