Skip to main content
Latest
interface ConfigurationParameters
import { type ConfigurationParameters } from "https://deno.land/x/periskope_maytapi_deno@v1.4.0/configuration.ts";

Interface with which a configuration object can be configured.

Properties

optional
baseServer: BaseServerConfiguration

Default server to use - a list of available servers (according to the OpenAPI yaml definition) is included in the servers const in ./servers. You can also create your own server with the ServerConfiguration class from the same file.

optional
httpApi: HttpLibrary

HTTP library to use e.g. IsomorphicFetch. This can usually be skipped as all generators come with a default library. If available, additional libraries can be imported from ./http/*

optional
middleware: Middleware[]

The middlewares which will be applied to requests and responses. You can add any number of middleware components to modify requests before they are sent or before they are deserialized by implementing the Middleware interface defined in ./middleware

optional
promiseMiddleware: PromiseMiddleware[]

Configures middleware functions that return promises instead of Observables (which are used by middleware). Otherwise allows for the same functionality as middleware, i.e., modifying requests before they are sent and before they are deserialized.

optional
authMethods: AuthMethodsConfiguration

Configuration for the available authentication methods (e.g., api keys) according to the OpenAPI yaml definition. For the definition, please refer to ./auth/auth