README.md

API

encode

To encode any JSON serialiazable value to a string.

Parameters

• object - The state object to encode.

Returns

An encoded string

Example

import { encode } from 'state-in-url/encoder';

// to params
const params = new URLSearchParams();
Object.entries(state).forEach(([key, value]) => {
  params.set(key, encode(value));
});
const str = params.toString();

decode

To parse previously encoded string back to an object

Parameters

• payload: string - A string to decode.
• defaults?: object - Shape object, this values will be used as defaults.

Returns

A decoded object

Example

import { decode } from 'state-in-url/encoder';

// from params
const obj = Object.fromEntries(
  [...params.entries()].map(([key, value]) => [
    key,
    // decode(value, optionalFallback),
    decode(value),
  ]),
)