Class ActionHeaderSchema

Describes one binary metadata value accepted by an action call.

Index

Constructors

Properties

defaultValue description name

Methods

validate create

Constructors

constructor

new ActionHeaderSchema(options: ActionHeaderSchemaOptions): ActionHeaderSchema
Parameters
- options: ActionHeaderSchemaOptions
Returns ActionHeaderSchema
- Defined in src/action_schema.ts:186

Properties

defaultValue

defaultValue: Uint8Array<ArrayBufferLike> | null

Receiver-owned default bytes.

description

description: string

Developer-facing explanation of the metadata.

name

name: string

Header name.

Methods

validate

validate(): Status
Validate the name, description, and default bytes.

Returns Status
- Defined in src/action_schema.ts:215

`Static`create

create(options: ActionHeaderSchemaOptions): StatusOr<ActionHeaderSchema>
Construct and validate a header schema.
Parameters
- options: ActionHeaderSchemaOptions
Returns StatusOr<ActionHeaderSchema>
- Defined in src/action_schema.ts:202