Function initQuery

  • initQuery(
        fetchArgs: FetchArgs,
        endpoint:
            | "start"
            | "next"
            | "flow"
            | "success"
            | "error"
            | "failure"
            | "resume"
            | "authorize"
            | "tokenExchange"
            | "revoke"
            | "userInfo"
            | "endSession",
    ): {
        applyMiddleware(
            middleware: undefined | RequestMiddleware<ActionTypes, any>[],
        ): { applyMiddleware(middleware: RequestMiddleware<ActionTypes, any>[] | undefined): ...; applyQuery(callback: (request: FetchArgs) => Promise<...>): Promise<...>; };
        applyQuery(
            callback: (
                request: FetchArgs,
            ) => Promise<
                QueryReturnValue<unknown, FetchBaseQueryError, FetchBaseQueryMeta>,
            >,
        ): Promise<
            QueryReturnValue<unknown, FetchBaseQueryError, FetchBaseQueryMeta>,
        >;
    }

    Parameters

    • fetchArgs: FetchArgs

      The request object to initialize the query with

    • endpoint:
          | "start"
          | "next"
          | "flow"
          | "success"
          | "error"
          | "failure"
          | "resume"
          | "authorize"
          | "tokenExchange"
          | "revoke"
          | "userInfo"
          | "endSession"

      The endpoint to be used for the query

    Returns {
        applyMiddleware(
            middleware: undefined | RequestMiddleware<ActionTypes, any>[],
        ): { applyMiddleware(middleware: RequestMiddleware<ActionTypes, any>[] | undefined): ...; applyQuery(callback: (request: FetchArgs) => Promise<...>): Promise<...>; };
        applyQuery(
            callback: (
                request: FetchArgs,
            ) => Promise<
                QueryReturnValue<unknown, FetchBaseQueryError, FetchBaseQueryMeta>,
            >,
        ): Promise<
            QueryReturnValue<unknown, FetchBaseQueryError, FetchBaseQueryMeta>,
        >;
    }

    Function

    initQuery - Initializes a query object with the provided request object

Settings

Member Visibility