ConfigurationParameters Type — typescript-sdk Architecture

Architecture documentation for the ConfigurationParameters type/interface in runtime.ts from the typescript-sdk codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  10ef2793_8ba3_a09c_8c32_2b1ed903a3eb["ConfigurationParameters"]
  41b6b5c2_aa5b_90b9_c373_84e0a8cd9918["runtime.ts"]
  10ef2793_8ba3_a09c_8c32_2b1ed903a3eb -->|defined in| 41b6b5c2_aa5b_90b9_c373_84e0a8cd9918
  style 10ef2793_8ba3_a09c_8c32_2b1ed903a3eb fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/runtime.ts lines 18–29

export interface ConfigurationParameters {
    basePath?: string; // override base path
    fetchApi?: FetchAPI; // override for fetch implementation
    middleware?: Middleware[]; // middleware to apply before/after fetch requests
    queryParamsStringify?: (params: HTTPQuery) => string; // stringify function for query strings
    username?: string; // parameter for basic security
    password?: string; // parameter for basic security
    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>); // parameter for apiKey security
    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>); // parameter for oauth2 security
    headers?: HTTPHeaders; //header params we want to use on every request
    credentials?: RequestCredentials; //value for the credentials param we want to use on each request
}

Defined In

src/runtime.ts

Source

View on GitHub

Frequently Asked Questions

What is the ConfigurationParameters type?

ConfigurationParameters is a type/interface in the typescript-sdk codebase, defined in src/runtime.ts.

Where is ConfigurationParameters defined?

ConfigurationParameters is defined in src/runtime.ts at line 18.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free