@resistdesign/voltra
    Preparing search index...

    Type Alias ApplicationStateLoaderConfig<ValueType, ArgsType>

    The configuration for an application state loader.

    type ApplicationStateLoaderConfig<
        ValueType = ApplicationStateValue,
        ArgsType extends any[] = any[],
    > = {
        identifier: ApplicationStateIdentifier<ValueType>;
        manual?: boolean;
        onLoadComplete?: (success: boolean) => void;
        remoteProcedureCall: RemoteProcedureCall<ArgsType>;
        resetOnError?: boolean;
    }

    Type Parameters

    Index

    Properties

    identifier manual? onLoadComplete? remoteProcedureCall resetOnError?

    Properties

    identifier: ApplicationStateIdentifier<ValueType>

    Identifier for the value to update in application state.

    manual?: boolean

    Prevent automatic loading of the application state value and call the RemoteProcedureCall manually with makeRemoteProcedureCall on the ApplicationStateLoader.

    false
    onLoadComplete?: (success: boolean) => void

    Called each time the application state value has been loaded.

    Type Declaration

      • (success: boolean): void

      • Parameters

        • success: boolean

          Whether the request completed successfully.

        Returns void

    remoteProcedureCall: RemoteProcedureCall<ArgsType>

    RPC target configuration and arguments.

    resetOnError?: boolean

    Clear the application state value on error.

    false

    Settings

    Member Visibility

    On This Page

    Properties