Class ServerConfiguration<T>

Represents the configuration of a server including its url template and variable configuration based on the url.

Type Parameters

T extends {
[key: string]: string;
}

Implements

BaseServerConfiguration

Index

Constructors

Methods

getConfiguration makeRequestContext setVariables

Constructors

constructor

new ServerConfiguration<T>(url, variableConfiguration): ServerConfiguration<T>
Type Parameters
- T extends {
  [key: string]: string;
  }
Parameters
- url: string
- variableConfiguration: T
Returns ServerConfiguration<T>
- Defined in codegen/communication_preferences/servers.ts:14

Methods

getConfiguration

getConfiguration(): T
Returns T
- Defined in codegen/communication_preferences/servers.ts:27

makeRequestContext

makeRequestContext(endpoint, httpMethod): RequestContext
Creates a new request context for this server using the url with variables replaced with their respective values and the endpoint of the request appended.
Parameters
- endpoint: string
  the endpoint to be queried on the server
- httpMethod: HttpMethod
  httpMethod to be used
Returns RequestContext
Implementation of BaseServerConfiguration.makeRequestContext
- Defined in codegen/communication_preferences/servers.ts:48

setVariables

setVariables(variableConfiguration): void
Sets the value of the variables of this server. Variables are included in the url of this ServerConfiguration in the form {variableName}
Parameters
- variableConfiguration: Partial<T>
  a partial variable configuration for the variables contained in the url
Returns void
- Defined in codegen/communication_preferences/servers.ts:23