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

    Class QueryBoundWitnessBuilder<TBoundWitness, TQuery>

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _schema: string

    Accessors

    Methods

    • Parameters

      • fields: DeepOmitStartsWith<
            WithoutSchema<
                Omit<
                    TBoundWitness,
                    "addresses"
                    | "payload_hashes"
                    | "payload_schemas"
                    | "previous_hashes",
                >,
            >,
        >

      Returns this

    • Parameters

      • value: string

      Returns void

    • Type Parameters

      Parameters

      • payload: T

      Returns Promise<Lowercase<string>>

    • Parameters

      • payloads: undefined

      Returns Promise<undefined>

    • Type Parameters

      Parameters

      • payloads: T[]

      Returns Promise<Lowercase<string>[]>

    • Type Parameters

      Parameters

      • payloads: T[]

      Returns Promise<[T, Lowercase<string>][]>

    • Type Parameters

      Parameters

      • payloads: undefined | T[]
      • hash: Lowercase<string> | Lowercase<string>[]

      Returns Promise<T[]>

    • Type Parameters

      Parameters

      • payloads: undefined | T[]
      • hash: Lowercase<string> | Lowercase<string>[]

      Returns Promise<T[]>

    • Type Parameters

      Parameters

      • payloads: undefined | T[]
      • hash: Lowercase<string> | Lowercase<string>[]

      Returns Promise<T[]>

    • Type Parameters

      Parameters

      • payloads: undefined | T[]
      • hash: Lowercase<string> | Lowercase<string>[]

      Returns Promise<T[]>

    • Type Parameters

      Parameters

      • payloads: undefined | T[]
      • hash: Lowercase<string>

      Returns Promise<undefined | T>

    • Type Parameters

      Parameters

      • payload: T

      Returns Promise<Lowercase<string>>

    • Parameters

      • payloads: undefined

      Returns Promise<undefined>

    • Type Parameters

      Parameters

      • payloads: T[]

      Returns Promise<Lowercase<string>[]>

    • Creates an array of payload/hash tuples based on the payloads passed in

      Type Parameters

      Parameters

      • payloads: T[]

      Returns Promise<[T, Lowercase<string>][]>

      An array of payload/hash tuples

    • Type Parameters

      • T extends object

      Parameters

      • payload: T
      • OptionalmaxDepth: number

      Returns WithoutMeta<T>

    • Type Parameters

      • T extends object

      Parameters

      • payloads: T[]
      • OptionalmaxDepth: number

      Returns WithoutMeta<T>[]

    • Type Parameters

      Parameters

      • payloads: T[]

      Returns Promise<Record<Lowercase<string>, T>>

    • Type Parameters

      Parameters

      • objs: T[]

      Returns Promise<Record<Lowercase<string>, T>>

    • Creates an object map of payload hashes to payloads based on the payloads passed in

      Type Parameters

      Parameters

      • objs: T[]

        Any array of payloads

      Returns Promise<Record<Lowercase<string>, T>>

      A map of hashes to payloads