flux

namespace flux

Functions

dispatch<A extends FluxAction<string>>(action: A & FluxActionOf<A["type"]>): Promise<void>

Sends a Flux action through Discord's dispatcher.

Returns

A promise that settles once Discord's stores handled the action.

getStore<K extends FluxStoreName>(name: K, options?: GetStoreOptions): FluxStoreOf<K>

Finds one of Discord's Flux stores by name. A store already loaded and cached is returned as itself; otherwise the search is lazy unless { lazy: false } is passed, and runs on first access.

Returns

The store, typed from FluxStores, else as a base FluxStore.

interceptAction<K extends FluxActionType>(type: K, interceptor: FluxActionInterceptor<K>): () => void

Runs an interceptor before Discord handles each Flux action of one type. It may change the action, or drop it by returning true.

Returns

A function that removes the interceptor.

onAction<K extends FluxActionType>(type: K, listener: FluxActionListener<K>): () => void

Runs a listener for each Flux action of one type, after Discord's stores handle it.

Returns

A function that removes the listener.

onStoreChange(store: FluxStore, listener: FluxChangeListener): () => void

Runs a listener each time a Flux store changes.

Returns

A function that removes the listener.

useStore<S extends FluxStore | readonly FluxStore[], T>(stores: S, selector: (stores: S) => T, options?: UseStoreOptions<T>): T

Selects state from Flux stores in a component, re-rendering only when the selection changes.

Returns

The selector's latest value.

Interfaces

FluxActions

The payload of each Flux action, keyed by action type. Add your own with declare module '@unbound-app/api/flux' { interface FluxActions { MY_ACTION: { id: string } } }.

FluxStores

The Flux stores flux.getStore knows, keyed by name without the Store suffix. Add your own with declare module '@unbound-app/api/flux' { interface FluxStores { Message: MessageStore } }.