@xyo-network/payload-validator

Primary SDK for using XYO Protocol 2.0

Install

Using npm:

npm install {{name}}

Using yarn:

yarn add {{name}}

Using pnpm:

pnpm add {{name}}

Using bun:

bun add {{name}}

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Reference

packages

protocol

### packages

  ### payload

    ### packages

      ### validator

        ### .temp-typedoc

          ### classes

            ### <a id="PayloadValidator"></a>PayloadValidator

@xyo-network/payload-validator

Extends

• ValidatorBase<T>

Type Parameters

T

T extends Payload = Payload

Implements

• Validator<T>

Constructors

Constructor

new PayloadValidator<T>(payload): PayloadValidator<T>;

Parameters

payload

T

Returns

PayloadValidator<T>

Overrides

ValidatorBase<T>.constructor

Properties

schemaNameValidatorFactory

protected static schemaNameValidatorFactory: AllValidatorFactory = defaultSchemaNameValidatorFactory;

payload

protected payload: Payload;

Accessors

schemaValidator

Get Signature

get schemaValidator(): AllValidator;

Returns

AllValidator

Methods

setSchemaNameValidatorFactory()

static setSchemaNameValidatorFactory(factory): void;

Parameters

factory

AllValidatorFactory

Returns

void

schemaName()

schemaName(): Error[];

Returns

Error[]

validate()

validate(): Promisable<Error[]>;

Returns

Promisable<Error[]>

Implementation of

Validator.validate

Overrides

ValidatorBase.validate

          ### type-aliases

            ### <a id="AllValidator"></a>AllValidator

@xyo-network/payload-validator

type AllValidator = object;

Methods

all()

all(): Error[];

Returns

Error[]

            ### <a id="AllValidatorFactory"></a>AllValidatorFactory

@xyo-network/payload-validator

type AllValidatorFactory = (schema) => AllValidator;

Parameters

schema

string

Returns

AllValidator