Class StoreCollection<T, V>Abstract

Collection backed by a Solid.js Store

Type Parameters

  • T

  • V

Hierarchy

Constructors

constructor

Properties

#objects #storage getUnderlyingObject updateUnderlyingObject

Methods

create delete entries filter find forEach get has isPartial keys map size toList values

Constructors

constructor

Properties

Private #objects

#objects: ReactiveMap<string, T> = ...

Private #storage

#storage: ObjectStorage<V> = ...

Readonly getUnderlyingObject

getUnderlyingObject: ((id: string) => V)

Type declaration

    • (id: string): V

    • Parameters

      • id: string

      Returns V

Readonly updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, V>>

Methods

create

  • Create a new instance of an object

    Parameters

    • id: string

      Id

    • type: "user" | "server" | "channel" | "bot" | "channelUnread" | "channelWebhook" | "emoji" | "message" | "serverMember" | "session"

      Type

    • instance: T

      Instance

    • context: unknown

      Context

    • Optional data: unknown

      Data

    Returns void

delete

entries

filter

  • Filter the collection by a given predicate

    Parameters

    • predicate: ((value: T, key: string) => boolean)

      Predicate to satisfy

        • (value: T, key: string): boolean

        • Parameters

          • value: T
          • key: string

          Returns boolean

    Returns T[]

find

  • Find some value based on a predicate

    Parameters

    • predicate: ((value: T, key: string) => boolean)

      Predicate to satisfy

        • (value: T, key: string): boolean

        • Parameters

          • value: T
          • key: string

          Returns boolean

    Returns undefined | T

forEach

  • Execute a provided function over each key, value pair in the map

    Returns

    Iterable

    Parameters

    • cb: ((value: T, key: string, map: ReactiveMap<string, T>) => void)

      Callback for each pair

        • (value: T, key: string, map: ReactiveMap<string, T>): void

        • Parameters

          • value: T
          • key: string
          • map: ReactiveMap<string, T>

          Returns void

    Returns void

get

has

isPartial

  • Check whether an object is partially defined

    Returns

    Whether it is a partial

    Parameters

    • id: string

      Id

    Returns boolean

keys

map

  • Map the collection using a given callback

    Type Parameters

    • O

    Parameters

    • cb: ((value: T, key: string) => O)

      Callback

        • (value: T, key: string): O

        • Parameters

          • value: T
          • key: string

          Returns O

    Returns O[]

size

toList

values

On This Page

Generated using TypeDoc