@wharfkit/atomicassets - v4.0.2
    Preparing search index...

    Class SchemaFormatField

    A schema format field as returned by the API.

    This is intentionally not the contract's FORMAT struct: createschema takes only {name, type}, while the API additionally reports a mediatype and an info descriptor per field. Widening the contract struct would let those fields leak into serialized action data.

    Hierarchy

    • Struct$1
      • SchemaFormatField
    Index
    info mediatype name type abiBase abiFields abiName
    structFields
    equals from
    info: string

    Free-form descriptor for the field, merged with the same heuristic as mediatype. SchemaObject.types reports the authored ones. AtomicAssets v2 only.

    mediatype: string

    Media type for the field. The API merges the descriptors authored through setschematyp with a name and type heuristic, so a value here can be derived rather than stored. SchemaObject.types reports the authored ones. AtomicAssets v2 only.

    name: string
    type: string
    abiBase: ABISerializableConstructor
    abiFields: ABIField[]
    abiName: string
    • get structFields(): ABIField[]

      Returns ABIField[]

    • Return true if this struct equals the other.

      Note: This compares the ABI encoded bytes of both structs, subclasses should implement their own fast equality check when possible.

      Parameters

      • other: any

      Returns boolean

    • Type Parameters

      • T extends StructConstructor

      Parameters

      • this: T
      • value: any

      Returns InstanceType<T>

    • Parameters

      • value: any

      Returns unknown

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods