Class StoreCollection<T, V>Abstract

Collection backed by a Solid.js Store

Type Parameters

  • T
  • V

Hierarchy (View Summary)

Constructors

constructor

Properties

getUnderlyingObject updateUnderlyingObject

Methods

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

Constructors

constructor

Properties

ReadonlygetUnderlyingObject

getUnderlyingObject: (id: string) => V

ReadonlyupdateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, V>>

Methods

Protectedadd

  • add(id: string, instance: T, hydrated: V): void

    Add a previously hydrated object to the collection

    Parameters

    • id: string

      Id

    • instance: T

      Instance

    • hydrated: V

      Hydrated

    Returns void

create

  • create(
        id: string,
        type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session",
        instance: T,
        context: unknown,
        data?: unknown,
    ): void

    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

    • Optionaldata: unknown

      Data

    Returns void

delete

entries

filter

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

    Filter the collection by a given predicate

    Parameters

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

      Predicate to satisfy

    Returns T[]

find

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

    Find some value based on a predicate

    Parameters

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

      Predicate to satisfy

    Returns undefined | T

forEach

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

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

    Parameters

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

      Callback for each pair

    Returns void

    Iterable

get

has

Protectedhydrate

  • hydrate(
        type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session",
        context: unknown,
        data: object,
    ): V

    Hydrate a new instance of an object. This function does not add the object to the collection.

    Parameters

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

      Type

    • context: unknown

      Context

    • data: object

      Data

    Returns V

isPartial

  • isPartial(id: string): boolean

    Check whether an object is partially defined

    Parameters

    • id: string

      Id

    Returns boolean

    Whether it is a partial

keys

map

size

toList

values

On This Page

Constructors
Properties
Methods