Add type toJSON implementation

The default behavior exposes internal data structures.
mtth · Jan 29, 2021 · 30a831a · 30a831a
1 parent a735f0e
commit 30a831a
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 4 deletions.
diff --git a/packages/types/lib/types.js b/packages/types/lib/types.js
@@ -603,6 +603,10 @@ Type.prototype.schema = function (opts) {
   });
 };
 
+Type.prototype.toJSON = function () {
+  return this.schema({exportAttrs: true});
+};
+
 Type.prototype.toString = function () {
   return f('<%s>', getClassName(this.typeName));
 };

diff --git a/packages/types/package.json b/packages/types/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@avro/types",
-  "version": "1.0.22",
+  "version": "1.0.23",
   "description": "Avro serialization",
   "homepage": "https://github.com/mtth/avsc",
   "keywords": [

diff --git a/packages/types/test/test-types.js b/packages/types/test/test-types.js
@@ -1875,6 +1875,27 @@ suite('types', function () {
       assert.equal(t.schema({noDeref: true}), 'earth.Person');
     });
 
+    test('toJSON', function () {
+      var s = {
+        type: 'record',
+        name: 'earth.Person',
+        doc: 'Hi!',
+        aliases: ['earth.Human'],
+        fields: [
+          {name: 'friends', type: {type: 'array', items: 'string'}},
+          {
+            name: 'age',
+            aliases: ['years'],
+            type: 'int',
+            'default': 0,
+            order: 'descending'
+          }
+        ]
+      };
+      var t = Type.forSchema(s)
+      assert.deepEqual(JSON.parse(JSON.stringify(t)), s);
+    });
+
     test('schema recursive schema', function () {
       var t = Type.forSchema({
         type: 'record',
@@ -3304,7 +3325,7 @@ suite('types', function () {
     });
   });
 
-  suite('fromJSON', function () {
+  suite('JSON decode', function () {
 
     test('int', function () {
       var t = Type.forSchema('int');
@@ -3333,12 +3354,11 @@ suite('types', function () {
 
   });
 
-  suite('toJSON', function () {
+  suite('JSON encode', function () {
 
     test('int', function () {
       var t = Type.forSchema('int');
       assert.equal(t.jsonEncode(2), 2);
-      assert.throws(function () { t.toJSON('a'); });
     });
 
   });