# @zondax/dag-cbor

> JS implementation of DAG-CBOR

Latest version **9.0.0** (published 2023-04-07) · Apache-2.0 OR MIT license · 0 weekly downloads

## Install

```sh
npm install @zondax/dag-cbor
pnpm add @zondax/dag-cbor
yarn add @zondax/dag-cbor
bun add @zondax/dag-cbor
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 9.0.0 |
| Published | 2023-04-07 |
| First published | 2023-04-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 OR MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=16.0.0 |
| Dependencies | 2 |
| Unpacked size | 42.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Rod |
| Maintainers | ftheirs, carlosala, jleni |
| Keywords | ipfs, ipld, multiformats |

## Links

- npm: https://www.npmjs.com/package/@zondax/dag-cbor
- Repository: https://github.com/zondax/js-dag-cbor
- Homepage: https://github.com/zondax/js-dag-cbor#readme
- Issues: https://github.com/zondax/js-dag-cbor/issues
- npm.io page: https://npm.io/package/@zondax/dag-cbor

## Dependencies (2)

- [cborg](https://npm.io/package/cborg.md) ^1.10.0
- [multiformats](https://npm.io/package/multiformats.md) ^11.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 9.0.0 (latest) — 2023-04-07

## README

# @ipld/dag-cbor <!-- omit in toc -->

[![codecov](https://img.shields.io/codecov/c/github/ipld/js-dag-cbor.svg?style=flat-square)](https://codecov.io/gh/ipld/js-dag-cbor)
[![CI](https://img.shields.io/github/workflow/status/ipld/js-dag-cbor/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipld/js-dag-cbor/actions/workflows/js-test-and-release.yml)

> JS implementation of DAG-CBOR

## Table of contents <!-- omit in toc -->

- [Install](#install)
- [Spec](#spec)
- [License](#license)
- [Contribute](#contribute)

## Install

```console
$ npm i @ipld/dag-cbor
```

This is the *new* interface meant for use by itself or with `multiformats` and
`@ipld/block`. It is not used by `js-ipld-format` which is currently
used in IPFS. That library is [here](https://github.com/ipld/js-ipld-dag-cbor).

Usage:

```javascript
import { encode, decode } from '@ipld/dag-cbor'
import { CID } from 'multiformats'

const obj = {
  x: 1,
  /* CID instances are encoded as links */
  y: [2, 3, CID.parse('QmaozNR7DZHQK1ZcU9p7QdrshMvXqWK6gpu5rmrkPdT3L4')],
  z: {
    a: CID.parse('QmaozNR7DZHQK1ZcU9p7QdrshMvXqWK6gpu5rmrkPdT3L4'),
    b: null,
    c: 'string'
  }
}

let data = encode(obj)
let decoded = decode(data)
decoded.y[0] // 2
CID.asCID(decoded.z.a) // cid instance
```

## Spec

The [`dag-cbor` specification is in the IPLD specs repo](https://github.com/ipld/specs/blob/master/block-layer/codecs/dag-cbor.md).

## License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

## Contribute

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

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