cbor-bigdecimal/README.md

Plugin for node-cbor to add BigDecimal and BigFloat support. Requires bignumber.js

# cbor-bignumber

This package adds support for BigDecimal and BigFloats to the [cbor](../cbor)
package, relying on [bignumber.js](https://github.com/MikeMcl/bignumber.js).

## MOVE TO CBOR2

**NOTE**

All new users and most existing users of this library should move to the
[cbor2](https://github.com/hildjj/cbor2) library.  It is where most
maintenance and support and all new features are happening.  cbor2 has
support for JavaScript bigints enabled by default.

*Only* catastrophic bugs will be fixed in this library going forward.

## Installation

```sh
npm install cbor cbor-bignumber
```

## Usage

Before trying to encode or decode:

```js
const cbor = require('cbor');
const bdec = require('cbor-bigdecimal');
bdec(cbor);
```

If you want to remove the added encoders and decoders:

```js
cbor.reset();
```

If you need to access the same BigNumber class that `cbor-bigdecimal` is (e.g.
because the class has been mangled by your compressor), it is available as
`bdec.BigNumber`.

## Supported Types

Decoding supports the following CBOR tag numbers:

| Tag | Generated Type      |
|-----|---------------------|
| 4   | bignumber           |
| 5   | bignumber           |