Home > @activeviam/activeui-sdk > SerializationHelper

SerializationHelper interface

An object that provides predefined Serialization objects that handle different types of plugin parameters. These are useful when defining the PluginParametersSerializationFn of a plugin.

Signature:

export interface SerializationHelper 

Properties

Property	Type	Description
any	Serialization	Can be used with any serializable variable.
array	<S, T>(helperType: TypedSerialization<S, T>) => ArraySerialization<S, T>	Returns a Serialization object that handles arrays of the type catered by the Serialization passed in argument.
arrayOf	(type: PluginType) => Serialization	Returns a Serialization object that handles arrays of plugins of the type passed as argument.
boolean	TypedIdentitySerialization<boolean>
instanceOf	(type: PluginType) => Serialization	Returns a Serialization object that handles a plugin of the type passed as argument.
number	TypedIdentitySerialization<number>
optional	(helperType: Serialization) => Serialization	Returns a Serialization object that handles a plugin parameter as being optional.
string	TypedIdentitySerialization<string>