# amogus-driver

> AMOGUS wire protocol implementation for TypeScript

Latest version **1.3.0** (published 2022-06-04) · BSD-3-Clause license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install amogus-driver
pnpm add amogus-driver
yarn add amogus-driver
bun add amogus-driver
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2022-06-04 |
| First published | 2022-01-04 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 85.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | portasynthinca3 |
| Maintainers | portasynthinca3 |
| Keywords | amogus, api, protocol, binary, front-end, backend |

## Links

- npm: https://www.npmjs.com/package/amogus-driver
- Repository: https://github.com/amogus-api/driver-ts
- Homepage: https://github.com/amogus-api/info#readme
- Issues: https://github.com/amogus-api/driver-ts/issues
- npm.io page: https://npm.io/package/amogus-driver

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^2.3.1

## Recent versions

- 1.3.0 (latest) — 2022-06-04
- 1.2.11 — 2022-04-17
- 1.2.10 — 2022-04-17
- 1.2.9 — 2022-04-17
- 1.2.8 — 2022-04-17
- 1.2.7 — 2022-04-17
- 1.2.6 — 2022-04-16
- 1.2.5 — 2022-04-16
- 1.2.4 — 2022-04-16
- 1.2.3 — 2022-04-16
- 1.2.2 — 2022-04-16
- 1.2.1 — 2022-04-16
- 1.2.0 — 2022-04-16
- 1.1.0 — 2022-04-16
- 1.0.0 — 2022-04-16
- … 28 more at https://npm.io/package/amogus-driver/versions

## README

![License](https://img.shields.io/github/license/amogus-api/driver-ts)
![Version](https://img.shields.io/npm/v/amogus-driver)
![Coverage](https://coveralls.io/repos/github/amogus-api/driver-ts/badge.svg?branch=master)
![Downloads](https://img.shields.io/npm/dm/amogus-driver)
![PRs and issues](https://img.shields.io/badge/PRs%20and%20issues-welcome-brightgreen)

# AMOGUS wire protocol implementation
This library provides an AMOGUS implementation for JS and TS in all major environments (browser, node, etc.). Install it with:
```console
npm i amogus-driver
```
**If you're using a BigInt polyfill**, add this as close to the entry as possible:
```typescript
import * as amogus from "amogus-driver";

// if using a polyfill that provides a BigInt(string, radix) constructor
// (e.g. 'big-integer', 'bigint-polyfill'):
amogus.repr.BigInteger.polyfillMode = "radix";

// if using a polyfill that supports BigInt("0x<data>"):
amogus.repr.BigInteger.polyfillMode = "0x";

// if not using a polyfill or using a polyfill that implements
// operators like native BigInts (haven't seen one of those in
// the wild):
amogus.repr.BigInteger.polyfillMode = "none";
// OR don't do anything, this is the default value
```

# How do I use it??
There's a complete tutorial over [here](https://github.com/amogus-api/info/tree/master/amogus-tutorial).

# Testing
**Warning**: this repository uses a `pnpm` lock file, hence you can't substitute it for `npm` below.
```
git clone https://github.com/amogus-api/driver-ts
cd driver-ts
pnpm i
pip3 install susc
pnpm test
```

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