Options
All
  • Public
  • Public/Protected
  • All
Menu

supertokens-website

Index

Classes

Type Aliases

Functions

Type Aliases

ClaimValidationError

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

Type declaration

  • Optional reason?: any
  • validatorId: string

ClaimValidationResult

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

InputType

InputType: { apiBasePath?: string; apiDomain: string; autoAddCredentials?: boolean; cookieDomain?: string; cookieHandler?: CookieHandlerInput; enableDebugLogs?: boolean; invalidClaimStatusCode?: number; isInIframe?: boolean; onHandleEvent?: EventHandler; override?: { functions?: any }; postAPIHook?: RecipePostAPIHookFunction; preAPIHook?: RecipePreAPIHookFunction; sessionExpiredStatusCode?: number; sessionScope?: string; windowHandler?: WindowHandlerInput }

Type declaration

  • Optional apiBasePath?: string
  • apiDomain: string
  • Optional autoAddCredentials?: boolean
  • Optional cookieDomain?: string
  • Optional cookieHandler?: CookieHandlerInput
  • Optional enableDebugLogs?: boolean
  • Optional invalidClaimStatusCode?: number
  • Optional isInIframe?: boolean
  • Optional onHandleEvent?: EventHandler
  • Optional override?: { functions?: any }
  • Optional postAPIHook?: RecipePostAPIHookFunction
  • Optional preAPIHook?: RecipePreAPIHookFunction
  • Optional sessionExpiredStatusCode?: number
  • Optional sessionScope?: string
  • Optional windowHandler?: WindowHandlerInput

RecipeInterface

RecipeInterface: { addAxiosInterceptors: any; addFetchInterceptorsAndReturnModifiedFetch: any; doesSessionExist: any; getAccessTokenPayloadSecurely: any; getGlobalClaimValidators: any; getInvalidClaimsFromResponse: any; getUserId: 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>

  • 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>

  • 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>

Functions

addAxiosInterceptors

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

  • 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>

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