Store

enqueue

js

abstract suspend fun enqueue(update: QueuedUpdate<T>)

abstract method defining, how this Store handles an Update

errorHandler

js

open fun errorHandler(exception: Throwable, oldValue: T): T

Default error handler printing the error to console and keeping the previous value.

handle

js

open fun handle(errorHandler: ErrorHandler<T> = ::errorHandler, execute: suspend (T) -> T): SimpleHandler<Unit>

Factory method to create a SimpleHandler that does not take an Action

open fun <A> handle(errorHandler: ErrorHandler<T> = ::errorHandler, execute: suspend (T, A) -> T): SimpleHandler<A>

Factory method to create a SimpleHandler mapping the actual value of the Store and a given Action to a new value.

handleAndEmit

js

open fun <E> handleAndEmit(errorHandler: ErrorHandler<T> = ::errorHandler, execute: suspend FlowCollector<E>.(T) -> T): EmittingHandler<Unit, E>

factory method to create an EmittingHandler that does not take an action in it's execute-lambda.

open fun <A, E> handleAndEmit(errorHandler: ErrorHandler<T> = ::errorHandler, execute: suspend FlowCollector<E>.(T, A) -> T): EmittingHandler<A, E>

Factory method to create a EmittingHandler taking an action-value and the current store value to derive the new value.

handledBy

js

open infix fun <E : Event, X : Element> DomListener<E, X>.handledBy(handler: Handler<Unit>)

Connects Events to a Handler.

open infix fun <E : Event, X : Element> DomListener<E, X>.handledBy(execute: suspend (E) -> Unit): Job

Connects a Flow to a suspendable execute function.

open infix fun <E : Event> WindowListener<E>.handledBy(handler: Handler<Unit>)

Connects Events to a Handler.

open infix fun <E : Event> WindowListener<E>.handledBy(execute: suspend (E) -> Unit): Job

Connects a Flow to a suspendable execute function.

open infix fun <A> Flow<A>.handledBy(handler: Handler<A>)

Connects a Flow to a Handler.

open infix fun <A> Flow<A>.handledBy(execute: suspend (A) -> Unit): Job

Connects a Flow to a suspendable execute function.

sub

js

open fun <X> sub(lens: Lens<T, X>): SubStore<T, X>

create a SubStore that represents a certain part of your data model.

syncBy

js

open fun syncBy(handler: Handler<T>)

calls a handler on each new value of the Store

open fun syncBy(handler: Handler<Unit>)

calls a handler on each new value of the Store

syncWith

js

open fun <I> syncWith(socket: Socket, resource: Resource<T, I>)

current

js

abstract val current: T

represents the current value of the Store

data

js

abstract val data: Flow<T>

the Flow representing the current value of the Store.

id

js

abstract val id: String

id of this Store.

job

js

abstract val job: Job

Job for launching coroutines in.

path

js

abstract val path: String

Path of this Store derived from the underlying model.

update

js

abstract val update: Handler<T>

a simple SimpleHandler that just takes the given action-value as the new value for the Store.

RootStore

SubStore

Router

inspect

js

fun <T> Store<T>.inspect(data: T): RootInspector<T>

sub

js

fun <T, I> Store<List<T>>.sub(element: T, id: IdProvider<T, I>): SubStore<List<T>, T>

creates a SubStore using a RootStore as parent using a given IdProvider.

fun <T> Store<List<T>>.sub(index: Int): SubStore<List<T>, T>

creates a SubStore using a RootStore as parent using the index in the list (do not use this, if you want to manipulate the list itself (add or move elements, filter, etc.).

syncBy

js

inline fun <T, R> Store<T>.syncBy(handler: Handler<R>, crossinline mapper: suspend (T) -> R)

calls a handler on each new value of the Store

syncWith

js

fun <T, I> Store<List<T>>.syncWith(socket: Socket, resource: Resource<T, I>)

watch

js

fun <T> Store<T>.watch(scope: CoroutineScope = MainScope()): Store<T>

If a Store's data-Flow is never mounted, use this method to start the updating of derived values.

Store

Functions

Properties

Inheritors

Extensions