XYO Platform SDK - v3.10.6
    Preparing search index...

    Type Alias PayloadPlugin<TPayload>

    type PayloadPlugin<TPayload extends Payload = AnyPayload> = {
        build?: () => PayloadBuilder<TPayload>;
        jsonSchema?: SomeJSONSchema;
        schema: TPayload["schema"];
        template?: () => Partial<TPayload>;
        validate?: (payload: Payload) => Validator<Payload>;
        wrap?: (payload: Payload) => PayloadWrapper;
    }

    Type Parameters

    Index

    Properties

    build?: () => PayloadBuilder<TPayload>
    jsonSchema?: SomeJSONSchema
    schema: TPayload["schema"]
    template?: () => Partial<TPayload>
    validate?: (payload: Payload) => Validator<Payload>
    wrap?: (payload: Payload) => PayloadWrapper