node package manager
We need your input. Help make JavaScript better: Take the 2017 JavaScript Ecosystem survey »

github-repository-provider

npm Greenkeeper semantic-release styled with prettier Build Status bithound codecov.io Coverage Status Known Vulnerabilities GitHub Issues Stories in Ready Dependency Status devDependency Status docs XO code style downloads Commitizen friendly

github-repository-provider

repository provider for github

API

Table of Contents

GithubProvider

Extends Provider

GitHub provider

Parameters

  • config

Properties

repository

Parameters

Returns Repository

checkForApiLimitError

Check for ecistanse of an api rate limit Error also sets rateLimitReached to true

Parameters

Returns Promise<boolean> true if api rate limit error present

options

Pepare configuration by mixing together defaultOptions with actual options

Parameters

Returns Object combined options

GithubRepository

Extends Repository

Repository on GitHub

Parameters

  • provider
  • name

initialize

Collect all branches

Returns Promise

urls

Returns Array<string> github https url

GithubBranch

Extends Branch

Branch on GitHub

commit

Parameters

  • message
  • blobs
  • options (optional, default {})

content

Parameters

  • path
  • options (optional, default {})

install

With npm do:

npm install mock-repository-provider

license

BSD-2-Clause