Class PayloadWrapper<TPayload>

payload

dataHash

• dataHash(): Promise<Lowercase<string>>

• Returns Promise<Lowercase<string>>

getErrors

• getErrors(): Promise<Error[]>

• Returns Promise<Error[]>

getValid

• getValid(): Promise<boolean>

• Returns Promise<boolean>

schema

• schema(): string

• Returns string

validate

• validate(): Promise<Error[]>

• Returns Promise<Error[]>

Staticas

• as<
      T extends
          DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
          { schema: string },
      >,
  >(
      value: unknown,
  ): null | PayloadDataWrapper<T>

• Type Parameters

  • T extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>

  Parameters

  • value: unknown

  Returns null | PayloadDataWrapper<T>

Staticload

• load(address: Lowercase<string>): Promise<null | PayloadDataWrapper>

• Parameters

  • address: Lowercase<string>

  Returns Promise<null | PayloadDataWrapper>

Staticparse

• parse<T extends DeepRestrictToStringKeys<{ schema: string }>>(
      payload?: unknown,
  ): undefined | PayloadDataWrapper<T>

• Type Parameters

  • T extends DeepRestrictToStringKeys<{ schema: string }>

  Parameters

  • Optionalpayload: unknown

  Returns undefined | PayloadDataWrapper<T>

StaticsetLoaderFactory

• setLoaderFactory(factory: null | PayloadLoaderFactory): void

• Parameters

  • factory: null | PayloadLoaderFactory

  Returns void

StatictryParse

• tryParse<T extends DeepRestrictToStringKeys<{ schema: string }>>(
      obj: unknown,
  ): undefined | PayloadDataWrapper<T>

• Type Parameters

  • T extends DeepRestrictToStringKeys<{ schema: string }>

  Parameters

  • obj: unknown

  Returns undefined | PayloadDataWrapper<T>

Staticunwrap

• unwrap<
      TPayload extends
          DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
          { schema: string },
      >,
  >(
      payload?: TPayload,
  ): undefined | TPayload

• Type Parameters

  • TPayload extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>

  Parameters

  • Optionalpayload: TPayload

  Returns undefined | TPayload

• unwrap<
      TPayload extends
          DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
          { schema: string },
      >,
      TWrapper extends
          PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
  >(
      payload: TPayload | TWrapper,
  ): TPayload

• Type Parameters

  • TPayload extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
  • TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>

  Parameters

  • payload: TPayload | TWrapper

  Returns TPayload

• unwrap<
      TPayload extends
          DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
          { schema: string },
      >,
      TWrapper extends
          PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
  >(
      payload: (TPayload | TWrapper)[],
  ): TPayload[]

• Type Parameters

  • TPayload extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
  • TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>

  Parameters

  • payload: (TPayload | TWrapper)[]

  Returns TPayload[]

StaticunwrapSinglePayload

• unwrapSinglePayload<
      TPayload extends
          DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
          { schema: string },
      >,
  >(
      payload?: TPayload,
  ): undefined | TPayload

• Type Parameters

  • TPayload extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>

  Parameters

  • Optionalpayload: TPayload

  Returns undefined | TPayload

• unwrapSinglePayload<
      TPayload extends
          DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
          { schema: string },
      >,
      TWrapper extends
          PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
  >(
      payload: TPayload | TWrapper,
  ): TPayload

• Type Parameters

  • TPayload extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
  • TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>

  Parameters

  • payload: TPayload | TWrapper

  Returns TPayload

Staticwrap

• wrap<T extends DeepRestrictToStringKeys<{ schema: string }>>(
      payload?: T | PayloadDataWrapper<T>,
  ): PayloadDataWrapper<T>

• Type Parameters

  • T extends DeepRestrictToStringKeys<{ schema: string }>

  Parameters

  • Optionalpayload: T | PayloadDataWrapper<T>

  Returns PayloadDataWrapper<T>

StaticwrappedMap

• wrappedMap<T extends DeepRestrictToStringKeys<{ schema: string }>>(
      payloads: (T | PayloadDataWrapper<T>)[],
  ): Promise<Record<string, PayloadDataWrapper<T>>>

• Type Parameters

  • T extends DeepRestrictToStringKeys<{ schema: string }>

  Parameters

  • payloads: (T | PayloadDataWrapper<T>)[]

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