Skip to content
Baumbart logo Baumbart Documentation

qanary-component-helpers/configuration

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

qanary-component-helpers/configuration

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

Summary

Section titled “Summary”

OpenAPI definition No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 3.5.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Classes

Section titled “Classes”

Configuration

Section titled “Configuration”
class Configuration

Properties

  • apiKey (string | Promise | ((name: string) => string) | ((name: string) => Promise)): parameter for apiKey security
  • username (string): parameter for basic security

string Configuration

  • password (string): parameter for basic security

string Configuration

  • accessToken (| string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise)): parameter for oauth2 security
  • basePath (string): override base path

string Configuration

  • baseOptions (any): base options for axios calls

any Configuration

  • formDataCtor (new () => any): The FormData constructor that will be used to create multipart form data requests. You can inject this here so that execution environments that do not support the FormData class can still run the generated client.

new () = FormData Methods

  • constructor(param: ConfigurationParameters)
  • isJsonMime(mime: string): boolean: Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json Defined at: line 29

Interfaces

Section titled “Interfaces”

ConfigurationParameters

Section titled “ConfigurationParameters”
interface ConfigurationParameters

OpenAPI definition No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 3.5.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Properties

  • apiKey (string | Promise | ((name: string) => string) | ((name: string) => Promise))
  • username (string)
  • password (string)
  • accessToken (| string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise))
  • basePath (string)
  • baseOptions (any)
  • formDataCtor (new () => any) Defined at: line 15

In qanary-component-helpers

Section titled “In qanary-component-helpers”