Class PayloadBuilder<T, R>

constructor

• new PayloadBuilder<T extends Payload = Payload<AnyObject>, R = T>(
      options: PayloadBuilderOptions,
  ): PayloadBuilder<T, R>

  Type Parameters

  • T extends Payload = Payload<AnyObject>
  • R = T

  Parameters

  • options: PayloadBuilderOptions

  Returns PayloadBuilder<T, R>

Readonlyoptions

build

• build(): R

  Returns R

dataHashableFields

• dataHashableFields(): Promise<
      DeepOmitStartsWith<DeepOmitStartsWith<T, "_">, "$">,
  >

  Returns Promise<DeepOmitStartsWith<DeepOmitStartsWith<T, "_">, "$">>

fields

• fields(fields: DeepOmitStartsWith<WithoutSchema<T>>): PayloadBuilder<T, R>

  Parameters

  • fields: DeepOmitStartsWith<WithoutSchema<T>>

  Returns PayloadBuilder<T, R>

meta

• meta(meta: DeepPickStartsWith<T>): PayloadBuilder<T, R>

  Parameters

  • meta: DeepPickStartsWith<T>

  Returns PayloadBuilder<T, R>

schema

• schema(value: string): void

  Parameters

  • value: string

  Returns void

StaticaddStorageMeta

• addStorageMeta<T extends Payload>(
      payload: T,
      index?: number,
  ): Promise<WithStorageMeta<T>>

  Type Parameters

  • T extends Payload

  Parameters

  • payload: T
  • Optionalindex: number

  Returns Promise<WithStorageMeta<T>>

• addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>

  Type Parameters

  • T extends Payload

  Parameters

  • payloads: T[]

  Returns Promise<WithStorageMeta<T>[]>

StaticcompareStorageMeta

• compareStorageMeta(
      a: WithStorageMeta<Payload>,
      b: WithStorageMeta<Payload>,
      comparer?: Compare<Lowercase<string>>,
  ): number

  Parameters

  • a: WithStorageMeta<Payload>
  • b: WithStorageMeta<Payload>
  • comparer: Compare<Lowercase<string>> = SequenceComparer.local

  Returns number

StaticdataHash

• dataHash<T extends Payload>(payload: T): Promise<Lowercase<string>>

  Type Parameters

  • T extends Payload

  Parameters

  • payload: T

  Returns Promise<Lowercase<string>>

StaticdataHashableFields

• dataHashableFields<T extends Payload>(
      schema: string,
      payload: WithoutSchema<T>,
  ): Promisable<WithoutMeta<T>>

  Type Parameters

  • T extends Payload

  Parameters

  • schema: string
  • payload: WithoutSchema<T>

  Returns Promisable<WithoutMeta<T>>

StaticdataHashes

• dataHashes(payloads: undefined): Promise<undefined>

  Parameters

  • payloads: undefined

  Returns Promise<undefined>

• dataHashes<T extends Payload>(payloads: T[]): Promise<Lowercase<string>[]>

  Type Parameters

  • T extends Payload

  Parameters

  • payloads: T[]

  Returns Promise<Lowercase<string>[]>

StaticdataHashPairs

• dataHashPairs<T extends Payload>(
      payloads: T[],
  ): Promise<[T, Lowercase<string>][]>

  Type Parameters

  • T extends Payload

  Parameters

  • payloads: T[]

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

StaticfilterExclude

• filterExclude<T extends Payload>(
      payloads?: T[],
      hash: Lowercase<string> | Lowercase<string>[],
  ): Promise<T[]>

  Type Parameters

  • T extends Payload

  Parameters

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

  Returns Promise<T[]>

StaticfilterExcludeByDataHash

• filterExcludeByDataHash<T extends Payload>(
      payloads?: T[],
      hash: Lowercase<string> | Lowercase<string>[],
  ): Promise<T[]>

  Type Parameters

  • T extends Payload

  Parameters

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

  Returns Promise<T[]>

StaticfilterIncludeByDataHash

• filterIncludeByDataHash<T extends Payload>(
      payloads?: T[],
      hash: Lowercase<string> | Lowercase<string>[],
  ): Promise<T[]>

  Type Parameters

  • T extends Payload

  Parameters

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

  Returns Promise<T[]>

StaticfilterIncludeByEitherHash

• filterIncludeByEitherHash<T extends Payload>(
      payloads?: T[],
      hash: Lowercase<string> | Lowercase<string>[],
  ): Promise<T[]>

  Type Parameters

  • T extends Payload

  Parameters

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

  Returns Promise<T[]>

StaticfindByDataHash

• findByDataHash<T extends Payload>(
      payloads?: T[],
      hash: Lowercase<string>,
  ): Promise<undefined | T>

  Type Parameters

  • T extends Payload

  Parameters

  • payloads: T[] = []
  • hash: Lowercase<string>

  Returns Promise<undefined | T>

Statichash

• hash<T extends Payload>(payload: T): Promise<Lowercase<string>>

  Type Parameters

  • T extends Payload

  Parameters

  • payload: T

  Returns Promise<Lowercase<string>>

StatichashableFields

