Class FtNodeXmlMetaSerialization

API for serializing and deserializing FtMeta objects to and from XML files.

Extends FtXmlMetaSerialization with Node.js file system access.

Hierarchy

FtXmlMetaSerialization
- FtNodeXmlMetaSerialization

Index

Constructors

Methods

deserialize deserializeFromFile serialize serializeToFile

Constructors

constructor

new FtNodeXmlMetaSerialization(): FtNodeXmlMetaSerialization

Returns FtNodeXmlMetaSerialization

Inherited from FtXmlMetaSerialization.constructor

Methods

deserialize

deserialize(xml: string, warnings?: string[]): FtMeta
Deserialize XML string to an FtMeta object.
Parameters
- xml: string
- Optionalwarnings: string[]
Returns FtMeta
Inherited from FtXmlMetaSerialization.deserialize
- Defined in web/dist/index.d.ts:3781

deserializeFromFile

deserializeFromFile(
    filePath: PathOrFileDescriptor,
    warnings?: string[],
    encoding?: BufferEncoding,
): FtMeta
Deserialize an FtMeta object from an XML file.
Parameters
- filePath: PathOrFileDescriptor
  The path or file descriptor of the XML file.
- Optionalwarnings: string[]
  An optional array to receive deserialization warnings.
- encoding: BufferEncoding = 'utf-8'
  The encoding of the file. Defaults to utf-8.
Returns FtMeta
The deserialized meta object.
- Defined in node/src/ft-node-xml-meta-serialization.ts:18

serialize

serialize(meta: FtMeta, options?: FtMetaSerializerOptions): string
Serialize an FtMeta object to XML string.
Parameters
- meta: FtMeta
- Optionaloptions: FtMetaSerializerOptions
Returns string
Inherited from FtXmlMetaSerialization.serialize
- Defined in web/dist/index.d.ts:3777

serializeToFile

serializeToFile(
    meta: FtMeta,
    filePath: PathOrFileDescriptor,
    options?: FtMetaSerializerOptions,
    encoding?: BufferEncoding,
): void
Serialize an FtMeta object to an XML file.
Parameters
- meta: FtMeta
  The meta object to serialize.
- filePath: PathOrFileDescriptor
  The output path or file descriptor.
- Optionaloptions: FtMetaSerializerOptions
  Optional serialization settings.
- encoding: BufferEncoding = 'utf-8'
  The encoding of the file. Defaults to utf-8.
Returns void
- Defined in node/src/ft-node-xml-meta-serialization.ts:30