supertokens-node
    Preparing search index...

    Type Alias APIInterface

    type APIInterface = {
        refreshPOST:
            | undefined
            | (
                (
                    input: { options: APIOptions; userContext: UserContext },
                ) => Promise<SessionContainer>
            );
        signOutPOST:
            | undefined
            | (
                (
                    input: {
                        options: APIOptions;
                        session: SessionContainer;
                        userContext: UserContext;
                    },
                ) => Promise<{ status: "OK" } | GeneralErrorResponse>
            );
        verifySession(
            input: {
                options: APIOptions;
                userContext: UserContext;
                verifySessionOptions: VerifySessionOptions | undefined;
            },
        ): Promise<undefined | SessionContainer>;
    }
    Index

    Properties

    refreshPOST signOutPOST

    Methods

    verifySession

    Properties

    refreshPOST:
        | undefined
        | (
            (
                input: { options: APIOptions; userContext: UserContext },
            ) => Promise<SessionContainer>
        )

    We do not add a GeneralErrorResponse response to this API since it's not something that is directly called by the user on the frontend anyway

    signOutPOST:
        | undefined
        | (
            (
                input: {
                    options: APIOptions;
                    session: SessionContainer;
                    userContext: UserContext;
                },
            ) => Promise<{ status: "OK" } | GeneralErrorResponse>
        )

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods