Socket
Socket
Sign inDemoInstall

github-api

Package Overview
Dependencies
8
Maintainers
4
Versions
23
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install
Previous13Next

1.3.0

Diff

clayreimann
published 1.2.1 •

Changelog

Source

1.2.1

Fixes

  • Repository: Replace invalid references to postTree with createTree
clayreimann
published 1.2.0 •

Changelog

Source

1.2.0 - 2016/05/11

Features

  • Search API now returns all pages of results
  • Added Repository.listReleases

Added functions for querying organization membership

  • Organization.listMembers
  • Organization.isMember

Added functions for issue comments

  • Issue.listComments
  • Issue.getComment
  • Issue.editComment
  • Issue.deleteComment

Fixes

  • all functions now return a Promise
clayreimann
published 1.1.0 •

Changelog

Source

1.1.0 - 2016/05/03

Features

Added methods for commenting on Gists:

  • Gist.listComments
  • Gist.getComment
  • Gist.editComment
  • Gist.deleteComment
  • Gist.createComment

Fixes

  • Repository.deleteFile now correctly returns a promise.
clayreimann
published 1.0.0 •

Changelog

Source

1.0.0 - 2016/04/27

Complete rewrite in ES2015.

  • Promise-ified the API
  • Auto-generation of documentation
  • Modularized codebase
  • Refactored tests to run primarily in mocha

Breaking changes

Most of the breaking changes are just methods that got renamed. The changes to User and Organization are deeper changes that now scope a particular User or Organization to the entity they were instantiated with. You will need separate Users to query data about different user accounts.

  • Github.getOrgGithub.getOrganization and requires an organization name.
  • Github.getUser now requires a username.
  • Issue.commentIssue.createIssueComment
  • Issue.createIssue.createIssue
  • Issue.editIssue.editIssue
  • Issue.getIssue.getIssue
  • Issue.listIssue.listIssues
  • Repository.branchRepository.createBranch
  • Repository.collaboratorsRepository.getCollaborators
  • Repository.compareRepository.compareBranches
  • Repository.contentsRepository.getContents and now takes an argument for the content type
  • Repository.delete has been removed.
  • Repository.editHookRepository.updateHook
  • Repository.editReleaseRepository.updateRelease
  • Repository.getCommit no longer takes a branch as the first argument
  • Repository.getPullRepository.getPullRequest
  • Repository.getRef now returns the refspec from GitHub's API.
  • Repository.getSha now returns the same data as GitHub's API. If the reqeusted object is not a directory then the response will contain a property SHA, and if the reqeusted object is a directory then the contents of the directory are stated.
  • Repository.getStatusesRepository.listStatuses
  • Repository.listPullsRepository.listPullRequests
  • Repository.postBlobRepository.createBlob
  • Repository.postTreeRepository.createTree
  • Repository.read remove in favor of Repository.getContents
  • Repository.removeRepository.deleteFile
  • Repository.showRepository.getDetails
  • Repository.writeRepository.writeFile
  • Search.codeSearch.forCode
  • Search.issuesSearch.forIssues
  • Search.repositoriesSearch.forRepositories
  • Search.usersSearch.forUsers
  • The Search API no longer takes a string, it now takes an object with properties q, sort, and order to make the parts of the query easier to grok and to better match GitHub's API.
  • User.gistsUser.getGists
  • User.notificationsUser.getNotifications
  • User.orgReposOrganization.getRepos
  • User.orgsUser.getOrgs
  • User.reposUser.getRepos
  • User.showUser.getProfile and no longer takes filtering options
  • User.userStarredUser.getStarredRepos
aendrew
published 0.11.2 •

aendrew
published 0.10.7 •

aendrew
published 0.10.6 •

ingalls
published 0.10.4 •

ingalls
published 0.10.3 •

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc