Giter Club home page Giter Club logo

arena-ts's Introduction

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

// using npm
npm install arena-ts
// using yarn
yarn add arena-ts

Usage

Simple Example:
import {ArenaClient} from 'arena-ts';

const client = new ArenaClient();

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

arena-ts's People

Contributors

e-e-e avatar jakeisnt avatar mguidetti avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.