Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flightcontrolhq/superjson
Safely serialize JavaScript expressions to a superset of JSON, which includes Dates, BigInts, and more.
https://github.com/flightcontrolhq/superjson
blitzjs hacktoberfest javascript json superjson
Last synced: 7 days ago
JSON representation
Safely serialize JavaScript expressions to a superset of JSON, which includes Dates, BigInts, and more.
- Host: GitHub
- URL: https://github.com/flightcontrolhq/superjson
- Owner: flightcontrolhq
- License: mit
- Created: 2014-12-30T10:48:42.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-01-10T09:45:12.000Z (11 months ago)
- Last Synced: 2024-11-27T05:46:37.886Z (15 days ago)
- Topics: blitzjs, hacktoberfest, javascript, json, superjson
- Language: TypeScript
- Homepage: https://www.flightcontrol.dev?ref=superjson
- Size: 2.12 MB
- Stars: 4,182
- Watchers: 11
- Forks: 90
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- my-awesome-list - superjson
README
Safely serialize JavaScript expressions to a superset of JSON, which includes Dates, BigInts, and more.
## Key features
- 🍱 Reliable serialization and deserialization
- 🔐 Type safety with autocompletion
- 🐾 Negligible runtime footprint
- 💫 Framework agnostic
- 🛠 Perfect fix for Next.js's serialisation limitations in `getServerSideProps` and `getInitialProps`
## Backstory
At [Blitz](https://github.com/blitz-js/blitz), we have struggled with the limitations of JSON. We often find ourselves working with `Date`, `Map`, `Set` or `BigInt`, but `JSON.stringify` doesn't support any of them without going through the hassle of converting manually!
Superjson solves these issues by providing a thin wrapper over `JSON.stringify` and `JSON.parse`.
## Sponsors
[
](https://www.flightcontrol.dev/?ref=superjson)
Superjson logo by [NUMI](https://github.com/numi-hq/open-design):
[
](https://numi.tech/?ref=superjson)
## Getting started
Install the library with your package manager of choice, e.g.:
```
yarn add superjson
```
## Basic Usage
The easiest way to use Superjson is with its `stringify` and `parse` functions. If you know how to use `JSON.stringify`, you already know Superjson!
Easily stringify any expression you’d like:
```js
import superjson from 'superjson';
const jsonString = superjson.stringify({ date: new Date(0) });
// jsonString === '{"json":{"date":"1970-01-01T00:00:00.000Z"},"meta":{"values":{date:"Date"}}}'
```
And parse your JSON like so:
```js
const object = superjson.parse<
{ date: Date }
>(jsonString);
// object === { date: new Date(0) }
```
## Advanced Usage
For cases where you want lower level access to the `json` and `meta` data in the output, you can use the `serialize` and `deserialize` functions.
One great use case for this is where you have an API that you want to be JSON compatible for all clients, but you still also want to transmit the meta data so clients can use superjson to fully deserialize it.
For example:
```js
const object = {
normal: 'string',
timestamp: new Date(),
test: /superjson/,
};
const { json, meta } = superjson.serialize(object);
/*
json = {
normal: 'string',
timestamp: "2020-06-20T04:56:50.293Z",
test: "/superjson/",
};
// note that `normal` is not included here; `meta` only has special cases
meta = {
values: {
timestamp: ['Date'],
test: ['regexp'],
}
};
*/
```
## Using with Next.js
The `getServerSideProps`, `getInitialProps`, and `getStaticProps` data hooks provided by Next.js do not allow you to transmit Javascript objects like Dates. It will error unless you convert Dates to strings, etc.
Thankfully, Superjson is a perfect tool to bypass that limitation!
### Next.js SWC Plugin (experimental, v13 or above)
Next.js SWC plugins are [experimental](https://nextjs.org/docs/advanced-features/compiler#swc-plugins-experimental), but promise a significant speedup.
To use the [SuperJSON SWC plugin](https://github.com/blitz-js/next-superjson-plugin), install it and add it to your `next.config.js`:
```sh
yarn add next-superjson-plugin
```
```js
// next.config.js
module.exports = {
experimental: {
swcPlugins: [
[
'next-superjson-plugin',
{
excluded: [],
},
],
],
},
};
```
### Next.js (stable Babel transform)
Install the library with your package manager of choice, e.g.:
```sh
yarn add babel-plugin-superjson-next
```
Add the plugin to your .babelrc. If you don't have one, create it.
```js
{
"presets": ["next/babel"],
"plugins": [
...
"superjson-next" // 👈
]
}
```
Done! Now you can safely use all JS datatypes in your `getServerSideProps` / etc. .
## API
### serialize
Serializes any JavaScript value into a JSON-compatible object.
#### Examples
```js
const object = {
normal: 'string',
timestamp: new Date(),
test: /superjson/,
};
const { json, meta } = serialize(object);
```
Returns **`json` and `meta`, both JSON-compatible values.**
## deserialize
Deserializes the output of Superjson back into your original value.
#### Examples
```js
const { json, meta } = serialize(object);
deserialize({ json, meta });
```
Returns **`your original value`**.
### stringify
Serializes and then stringifies your JavaScript value.
#### Examples
```js
const object = {
normal: 'string',
timestamp: new Date(),
test: /superjson/,
};
const jsonString = stringify(object);
```
Returns **`string`**.
### parse
Parses and then deserializes the JSON string returned by `stringify`.
#### Examples
```js
const jsonString = stringify(object);
parse(jsonString);
```
Returns **`your original value`**.
---
Superjson supports many extra types which JSON does not. You can serialize all these:
| type | supported by standard JSON? | supported by Superjson? |
| ----------- | --------------------------- | ----------------------- |
| `string` | ✅ | ✅ |
| `number` | ✅ | ✅ |
| `boolean` | ✅ | ✅ |
| `null` | ✅ | ✅ |
| `Array` | ✅ | ✅ |
| `Object` | ✅ | ✅ |
| `undefined` | ❌ | ✅ |
| `bigint` | ❌ | ✅ |
| `Date` | ❌ | ✅ |
| `RegExp` | ❌ | ✅ |
| `Set` | ❌ | ✅ |
| `Map` | ❌ | ✅ |
| `Error` | ❌ | ✅ |
| `URL` | ❌ | ✅ |
## Recipes
SuperJSON by default only supports built-in data types to keep bundle-size as low as possible.
Here are some recipes you can use to extend to non-default data types.
Place them in some central utility file and make sure they're executed before any other `SuperJSON` calls.
In a Next.js project, `_app.ts` would be a good spot for that.
### `Decimal.js` / `Prisma.Decimal`
```ts
import { Decimal } from 'decimal.js';
SuperJSON.registerCustom(
{
isApplicable: (v): v is Decimal => Decimal.isDecimal(v),
serialize: v => v.toJSON(),
deserialize: v => new Decimal(v),
},
'decimal.js'
);
```
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Dylan Brookes
💻 📖 🎨 ⚠️
Simon Knott
💻 🤔 ⚠️ 📖
Brandon Bayer
🤔
Jeremy Liberman
⚠️ 💻
Joris
💻
tomhooijenga
💻 🐛
Ademílson F. Tonato
⚠️
Piotr Monwid-Olechnowicz
🤔
Alex Johansson
💻 ⚠️
Simon Edelmann
🐛 💻 🤔
Sam Garson
🐛
Mark Hughes
🐛
Lxxyx
💻
Máximo Mussini
💻
Peter Dekkers
🐛
Gabe O'Leary
📖
Benjamin
📖
Ionut-Cristian Florescu
🐛
Chris Johnson
📖
Nicholas Chiang
🐛 💻
Datner
💻
ruessej
🐛
JH.Lee
📖
narumincho
💻
Markus Greystone
🐛
darthmaim
💻
Max Malm
📖
Tyler Collier
📖
Nick Quebbeman
📖
Tom MacWright
🐛 💻
Peter Budai
🐛
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## See also
Other libraries that aim to solve a similar problem:
- [Serialize JavaScript](https://github.com/yahoo/serialize-javascript) by Eric Ferraiuolo
- [devalue](https://github.com/Rich-Harris/devalue) by Rich Harris
- [next-json](https://github.com/iccicci/next-json) by Daniele Ricci