@bevry/github-commit
Fetch the latest commit of a GitHub repository
Usage
// 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
- Install:
npm install --save @bevry/github-commit
- Import:
import pkg from ('@bevry/github-commit')
- Require:
const pkg = require('@bevry/github-commit').default
<script type="module">
import pkg from '//cdn.skypack.dev/@bevry/github-commit@^1.1.0'
</script>
<script type="module">
import pkg from '//unpkg.com/@bevry/github-commit@^1.1.0'
</script>
<script type="module">
import pkg from '//dev.jspm.io/@bevry/github-commit@1.1.0'
</script>
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?
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:
- Copyright © 2020+ Benjamin Lupton
and licensed under: