diff --git a/docs/classes/BooleanClaim.html b/docs/classes/BooleanClaim.html index 55508fec..07e059f8 100644 --- a/docs/classes/BooleanClaim.html +++ b/docs/classes/BooleanClaim.html @@ -1,3 +1,3 @@ -BooleanClaim | supertokens-website
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BooleanClaim

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new BooleanClaim(config: PrimitiveClaimConfig): BooleanClaim

Properties

Readonly defaultMaxAgeInSeconds

defaultMaxAgeInSeconds: undefined | number

Readonly id

id: string

Readonly refresh

refresh: ((userContext: any) => Promise<void>)

Type declaration

validators

validators: { hasValue: ((val: boolean, maxAgeInSeconds?: undefined | number, id?: string) => SessionClaimValidator) } & BooleanValidators

Methods

getLastFetchedTime

  • getLastFetchedTime(payload: any, _userContext?: any): undefined | number

getValueFromPayload

  • getValueFromPayload(payload: any, _userContext?: any): boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/PrimitiveArrayClaim.html b/docs/classes/PrimitiveArrayClaim.html index bed5c4e9..04319e2a 100644 --- a/docs/classes/PrimitiveArrayClaim.html +++ b/docs/classes/PrimitiveArrayClaim.html @@ -1,3 +1,3 @@ -PrimitiveArrayClaim | supertokens-website
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PrimitiveArrayClaim<ValueType>

Type Parameters

  • ValueType

Hierarchy

  • PrimitiveArrayClaim

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PrimitiveArrayClaim<ValueType>(config: PrimitiveArrayClaimConfig): PrimitiveArrayClaim<ValueType>

Properties

Readonly defaultMaxAgeInSeconds

defaultMaxAgeInSeconds: undefined | number

Readonly id

id: string

Readonly refresh

refresh: ((userContext: any) => Promise<void>)

Type declaration

validators

validators: { excludes: ((val: ValueType, maxAgeInSeconds?: undefined | number, id?: string) => SessionClaimValidator); excludesAll: ((val: ValueType[], maxAgeInSeconds?: undefined | number, id?: string) => SessionClaimValidator); includes: ((val: ValueType, maxAgeInSeconds?: undefined | number, id?: string) => SessionClaimValidator); includesAll: ((val: ValueType[], maxAgeInSeconds?: undefined | number, id?: string) => SessionClaimValidator); includesAny: ((val: ValueType[], maxAgeInSeconds?: undefined | number, id?: string) => SessionClaimValidator) } = ...

Type declaration

Methods

getLastFetchedTime

  • getLastFetchedTime(payload: any, _userContext?: any): undefined | number

