canonify/README.md

**NOTE: This is effictively a fork of [@truestamp/canonify](https://www.npmjs.com/package/@truestamp/canonify) to fix an issue with exporting types. Since a repo could not be found, a fork/PR was not possible. All copyrights/attribution has been left in p

# Canonify

**NOTE: This is effictively a fork of [@truestamp/canonify](https://www.npmjs.com/package/@truestamp/canonify) to fix an issue with exporting types. Since a repo could not be found, a fork/PR was not possible. All copyrights/attribution has been left in place.**

## Description

A tiny zero-dependency JSON canonicalization library written in Typescript that supports ES Modules, IIFE, and CommonJS loaders and runs in Deno, Node.js, and modern browsers.

Canonicalization of JavaScript/TypeScript data structures to a standard and deterministically ordered output can be very useful for hashing and signing complex nested structures where the ordering is unknown.

This library should fully implements the JSON Canonicalization Scheme (JCS) as documented in [RFC8785](https://datatracker.ietf.org/doc/html/rfc8785).

Significant testing was done to ensure the library stays true to `JSON.stringify()` single argument behaviors.

## Usage

In your NPM project directory.

```bash
npm install --save canonify
```

Import the `canonify` module in your project.

```js
import { canonify } from "canonify";

const example = {
  big: BigInt(42).toString(),
  f: false,
  fun: () => {},
  n: null,
  num: 42,
  s: "string",
  sym: Symbol("hello"),
  t: true,
  u: undefined,
  a: [
    undefined,
    null,
    true,
    false,
    "foo",
    42,
    BigInt(42).toString(),
    Symbol("hello"),
    () => {},
  ],
};

console.log(canonify(example));
```

## Testing

This library aims to maintain 100% code test coverage and it passes 100% of the test vectors provided by the [RFC8785](https://datatracker.ietf.org/doc/html/rfc8785) testdata vectors.

This should help ensure that its output is consistent with other compliant libraries on other runtimes.

## Thanks

Much of the code is ported to TypeScript from, and was based on, the following excellent examples:

- [https://github.com/cyberphone/json-canonicalization](https://github.com/cyberphone/json-canonicalization)
- [erdtman/canonicalize](https://github.com/erdtman/canonicalize)

## Legal

Copyright © 2019-2023 Truestamp Inc. All Rights Reserved.