Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Context<TState>

Type parameters

  • TState = any

Hierarchy

Index

Properties

Methods

Properties

Readonly cubiz

cubiz: Cubiz<TState>

Get current cubiz

Readonly data

data: Record<string, any>

Get data of the effect. The data is persisted between effect calls

Readonly effect

effect: Effect<any, [], void>

Get effect info

Readonly key

key: any

Readonly params

params: any

state

state: StateAccessor<TState>

Methods

call

  • call<TPayload, TResult>(effect: Effect<TState, TPayload, TResult>, ...args: TPayload): InferEffectResult<TResult>

  • call effect

    Type parameters

    • TPayload: any[]

    • TResult

    Parameters

    • effect: Effect<TState, TPayload, TResult>
    • Rest ...args: TPayload

    Returns InferEffectResult<TResult>

cancel

  • cancel(): void

cancelled

  • cancelled(): boolean

configure

  • configure(configs: Partial<CubizConfigs>): void

dispose

  • dispose(): void

disposed

  • disposed(): boolean

findContexts

  • findContexts(predicate?: (context: Context<TState>) => boolean): Context<TState>[]

  • Find all contents that mathes specified predicate. This method is useful to implement the effect that impacts to other effect calls

    Parameters

    • Optional predicate: (context: Context<TState>) => boolean
        • (context: Context<TState>): boolean

        • Parameters

          Returns boolean

    Returns Context<TState>[]

fork

  • fork<TPayload, TResult>(effect: Effect<TState, TPayload, TResult>, ...args: TPayload): InferEffectResult<TResult>

  • Type parameters

    • TPayload: any[]

    • TResult

    Parameters

    • effect: Effect<TState, TPayload, TResult>
    • Rest ...args: TPayload

    Returns InferEffectResult<TResult>

on

spawn

  • spawn<TPayload, TResult>(effect: Effect<TState, TPayload, TResult>, ...args: TPayload): InferEffectResult<TResult>

  • call effect with new context

    Type parameters

    • TPayload: any[]

    • TResult

    Parameters

    • effect: Effect<TState, TPayload, TResult>
    • Rest ...args: TPayload

    Returns InferEffectResult<TResult>

use

Generated using TypeDoc