mobx-sentinel API doc
    Preparing search index...

    Type Alias Handlers

    type Handlers = {
        didSubmit: (succeed: boolean) => void;
        submit: (abortSignal: AbortSignal) => Promise<boolean>;
        willSubmit: (abortSignal: AbortSignal) => Promise<boolean>;
    }
    Index

    Properties

    didSubmit submit willSubmit

    Properties

    didSubmit: (succeed: boolean) => void

    Called after submission completes

    Type declaration

      • (succeed: boolean): void

      • Parameters

        • succeed: boolean

          true if submission succeeded, false if failed or aborted

        Returns void

    submit: (abortSignal: AbortSignal) => Promise<boolean>

    Async handler that perform the submission (serialized)

    Type declaration

      • (abortSignal: AbortSignal): Promise<boolean>

      • Parameters

        • abortSignal: AbortSignal

          Abort signal for the submission

        Returns Promise<boolean>

        true if submission succeeded, false if failed or aborted

    willSubmit: (abortSignal: AbortSignal) => Promise<boolean>

    Called before submission starts

    Type declaration

      • (abortSignal: AbortSignal): Promise<boolean>

      • Parameters

        • abortSignal: AbortSignal

          Abort signal for the submission

        Returns Promise<boolean>

        true to continue submission, false to cancel submission

    Settings

    Member Visibility

    On This Page

    Properties