Function StateEffectFactory

Returns {
    effect: {
        state: {
            UnsubscribedError: typeof UnsubscribedError;
            create: (<Data, Modifiers>(initialValue, modifiers) => StateAtom<Data, Modifiers>);
            dispatch: (<Modifier>(modifier, ...payload) => void);
            subscribe: (<Ctx, Atom, A>(context, atom, task, errorCallback?) => ((shouldAbort?) => void));
        };
    };
    removeEffect?: (() => void);
}

• effect: {
      state: {
          UnsubscribedError: typeof UnsubscribedError;
          create: (<Data, Modifiers>(initialValue, modifiers) => StateAtom<Data, Modifiers>);
          dispatch: (<Modifier>(modifier, ...payload) => void);
          subscribe: (<Ctx, Atom, A>(context, atom, task, errorCallback?) => ((shouldAbort?) => void));
      };
  }

  • state: {
        UnsubscribedError: typeof UnsubscribedError;
        create: (<Data, Modifiers>(initialValue, modifiers) => StateAtom<Data, Modifiers>);
        dispatch: (<Modifier>(modifier, ...payload) => void);
        subscribe: (<Ctx, Atom, A>(context, atom, task, errorCallback?) => ((shouldAbort?) => void));
    }

    • UnsubscribedError: typeof UnsubscribedError

    • create: (<Data, Modifiers>(initialValue, modifiers) => StateAtom<Data, Modifiers>)

      • • <Data, Modifiers>(initialValue, modifiers): StateAtom<Data, Modifiers>

        • Type Parameters

          • Data extends AnyRecord | AnyArray

          • Modifiers extends {
                [modifierName: string]: ((data, ...payload) => boolean);
            }

          Parameters

          • initialValue: Data

          • modifiers: Modifiers

          Returns StateAtom<Data, Modifiers>

    • dispatch: (<Modifier>(modifier, ...payload) => void)

      • • <Modifier>(modifier, ...payload): void

        • Type Parameters

          • Modifier extends ((...parameters) => boolean) & {
                [ModifierIdentifier]: StateAtom;
            }

          Parameters

          • modifier: Modifier

          • Rest ...payload: Parameters<Modifier>

          Returns void

    • subscribe: (<Ctx, Atom, A>(context, atom, task, errorCallback?) => ((shouldAbort?) => void))

      • • <Ctx, Atom, A>(context, atom, task, errorCallback?): ((shouldAbort?) => void)

        • Type Parameters

          • Ctx extends ExecutionContext<any, any, Ctx>

          • Atom extends StateAtom

          • A extends NamedTask<AnyTask>

          Parameters

          • context: Ctx

          • atom: TaskParameter<Atom, A>

          • task: ContextualizedTask<Ctx, A>

          • Optional errorCallback: ErrorCallback

          Returns ((shouldAbort?) => void)

          • • (shouldAbort?): void

            • Parameters

              • Optional shouldAbort: boolean

              Returns void

• Optional removeEffect?: (() => void)

  • • (): void

    • Returns void