https://github.com/juunini/github-api-helper-ts

Helper using GitHub API
https://github.com/juunini/github-api-helper-ts

api github typescript

Last synced: 2 months ago
JSON representation

Helper using GitHub API

• Host: GitHub
• URL: https://github.com/juunini/github-api-helper-ts
• Owner: juunini
• License: mit
• Created: 2023-04-20T08:47:54.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-01T08:24:56.000Z (about 3 years ago)
• Last Synced: 2025-02-18T12:06:18.905Z (over 1 year ago)
• Topics: api, github, typescript
• Language: TypeScript
• Homepage:
• Size: 129 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# github-api-helper

![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)

![BunJS](https://img.shields.io/badge/Bun-beige?style=for-the-badge&logo=bun&logoColor=black)

![Parcel](https://img.shields.io/badge/Parcel-deac79?style=for-the-badge&logoColor=black&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pgo8IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDIwMDEwOTA0Ly9FTiIKICJodHRwOi8vd3d3LnczLm9yZy9UUi8yMDAxL1JFQy1TVkctMjAwMTA5MDQvRFREL3N2ZzEwLmR0ZCI+CjxzdmcgdmVyc2lvbj0iMS4wIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiB3aWR0aD0iMzguMDAwMDAwcHQiIGhlaWdodD0iMzAuMDAwMDAwcHQiIHZpZXdCb3g9IjAgMCAzOC4wMDAwMDAgMzAuMDAwMDAwIgogcHJlc2VydmVBc3BlY3RSYXRpbz0ieE1pZFlNaWQgbWVldCI+Cgo8ZyB0cmFuc2Zvcm09InRyYW5zbGF0ZSgwLjAwMDAwMCwzMC4wMDAwMDApIHNjYWxlKDAuMTAwMDAwLC0wLjEwMDAwMCkiCmZpbGw9IiMwMDAwMDAiIHN0cm9rZT0ibm9uZSI+CjxwYXRoIGQ9Ik0xNzYgMjI1IGMtMyAtOSAtMTIgLTEyIC0yMyAtOSAtMTAgMyAxIC02IDI1IC0yMSBsNDQgLTI3IDI0IDIzIGMyNwoyNSAyMiAzMiAtMzMgNDIgLTIyIDQgLTMzIDIgLTM3IC04eiIvPgo8cGF0aCBkPSJNMTA4IDIwMyBjNyAtMyAxOCAtMTcgMjMgLTMxIDggLTIwIDEyIC0yMyAyMiAtMTMgOSAxMCA3IDE3IC0xMiAzMgotMTMgMTAgLTI4IDE5IC0zNSAxOCAtNiAwIC02IC0zIDIgLTZ6Ii8+CjxwYXRoIGQ9Ik0yODYgMTMxIGMtMyAtNSAwIC0xMSA3IC0xNCA4IC0zIDE0IDEgMTQgOSAwIDE2IC0xMyAxOSAtMjEgNXoiLz4KPHBhdGggZD0iTTE2MCA4NCBjMCAtMTQgNCAtMjMgMTAgLTE5IDYgMyAxMCAyIDEwIC00IDAgLTYgNyAtOCAxNSAtNSA4IDQgMTUKMTUgMTUgMjUgMCAyMSAtMTYgMjYgLTIzIDcgLTMgLTggLTYgLTYgLTYgNSAtMSAyNyAtMjEgMjAgLTIxIC05eiIvPgo8L2c+Cjwvc3ZnPg==)

![Version](https://img.shields.io/npm/v/github-api-helper)

[![codecov](https://codecov.io/gh/juunini/github-api-helper-ts/branch/main/graph/badge.svg?token=ZZE5D2GG05)](https://codecov.io/gh/juunini/github-api-helper-ts)

[![ESLint](https://github.com/juunini/github-api-helper-ts/actions/workflows/eslint.yaml/badge.svg)](https://github.com/juunini/github-api-helper-ts/actions/workflows/eslint.yaml)



## Install

```bash

# npm

npm install github-api-helper

# yarn

yarn add github-api-helper

# pnpm

pnpm add github-api-helper

# bun

bun add github-api-helper

```

## Usage

### OAuth

```ts

import { OAuth, loginURL } from 'github-api-helper'

const oauth = new OAuth('client_id', 'client_secret')

const githubLoginURL = oauth.loginURL

// or

// const githubLoginURL = loginURL({ clientId: 'client_id' })

oauth.access_token('code').then((response) => console.log({

  access_token: response.access_token,

  refresh_token: response.refresh_token,

}))

oauth.refresh_token('refresh_token').then((response) => console.log({

  access_token: response.access_token,

  refresh_token: response.refresh_token,

}))

```

### Commit

> Access Token(or Personal access token) must have `Contents` Read and write permission of `Repository permissions`

```ts

import { commit } from 'github-api-helper'

commit({

  owner: 'juunini',

  repo: 'test',

  branch: 'main',

  accessToken: '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',

  files: [

    {

      path: 'README.md',

      data: '# GitHub API Helper'

    },

    {

      path: 'src/index.ts',

      data: 'console.log(\'Hello World\')'

    }

  ],

  committer: {

    name: 'bot',

    email: 'noreply@example.com'

  },

  message: 'commit message'

})

  .then(console.log)

```

### Read

```ts

import { read } from 'github-api-helper'

read({

  owner: 'juunini',

  repo: 'test',

  branch: 'main', // optional

  accessToken: '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',

  path: 'README.md'

}).then((response) => {

  if (response instanceof Array) {

    // directory

  } else {

    // file

  }

})

```

### User

```ts

import { user } from 'github-api-helper'

user({ accessToken: 'accessToken' }).then(console.log)

// or

user({ id: 41536271 }).then(console.log)

```