Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ItemStore<T>

Observable-based class used for storing any kind of data, primarily for use with the *Loader classes.

Type parameters

  • T = { id: string }

Hierarchy

  • ItemStore

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private Readonly items

items: Map<string, 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

Methods

add

  • add(...items: T[]): void

  • Adds one or more items to the store

    Parameters

    • Rest ...items: T[]

    Returns void

clear

  • clear(): void

find

  • find(predicate: (item: T) => boolean): undefined | T

  • Helper for finding an item based on a condition. Works similarly to array.find

    Parameters

    • predicate: (item: T) => boolean
        • (item: T): boolean

        • Parameters

          • item: T

          Returns boolean

    Returns undefined | T

get

  • get(itemId: string): undefined | T

Private getDefaultItemId

  • getDefaultItemId(item: undefined | null | { id?: unknown }): undefined | string

  • Parameters

    • item: undefined | null | { id?: unknown }

    Returns undefined | string

getItemId

  • getItemId(item: T): undefined | string

remove

  • remove(itemId: string): void

  • Removes an item by ID. Calling this will make it disappear from dependent loaders and list loaders

    Parameters

    • itemId: string

    Returns void

Generated using TypeDoc