Skip to content
Baumbart logo Baumbart Documentation

qanary-component-helpers/common

This page is auto-generated from TSDoc output. Edit the source file, not this Markdown.

qanary-component-helpers/common

Section titled “qanary-component-helpers/common”
  • Package: @leipzigtreechat/qanary-component-helpers
  • Source file: packages/qanary-component-helpers/src/common.ts

Summary

Section titled “Summary”

No summary is available for this file.

Functions

Section titled “Functions”

assertParamExists

Section titled “assertParamExists”
function assertParamExists(functionName: string, paramName: string, paramValue: unknown): void

Parameters

  • functionName (string)
  • paramName (string)
  • paramValue (unknown) Defined at: line 30

setApiKeyToObject

Section titled “setApiKeyToObject”
function setApiKeyToObject(object: any, keyParamName: string, configuration: Configuration): void

Parameters

  • object (any)
  • keyParamName (string)
  • configuration (Configuration) Defined at: line 43

setBasicAuthToObject

Section titled “setBasicAuthToObject”
function setBasicAuthToObject(object: any, configuration: Configuration): void

Parameters

  • object (any)
  • configuration (Configuration) Defined at: line 57

setBearerAuthToObject

Section titled “setBearerAuthToObject”
function setBearerAuthToObject(object: any, configuration: Configuration): void

Parameters

  • object (any)
  • configuration (Configuration) Defined at: line 67

setOAuthToObject

Section titled “setOAuthToObject”
function setOAuthToObject(object: any, name: string, scopes: string[], configuration: Configuration): void

Parameters

  • object (any)
  • name (string)
  • scopes (string[])
  • configuration (Configuration) Defined at: line 81

setSearchParams

Section titled “setSearchParams”
function setSearchParams(url: URL, objects: any[]): void

Parameters

  • url (URL)
  • objects (any[]) Defined at: line 113

serializeDataIfNeeded

Section titled “serializeDataIfNeeded”
function serializeDataIfNeeded(value: any, requestOptions: any, configuration: Configuration): void

Parameters

  • value (any)
  • requestOptions (any)
  • configuration (Configuration) Defined at: line 123

toPathString

Section titled “toPathString”
function toPathString(url: URL): void

Parameters

  • url (URL) Defined at: line 136

createRequestFunction

Section titled “createRequestFunction”
function createRequestFunction(axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration: Configuration): void

Parameters

  • axiosArgs (RequestArgs)
  • globalAxios (AxiosInstance)
  • BASE_PATH (string)
  • configuration (Configuration) Defined at: line 142

Constants

Section titled “Constants”

DUMMY_BASE_URL

Section titled “DUMMY_BASE_URL”
const DUMMY_BASE_URL: string

Defined at: line 23

In qanary-component-helpers

Section titled “In qanary-component-helpers”