getValueFromPayload

  • getValueFromPayload(payload: any, _userContext?: any): ValueType[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/PrimitiveClaim.html b/docs/classes/PrimitiveClaim.html index ca03591f..8c0e0b6c 100644 --- a/docs/classes/PrimitiveClaim.html +++ b/docs/classes/PrimitiveClaim.html @@ -1,3 +1,3 @@ -PrimitiveClaim | supertokens-website
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PrimitiveClaim<ValueType>

Type Parameters

  • ValueType

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PrimitiveClaim<ValueType>(config: PrimitiveClaimConfig): PrimitiveClaim<ValueType>

Properties

Readonly defaultMaxAgeInSeconds

defaultMaxAgeInSeconds: undefined | number

Readonly id

id: string

Readonly refresh

refresh: ((userContext: any) => Promise<void>)

Type declaration

validators

validators: { hasValue: ((val: ValueType, maxAgeInSeconds?: undefined | number, id?: string) => SessionClaimValidator) } = ...

Type declaration

Methods

getLastFetchedTime

  • getLastFetchedTime(payload: any, _userContext?: any): undefined | number

getValueFromPayload

  • getValueFromPayload(payload: any, _userContext?: any): ValueType

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/default.html b/docs/classes/default.html index 94e5ea2d..2d86f002 100644 --- a/docs/classes/default.html +++ b/docs/classes/default.html @@ -1 +1 @@ -default | supertokens-website
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • default

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Private axiosInterceptorQueue

axiosInterceptorQueue: (() => void)[] = []

Static getClaimValue

getClaimValue: (<T>(input: { claim: SessionClaim<T>; userContext?: any }) => Promise<undefined | T>) = ...

Type declaration

    • <T>(input: { claim: SessionClaim<T>; userContext?: any }): Promise<undefined | T>

    • Type Parameters

      • T

      Parameters

      Returns Promise<undefined | T>

Static getInvalidClaimsFromResponse

getInvalidClaimsFromResponse: ((input: { response: Response | { data: any }; userContext?: any }) => Promise<ClaimValidationError[]>) = ...

Type declaration

    • Parameters

      • input: { response: Response | { data: any }; userContext?: any }
        • response: Response | { data: any }
        • Optional userContext?: any

      Returns Promise<ClaimValidationError[]>

Methods

Static addAxiosInterceptors

  • addAxiosInterceptors(axiosInstance: any, userContext?: any): void
  • deprecated

    Parameters

    • axiosInstance: any
    • Optional userContext: any

    Returns void

Static attemptRefreshingSession

  • attemptRefreshingSession(): Promise<boolean>

Static doesSessionExist

  • doesSessionExist(input?: { userContext?: any }): Promise<boolean>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<boolean>

Static getAccessToken

  • getAccessToken(input?: { userContext?: any }): Promise<undefined | string>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<undefined | string>

Static getAccessTokenPayloadSecurely

  • getAccessTokenPayloadSecurely(input?: { userContext?: any }): Promise<any>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<any>

Static getUserId

  • getUserId(input?: { userContext?: any }): Promise<string>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<string>

Static init

Static signOut

  • signOut(input?: { userContext?: any }): Promise<void>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<void>

Static validateClaims

Generated using TypeDoc

\ No newline at end of file +default | supertokens-website
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • default

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Private axiosInterceptorQueue

axiosInterceptorQueue: (() => void)[] = []

Static getClaimValue

getClaimValue: (<T>(input: { claim: SessionClaim<T>; userContext?: any }) => Promise<undefined | T>) = ...

Type declaration

    • <T>(input: { claim: SessionClaim<T>; userContext?: any }): Promise<undefined | T>

    • Type Parameters

      • T

      Parameters

      Returns Promise<undefined | T>

Static getInvalidClaimsFromResponse

getInvalidClaimsFromResponse: ((input: { response: Response | { data: any }; userContext?: any }) => Promise<ClaimValidationError[]>) = ...

Type declaration

    • Parameters

      • input: { response: Response | { data: any }; userContext?: any }
        • response: Response | { data: any }
        • Optional userContext?: any

      Returns Promise<ClaimValidationError[]>

Methods

Static addAxiosInterceptors

  • addAxiosInterceptors(axiosInstance: any, userContext?: any): void
  • deprecated

    Parameters

    • axiosInstance: any
    • Optional userContext: any

    Returns void

Static attemptRefreshingSession

  • attemptRefreshingSession(): Promise<boolean>

Static doesSessionExist

  • doesSessionExist(input?: { userContext?: any }): Promise<boolean>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<boolean>

Static getAccessToken

  • getAccessToken(input?: { userContext?: any }): Promise<undefined | string>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<undefined | string>

Static getAccessTokenPayloadSecurely

  • getAccessTokenPayloadSecurely(input?: { userContext?: any }): Promise<any>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<any>

Static getUserId

  • getUserId(input?: { userContext?: any }): Promise<string>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<string>

Static init

Static signOut

  • signOut(input?: { userContext?: any }): Promise<void>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<void>

Static validateClaims

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index 857cdb16..869bae15 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,12 +1,12 @@ -supertokens-website
Options
All
  • Public
  • Public/Protected
  • All
Menu

supertokens-website

Index

Classes

Type Aliases

Functions

Type Aliases

ClaimValidationError

ClaimValidationError: { id: string; reason?: any }

Type declaration

  • id: string
  • Optional reason?: any

ClaimValidationResult

ClaimValidationResult: { isValid: true } | { isValid: false; reason?: any }

InputType

InputType: { apiBasePath?: string; apiDomain: string; autoAddCredentials?: boolean; cookieHandler?: CookieHandlerInput; dateProvider?: DateProviderInput; enableDebugLogs?: boolean; invalidClaimStatusCode?: number; isInIframe?: boolean; lockFactory?: LockFactory; onHandleEvent?: EventHandler; override?: { functions?: any }; postAPIHook?: RecipePostAPIHookFunction; preAPIHook?: RecipePreAPIHookFunction; sessionExpiredStatusCode?: number; sessionTokenBackendDomain?: string; sessionTokenFrontendDomain?: string; tokenTransferMethod?: "cookie" | "header"; windowHandler?: WindowHandlerInput }

Type declaration

  • Optional apiBasePath?: string
  • apiDomain: string
  • Optional autoAddCredentials?: boolean
  • Optional cookieHandler?: CookieHandlerInput
  • Optional dateProvider?: DateProviderInput
  • Optional enableDebugLogs?: boolean
  • Optional invalidClaimStatusCode?: number
  • Optional isInIframe?: boolean
  • Optional lockFactory?: LockFactory
    +supertokens-website
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    supertokens-website

    Index

    Classes

    Type Aliases

    Functions

    Type Aliases

    ClaimValidationError

    ClaimValidationError: { id: string; reason?: any }

    Type declaration

    • id: string
    • Optional reason?: any

    ClaimValidationResult

    ClaimValidationResult: { isValid: true } | { isValid: false; reason?: any }

    InputType

    InputType: { apiBasePath?: string; apiDomain: string; autoAddCredentials?: boolean; cookieHandler?: CookieHandlerInput; dateProvider?: DateProviderInput; enableDebugLogs?: boolean; invalidClaimStatusCode?: number; isInIframe?: boolean; lockFactory?: LockFactory; onHandleEvent?: EventHandler; override?: { functions?: any }; postAPIHook?: RecipePostAPIHookFunction; preAPIHook?: RecipePreAPIHookFunction; sessionExpiredStatusCode?: number; sessionTokenBackendDomain?: string; sessionTokenFrontendDomain?: string; tokenTransferMethod?: "cookie" | "header"; windowHandler?: WindowHandlerInput }

    Type declaration

    • Optional apiBasePath?: string
    • apiDomain: string
    • Optional autoAddCredentials?: boolean
    • Optional cookieHandler?: CookieHandlerInput
    • Optional dateProvider?: DateProviderInput
    • Optional enableDebugLogs?: boolean
    • Optional invalidClaimStatusCode?: number
    • Optional isInIframe?: boolean
    • Optional lockFactory?: LockFactory

      This allows for a Lock factory to be configured, which defaults to browser-tabs-lock. This can be used, for example, by a WebExtension that needs to update cookies for a domain that may or may not have an associated tab open.

      -
    • Optional onHandleEvent?: EventHandler
    • Optional override?: { functions?: any }
    • Optional postAPIHook?: RecipePostAPIHookFunction
    • Optional preAPIHook?: RecipePreAPIHookFunction
    • Optional sessionExpiredStatusCode?: number
    • Optional sessionTokenBackendDomain?: string
    • Optional sessionTokenFrontendDomain?: string
    • Optional tokenTransferMethod?: "cookie" | "header"
    • Optional windowHandler?: WindowHandlerInput

    RecipeInterface

    RecipeInterface: { addAxiosInterceptors: any; addFetchInterceptorsAndReturnModifiedFetch: any; addXMLHttpRequestInterceptor: any; calculateClockSkewInMillis: any; doesSessionExist: any; getAccessTokenPayloadSecurely: any; getGlobalClaimValidators: any; getInvalidClaimsFromResponse: any; getUserId: any; shouldDoInterceptionBasedOnUrl: any; signOut: any; validateClaims: any }

    Type declaration

    • addAxiosInterceptors:function
      • addAxiosInterceptors(input: { axiosInstance: any; userContext: any }): void

      • Parameters

        • input: { axiosInstance: any; userContext: any }
          • axiosInstance: any
          • userContext: any

        Returns void

    • addFetchInterceptorsAndReturnModifiedFetch:function
      • addFetchInterceptorsAndReturnModifiedFetch(input: { originalFetch: any; userContext: any }): ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)

      • Parameters

        • input: { originalFetch: any; userContext: any }
          • originalFetch: any
          • userContext: any

        Returns ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)

          • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

          • Parameters

            • input: URL | RequestInfo
            • Optional init: RequestInit

            Returns Promise<Response>

    • addXMLHttpRequestInterceptor:function
      • addXMLHttpRequestInterceptor(input: { userContext: any }): void

      • Parameters

        • input: { userContext: any }
          • userContext: any

        Returns void

    • calculateClockSkewInMillis:function
      • calculateClockSkewInMillis(params: { accessTokenPayload: any; responseHeaders: Headers }): number

      • Parameters

        • params: { accessTokenPayload: any; responseHeaders: Headers }
          • accessTokenPayload: any
          • responseHeaders: Headers

        Returns number

    • doesSessionExist:function
      • doesSessionExist(input: { userContext: any }): Promise<boolean>

      • Parameters

        • input: { userContext: any }
          • userContext: any

        Returns Promise<boolean>

    • getAccessTokenPayloadSecurely:function
      • getAccessTokenPayloadSecurely(input: { userContext: any }): Promise<any>

      • Parameters

        • input: { userContext: any }
          • userContext: any

        Returns Promise<any>

    • getGlobalClaimValidators:function
    • getInvalidClaimsFromResponse:function
      • getInvalidClaimsFromResponse(input: { response: { data: any } | Response; userContext: any }): Promise<ClaimValidationError[]>
    • getUserId:function
      • getUserId(input: { userContext: any }): Promise<string>

      • Parameters

        • input: { userContext: any }
          • userContext: any

        Returns Promise<string>

    • shouldDoInterceptionBasedOnUrl:function
      • shouldDoInterceptionBasedOnUrl(toCheckUrl: string, apiDomain: string, sessionTokenBackendDomain: undefined | string): boolean

      • Parameters

        • toCheckUrl: string
        • apiDomain: string
        • sessionTokenBackendDomain: undefined | string

        Returns boolean

    • signOut:function
      • signOut(input: { userContext: any }): Promise<void>

      • Parameters

        • input: { userContext: any }
          • userContext: any

        Returns Promise<void>

    • validateClaims:function

    SessionClaim

    SessionClaim<ValueType>: { getLastFetchedTime: any; getValueFromPayload: any; refresh: any }

    Type Parameters

    • ValueType

    Type declaration

    • getLastFetchedTime:function
      • getLastFetchedTime(payload: any, _userContext?: any): undefined | number

      • Parameters

        • payload: any
        • Optional _userContext: any

        Returns undefined | number

    • getValueFromPayload:function
      • getValueFromPayload(payload: any, _userContext?: any): undefined | ValueType

      • Parameters

        • payload: any
        • Optional _userContext: any

        Returns undefined | ValueType

    • refresh:function
      • refresh(userContext: any): Promise<void>

    SessionClaimValidator

    SessionClaimValidator: { id: string; refresh: any; shouldRefresh: any; validate: any }

    Type declaration

    • Readonly id: string
    • refresh:function
      • refresh(userContext: any): Promise<void>
      • +
      • Optional onHandleEvent?: EventHandler
      • Optional override?: { functions?: any }
      • Optional postAPIHook?: RecipePostAPIHookFunction
      • Optional preAPIHook?: RecipePreAPIHookFunction
      • Optional sessionExpiredStatusCode?: number
      • Optional sessionTokenBackendDomain?: string
      • Optional sessionTokenFrontendDomain?: string
      • Optional tokenTransferMethod?: "cookie" | "header"
      • Optional windowHandler?: WindowHandlerInput

    RecipeInterface

    RecipeInterface: { addAxiosInterceptors: any; addFetchInterceptorsAndReturnModifiedFetch: any; addXMLHttpRequestInterceptor: any; calculateClockSkewInMillis: any; doesSessionExist: any; getAccessTokenPayloadSecurely: any; getGlobalClaimValidators: any; getInvalidClaimsFromResponse: any; getUserId: any; shouldDoInterceptionBasedOnUrl: any; signOut: any; validateClaims: any }

    Type declaration

    • addAxiosInterceptors:function
      • addAxiosInterceptors(input: { axiosInstance: any; userContext: any }): void

      • Parameters

        • input: { axiosInstance: any; userContext: any }
          • axiosInstance: any
          • userContext: any

        Returns void

    • addFetchInterceptorsAndReturnModifiedFetch:function
      • addFetchInterceptorsAndReturnModifiedFetch(input: { originalFetch: any; userContext: any }): ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)

      • Parameters

        • input: { originalFetch: any; userContext: any }
          • originalFetch: any
          • userContext: any

        Returns ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)

          • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

          • Parameters

            • input: URL | RequestInfo
            • Optional init: RequestInit

            Returns Promise<Response>

    • addXMLHttpRequestInterceptor:function
      • addXMLHttpRequestInterceptor(input: { userContext: any }): void

      • Parameters

        • input: { userContext: any }
          • userContext: any

        Returns void

    • calculateClockSkewInMillis:function
      • calculateClockSkewInMillis(params: { accessTokenPayload: any; responseHeaders: Headers }): number

      • Parameters

        • params: { accessTokenPayload: any; responseHeaders: Headers }
          • accessTokenPayload: any
          • responseHeaders: Headers

        Returns number

    • doesSessionExist:function
      • doesSessionExist(input: { userContext: any }): Promise<boolean>

      • Parameters

        • input: { userContext: any }
          • userContext: any

        Returns Promise<boolean>

    • getAccessTokenPayloadSecurely:function
      • getAccessTokenPayloadSecurely(input: { userContext: any }): Promise<any>

      • Parameters

        • input: { userContext: any }
          • userContext: any

        Returns Promise<any>

    • getGlobalClaimValidators:function
    • getInvalidClaimsFromResponse:function
      • getInvalidClaimsFromResponse(input: { response: { data: any } | Response; userContext: any }): Promise<ClaimValidationError[]>
    • getUserId:function
      • getUserId(input: { userContext: any }): Promise<string>

      • Parameters

        • input: { userContext: any }
          • userContext: any

        Returns Promise<string>

    • shouldDoInterceptionBasedOnUrl:function
      • shouldDoInterceptionBasedOnUrl(toCheckUrl: string, apiDomain: string, sessionTokenBackendDomain: undefined | string): boolean

      • Parameters

        • toCheckUrl: string
        • apiDomain: string
        • sessionTokenBackendDomain: undefined | string

        Returns boolean

    • signOut:function
      • signOut(input: { userContext: any }): Promise<void>

      • Parameters

        • input: { userContext: any }
          • userContext: any

        Returns Promise<void>

    • validateClaims:function

    SessionClaim

    SessionClaim<ValueType>: { getLastFetchedTime: any; getValueFromPayload: any; refresh: any }

    Type Parameters

    • ValueType

    Type declaration

    • getLastFetchedTime:function
      • getLastFetchedTime(payload: any, _userContext?: any): undefined | number

      • Parameters

        • payload: any
        • Optional _userContext: any

        Returns undefined | number

    • getValueFromPayload:function
      • getValueFromPayload(payload: any, _userContext?: any): undefined | ValueType

      • Parameters

        • payload: any
        • Optional _userContext: any

        Returns undefined | ValueType

    • refresh:function
      • refresh(userContext: any): Promise<void>

    SessionClaimValidator

    SessionClaimValidator: { id: string; refresh: any; shouldRefresh: any; validate: any }

    Type declaration

    • Readonly id: string
    • refresh:function
      • refresh(userContext: any): Promise<void>

      • Makes an API call that will refresh the claim in the token.

        -

        Parameters

        • userContext: any

        Returns Promise<void>

    • shouldRefresh:function
      • shouldRefresh(accessTokenPayload: any, userContext: any): boolean | Promise<boolean>
    • shouldRefresh:function
      • shouldRefresh(accessTokenPayload: any, userContext: any): boolean | Promise<boolean>

      • Decides if we need to refresh the claim value before checking the payload with validate. E.g.: if the information in the payload is expired, or is not sufficient for this validator.

        -

        Parameters

        • accessTokenPayload: any
        • userContext: any

        Returns boolean | Promise<boolean>

    • validate:function
      • +

        Parameters

        • accessTokenPayload: any
        • userContext: any

        Returns boolean | Promise<boolean>

    • validate:function

    Functions

    addAxiosInterceptors

    • addAxiosInterceptors(axiosInstance: any, userContext?: any): void
    • deprecated

      Parameters

      • axiosInstance: any
      • Optional userContext: any

      Returns void

    attemptRefreshingSession

    • attemptRefreshingSession(): Promise<boolean>

    doesSessionExist

    • doesSessionExist(input?: { userContext?: any }): Promise<boolean>

    • Parameters

      • Optional input: { userContext?: any }
        • Optional userContext?: any

      Returns Promise<boolean>

    getAccessToken

    • getAccessToken(input?: { userContext?: any }): Promise<undefined | string>

    • Parameters

      • Optional input: { userContext?: any }
        • Optional userContext?: any

      Returns Promise<undefined | string>

    getAccessTokenPayloadSecurely

    • getAccessTokenPayloadSecurely(input?: { userContext?: any }): Promise<any>

    • Parameters

      • Optional input: { userContext?: any }
        • Optional userContext?: any

      Returns Promise<any>

    getClaimValue

    • getClaimValue<T>(input: { claim: SessionClaim<T>; userContext?: any }): Promise<undefined | T>

    getInvalidClaimsFromResponse

    • getInvalidClaimsFromResponse(input: { response: Response | { data: any }; userContext?: any }): Promise<ClaimValidationError[]>

    • Parameters

      • input: { response: Response | { data: any }; userContext?: any }
        • response: Response | { data: any }
        • Optional userContext?: any

      Returns Promise<ClaimValidationError[]>

    getUserId

    • getUserId(input?: { userContext?: any }): Promise<string>

    • Parameters

      • Optional input: { userContext?: any }
        • Optional userContext?: any

      Returns Promise<string>

    init

    signOut

    • signOut(input?: { userContext?: any }): Promise<void>

    • Parameters

      • Optional input: { userContext?: any }
        • Optional userContext?: any

      Returns Promise<void>

    validateClaims

    Legend

    • Constructor
    • Property
    • Method
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • accessTokenPayload: any
    • userContext: any

    Returns ClaimValidationResult | Promise<ClaimValidationResult>

