Skip to content

Interface: CharsetPage ​

Defined in: packages/core/src/charset/pages.ts:25

A pluggable charset codec, matched by name against Firebird charset names and user-facing encoding options.

Properties ​

PropertyTypeDescriptionDefined in
maxBytesPerCharnumberWire bytes per character — sizes CHAR/VARCHAR buffers. 1 for single-byte pages.packages/core/src/charset/pages.ts:33
namesstring[]Primary name first, then aliases. Matching is case-insensitive and ignores -, _ and spaces, so ['WIN1252', 'CP1252'] also matches "win-1252" or "cp_1252".packages/core/src/charset/pages.ts:31

Methods ​

createStreamDecoder()? ​

ts
optional createStreamDecoder(onError?): CharsetStreamDecoder;

Defined in: packages/core/src/charset/pages.ts:38

Chunk-safe decoding for large blobs. Single-byte pages get a stateless one from the helper.

Parameters ​

ParameterType
onError?DecodeErrorMode

Returns ​

CharsetStreamDecoder


decode() ​

ts
decode(buf, onError?): string;

Defined in: packages/core/src/charset/pages.ts:34

Parameters ​

ParameterType
bufBuffer
onError?DecodeErrorMode

Returns ​

string


encode() ​

ts
encode(value): Buffer;

Defined in: packages/core/src/charset/pages.ts:36

Mandatory: a decode-only page would fail at the first bound parameter. Unmappable characters become ?.

Parameters ​

ParameterType
valuestring

Returns ​

Buffer

MIT Licensed. Contains data derived from the Firebird project under IDPL/IPL.