Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bevry-archive/github-commit

Deprecated. Use https://github.com/bevry/github-api
https://github.com/bevry-archive/github-commit

Last synced: about 9 hours ago
JSON representation

Deprecated. Use https://github.com/bevry/github-api

Awesome Lists containing this project

README

        

@bevry/github-commit

Status of the GitHub Workflow: bevry
NPM version
NPM downloads
Dependency Status
Dev Dependency Status


GitHub Sponsors donate button
Patreon donate button
Flattr donate button
Liberapay donate button
Buy Me A Coffee donate button
Open Collective donate button
crypto donate button
PayPal donate button
Wishlist browse button

Fetch the latest commit of a GitHub repository

## Usage

[Complete API Documentation.](http://master.github-commit.bevry.surge.sh/docs/)

```typescript
// import the library
import getCommit from '@bevry/github-commit'

// fetch the commit
const commit = await getCommit('bevry/github-commit').catch((err) => {
// if something went wrong, such as unauthorized, empty repository, no internet connection
// then log the error as a warning
console.warn(err)

// and fallback to master
return 'master'
})

// log the eventual result
console.log(commit)
```

Install

npm



  • Install: npm install --save @bevry/github-commit

  • Import: import pkg from ('@bevry/github-commit')

  • Require: const pkg = require('@bevry/github-commit').default

Skypack

``` html

import pkg from '//cdn.skypack.dev/@bevry/github-commit@^1.1.0'

```

unpkg

``` html

import pkg from '//unpkg.com/@bevry/github-commit@^1.1.0'

```

jspm

``` html

import pkg from '//dev.jspm.io/@bevry/[email protected]'

```

Editions

This package is published with the following editions:



  • @bevry/github-commit/source/index.ts is TypeScript source code with Import for modules


  • @bevry/github-commit/edition-browsers/index.js is TypeScript compiled against ES2020 for web browsers with Import for modules


  • @bevry/github-commit aliases @bevry/github-commit/edition-es2019/index.js


  • @bevry/github-commit/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js 10 || 12 || 14 || 16 with Require for modules


  • @bevry/github-commit/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js 12 || 14 || 16 with Import for modules

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

GitHub Sponsors donate button
Patreon donate button
Flattr donate button
Liberapay donate button
Buy Me A Coffee donate button
Open Collective donate button
crypto donate button
PayPal donate button
Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under: