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
  • pullRequestClass
  • rateLimitReached
  • name
  • provider
  • defaultOptions
  • optionsFromEnvironment
    • Parameters
  • options
    • Parameters
• Branch
  • Parameters
  • Properties
• defaultOptions
• defaultOptions
• defaultOptions
• OneTimeInititalizer
• Owner
  • Properties
• Repository
  • Parameters
  • Properties
• description
• description
• id
• id
• PullRequest
  • Parameters
  • Properties
  • provider
  • delete
  • merge
  • decline
• title
• state
• RepositoryGroup
  • Parameters
  • Properties
  • repositoryClass
  • branchClass
  • contentClass
• Content
  • Parameters
  • Properties
• propertiesFromOptions
  • 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

pullRequestClass

Returns Class pull request 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

Branch

• See: Repository#addBranch

Abstract branch

Parameters

• repository Repository
• name string
• options Object

Properties

• repository Repository
• provider Provider
• name string

defaultOptions

options

defaultOptions

options

defaultOptions

options

OneTimeInititalizer

enshures tha _initialize() will be called only once

Owner

Collection of repositories

Properties

• repositories Map<string, Repository>

Repository

Abstract repository

Parameters

• owner Owner
• name string (#branch) will be removed
• options Object
  • options.description string? human readable description
  • options.id string? internal id

Properties

• owner Owner
• name string without (#branch)
• description string? from options.description
• id string? from options.id
• branches Map<string, Branch>
• pullRequests Map<string, PullRequest>

description

the description of the repository content.

Returns string

description

the description of the repository content.

Returns string

id

unique id within the provider.

Returns string

id

unique id within the provider.

Returns string

PullRequest

Abstract pull request Repository#addPullRequest

Parameters

• repository Repositoy
• name string
• options Object
  • options.title string
  • options.state string

Properties

• name string
• repository Repository
• provider Provider
• title string?
• state string?

provider

Returns Provider

delete

• See: Repository#deletePullRequest

Delete the pull request from the Repository.

Returns Promise

merge

Merge the pull request

decline

Decline the pull request

title

the description of the pull request.

Returns string

state

state of the pull request.

Returns string

RepositoryGroup

Extends Owner

Abstract repository as a collection

Parameters

• provider Provider
• name string of the group
• options Object
  • options.description string? human readable description
  • options.id string? internal id

Properties

• provider Provider
• name string

repositoryClass

By default we use the providers implementation.

Returns Class as defined in the provider

branchClass

By default we use the providers implementation.

Returns Class as defined in the provider

contentClass

By default we use the providers implementation.

Returns Class as defined in the provider

Content

Representation of one file or directory entry

Parameters

• path string file name inside of the repository
• content (string | Buffer | Stream) (optional, default undefined)
• type string type of the content (optional, default "blob")
• mode string file permissions (optional, default "100644")

Properties

• path string file name inside of the repository
• content (string | Buffer | Stream)
• type string type of the content
• mode string file permissions

propertiesFromOptions

• See: Object.definedProperties()

create properties from options and default options

Parameters

• properties Object where the properties will be stored
• options Object
• defaultOptions Object

install

With npm do:

npm install repository-provider

license

BSD-2-Clause