Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Loader<T>

Type parameters

  • T

Hierarchy

  • Loader

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Optional itemId

itemId: undefined | string

The ID of the item we're pulling from the store

Private Readonly loadData

loadData: () => Promise<T>

Type declaration

    • (): Promise<T>

    • Returns Promise<T>

Private Readonly messages

messages: { invalidItemWarning: (value: unknown) => string; loaderError: (error: string) => string; missingItemsWarning: (value: unknown) => string; nilValueWarning: () => string }

Type declaration

  • invalidItemWarning: (value: unknown) => string
      • (value: unknown): string

      • Parameters

        • value: unknown

        Returns string

  • loaderError: (error: string) => string
      • (error: string): string

      • Parameters

        • error: string

        Returns string

  • missingItemsWarning: (value: unknown) => string
      • (value: unknown): string

      • Parameters

        • value: unknown

        Returns string

  • nilValueWarning: () => string
      • (): string

      • Returns string

Private Readonly state

state: LoadingState<T>

Readonly store

store: ItemStore<T>

Accessors

data

  • get data(): undefined | T

  • The data loaded by the loader. Pulls the data from the store by itemId

    Returns undefined | T

error

  • get error(): unknown

isDelayed

  • get isDelayed(): boolean

  • true if the data has been loading for a while

    Returns boolean

isLoading

  • get isLoading(): boolean

  • true if the data is currently being loaded

    Returns boolean

Methods

lazyLoad

  • lazyLoad(): Promise<undefined | T>

  • Loads the data, but only if it's not already loaded

    Returns Promise<undefined | T>

load

  • load(): Promise<undefined | T>

  • Try to load the data, then store it in the store. If already loading, will wait until it's finished

    Returns Promise<undefined | T>

setData

  • setData(data: T): void

  • Sets the Loader's itemId to that of the data, and adds the data to the store, effectively setting the data that the Loader is working with.

    Parameters

    • data: T

    Returns void

Generated using TypeDoc