5.0.6 • Published 2 years ago

@pushrocks/smartjson v5.0.6

Weekly downloads
179
License
MIT
Repository
gitlab
Last release
2 years ago

@pushrocks/smartjson

typed json handlers

Availabililty and Links

Status for master

Status CategoryStatus Badge
GitLab Pipelinespipeline status
GitLab Pipline Test Coveragecoverage report
npmnpm downloads per month
SnykKnown Vulnerabilities
TypeScript SupportTypeScript
node Supportnode
Code StyleCode Style
PackagePhobia (total standalone install weight)PackagePhobia
PackagePhobia (package size on registry)PackagePhobia
BundlePhobia (total size when bundled)BundlePhobia

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.

Legal

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