https://github.com/batterii/encode-object

Object encoding and decoding utils
https://github.com/batterii/encode-object

Last synced: 9 days ago
JSON representation

Object encoding and decoding utils

• Host: GitHub
• URL: https://github.com/batterii/encode-object
• Owner: Batterii
• Created: 2020-01-16T18:13:00.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-04-29T19:27:46.000Z (over 2 years ago)
• Last Synced: 2024-11-07T13:47:50.864Z (12 days ago)
• Language: TypeScript
• Size: 298 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @batterii/encode-object

This module contains utility functions for encoding and decoding

JSON-serializable objects from [base64url][1], allowing them to be safely sent

as HTTP headers and URI components.

There are many modules like this already, but at Batterii we wrote yet another

one and ended up wanting to open-source some things that depend on it. So we

open-sourced this as well. Feel free to use but there's really nothing special

about it.

Note that while encoded objects are not typically human-readable, that does not

mean they are encrypted or signed in any way. Reading the data from them is as

simple as reversing the encoding process, and tampering with them is as simple

as repeating it with different data.

To produce signed tokens, which prevent tampering, use [tokengrip][2] instead.

## Usage

```js

import { decodeObject, encodeObject } from '@batterii/encode-object';

const str = encodeObject({ foo: 'bar' } );

console.log(str);

// eyJmb28iOiJiYXIifQ

const obj = decodeObject(str);

console.log(obj);

// { foo: 'bar' }

```

In addition to plain objects and arrays, top-level JSON primitives are also

supported:

```js

console.log(decodeObject(encodeObject('some string')));

// some string

console.log(decodeObject(encodeObject(true)));

// true

console.log(decodeObject(encodeObject(false)));

// false

console.log(decodeObject(encodeObject(null)));

// null

```

## Error Handling

This package uses [Nani][3] to define the following error classes:

- `EncodeObjectError`: This is the base class for all other errors in

  the package, for namespacing purposes.

- `InvalidJsonError`: Will be thrown if encoded text contaning invalid JSON is

  sent to `decodeObject`.

[1]: https://base64.guru/standards/base64url

[2]: https://www.npmjs.com/package/tokengrip

[3]: https://www.npmjs.com/package/nani