Home > @activeviam/activeui-sdk > PluginParametersSerializationFn

PluginParametersSerializationFn type

Indicates how to serialize and deserialize the parameters of a plugin implementation.

Signature:

export declare type PluginParametersSerializationFn = (s13n: SerializationHelper) => PluginParametersSerialization;

Remarks

Example

createActiveUI({
 plugins: {
   'action': [
     {
       key: 'my-custom-plugin',
       createProperties(parameters, activeUI) { ... },
       parametersSerializationFn: (s13n: SerializationHelper) => [
         {name: 'my-string-param', sn: s13n.string},
         {name: 'my-optional-number-param', sn: s13n.optional(s13n.number)},
         {name: 'my-plugin-param', sn: s13n.instanceOf(myPluginKey)},
         {name: 'my-array-param', sn: s13n.array(s13n.string)},
         {name: 'my-plugin-array-param', sn: s13n.arrayOf(myPluginKey)},
       ]
     }
   ]
  },
});