Code Monkey home page Code Monkey logo

json-roundtrip's Introduction

json-roundtrip

This library provides a type-safe implementation of safely cloning values using JSON.parse and JSON.stringify.

import { jsonRoundtrip } from 'json-roundtrip';

const value1 = jsonRoundtrip({ a: 1 });
const value2 = jsonRoundtrip('Hello, world');

// @ts-expect-error
const error1 = jsonRoundtrip({ a: 5, double: n => n * 2 });

// @ts-expect-error
const error2 = jsonRoundtrip({ [Symbol('foo')]: 'bar' });

json-roundtrip exports a JsonCompatible type that can be used to typecheck values:

import { jsonRoundtrip, JsonCompatible } from 'json-roundtrip';

const myValue: JsonCompatible = {
	a: 1,
	b: 'Hello, world',
	c: null,
	d: [1, 2, 'three'],
	e: {
		f: true,
		g: 0.5,
	},
};

jsonRoundtrip(myValue);

Note that interface values are not supported as they may have additional unserializable properties:

interface MyProps {
	a: number;
	b: string;
}

function MyComponent(props: MyProps) {
	// @ts-expect-error
	const copiedProps = jsonRoundtrip(props);

	// ...
}

Instead, use type to define the shape of the value:

type MyProps = {
	a: number;
	b: string;
};

function MyComponent(props: MyProps) {
	const copiedProps = jsonRoundtrip(props);

	// ...
}

json-roundtrip's People

Contributors

printfn avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.