examine-instance

1.1.2 • Public • Published

examine-instance

Greenkeeper badge

Build Status

examine-instance inspects an object and its prototype and catalogues the properties and methods. Categorises methods as private if they are prefixed or suffixed by an underscore, otherwise marks as public.

Installation

npm install examine-instance -S

Usage

 
import examine from "examine-instance";
 
class MyClass {
 
  constructor() {
    this._property1 = "";
    this._isGood = true;
  }
 
  get isGood() { return this._isGood; }
  get property1() { return this._property1; }
  set property1(value) { this._property1 = value; }
 
  method1(value) {
    return value;
  }
 
  method2_(value) {
    return value;
  }
}
 
const instance = new MyClass();
const result = examine(instance);
 
/*
{
  methods: [ 'method1', 'method2_' ],
  privateMethods: [ 'method2_' ],
  publicMethods: [ 'method1' ],
  attributes: [ '_property1', '_isGood' ],
  readOnly: [ 'isGood' ],
  readWrite: [ 'property1' ],
  writeOnly: []
}
 
*/

Readme

Keywords

Package Sidebar

Install

npm i examine-instance

Weekly Downloads

27

Version

1.1.2

License

MIT

Unpacked Size

13.2 kB

Total Files

5

Last publish

Collaborators

  • midknight41