Merge pull request #66 from bem-sdk/qfox.feat-tojson

feat: add toJSON method for good stringify

Author: qfox

README.md

@@ -106,6 +106,7 @@ API
 * [isBemEntityName(entityName)](#isbementitynameentityname)
 * [toString()](#tostring)
 * [valueOf()](#valueof)
+* [toJSON()](#tojson)
 
 ### constructor({ block, elem, mod })
 
@@ -250,6 +251,10 @@ name.valueOf();
 // ➜ { block: 'button', mod: { name: 'focused', value: true } }
 ```
 
+### toJSON()
+
+Returns object for `JSON.stringify()` purposes.
+
 Debuggability
 -------------
 
@@ -279,6 +284,19 @@ console.log(`name: ${name}`);
 // ➜ name: input_available
 ```
 
+Also `BemEntityName` has `toJSON` method to support `JSON.stringify()` behaviour.
+
+```js
+const BemEntityName = require('@bem/entity-name');
+
+const name = new BemEntityName({ block: 'input', mod: 'available' });
+
+console.log(JSON.stringify(name));
+
+// ➜ {"block":"input","mod":{"name":"available","val":true}}
+```
+
+
 License
 -------
 

index.js

@@ -240,6 +240,15 @@ module.exports = class BemEntityName {
         return `BemEntityName ${stringRepresentation}`;
     }
 
+    /**
+     * Return raw data for `JSON.stringify()`.
+     *
+     * @returns {{block: string, elem: ?string, mod: ?{name: string, val: *}}}
+     */
+    toJSON() {
+        return this._data;
+    }
+
     /**
      * Determines whether specified entity is the deepEqual entity.
      *

test/to-json.test.js

@@ -0,0 +1,9 @@
+const test = require('ava');
+
+const BemEntityName = require('../index');
+
+test('should return stringified cell', t => {
+    const cell = new BemEntityName({ block: 'button' });
+
+    t.is(JSON.stringify([cell]), '[{"block":"button"}]');
+});