Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "common"

Index

Variables

Functions

Variables

Const DUMMY_BASE_URL

DUMMY_BASE_URL: "https://example.com" = "https://example.com"
export

Functions

Const assertParamExists

  • assertParamExists(functionName: string, paramName: string, paramValue: unknown): void
  • throws

    {RequiredError}

    export

    Parameters

    • functionName: string
    • paramName: string
    • paramValue: unknown

    Returns void

Const createRequestFunction

  • createRequestFunction(axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration): (Anonymous function)
  • export

    Parameters

    Returns (Anonymous function)

Const serializeDataIfNeeded

  • serializeDataIfNeeded(value: any, requestOptions: any, configuration?: Configuration): any
  • export

    Parameters

    • value: any
    • requestOptions: any
    • Optional configuration: Configuration

    Returns any

Const setApiKeyToObject

  • setApiKeyToObject(object: any, keyParamName: string, configuration?: Configuration): Promise<void>
  • export

    Parameters

    • object: any
    • keyParamName: string
    • Optional configuration: Configuration

    Returns Promise<void>

Const setBasicAuthToObject

  • setBasicAuthToObject(object: any, configuration?: Configuration): void
  • export

    Parameters

    Returns void

Const setBearerAuthToObject

  • setBearerAuthToObject(object: any, configuration?: Configuration): Promise<void>
  • export

    Parameters

    Returns Promise<void>

Const setOAuthToObject

  • setOAuthToObject(object: any, name: string, scopes: string[], configuration?: Configuration): Promise<void>
  • export

    Parameters

    • object: any
    • name: string
    • scopes: string[]
    • Optional configuration: Configuration

    Returns Promise<void>

Const setSearchParams

  • setSearchParams(url: URL, ...objects: any[]): void
  • export

    Parameters

    • url: URL
    • Rest ...objects: any[]

    Returns void

Const toPathString

  • toPathString(url: URL): string
  • export

    Parameters

    • url: URL

    Returns string

Generated using TypeDoc