Function ServerApiFp

ServerApi - functional programming interface

Export

  • ServerApiFp(
        configuration?: Configuration,
    ): {
        serverListShare(
            directory?: string,
            search?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileInfo[]>,
        >;
        serverRetrieveAbout(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<About>,
        >;
        serverRetrieveAnnotationFormats(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<DatasetFormats>,
        >;
        serverRetrievePlugins(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Plugins>,
        >;
    }

    Parameters

    Returns {
        serverListShare(
            directory?: string,
            search?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileInfo[]>,
        >;
        serverRetrieveAbout(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<About>,
        >;
        serverRetrieveAnnotationFormats(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<DatasetFormats>,
        >;
        serverRetrievePlugins(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Plugins>,
        >;
    }

    • serverListShare:function
      • serverListShare(
            directory?: string,
            search?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileInfo[]>,
        >

        Parameters

        • Optionaldirectory: string

          Directory to browse

        • Optionalsearch: string

          Search for specific files

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileInfo[]>>

        Throws

    • serverRetrieveAbout:function
      • serverRetrieveAbout(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<About>,
        >

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • serverRetrieveAnnotationFormats:function
      • serverRetrieveAnnotationFormats(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<DatasetFormats>,
        >

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • serverRetrievePlugins:function
      • serverRetrievePlugins(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Plugins>,
        >

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility