ejson2/README.md

Extended JSON Evolved

# EJSON 2

This library allows stringifying objects while preserving some object types on parse, like Dates, Binary and also custom types defined by the user.

This is an improved version of the original `ejson` library from Meteor:

1. Cloned from the Meteor repo and converted the entire codebase to TypeScript and Vitest.
2. Now it eliminates circular references automatically.
3. Added `base64-js` for handling binary data instead of maintaing own code.
4. Removed Meteor specific code references.

All tests have been converted to Vitest and all of them pass, including new tests added.

## Roadmap

1. Add types to the entire codebase.
2. Performance improvements as needed.

## Mongoose

If you work with Mongoose now this library automatically converts `ObjectId`s to strings.

## Installation


```sh
yarn add ejson2
```

or


```sh
npm install ejson2
```


## Usage

```js

import { EJSON } from 'ejson2'

EJSON.parse('{}')

EJSON.stringify({})

```