Function ConfigurationApiFp

ConfigurationApi - functional programming interface

Export

  • ConfigurationApiFp(configuration?): {
        getConfiguration(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerConfiguration>)>;
        getDefaultMetadataOptions(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataOptions>)>;
        getNamedConfiguration(key: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
        updateConfiguration(serverConfiguration: ServerConfiguration, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        updateNamedConfiguration(key: string, body: any, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    }

  • Parameters

    Returns {
        getConfiguration(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerConfiguration>)>;
        getDefaultMetadataOptions(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataOptions>)>;
        getNamedConfiguration(key: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
        updateConfiguration(serverConfiguration: ServerConfiguration, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        updateNamedConfiguration(key: string, body: any, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    }

    • getConfiguration:function
    • getDefaultMetadataOptions:function
      • getDefaultMetadataOptions(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataOptions>)>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataOptions>)>

        Summary

        Gets a default MetadataOptions object.

        Throws

    • getNamedConfiguration:function
      • getNamedConfiguration(key, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

      • Parameters

        • key: string

          Configuration key.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

        Summary

        Gets a named configuration.

        Throws

    • updateConfiguration:function
      • updateConfiguration(serverConfiguration, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • Parameters

        • serverConfiguration: ServerConfiguration

          Configuration.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Summary

        Updates application configuration.

        Throws

    • updateNamedConfiguration:function
      • updateNamedConfiguration(key, body, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • Parameters

        • key: string

          Configuration key.

        • body: any

          Configuration.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Summary

        Updates named configuration.

        Throws

Settings

Member Visibility