Skip to main content

LensStudio:Serialization.Yaml

Class

Class which allows you to serialize and deserialize data from YAML.

Class which allows you to serialize and deserialize data from YAML. Useful for modifying layout with Editor.Dock.IDockManager.

Index

Example

// Yaml provides static helpers for YAML serialization/deserialization.
// Useful for modifying dock layouts via Editor.Dock.IDockManager.
const { Yaml } = await import('LensStudio:Serialization');

// createWriter() returns an IWriter; getString() retrieves the output.
const writer = Yaml.createWriter();
const serialized = writer.getString();
console.log('Yaml writer produced:', serialized);

// createReader() parses a YAML string back into an IReader.
const reader = Yaml.createReader(serialized);
console.log('Yaml reader created from string:', reader);

Methods

createReader()

static createReader(data): IReader

Create a YAML reader from a string.

Parameters

ParameterType
datastring

Returns

IReader


createWriter()

static createWriter(): IWriter

Create a YAML writer for serializing data.

Returns

IWriter