repository-provider

repository-provider

abstract interface to git repository providers like github bitbucket

Example

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();

Derived Providers

list by repository-provider keyword

API

Table of Contents

• Provider
  • Parameters
  • Properties
  • repositoryGroup
    • Parameters
  • createRepositoryGroup
    • Parameters
  • repository
    • Parameters
  • branch
    • Parameters
  • repositoryGroupClass
  • rateLimitReached
  • name
  • provider
  • defaultOptions
  • optionsFromEnvironment
    • Parameters
  • options
    • Parameters

Provider

Extends Owner

Base repository provider acts as a source of repositories

Parameters

• options Object

Properties

• repositoryGroups Map<string, RepositoryGroup>
• config Object

repositoryGroup

Lookup a repository group

Parameters

• name string of the group
• options Object

Returns Promise<RepositoryGroup>

createRepositoryGroup

Create a new repository group

Parameters

• name string
• options Object

Returns Promise<RepositoryGroup>

repository

Lookup a repository in the provider and all of its repository groups

Parameters

• name string of the repository
• options Object

Returns Promise<Repository>

branch

Lookup a branch in the provider and all of its repository groups

Parameters

• name string of the branch
• options Object

Returns Promise<Branch>

repositoryGroupClass

Returns Class repository group class used by the Provider

rateLimitReached

Is our rate limit reached. By default we have no rate limit

Returns boolean always false

name

Deliver the provider name

Returns string class name by default

provider

we are our own provider

Returns Provider this

defaultOptions

Default configuration options

Returns Object

optionsFromEnvironment

Extract options suitable for the constructor form the given set of environment variables

Parameters

• env Object

Returns Object undefined if no suitable environment variables have been found

options

Pepare configuration by mixing together defaultOptions with actual options

Parameters

• config Object raw config

Returns Object combined options

install

With npm do:

npm install repository-provider

license

BSD-2-Clause