项目作者: e-e-e

项目描述 :
A client library for interacting with the are.na api
高级语言: TypeScript
项目地址: git://github.com/e-e-e/arena-ts.git
创建时间: 2020-09-20T17:48:04Z
项目社区:https://github.com/e-e-e/arena-ts

开源协议:

下载


arena-ts

Build Status
Coverage Status

A typescript client for are.na. Compatible in node and browser environments.

Minimum node version 18.

Prior art: arena-js.

Note: This is an unofficial client and typing information has been derived by comparing the official documentation
with response types from use. These may change over time or depending on context, if you notice any discrepancies please
let us know. Contributions are welcome.

Installation

  1. // using npm
  2. npm install arena-ts
  3. // using yarn
  4. yarn add arena-ts

Usage

Simple Example:
  1. import {ArenaClient} from 'arena-ts';
  2. const client = new ArenaClient();
  3. client.channels().then(console.log);

API

Check out the complete API Documentation.

This is based on Arena’s Restful API.

Note: some undocumented endpoints have been added:

  • client.me() - gets authenticated users details
  • client.group('groupname').get() - get group details
  • client.group('groupname').channels() - group channels
  • client.block(123).comments() - fetch block comments
  • client.block(123).addComment('comment') - add new comment to block
  • client.block(123).deleteComment(123) - delete comment by id
  • client.block(123).updateComment(123, 'new comment') - update comment by id