Type Alias AuthModule<A>

An authentication module for a specific authentication format, like oauth, cookies etc

type AuthModule<A extends AuthType = AuthType> = {
    getRestCallAuthParams: (
        props: GetRestCallAuthParamsProps<A>,
    ) => Promise<RestCallAuthParams>;
    getWebResourceAuthParams?: (
        props: GetWebResourceAuthParamsProps<A>,
    ) => Promise<WebResourceAuthParams>;
    getWebSocketAuthParams: (
        props: GetWebSocketAuthParamsProps<A>,
    ) => Promise<WebSocketAuthParams>;
    handleAuthenticationError: (
        props: HandleAuthenticationErrorProps<A>,
    ) => Promise<AuthenticationErrorAction>;
    optionalProps?: OptionalKeys<HostConfig<A>>[];
    requiredProps?: RequiredKeys<HostConfig<A>>[];
    validateHostConfig?: (hostConfig: Record<string, unknown>) => boolean;
}

Type Parameters

A extends AuthType = AuthType

Index

Properties

getRestCallAuthParams getWebResourceAuthParams? getWebSocketAuthParams handleAuthenticationError optionalProps? requiredProps? validateHostConfig?

Properties

getRestCallAuthParams

getRestCallAuthParams: (
props: GetRestCallAuthParamsProps<A>,
) => Promise<RestCallAuthParams>

`Optional`getWebResourceAuthParams

getWebResourceAuthParams?: (
props: GetWebResourceAuthParamsProps<A>,
) => Promise<WebResourceAuthParams>

getWebSocketAuthParams

getWebSocketAuthParams: (
props: GetWebSocketAuthParamsProps<A>,
) => Promise<WebSocketAuthParams>

handleAuthenticationError

handleAuthenticationError: (
props: HandleAuthenticationErrorProps<A>,
) => Promise<AuthenticationErrorAction>

`Optional`optionalProps

optionalProps?: OptionalKeys<HostConfig<A>>[]

`Optional`requiredProps

requiredProps?: RequiredKeys<HostConfig<A>>[]

Properties required for this auth module

`Optional`validateHostConfig

validateHostConfig?: (hostConfig: Record<string, unknown>) => boolean