Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

  • Parameters

    Returns XOAuth2

Properties

accessToken

accessToken: string | false

expires

expires: number

logger

logger: Logger

options

options: Options

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: "error", listener: function): this
  • addListener(event: "token", listener: function): this
  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "token"
    • listener: function
        • Parameters

          Returns void

    Returns this

buildXOAuth2Token

  • buildXOAuth2Token(accessToken: string): string
  • Converts an access_token and user id into a base64 encoded XOAuth2 token

    Parameters

    • accessToken: string

    Returns string

emit

  • emit(event: "error", error: Error): boolean
  • emit(event: "token", token: Token): boolean
  • Parameters

    • event: "error"
    • error: Error

    Returns boolean

  • Parameters

    • event: "token"
    • token: Token

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

generateToken

  • generateToken(callback: function): void
  • Generates a new XOAuth2 token with the credentials provided at initialization

    Parameters

    • callback: function
        • (err: Error | null, accessToken: string): void
        • Parameters

          • err: Error | null
          • accessToken: string

          Returns void

    Returns void

getMaxListeners

  • getMaxListeners(): number

getToken

  • getToken(renew: boolean, callback: function): void
  • Returns or generates (if previous has expired) a XOAuth2 token

    Parameters

    • renew: boolean
    • callback: function
        • (err: Error | null, accessToken: string): void
        • Parameters

          • err: Error | null
          • accessToken: string

          Returns void

    Returns void

jwtSignRS256

  • jwtSignRS256(payload: object): string
  • Creates a JSON Web Token signed with RS256 (SHA256 + RSA)

    Parameters

    • payload: object

    Returns string

listenerCount

  • listenerCount(type: string | symbol): number

listeners

  • listeners(event: "error"): Array<function>
  • listeners(event: "end"): Array<function>
  • Parameters

    • event: "error"

    Returns Array<function>

  • Parameters

    • event: "end"

    Returns Array<function>

off

  • off(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: "error", listener: function): this
  • on(event: "token", listener: function): this
  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "token"
    • listener: function
        • Parameters

          Returns void

    Returns this

once

  • once(event: "error", listener: function): this
  • once(event: "token", listener: function): this
  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "token"
    • listener: function
        • Parameters

          Returns void

    Returns this

pipe

  • pipe<T>(destination: T, options?: undefined | object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: undefined | object

    Returns T

postRequest

  • Custom POST request handler. This is only needed to keep paths short in Windows – usually this module is a dependency of a dependency and if it tries to require something like the request module the paths get way too long to handle for Windows. As we do only a simple POST request we do not actually require complicated logic support (no redirects, no nothing) anyway.

    Parameters

    Returns void

prependListener

  • prependListener(event: "error", listener: function): this
  • prependListener(event: "end", listener: function): this
  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • Parameters

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: "error", listener: function): this
  • prependOnceListener(event: "end", listener: function): this
  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • Parameters

          Returns void

    Returns this

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

toBase64URL

  • toBase64URL(data: Buffer | string): string
  • Encodes a buffer or a string into Base64url format

    Parameters

    Returns string

updateToken

  • updateToken(accessToken: string, timeout: s): Token
  • Updates token values

    Parameters

    • accessToken: string
    • timeout: s

    Returns Token

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    Returns number

Generated using TypeDoc