# @foxglove/cdr

> Common Data Representation serialization and deserialization library

Latest version **3.5.1** (published 2026-05-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @foxglove/cdr
pnpm add @foxglove/cdr
yarn add @foxglove/cdr
bun add @foxglove/cdr
```

## Health

**Score 60/100 (C)** — status: active.

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

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 3.5.1 |
| Published | 2026-05-25 |
| First published | 2021-06-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 14 |
| Dependencies | 0 |
| Unpacked size | 237.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 22 |
| Author | Foxglove Technologies |
| Maintainers | foxglovebot, amacneil |
| Keywords | cdr, dds, rtps, omg, serialization, deserialization, serde, ros2 |

## Links

- npm: https://www.npmjs.com/package/@foxglove/cdr
- Repository: https://github.com/foxglove/cdr
- npm.io page: https://npm.io/package/@foxglove/cdr

## Recent versions

- 3.5.1 (latest) — 2026-05-25
- 3.5.0 — 2025-08-28
- 3.4.0 — 2025-07-16
- 3.3.0 — 2024-02-29
- 3.2.1 — 2024-01-02
- 3.2.0 — 2023-11-16
- 3.1.0 — 2023-08-22
- 3.0.0 — 2023-08-11
- 2.1.0 — 2023-07-10
- 2.0.0 — 2021-11-29
- 1.2.0 — 2021-10-04
- 1.1.1 — 2021-08-13
- 1.1.0 — 2021-07-21
- 1.0.0 — 2021-07-20
- 0.2.1 — 2021-06-29
- … 2 more at https://npm.io/package/@foxglove/cdr/versions

## README

# @foxglove/cdr

> _Common Data Representation serialization and deserialization library_

[![npm version](https://img.shields.io/npm/v/@foxglove/cdr.svg?style=flat)](https://www.npmjs.com/package/@foxglove/cdr)

## Introduction

Common Data Representation (CDR) defines a serialization format for primitive types. When combined with an Interface Definition Language (IDL) it can be used to create complex types that can be serialized to disk, transmitted over the network, etc. while transparently handling endianness and alignment requirements. It's specified by https://www.omg.org/spec/DDSI-RTPS/2.3/PDF (chapter 10) and https://www.omg.org/cgi-bin/doc?formal/02-06-51.

XCDR implementation follows [DDS-XTypes V1.3 specification](https://www.omg.org/spec/DDS-XTypes/1.3/PDF).

CDR is found in OMG DDS (Data Distributed Service) implementations such as the Real-Time Publish Subscribe (RTPS) protocol. This is the wire protocol found in ROS2, and CDR is the default serialization format used in rosbag2.

## Usage

```Typescript
import { CdrReader, CdrSizeCalculator, CdrWriter } from "@foxglove/cdr";

const calc = new CdrSizeCalculator();
calc.int8();
calc.uint8();
calc.int16();
calc.uint16();
calc.int32();
calc.uint32();
calc.int64();
calc.uint64();
calc.float32();
calc.float64();
calc.string("abc".length);
calc.sequenceLength();
console.log(calc.size);

const writer = new CdrWriter();
writer.int8(-1);
writer.uint8(2);
writer.int16(-300);
writer.uint16(400);
writer.int32(-500_000);
writer.uint32(600_000);
writer.int64(-7_000_000_001n);
writer.uint64(8_000_000_003n);
writer.float32(-9.14);
writer.float64(1.7976931348623158e100);
writer.string("abc");
writer.sequenceLength(0);

const reader = new CdrReader(writer.data);
console.log(reader.int8());
console.log(reader.uint8());
console.log(reader.int16());
console.log(reader.uint16());
console.log(reader.int32());
console.log(reader.uint32());
console.log(reader.int64());
console.log(reader.uint64());
console.log(reader.float32());
console.log(reader.float64());
console.log(reader.string());
console.log(reader.sequenceLength());
```

## Alternatives

[jscdr](https://github.com/atolab/jscdr) - Does not support bigint, pre-allocated buffers, or buffer length calculations.

## License

@foxglove/cdr is licensed under the [MIT License](https://opensource.org/licenses/MIT).

## Releasing

1. Run `yarn version [major|minor|patch]` to bump version
2. Run `git push && git push --tags` to push new tag
3. GitHub Actions will take care of the rest

## Stay in touch

Join our [Slack channel](https://foxglove.dev/slack) to ask questions, share feedback, and stay up to date on what our team is working on.

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