Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Const appendAuthorization

  • appendAuthorization(options: AppendAuthorizationOptions): StringMap
  • appendAuthorization

    Mutates a headers object to include Authorization header. Will insert if found:

    • api_key
    • licensee
    • user_token

    Parameters

    • options: AppendAuthorizationOptions

    Returns StringMap

Const toAuthHeader

  • toAuthHeader

    Extracts credentials into authorization header format

    Parameters

    Returns string

Const toHeader

  • toHeader(__namedParameters: OptionalHeader, client: Client): StringMap
  • toHeader

    Extracts HTTP Header object from request and client default headers

    Precendence is given to request specific headers

    Parameters

    • __namedParameters: OptionalHeader
    • client: Client

    Returns StringMap

Const toStringMap

  • toStringMap(optional?: OptionalStringMap): StringMap
  • toQuery

    Shallow copies object while omitting undefined attributes

    Parameters

    • Optional optional: OptionalStringMap

    Returns StringMap

Const toTimeout

  • toTimeout(__namedParameters: OptionalTimeout, client: Client): number
  • toTimeout

    Returns timeout value from request object. Delegates to default client timeout if not specified

    Parameters

    • __namedParameters: OptionalTimeout
    • client: Client

    Returns number