# github-data-cat

Latest version **1.1.9** (published 2023-04-19) · Apache 2.0 license · 0 weekly downloads

## Install

```sh
npm install github-data-cat
pnpm add github-data-cat
yarn add github-data-cat
bun add github-data-cat
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.9 |
| Published | 2023-04-19 |
| First published | 2019-11-20 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 81 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | frank-zsy |
| Maintainers | frankzhao |

## Links

- npm: https://www.npmjs.com/package/github-data-cat
- Repository: https://github.com/X-lab2017/data-cat
- Homepage: https://github.com/X-lab2017/data-cat#readme
- Issues: https://github.com/X-lab2017/data-cat/issues
- npm.io page: https://npm.io/package/github-data-cat

## Dependencies (3)

- [bunyan](https://npm.io/package/bunyan.md) ^1.8.12
- [@types/node](https://npm.io/package/@types/node.md) ^12.11.1
- [github-graphql-v4-client](https://npm.io/package/github-graphql-v4-client.md) ^0.1.4

## Recent versions

- 1.1.9 (latest) — 2023-04-19
- 1.1.8 — 2023-04-19
- 1.1.7 — 2023-04-19
- 1.1.6 — 2023-04-18
- 1.1.5 — 2023-04-18
- 1.1.4 — 2022-01-13
- 1.1.3 — 2022-01-13
- 1.1.2 — 2021-11-05
- 1.1.1 — 2021-11-05
- 1.1.0 — 2021-11-05
- 1.0.2 — 2019-12-12
- 1.0.1 — 2019-11-20
- 1.0.0 — 2019-11-20

## README

<div align="left">
<img src="https://raw.githubusercontent.com/Badstu/pic_set/master/img/20191019163227.png" height="120"/>
</div>

---

# description

`data-cat` is a module for fetcher the graphql data from github, with the structural data as return.

# demo

```typescript
import { DataCat } from "data-cat"

async function test_data_cat() {
  let data_cat = new DataCat({
    tokens: ["xxx", "xxx"],
  });
  await data_cat.init();

  let repos = await data_cat.org.repos('X-lab2017');
  return repos;
}

console.log(test_data_cat());
```
# docs

```typescript
org{
  repos: (login: string, updatedAfter?: Date) => Promise<Repo[]>
};
repo{
  info: (owner: string, name: string) => Promise<Repo>;
  stars: (owner: string, name: string, updatedAfter?: Date) => Promise<UserWithTimeStamp[]>;
  forks: (owner: string, name: string, updatedAfter?: Date) => Promise<UserWithTimeStamp[]>;
  issues: (owner: string, name: string, updatedAfter?: Date) => Promise<Issue[]>;
  pulls: (owner: string, name: string, updatedAfter?: Date) => Promise<PullRequest[]>;
  contributors: (owner: string, name: string, branch: string, commitLimit?: number) => Promise<UserWithTimeStampAndEmail[]>;
  full: (owner: string, name: string, param?: RepoFullParam, updatedAfter?: Date) => Promise<Repo>;
};
user{
  info: (login: string) => Promise<User>;
  following: (login: string) => Promise<UserFollower[]>;
  follower: (login: string) => Promise<UserFollower[]>;
}
```

---
_Source: https://npm.io/package/github-data-cat · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._