Functions

addAxiosInterceptors

  • addAxiosInterceptors(axiosInstance: any, userContext?: any): void
  • deprecated

    Parameters

    • axiosInstance: any
    • Optional userContext: any

    Returns void

attemptRefreshingSession

  • attemptRefreshingSession(): Promise<boolean>

doesSessionExist

  • doesSessionExist(input?: { userContext?: any }): Promise<boolean>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<boolean>

getAccessToken

  • getAccessToken(input?: { userContext?: any }): Promise<undefined | string>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<undefined | string>

getAccessTokenPayloadSecurely

  • getAccessTokenPayloadSecurely(input?: { userContext?: any }): Promise<any>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<any>

getClaimValue

  • getClaimValue<T>(input: { claim: SessionClaim<T>; userContext?: any }): Promise<undefined | T>

getInvalidClaimsFromResponse

  • getInvalidClaimsFromResponse(input: { response: Response | { data: any }; userContext?: any }): Promise<ClaimValidationError[]>

  • Parameters

    • input: { response: Response | { data: any }; userContext?: any }
      • response: Response | { data: any }
      • Optional userContext?: any

    Returns Promise<ClaimValidationError[]>

getUserId

  • getUserId(input?: { userContext?: any }): Promise<string>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<string>

init

signOut

  • signOut(input?: { userContext?: any }): Promise<void>

  • Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns Promise<void>

validateClaims

Generated using TypeDoc

\ No newline at end of file