Function PackageApiAxiosParamCreator

PackageApi - axios parameter creator

Export

  • PackageApiAxiosParamCreator(configuration?): {
        cancelPackageInstallation: ((packageId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPackageInfo: ((name: string, assemblyGuid?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPackages: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getRepositories: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        installPackage: ((name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        setRepositories: ((repositoryInfo: RepositoryInfo[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

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

    • cancelPackageInstallation: ((packageId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Cancels a package installation.

      Throws

        • (packageId, options?): Promise<RequestArgs>

        • Parameters

          • packageId: string

            Installation Id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getPackageInfo: ((name: string, assemblyGuid?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a package by name or assembly GUID.

      Throws

        • (name, assemblyGuid?, options?): Promise<RequestArgs>

        • Parameters

          • name: string

            The name of the package.

          • OptionalassemblyGuid: string

            The GUID of the associated assembly.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getPackages: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets available packages.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getRepositories: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets all package repositories.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • installPackage: ((name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Installs a package.

      Throws

        • (name, assemblyGuid?, version?, repositoryUrl?, options?): Promise<RequestArgs>

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

    • setRepositories: ((repositoryInfo: RepositoryInfo[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Sets the enabled and existing package repositories.

      Throws

        • (repositoryInfo, options?): Promise<RequestArgs>

        • Parameters

          • repositoryInfo: RepositoryInfo[]

            The list of package repositories.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility