Function EnvironmentApiFp

Returns {
    getDefaultDirectoryBrowser(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DefaultDirectoryBrowserInfoDto>,
    >;
    getDirectoryContents(
        path: string,
        includeFiles?: boolean,
        includeDirectories?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FileSystemEntryInfo[]>,
    >;
    getDrives(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FileSystemEntryInfo[]>,
    >;
    getParentPath(
        path: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >;
    validatePath(
        validatePathDto: ValidatePathDto,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• getDefaultDirectoryBrowser: function

  • getDefaultDirectoryBrowser(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DefaultDirectoryBrowserInfoDto>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getDirectoryContents: function

  • getDirectoryContents(
        path: string,
        includeFiles?: boolean,
        includeDirectories?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FileSystemEntryInfo[]>,
    >

    Parameters

    • path: string

      The path.

    • OptionalincludeFiles: boolean

      An optional filter to include or exclude files from the results. true/false.

    • OptionalincludeDirectories: boolean

      An optional filter to include or exclude folders from the results. true/false.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getDrives: function

  • getDrives(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FileSystemEntryInfo[]>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getParentPath: function

  • getParentPath(
        path: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >

    Parameters

    • path: string

      The path.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• validatePath: function

  • validatePath(
        validatePathDto: ValidatePathDto,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • validatePathDto: ValidatePathDto

      Validate request object.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws