instance-stringer

Convert content of a class instance to a string.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
instance-stringer
001.0.06 years ago7 years agoMinified + gzip package size for instance-stringer in KB

Readme

Converts a content of a class instance to a string.

Install

To install from npm:
$ npm i instance-stringer --save

Load this module

For Node.js
const instanceStringer = require('instance-stringer')
const { propsStringer, arrayStringer } = instanceStringer

For Web browser (only supporting es6):
<script src="instance-stringer.min.js"></script>
<script>
const { propsStringer, arrayStringer } = instanceStringer
</script>

Usage

Converts content of the instance of MyClass :
class SubClass {
  constructor() {
    this.p = 1
    this.q = 2
  }
}
class MyClass {
  constructor() {
    this.a = 123
    this.b = { c: 'A', d: [{ g: 1, h: 2 }, 3], e: new SubClass() }
  }
}

const myInstance = new MyClass()

instanceStringer(myInstance)
// => "MyClass { a: 123, b: { c: 'A', d: [{ g: 1, h: 2 }, 3], e: SubClass { p: 1, q: 2 } } }"

propsStringer(myInstance)
// => "{ a: 123, b: { c: 'A', d: [{ g: 1, h: 2 }, 3], e: SubClass { p: 1, q: 2 } } }"


arrayStringer(myInstance.b.d)
// => "[{ g: 1, h: 2 }, 3]"

API

instanceStringer(instance) : string

Converts content of class instance to a string with its class name. If the instance is a plain object its class name (Object) is not output.

propsStringer(object) : string

Converts properties of a plain object or a class instance to a string without its class name.

arrayStringer(array) : string

Converts elements of an array to a string.

License

Copyright (C) 2017-2018 Takayuki sato
This program is free software under MITmit-url License. See the file LICENSE in this distribution for more details.