Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Interfaces

Type aliases

Type aliases

Basic

Basic: XOR<{ apiToken: string; email: string }, { password: string; username: string }>

JWT

JWT: { expiryTimeSeconds?: number; issuer: string; secret: string }

Type declaration

  • Optional expiryTimeSeconds?: number

    Token expiry time (default 3 minutes after issuing)

  • issuer: string

    The key from the app descriptor.

  • secret: string

    The sharedsecret key received during the app installation handshake

OAuth2

OAuth2: { accessToken: string }

Type declaration

  • accessToken: string

Types

Types: XOR<{ jwt: JWT }, XOR<{ oauth: OAuth }, XOR<{ basic: Basic }, { oauth2: OAuth2 }>>>

Legend

  • Namespace
  • Variable
  • Function
  • Type alias
  • Class
  • Class with type parameter
  • Enumeration
  • Interface

Generated using TypeDoc