Methods

staticserializable(customSerializationKey)

Decorates a class with serialization metadata.

Parameters:
Name Type Description
customSerializationKey

By default, when the class is serialized, it is keyed on its name; this default can be overridden by setting this parameter.

Source:
tanagra-core/decorate-class.js, line 9
Examples
const serializable = require('tanagra-core').serializable

module.exports = serializable()(class Foo {
  constructor(barNumber, bazObject) {
    this.barNumber = barNumber // primitive
    this.bazObject = bazObject // serializable object
  }
})
Javascript
import { serializable } from 'tanagra-core'

@serializable()
export default class Foo {
  private bar: number
  private baz: Baz

  constructor(bar: number, baz: Baz) {
    this.bar = bar // primitive
    this.baz = baz // serializable object
  }
}
Typescript

staticserializableClassMappings()

Returns an ES6 Map, mapping the _serializationKey of a serialised class to its prototype. Needed if extending tanagra with custom serializers.

Source:
tanagra-core/serializable-class-mappings.js, line 1
Examples
const serializableClassMappings = require('tanagra-core').serializableClassMappings.get

const prototype = serializableClassMappings.get(instance._serializationKey)
Javascript
import { serializableClassMappings } from 'tanagra-core'

const prototypes = serializableClassMappings.get
const prototype = prototypes.get(instance._serializationKey)
Typescript

Licensed under the MIT License

Documentation generated by JSDoc 3.6.3 using Docolatte theme on