function text
text(): XmlField<string>

A text field, such as <name>Front door</name>. XML entities are escaped on write and unescaped on read.

Examples

Round-trip text with an ampersand

import { assertEquals } from "@std/assert";
import { parse } from "@std/xml";
import { text } from "@hertzg/reolink-api/protocol/xml";

const xml = text().encode("name", "Tom & Jerry");

assertEquals(xml, "<name>Tom &amp; Jerry</name>");
assertEquals(text().decode("name", parse(`<p>${xml}</p>`).root), "Tom & Jerry");

Return Type

XmlField<string>

A field codec for a string.

Usage

import { text } from "protocol/xml.ts";