https://github.com/traPtitech/node-traq

Node.js client library for the traQ API.
https://github.com/traPtitech/node-traq

hacktoberfest traq

Last synced: 3 months ago
JSON representation

Node.js client library for the traQ API.

• Host: GitHub
• URL: https://github.com/traPtitech/node-traq
• Owner: traPtitech
• License: mit
• Created: 2019-07-01T07:38:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-01T00:27:20.000Z (3 months ago)
• Last Synced: 2024-08-01T03:24:56.814Z (3 months ago)
• Topics: hacktoberfest, traq
• Language: TypeScript
• Homepage:
• Size: 1.32 MB
• Stars: 2
• Watchers: 13
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-traQ

[![npm version](https://badge.fury.io/js/%40traptitech%2Ftraq.svg)](https://www.npmjs.com/package/@traptitech/traq)

![check npm ci & build](https://github.com/traPtitech/node-traq/workflows/check%20npm%20ci%20%26%20build/badge.svg)

A client library for the traQ API.

Typescript type definition included.

This package is updated automatically.

## How to use

Node.js v20 or later is required.

```shell

npm i @traptitech/traq

```

```js

import { Apis, Configuration } from "@traptitech/traq";

// const { Apis, Configuration } = require("@traptitech/traq");

const api = new Apis(new Configuration({

  accessToken: "/* your token */"

}));

api.getChannels().then(res => {

  console.log(res);

});

```

## Versioning

`x.y.z-n`

- `x.y.z-0`: It is assured that this version is compatible with traQ server version `x.y.z`.

## Diff

Use [`npm diff`](https://docs.npmjs.com/cli/v7/commands/npm-diff) to check diff between versions.

```shell

npm diff --diff=@traptitech/[email protected] --diff=@traptitech/[email protected]

```