Welshman

Appearance

Welshman Docs / @welshman/app / DerivedPlugin

Abstract Class: DerivedPlugin<T> ​

Defined in: plugins/base.ts:204

A CollectionPlugin over deriveItemsByKey: one item per key across all relays.

Extends ​

Extended by ​

Type Parameters ​

T ​

T

Constructors ​

Constructor ​

new DerivedPlugin<T>(app, options): DerivedPlugin<T>

Defined in: plugins/base.ts:205

Parameters ​

app ​

IApp

options ​

DerivedPluginOptions<T>

Returns ​

DerivedPlugin<T>

Overrides ​

CollectionPlugin.constructor

Properties ​

all ​

all: Projection<T[]>

Defined in: plugins/base.ts:167

Inherited from ​

CollectionPlugin.all

app ​

protected readonly app: IApp

Defined in: plugins/base.ts:175

Inherited from ​

CollectionPlugin.app

forceLoad ​

forceLoad: (key, ...args) => Promise<Maybe<T>>

Defined in: plugins/base.ts:170

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<T>>

Inherited from ​

CollectionPlugin.forceLoad

index ​

readonly index: ItemCollection<T>

Defined in: plugins/base.ts:176

Inherited from ​

CollectionPlugin.index

load ​

load: (key, ...args) => Promise<Maybe<T>>

Defined in: plugins/base.ts:169

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<T>>

Inherited from ​

CollectionPlugin.load

one ​

one: (key?, ...args) => Readable<Maybe<T>>

Defined in: plugins/base.ts:168

Parameters ​

key? ​

string

args ​

...any[]

Returns ​

Readable<Maybe<T>>

Inherited from ​

CollectionPlugin.one

Methods ​

fetch() ​

abstract fetch(key, ...args): Promise<unknown>

Defined in: plugins/base.ts:172

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<unknown>

Inherited from ​

CollectionPlugin.fetch

get() ​

get(key): T | undefined

Defined in: plugins/base.ts:190

Parameters ​

key ​

string

Returns ​

T | undefined

Inherited from ​

CollectionPlugin.get

project() ​

project<U>(key, read): Projection<U>

Defined in: plugins/base.ts:192

Type Parameters ​

U ​

U

Parameters ​

key ​

string

read ​

(item) => U

Returns ​

Projection<U>

Inherited from ​

CollectionPlugin.project