A library for handling typed JSON data, providing functionalities for parsing, stringifying, and working with JSON objects, including support for encoding and decoding buffers.
Go to file
2022-06-09 19:55:12 +02:00
.vscode fix(core): update 2022-06-09 19:54:43 +02:00
test fix(core): update 2022-06-09 19:54:43 +02:00
ts BREAKING CHANGE(core): update 2022-06-09 19:55:12 +02:00
.gitignore fix(core): update 2020-10-05 11:26:06 +00:00
.gitlab-ci.yml fix(core): update 2022-06-09 19:54:43 +02:00
.snyk fix(security): add snyk policy 2019-02-14 23:21:03 +01:00
npmextra.json fix(core): update 2022-06-09 19:54:43 +02:00
package-lock.json 5.0.0 2022-06-09 19:55:12 +02:00
package.json 5.0.0 2022-06-09 19:55:12 +02:00
readme.md fix(core): update 2020-10-05 12:06:13 +00:00
tsconfig.json fix(core): update 2022-06-09 19:54:43 +02:00
tslint.json BREAKING CHANGE(core): renamed Folable to Smartjson and added deterministic stringify 2019-02-14 23:16:34 +01:00

@pushrocks/smartjson

typed json handlers

Status for master

Status Category Status Badge
GitLab Pipelines pipeline status
GitLab Pipline Test Coverage coverage report
npm npm downloads per month
Snyk Known Vulnerabilities
TypeScript Support TypeScript
node Support node
Code Style Code Style
PackagePhobia (total standalone install weight) PackagePhobia
PackagePhobia (package size on registry) PackagePhobia
BundlePhobia (total size when bundled) BundlePhobia
Platform support Supports Windows 10 Supports Mac OS X

Usage

Use TypeScript for best in class instellisense.

Classes

SmartJson makes it easy to fold and enfold classes into and from JSON

import { Smartjson, foldDec } from 'smartjson';

class AwesomeClass extends Smartjson {
  static stringify;

  computedValue: string;

  @foldDec() // mark anotherValueToStore as foldable
  anotherValueToStore: string = null;
  constructor() {
    super(); // this is important
  }
}

let myAwesomeInstance = new AwesomeClass();
let foldedObject = myAwesomeInstance.foldToObject(); // will return {anotherValueToStore: null}
// You can also fold to Json, with support for buffers
// const jsonString = myAwesomeInstance.foldToJson();
myAwesomeInstance = AwesomeClass.enfoldFromObject({ anotherValueToStore: 'hi' });
foldedObject = myAwesomeInstance.foldToObject(); // will return {anotherValueToStore: 'hi'}

Contribution

We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can contribute one time or contribute monthly. :)

For further information read the linked docs at the top of this readme.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

repo-footer