Skip to main content
Version: v0.0.4

Type Alias: AstmSerializeErrorCode

AstmSerializeErrorCode = "ASTM_EMIT_UNENCODABLE_VALUE" | "ASTM_EMIT_INVALID_DELIMITERS"

The reasons emit refuses rather than writing a stream that cannot be read back.

  • ASTM_EMIT_UNENCODABLE_VALUE - a component holds a record terminator (CR/LF), which the escape codec has no mnemonic for.
  • ASTM_EMIT_INVALID_DELIMITERS - the delimiter set to emit against failed one of the three conditions readback requires (see serializeAstmRecords). Those conditions are necessary rather than sufficient, so this code means a set was rejected, not that every unreversible set is.

Example

import type { AstmSerializeErrorCode } from "@cosyte/astm";
const code: AstmSerializeErrorCode = "ASTM_EMIT_INVALID_DELIMITERS";