npmpackage.info

@suin/esa-api

esa.io API のクライアントライブラリ。Node.js、TypeScript/JavaScript向け。

4.0.1

MIT

TypeScript

21.22 kB

7,814 2.5

Installations

npm install @suin/esa-api

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.7.0

NPM Version

10.1.0 Score

76.4

Supply Chain

98.3

Quality

75.4

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

8

Total

19

Closed

11

Issues

Open

0

Total

0

Closed

0

Releases

v4.0.1

Published on 20 Sept 2023

v4.0.0

Published on 23 Apr 2021

v3.2.0

Published on 24 Mar 2021

v3.1.0

Published on 24 Mar 2021

v3.0.2

Published on 22 Jun 2020

v3.0.1

Published on 22 Jun 2020

View all 12 releases

Contributors

Unable to fetch Contributors

View all 2 contributors

Languages

TypeScript

Shell

TypeScript (99.6%)

Shell (0.4%)

Developer

suin

Download Statistics

Total Downloads

7,814

Last Day

Last Week

191

Last Month

1,149

Last Year

4,370

GitHub Statistics

8 Stars

36 Commits

3 Watching

10 Branches

2 Contributors

Bundle Size

120.19 kB

Minified

21.22 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

4.0.1

Package Id

@suin/esa-api@4.0.1

Unpacked Size

1.30 MB

Size

109.28 kB

File Count

298

NPM Version

10.1.0

Node Version

20.7.0

Publised On

20 Sept 2023

Total Downloads

Cumulative downloads

Total Downloads

7,814

Last day

-93.8%

Compared to previous day

Last week

-20.7%

191

Compared to previous week

Last month

-35.6%

1,149

Compared to previous month

Last year

402.9%

4,370

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

@suin/esa-api

esa.io API のクライアントライブラリ。

特徴

すべてのエンドポイントに対応しています。
esa API の OpenAPI 仕様書から生成したクライアントライブラリをベースに一部拡張を加えたライブラリです。

インストール

1yarn add @suin/esa-api
2# or
3npm install @suin/esa-api

使い方

基本的な用法:

1import { createClient } from "@suin/esa-api";
2
3const teamName = "your_team_name";
4
5const client = createClient({
6  token: process.env.ESA_TOKEN, // アクセストーン
7});
8
9{
10  // 記事一覧を取得する
11  const {
12    data: { posts },
13  } = await client.getPosts({ teamName });
14}
15
16{
17  // 指定した記事を取得する
18  const { data: post } = await client.getPost({ teamName, postNumber: 1 });
19}
20
21{
22  // 記事を新規投稿する
23  const { data: createdPost } = await client.createPost({
24    teamName,
25    post: {
26      name: "hi!",
27      body_md: "# Getting Started\n",
28      tags: ["api", "dev"],
29      category: "dev/2015/05/10",
30      wip: false,
31      message: "Add Getting Started section",
32    },
33  });
34}
35
36{
37  // 指定した記事を編集する
38  const { data: updatedPost } = await client.updatePost({
39    teamName,
40    postNumber: 1,
41    updatePostBody: {
42      post: {
43        wip: false,
44        message: "Ship it!",
45      },
46    },
47  });
48}

複雑なクエリの例:

1import { createClient } from "@suin/esa-api";
2
3const teamName = "your_team_name";
4
5const client = createClient({
6  token: process.env.ESA_TOKEN,
7});
8
9// 細かい条件を設定して記事一覧を取得する
10const response = await client.getPosts({
11  teamName,
12  q: "wip:false",
13  include: ["comments", "comments.stargazers", "stargazers"],
14  sort: "updated",
15  order: "desc",
16  per_page: 100,
17  page: 1,
18});
19
20// 結果からは様々な付随情報が得られます:
21// 1. 記事一覧
22const { posts } = response.data;
23// 2. 利用制限
24const { limit, remaining, reset } = response.ratelimit;
25// 3. ページネーション
26const { prev_page, next_page, page, per_page, max_per_page, total_count } =
27  response.data;

API リファレンス

https://suin.github.io/esa-api/

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

SAST

Determines if the project uses static code analysis.

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.5

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @suin/esa-api

@suin/esa-openapi

2.2.0

esa.io APIのOpenAPI準拠の仕様書

@suin/esa-exporter

1.0.0

esa.io APIから全データをエクスポートするライブラリ

@suin/esa-api

Installations

Developer Guide

Yes

CommonJS

20.7.0

10.1.0

Score

Pull Requests

8

19

11

Issues

0

0

0

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

suin

Download Statistics

GitHub Statistics

Bundle Size

120.19 kB

21.22 kB

Maintainers

Package Meta Information

Total Downloads

7,814

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

@suin/esa-api

特徴

インストール

使い方

API リファレンス

10

10

10

0

0

0

0

0

0

0

0

0

0

2.5

/10

Other packages similar to @suin/esa-api