https://github.com/jcrqr/octono

🍂 GitHub REST API for Deno projects
https://github.com/jcrqr/octono

deno github github-rest-api octokit openapi

Last synced: about 1 month ago
JSON representation

🍂 GitHub REST API for Deno projects

• Host: GitHub
• URL: https://github.com/jcrqr/octono
• Owner: jcrqr
• License: mit
• Created: 2021-08-15T13:20:22.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-11T13:05:46.000Z (about 3 years ago)
• Last Synced: 2024-09-30T01:03:26.561Z (about 2 months ago)
• Topics: deno, github, github-rest-api, octokit, openapi
• Language: TypeScript
• Homepage: https://deno.land/x/octono
• Size: 180 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# :fallen_leaf: Octono

> GitHub REST API for Deno projects.

:construction: Under active development. **DO NOT** use in production.

## Installation

```typescript

import { Octono } from "https://deno.land/x/[email protected]/mod.ts";

```

## Usage

```typescript

import { request } from "https://deno.land/x/[email protected]/mod.ts";

const resp = await Octono.request("GET /users/{username}/repos", {

  username: "octocat"

})

const repos = await resp.json();

for (const repo of repos) {

  console.log(`Found repo: ${repo.full_name} (${repo.stargazers_count} stars)`);

}

```

See [example.ts](example.ts). Use `deno run --allow-env --allow-net example.ts` to run it.

## Permissions

This module requires `--allow-env` and `--allow-net` permissions.

## Contributing

Please, see [CONTRIBUTING.md](CONTRIBUTING.md) to learn how you can contribute to this repository.

## License

This project is released under the [MIT License](/LICENSE).