createPersistenceEnvelope

function

Back to Helios Web API

Kind

function

Source

src/persistence/schema.js:302

Description

Create a versioned persistence envelope.

Signature

export function createPersistenceEnvelope(kind, payload, metadata = {}) {

Parameters

Name	Type	Attributes	Default	Description
kind	string			One of preferences, visualization, or session.
payload	Object			Payload to normalize for the selected kind.
metadata	Object	optional		Caller-owned metadata copied into the envelope.

Returns

Current-schema persistence envelope.

Type Object

Notes

Envelopes are the boundary used by Helios persistence APIs and by portable network visualization attachments. Unknown payload fields are normalized rather than passed through blindly.