Documentation

API Reference

machine

Generic state machine system built on XState with built-in activities and services for UI layouts.

@quicksave/machine

Namespaces

Ƭ Event: xstate.EventObject

Ƭ Sender<EventT>: xstate.Sender<EventT>

Name	Type
`EventT`	extends `Event`

Ƭ State: xstate.StateSchema<Context> & { states: { [key: string]: State; } }

▸ activity<ContextT, EventT>(activity): (context: ContextT) => (sendBack: Sender<EventT>) => () => void

Helper to convert an activity function with context and sendBack parameters to an xstate compatible callback service declaration.

For example an xstate service like this:

function foobar(context) {
    return (sendBack) => {
        // ...
    };
}

    
  

Can be simplified into this by wrapping the service assignment with activity(foobar):

function foobar(context, sendBack) {
    // ...
}

Name	Type
`ContextT`	extends `Context`
`EventT`	extends `EventObject`

Name	Type	Description
`activity`	(`context`: `ContextT`, `sendBack`: `Sender`<`EventT`>) => () => `void`	The activity function to convert

fn

▸ (context): (sendBack: Sender<EventT>) => () => void

Name	Type
`context`	`ContextT`

fn

▸ (sendBack): () => void

Name	Type
`sendBack`	`Sender`<`EventT`>

fn

▸ (): void

void