Function createDownloader

  • Parameters

    Returns {
        download: ((repository, rootPackageJson?, ref?) => Promise<PluginResource>);
    }

    • download: ((repository, rootPackageJson?, ref?) => Promise<PluginResource>)
        • (repository, rootPackageJson?, ref?): Promise<PluginResource>
        • This does not care about whether the code itself is valid or not.

          Parameters

          • repository: string

            Full repository name in the format of :owner/:repo.

            Example

            "plugxjs/plugx"
            
          • Optional rootPackageJson: string

            The path to the root package.json file.

            Example

            "packages/idm/package.json"
            

            Default

            "package.json"
            
          • Optional ref: string

            The name of the commit/branch/tag.

            Example

            "refs/heads/main"
            

            Default

            the repositorys default branch.
            

          Returns Promise<PluginResource>

Generated using TypeDoc