Function PackageApiFp

Returns {
    cancelPackageInstallation(
        packageId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    getPackageInfo(
        name: string,
        assemblyGuid?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackageInfo>,
    >;
    getPackages(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PackageInfo[]>,
    >;
    getRepositories(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RepositoryInfo[]>,
    >;
    installPackage(
        name: string,
        assemblyGuid?: string,
        version?: string,
        repositoryUrl?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    setRepositories(
        repositoryInfo: RepositoryInfo[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• cancelPackageInstallation: function

  • cancelPackageInstallation(
        packageId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • packageId: string

      Installation Id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getPackageInfo: function

  • getPackageInfo(
        name: string,
        assemblyGuid?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackageInfo>,
    >

    Parameters

    • name: string

      The name of the package.
    • OptionalassemblyGuid: string

      The GUID of the associated assembly.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getPackages: function

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

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getRepositories: function

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

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• installPackage: function

  • installPackage(
        name: string,
        assemblyGuid?: string,
        version?: string,
        repositoryUrl?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • name: string

      Package name.
    • OptionalassemblyGuid: string

      GUID of the associated assembly.
    • Optionalversion: string

      Optional version. Defaults to latest version.
    • OptionalrepositoryUrl: string

      Optional. Specify the repository to install from.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• setRepositories: function

  • setRepositories(
        repositoryInfo: RepositoryInfo[],
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • repositoryInfo: RepositoryInfo[]

      The list of package repositories.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws