runtime/decoder

Enumerations

'Read the “', Enumerations, '” section'

EntityLevel

'Read the “', EntityLevel, '” section'

Defined in: studiocms/packages/studiocms/src/runtime/decoder/index.ts:4

The level of entities to support.

Enumeration Members

'Read the “', Enumeration Members, '” section'

HTML

'Read the “', HTML, '” section'

HTML: 1;

Defined in: studiocms/packages/studiocms/src/runtime/decoder/index.ts:8

Support HTML entities, which are a superset of XML entities.

XML

'Read the “', XML, '” section'

XML: 0;

Defined in: studiocms/packages/studiocms/src/runtime/decoder/index.ts:6

Support only XML entities.

Interfaces

'Read the “', Interfaces, '” section'

DecodingOptions

'Read the “', DecodingOptions, '” section'

Defined in: studiocms/packages/studiocms/src/runtime/decoder/index.ts:11

Properties

'Read the “', Properties, '” section'

level?

'Read the “', level?, '” section'

optional level: EntityLevel;

Defined in: studiocms/packages/studiocms/src/runtime/decoder/index.ts:16

The level of entities to support.

Default

'Read the “', Default, '” section'

EntityLevel.XML

mode?

'Read the “', mode?, '” section'

optional mode: DecodingMode;

Defined in: studiocms/packages/studiocms/src/runtime/decoder/index.ts:28

Decoding mode. If Legacy, will support legacy entities not terminated with a semicolon (;).

Always Strict for XML. For HTML, set this to true if you are parsing an attribute value.

The deprecated decodeStrict function defaults this to Strict.

Default

'Read the “', Default, '” section'

DecodingMode.Legacy

Functions

'Read the “', Functions, '” section'

decode()

'Read the “', decode(), '” section'

function decode(input: string, options:
  | DecodingOptions
  | EntityLevel): string

Defined in: studiocms/packages/studiocms/src/runtime/decoder/index.ts:37

Decodes a string with entities.

Parameters

'Read the “', Parameters, '” section'

input

'Read the “', input, '” section'

string

String to decode.

options

'Read the “', options, '” section'

Decoding options.

DecodingOptions | EntityLevel

Returns

'Read the “', Returns, '” section'

string