Module: github

github

Module that provides means to check/search in GitHub.
Source:

Members

<static> settings

Supported operation settings/options. Conform to format of nomnom options.
Source:

Methods

<static> detect(name, callback, settings)

Check whether repository with the specified name is existent. Data about found repositories will be passed into callback as array. If no repository is found, empty array will be passed into callback.
Parameters:
Name Type Argument Description
name String Name of the repository to check.
callback function Function that should be called to process operation's result.
settings Object <optional>
Operation settings. The following settings are supported (name - type - description):
  • caseSensitive - Boolean - Whether case-sensitive search should be used
  • partialMatch - Integer - Allow partial matching: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching
  • lang, language - String - Search repositories that are written in the specified language
  • user - String - GitHub username that should be used for authentication
  • password - String - GitHub account password
  • token - String - OAuth2 token that should be used for authentication instead of username and password
  • limit - Integer - Limit of quantity of results; default and maximum value is 100
  • pageSize - Integer - Quantity of results per page; default and maximum value is 100
Source:
Copyright (c) 2014 Denis Sikuler
Documentation generated by JSDoc 3.2.2 on Sun Mar 30 2014 11:56:30 GMT+0400 (MSK) using the DocStrap template.