{"id":16261411,"url":"https://github.com/intevel/gh-notifications","last_synced_at":"2025-03-19T22:30:47.818Z","repository":{"id":103218192,"uuid":"607374716","full_name":"Intevel/gh-notifications","owner":"Intevel","description":"📬 Lightweight (\u003c3KB) Wrapper around the GitHub Notifications API","archived":false,"fork":false,"pushed_at":"2023-02-28T21:21:55.000Z","size":66,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-15T03:12:08.321Z","etag":null,"topics":["gh-notifications","github","github-api","inbox","notifications","typescript","wrapper"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Intevel.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-27T21:17:30.000Z","updated_at":"2023-12-05T15:20:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"44f0c9c8-0bdb-45b9-a006-8e91a94c59d0","html_url":"https://github.com/Intevel/gh-notifications","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Intevel%2Fgh-notifications","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Intevel%2Fgh-notifications/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Intevel%2Fgh-notifications/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Intevel%2Fgh-notifications/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Intevel","download_url":"https://codeload.github.com/Intevel/gh-notifications/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244515615,"owners_count":20464919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gh-notifications","github","github-api","inbox","notifications","typescript","wrapper"],"created_at":"2024-10-10T16:41:24.926Z","updated_at":"2025-03-19T22:30:47.537Z","avatar_url":"https://github.com/Intevel.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gh-notifications\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![License][license-src]][license-href]\n\n📬 Lightweight (\u003c3KB) Wrapper around the GitHub Notifications API\n\n## Install\n\n```sh\n\n# Using npm\nnpm install gh-notifications\n\n# Using yarn\nyarn add gh-notifications\n```\n\n## Usage\n\n\u003e Warning:\n\u003e Usage of _gh-notifications_ requires a valid github api token: [Documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-authentication-to-github#authenticating-with-the-api)\n\n```js\nconst APITOKEN = \"**************\";\n\nasync function main() {\n  // get a GitHubInbox instance and pass the api token to it\n  const inbox = new GitHubInbox(APITOKEN);\n  // initialize the inbox\n  await inbox.initialize();\n\n  // fetch all unread notifications\n  const unreadNotifications = await inbox.fetchUnreadNotifications();\n  // view src/types.ts for all fields in the notification object\n  console.log(unreadNotifications);\n\n  // mark the latest unread notification as read\n  await inbox.markAsRead(unreadNotifications[0]?.id);\n}\n\nmain();\n```\n\n## License\n\nPublished under MIT - Made with ❤️ by Conner Bachmann\n\n\u003c!-- Badges --\u003e\n\n[npm-version-src]: https://img.shields.io/npm/v/gh-notifications/latest.svg\n[npm-version-href]: https://npmjs.com/package/gh-notifications\n[npm-downloads-src]: https://img.shields.io/npm/dt/gh-notifications.svg\n[npm-downloads-href]: https://npmjs.com/package/gh-notifications\n[github-actions-ci-src]: https://github.com/intevel/gh-notifications/actions/workflows/ci.yml/badge.svg\n[github-actions-ci-href]: https://github.com/intevel/gh-notifications/actions?query=workflow%3Aci\n[license-src]: https://img.shields.io/npm/l/gh-notifications.svg\n[license-href]: https://npmjs.com/package/gh-notifications\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintevel%2Fgh-notifications","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintevel%2Fgh-notifications","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintevel%2Fgh-notifications/lists"}