Class Serializer

The serializer class serialize and deserialize data using protocol buffers. It accepts the descriptor in JSON or binary format

NOTE: This class uses the protobufjs library internally, which uses reflection (use of eval and new Function) for the construction of the types. This could cause issues in environments where eval is not allowed, like in browser extensions. In such cases, this class must be confined in a sandbox environment where eval is allowed. This is the principal reason of having the serializer in a separate class.

Example

// using descriptor JSON
const descriptorJson = {
  nested: {
    awesomepackage: {
      nested: {
        AwesomeMessage: {
          fields: {
            awesome_field: {
              type: "string",
              id: 1,
            },
          },
        },
      },
    },
  },
};
const serializer1 = new Serializer(descriptorJson);
const message1 = await serializer1.deserialize(
  "CgZrb2lub3M=",
  "AwesomeMessage"
);
console.log(message1);
// { awesome_field: 'koinos' }

// using descriptor binary
const descriptorBinary =
  "Cl4KDWF3ZXNvbWUucHJvdG8SDmF3ZXNvbWVwYWN" +
  "rYWdlIjUKDkF3ZXNvbWVNZXNzYWdlEiMKDWF3ZX" +
  "NvbWVfZmllbGQYASABKAlSDGF3ZXNvbWVGaWVsZ" +
  "GIGcHJvdG8z";
const serializer2 = new Serializer(descriptorBinary);
const message2 = await serializer2.deserialize(
  "CgZrb2lub3M=",
  "AwesomeMessage"
);
console.log(message2);
// { awesome_field: 'koinos' }