PackageApi - functional programming interface

  • Parameters

    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
      • Parameters

        • packageId: string

          Installation Id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Cancels a package installation.

    • getPackageInfo:function
      • 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>)>

        Gets a package by name or assembly GUID.

    • getPackages:function
      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Gets available packages.

    • getRepositories:function
      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Gets all package repositories.

    • installPackage:function
      • 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>)>

        Installs a package.

    • setRepositories:function
      • Parameters

        • repositoryInfo: RepositoryInfo[]

          The list of package repositories.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Sets the enabled and existing package repositories.