Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthHttpOperator

Hierarchy

  • AuthHttpOperator

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

apiRootUrl

apiRootUrl: URL

baseCookieOptions

baseCookieOptions: { domain?: string; path: string; sameSite: "strict" | "lax" | "none"; secure: boolean }

Type declaration

  • Optional domain?: string
  • path: string
  • sameSite: "strict" | "lax" | "none"
  • secure: boolean

dataCookieMaxAge

dataCookieMaxAge: number

redirectRootUrl

redirectRootUrl: URL

refreshDuration

refreshDuration: number

secret

secret: string

secure

secure: boolean

tokenLifetime

tokenLifetime: number

Methods

clearCookies

  • clearCookies(res: ServerResponse): void

deleteAuth

  • deleteAuth(res: ServerResponse): void

deleteError

  • deleteError(res: ServerResponse): void

deleteState

  • deleteState(res: ServerResponse): void

getAuth

  • getAuth<Data>(req: IncomingMessage, platformAsserted: string, __namedParameters?: { acceptRefreshable?: boolean }): Promise<null | Data>

  • Type parameters

    • Data

    Parameters

    • req: IncomingMessage
    • platformAsserted: string
    • __namedParameters: { acceptRefreshable?: boolean } = {}
      • Optional acceptRefreshable?: boolean

    Returns Promise<null | Data>

getAuthUrl

  • getAuthUrl(platform: string, subpath?: string): string

getError

  • getError(req: IncomingMessage, platformAsserted: string): Promise<null | ErrorMessage>

getRedirectUrl

  • getRedirectUrl(path?: string): string

getState

  • getState<State>(req: IncomingMessage, platformAsserted: string): Promise<null | State>

issueAuth

  • issueAuth<Data>(res: ServerResponse, platform: string, data: Data, initiateAt?: number): Promise<string>

issueError

  • issueError(res: ServerResponse, platform: string, code: number, reason: string): Promise<string>

issueState

  • issueState<State>(res: ServerResponse, platform: string, state: State): Promise<string>

redirect

  • redirect(res: ServerResponse, url?: string, __namedParameters?: { assertInternal?: boolean }): boolean

  • Parameters

    • res: ServerResponse
    • Optional url: string
    • __namedParameters: { assertInternal?: boolean } = {}
      • Optional assertInternal?: boolean

    Returns boolean

signToken

  • signToken(platform: string, payload: unknown, options?: SignOptions): string

verifyToken

  • verifyToken<Data>(assertedPlatform: string, token: string): null | Data

Generated using TypeDoc