swarpc - v0.10.0
    Preparing search index...

    Type Alias Hooks<Procedures>

    Declaration of hooks to run on messages received from the server

    type Hooks<Procedures extends ProceduresMap> = {
        success?: <Procedure extends keyof ProceduresMap>(
            procedure: Procedure,
            data: Procedures[Procedure]["success"]["inferOut"],
        ) => void;
        error?: <Procedure extends keyof ProceduresMap>(
            procedure: Procedure,
            error: Error,
        ) => void;
        progress?: <Procedure extends keyof ProceduresMap>(
            procedure: Procedure,
            data: Procedures[Procedure]["progress"]["inferOut"],
        ) => void;
    }

    Type Parameters

    Index

    Properties

    success? error? progress?

    Properties

    success?: <Procedure extends keyof ProceduresMap>(
        procedure: Procedure,
        data: Procedures[Procedure]["success"]["inferOut"],
    ) => void

    Called when a procedure call has been successful.

    error?: <Procedure extends keyof ProceduresMap>(
        procedure: Procedure,
        error: Error,
    ) => void

    Called when a procedure call has failed.

    progress?: <Procedure extends keyof ProceduresMap>(
        procedure: Procedure,
        data: Procedures[Procedure]["progress"]["inferOut"],
    ) => void

    Called when a procedure call sends progress updates.

    Settings

    Member Visibility

    On This Page

    Properties