repository-provider
Advanced tools
abstract interface to git repository providers like github bitbucket
abstract interface to git repository providers like github bitbucket
import { GithubProvider } from 'repository-provider';
const provider = new GithubProvider({ token: 'xxx' });
const repository = await provider.repository('myuser/myrepo');
const branch = await repository.branch('master');
const files = await branch.list();
list by repository-provider keyword
Extends Owner
Base repository provider acts as a source of repositories
options ObjectrepositoryGroups Map<string, RepositoryGroup>config ObjectLookup a repository group
Returns Promise<RepositoryGroup>
Create a new repository group
Returns Promise<RepositoryGroup>
Lookup a repository in the provider and all of its repository groups
Returns Promise<Repository>
Lookup a branch in the provider and all of its repository groups
Returns Class repository group class used by the Provider
Returns Class pull request class used by the Provider
Is our rate limit reached. By default we have no rate limit
Returns boolean always false
Deliver the provider name
Returns string class name by default
we are our own provider
Returns Provider this
Default configuration options
Returns Object
Extract options suitable for the constructor form the given set of environment variables
env ObjectReturns Object undefined if no suitable environment variables have been found
Pepare configuration by mixing together defaultOptions with actual options
config Object raw configReturns Object combined options
Abstract branch
repository Repositoryname stringoptions Objectrepository Repositoryprovider Providername stringoptions
options
options
enshures tha _initialize() will be called only once
Collection of repositories
repositories Map<string, Repository>Abstract repository
owner Ownername string without (#branch)description string? from options.descriptionid string? from options.idbranches Map<string, Branch>pullRequests Map<string, PullRequest>the description of the repository content.
Returns string
the description of the repository content.
Returns string
unique id within the provider.
Returns string
unique id within the provider.
Returns string
Abstract pull request Repository#addPullRequest
name stringrepository Repositoryprovider Providertitle string?state string?Returns Provider
Delete the pull request from the Repository.
Returns Promise
Merge the pull request
Decline the pull request
the description of the pull request.
Returns string
state of the pull request.
Returns string
Extends Owner
Abstract repository as a collection
By default we use the providers implementation.
Returns Class as defined in the provider
By default we use the providers implementation.
Returns Class as defined in the provider
By default we use the providers implementation.
Returns Class as defined in the provider
Representation of one file or directory entry
path string file name inside of the repositorycontent (string | Buffer | Stream) (optional, default undefined)type string type of the content (optional, default "blob")mode string file permissions (optional, default "100644")path string file name inside of the repositorycontent (string | Buffer | Stream)type string type of the contentmode string file permissionscreate properties from options and default options
With npm do:
npm install repository-provider
BSD-2-Clause
FAQs
abstract interface to git repository providers like github, bitbucket and gitlab
The npm package repository-provider receives a total of 627 weekly downloads. As such, repository-provider popularity was classified as not popular.
We found that repository-provider demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.
Security News
Sonar’s acquisition of Tidelift highlights a growing industry shift toward sustainable open source funding, addressing maintainer burnout and critical software dependencies.