Depricated in favor of official github api

Github API SDK

JavaScript SDK for Github API. Contain only requests I actually need.

Bages

Documentation

Table of Contents

• ErrorServerResponse
• GitHubSDK
• upload
• create
• searchForUsers
• searchForUser
• getUser
• User
• Content
• Repository

ErrorServerResponse

Custom error message for abstract server response

Parameters

• statusCodenumber http status code
• statusTextstring http status code text
• message(string | null) error details (optional, default null)

GitHubSDK

• See: https://developer.github.com/v3/

SDK for GitHub API

Parameters

• tokenstring github app token

upload

Uload file to repository

Parameters

• propsObject upload props
  • props.ownerstring organization or user name
  • props.repostring repository name
  • props.pathstring relative file path with file name in it
  • props.messagestring commit message
  • props.contentstring base64 encoded content
  • props.branchstring name of the branch (optional, default 'master')

Examples

Upload binary file

importfsfrom'fs';importGitHubSDKfrom'@frontender-magazine/github-sdk';(async()=>{try{constgithub=newGitHubSDK('b8f921864bd9a9fb6585b10e6534baa37c4d45fe');constimage=fs.readFileSync('/path/image.jpg','base64');constcontent=awaitgithub.upload({owner: 'FrontenderMagazine',repo: 'article',path: 'images/image.jpg',message: 'Uploaded image.jpg',content: image,});}catch(error){console.log(error.message);}})();

Upload text file

import{Base64}from'js-base64';importGitHubSDKfrom'@frontender-magazine/github-sdk';(async()=>{try{constgithub=newGitHubSDK('b8f921864bd9a9fb6585b10e6534baa37c4d45fe');constreadme=Base64.btoa('# Title');constcontent=awaitgithub.upload({owner: 'FrontenderMagazine',repo: 'article',path: 'README.md',message: 'Uploaded README.md',content: readme,});}catch(error){console.log(error.message);}})();

• Throws ValidationError Error of fields validation
• Throws ErrorServerResponse Server error

Returns Promise<Content> uploaded content data

create

Create repository in the organization

Parameters

• propsObject Options
  • props.namestring Repository name
  • props.descriptionstring Repository description (optional, default null)
  • props.homepagestring Link to some related resourse (optional, default null)
  • props.orgstring? Organization name

Examples

Create repository

importGitHubSDKfrom'@frontender-magazine/github-sdk';(async()=>{try{constgithub=newGitHubSDK('b8f921864bd9a9fb6585b10e6534baa37c4d45fe');constresults=awaitgithub.create({name: 'owning-the-role-of-the-front-end-developer',description: 'Owning the Role of the Front-End Developer',homepage: 'http://alistapart.com/article/owning-the-role-of-the-front-end-developer',org: 'FrontenderMagazine',});}catch(error){console.log(error.message);}})();

• Throws ValidationError Error of fields validation
• Throws ErrorServerResponse Server error

Returns Promise<Repository> Repository object

searchForUsers

Search for users

Parameters

• keywordsListArray<string> Keywords array

Examples

Search for users

importGitHubSDKfrom'@frontender-magazine/github-sdk';(async()=>{try{constgithub=newGitHubSDK('b8f921864bd9a9fb6585b10e6534baa37c4d45fe');constresults=awaitgithub.searchForUsers(['octocat','silentimp']);}catch(error){console.log(error.message);}})();

• Throws ValidationError Error of fields validation
• Throws ErrorServerResponse Server error

Returns Promise<Users> array of users

searchForUser

Search for user

Parameters

• keywordString login to search

Examples

Search for user

importGitHubSDKfrom'@frontender-magazine/github-sdk';(async()=>{try{constgithub=newGitHubSDK('b8f921864bd9a9fb6585b10e6534baa37c4d45fe');constdetails=awaitgithub.searchForUser('octocat');}catch(error){console.log(error.message);}})();

• Throws ValidationError Error of fields validation
• Throws ErrorServerResponse Server error

Returns Promise<User> user

getUser

Get user details

Parameters

• loginString login

Examples

Get user details

importGitHubSDKfrom'@frontender-magazine/github-sdk';(async()=>{try{constgithub=newGitHubSDK('b8f921864bd9a9fb6585b10e6534baa37c4d45fe');constdetails=awaitgithub.getUser('octocat');}catch(error){console.log(error.message);}})();

• Throws ValidationError Error of fields validation
• Throws ErrorServerResponse Server error

Returns Promise<User> — user representation

User

• See: https://developer.github.com/v3/users/#response

User object

Type: User

Content

• See: https://developer.github.com/v3/repos/contents/#response-2

Content object

Type: Content

Repository

• See: https://developer.github.com/v3/repos/#response-2

Repository object

Type: Repository