# arena-ts

> A typescript API client for Are.na

Latest version **1.0.2** (published 2024-02-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install arena-ts
pnpm add arena-ts
yarn add arena-ts
bun add arena-ts
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2024-02-14 |
| First published | 2020-09-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 59.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 37 |
| Author | Benjamin Forster |
| Maintainers | e-e-e |

## Links

- npm: https://www.npmjs.com/package/arena-ts
- Repository: https://github.com/e-e-e/arena-ts
- Homepage: https://github.com/e-e-e/arena-ts#readme
- Issues: https://github.com/e-e-e/arena-ts/issues
- npm.io page: https://npm.io/package/arena-ts

## Recent versions

- 1.0.2 (latest) — 2024-02-14
- 1.0.1 — 2024-02-14
- 1.0.0 — 2023-11-13
- 0.1.4 — 2022-11-27
- 0.1.3 — 2022-11-27
- 0.1.2 — 2022-05-26
- 0.1.1 — 2022-05-08
- 0.1.0 — 2022-05-06
- 0.0.6 — 2020-10-04
- 0.0.5 — 2020-09-30
- 0.0.4 — 2020-09-29
- 0.0.3 — 2020-09-29
- 0.0.2 — 2020-09-20
- 0.0.1 — 2020-09-20

## README

# arena-ts

[![Build Status](https://travis-ci.org/e-e-e/arena-ts.svg?branch=master)](https://travis-ci.org/e-e-e/arena-ts)
[![Coverage Status](https://coveralls.io/repos/github/e-e-e/arena-ts/badge.svg?branch=master)](https://coveralls.io/github/e-e-e/arena-ts?branch=master)

A typescript client for [are.na](are.na). Compatible in node and browser environments.

Minimum node version 18.

Prior art: [arena-js](https://github.com/ivangreene/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

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

```

### Usage

##### Simple Example:

```ts
import {ArenaClient} from 'arena-ts';

const client = new ArenaClient();

client.channels().then(console.log);
```

### API

Check out the complete [API Documentation](https://e-e-e.github.io/arena-ts/).

This is based on [Arena's Restful API](dev.are.na).

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

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