@frontender-magazine/github-sdk

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

• statusCode number http status code
• statusText string http status code text
• message (string | null) error details (optional, default null)

GitHubSDK

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

SDK for GitHub API

Parameters

• token string github app token

upload

Uload file to repository

Parameters

• props Object upload props
  • props.owner string organization or user name
  • props.repo string repository name
  • props.path string relative file path with file name in it
  • props.message string commit message
  • props.content string base64 encoded content
  • props.branch string name of the branch (optional, default 'master')

Examples

Upload binary file

import fs from 'fs';
import GitHubSDK from '@frontender-magazine/github-sdk';
(async()=>{
  try {
    const github = new GitHubSDK('b8f921864bd9a9fb6585b10e6534baa37c4d45fe');
    const image = fs.readFileSync('/path/image.jpg', 'base64');
    const content = await github.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';
import GitHubSDK from '@frontender-magazine/github-sdk';
(async()=>{
  try {
    const github = new GitHubSDK('b8f921864bd9a9fb6585b10e6534baa37c4d45fe');
    const readme = Base64.btoa('# Title');
    const content = await github.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

• props Object Options
  • props.name string Repository name
  • props.description string Repository description (optional, default null)
  • props.homepage string Link to some related resourse (optional, default null)
  • props.org string? Organization name

Examples

Create repository

import GitHubSDK from '@frontender-magazine/github-sdk';
(async()=>{
  try {
    const github = new GitHubSDK('b8f921864bd9a9fb6585b10e6534baa37c4d45fe');
    const results = await github.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

• keywordsList Array<string> Keywords array

Examples

Search for users

import GitHubSDK from '@frontender-magazine/github-sdk';
(async()=>{
  try {
    const github = new GitHubSDK('b8f921864bd9a9fb6585b10e6534baa37c4d45fe');
    const results = await github.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

• keyword String login to search

Examples

Search for user

import GitHubSDK from '@frontender-magazine/github-sdk';
(async()=>{
  try {
    const github = new GitHubSDK('b8f921864bd9a9fb6585b10e6534baa37c4d45fe');
    const details = await github.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

• login String login

Examples

Get user details

import GitHubSDK from '@frontender-magazine/github-sdk';
(async()=>{
  try {
    const github = new GitHubSDK('b8f921864bd9a9fb6585b10e6534baa37c4d45fe');
    const details = await github.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