• hashableFields<T extends Payload>(payload: T): WithoutStorageMeta<T>

  Type Parameters

  • T extends Payload

  Parameters

  • payload: T

  Returns WithoutStorageMeta<T>

Statichashes

• hashes(payloads: undefined): Promise<undefined>

  Parameters

  • payloads: undefined

  Returns Promise<undefined>

• hashes<T extends Payload>(payloads: T[]): Promise<Lowercase<string>[]>

  Type Parameters

  • T extends Payload

  Parameters

  • payloads: T[]

  Returns Promise<Lowercase<string>[]>

StatichashPairs

• hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Lowercase<string>][]>

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

  Type Parameters

  • T extends Payload

  Parameters

  • payloads: T[]

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

  An array of payload/hash tuples

StaticomitClientMeta

• omitClientMeta<T extends object>(
      payload: T,
      maxDepth?: number,
  ): WithoutClientMeta<T>

  Type Parameters

  • T extends object

  Parameters

  • payload: T
  • OptionalmaxDepth: number

  Returns WithoutClientMeta<T>

• omitClientMeta<T extends object>(
      payloads: T[],
      maxDepth?: number,
  ): WithoutClientMeta<T>[]

  Type Parameters

  • T extends object

  Parameters

  • payloads: T[]
  • OptionalmaxDepth: number

  Returns WithoutClientMeta<T>[]

StaticomitMeta

• omitMeta<T extends object>(payload: T, maxDepth?: number): WithoutMeta<T>

  Type Parameters

  • T extends object

  Parameters

  • payload: T
  • OptionalmaxDepth: number

  Returns WithoutMeta<T>

• omitMeta<T extends object>(payloads: T[], maxDepth?: number): WithoutMeta<T>[]

  Type Parameters

  • T extends object

  Parameters

  • payloads: T[]
  • OptionalmaxDepth: number

  Returns WithoutMeta<T>[]

StaticomitPrivateStorageMeta

• omitPrivateStorageMeta<T extends object>(
      payload: T,
      maxDepth?: number,
  ): WithoutPrivateStorageMeta<T>

  Type Parameters

  • T extends object

  Parameters

  • payload: T
  • OptionalmaxDepth: number

  Returns WithoutPrivateStorageMeta<T>

• omitPrivateStorageMeta<T extends object>(
      payloads: T[],
      maxDepth?: number,
  ): WithoutPrivateStorageMeta<T>[]

  Type Parameters

  • T extends object

  Parameters

  • payloads: T[]
  • OptionalmaxDepth: number

  Returns WithoutPrivateStorageMeta<T>[]

StaticomitStorageMeta

• omitStorageMeta<T extends object>(
      payload: T,
      maxDepth?: number,
  ): WithoutStorageMeta<T>

  Type Parameters

  • T extends object

  Parameters

  • payload: T
  • OptionalmaxDepth: number

  Returns WithoutStorageMeta<T>

• omitStorageMeta<T extends object>(
      payloads: T[],
      maxDepth?: number,
  ): WithoutStorageMeta<T>[]

  Type Parameters

  • T extends object

  Parameters

  • payloads: T[]
  • OptionalmaxDepth: number

  Returns WithoutStorageMeta<T>[]

StaticpickClientMeta

• pickClientMeta<T extends object>(
      payload: T,
      maxDepth?: number,
  ): WithOnlyClientMeta<T>

  Type Parameters

  • T extends object

  Parameters

  • payload: T
  • OptionalmaxDepth: number

  Returns WithOnlyClientMeta<T>

• pickClientMeta<T extends object>(
      payloads: T[],
      maxDepth?: number,
  ): WithOnlyClientMeta<T>[]

  Type Parameters

  • T extends object

  Parameters

  • payloads: T[]
  • OptionalmaxDepth: number

  Returns WithOnlyClientMeta<T>[]

StaticsortByStorageMeta

• sortByStorageMeta<T extends Payload>(
      payloads: WithStorageMeta<T>[],
      direction?: -1 | 1,
      comparer?: Compare<Lowercase<string>>,
  ): WithStorageMeta<T>[]

  Type Parameters

  • T extends Payload

  Parameters

  • payloads: WithStorageMeta<T>[]
  • direction: -1 | 1 = 1
  • comparer: Compare<Lowercase<string>> = SequenceComparer.local

  Returns WithStorageMeta<T>[]

StatictoAllHashMap

• toAllHashMap<T extends Payload>(
      payloads: T[],
  ): Promise<Record<Lowercase<string>, T>>

  Type Parameters

  • T extends Payload

  Parameters

  • payloads: T[]

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

StatictoDataHashMap

• toDataHashMap<T extends Payload>(
      objs: T[],
  ): Promise<Record<Lowercase<string>, T>>

  Type Parameters

  • T extends Payload

  Parameters

  • objs: T[]

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

StatictoHashMap

• toHashMap<T extends Payload>(objs: T[]): Promise<Record<Lowercase<string>, T>>

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

  Type Parameters

  • T extends Payload

  Parameters

  • objs: T[]

    Any array of payloads

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

  A map of hashes to payloads