node-github-ridaura v1.3.0

Node.js GitHub v1.3.0

Copyright (c) 2024 Sergio Ridaura.
https://sergio-ridaura.vercel.app - sergio.ridaura@outlook.com

Description

Modules to manage GitHub in Node.js written with TypeScript.

Using modules

Install the module in your project.

npm i node-github-ridaura

Add environment variable GITHUB_ACCESS_TOKEN in the .env file.

GITHUB_ACCESS_TOKEN=github_pat_XXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Example of module use:

import { userGet } from "node-github-ridaura";

(async () => {
  console.log(await userGet("sergio-ridaura"));
})();

Modules

followers

• followersGet: Get the user's followers from the GitHub API.

following

• followingGet: Get the user's following from the GitHub API.

gists

• gistsGet: Get the user's gists from the GitHub API.

lang

• langGet: Get the user's languages used from the GitHub API.
• langGetRepo: Get the repository's languages used from the GitHub API.
• langGetPercent: Get the languages used by the user from the GitHub API, in percentages.
• langGetRepoPercent: Get the repository's languages used from the GitHub API, in percentages.

milestones

• milestonesAdd: Create repository milestones from the GitHub API.
• milestoneDelete: Delete repository milestones from the GitHub API.
• milestonesGet: Get repository milestones from the GitHub API.
• milestonesGetNumber: Get repository milestones by number from the GitHub API.
• milestoneUpdate: Update repository milestones from the GitHub API.

repos

• reposGetAll: Get the user's repositories from the GitHub API.

user

• userGet: Get user information from the GitHub API.

Author

Sergio Ridaura

Full stack developer in TypeScript with Astro.js, Next.js, React.js, Node.js and MongoDB.
Quick development of high-performance applications and websites.

MIT License

Copyright (c) 2024 Sergio Ridaura.
https://sergio-ridaura.vercel.app - sergio.ridaura@outlook.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.