Skip to content

Welshman Docs / @welshman/app / collection

Function: collection() ​

collection<T, LoadArgs>(__namedParameters): object

Defined in: packages/app/src/collection.ts:6

Type Parameters ​

• T

• LoadArgs extends any[]

Parameters ​

__namedParameters ​

getKey ​

(item) => string

load? ​

(key, ...args) => Promise<any>

name ​

string

store ​

Readable<T[]>

Returns ​

object

deriveItem() ​

deriveItem: (key, ...args) => Readable<undefined | T>

Parameters ​

key ​

Maybe<string>

args ​

...LoadArgs

Returns ​

Readable<undefined | T>

indexStore ​

indexStore: ReadableWithGetter<Map<string, T>>

loadItem() ​

loadItem: (key, ...args) => Promise<undefined | T>

Parameters ​

key ​

string

args ​

...LoadArgs

Returns ​

Promise<undefined | T>