Skip to main content
Version: v0.0.2

Type Alias: X12ProfileEffect

X12ProfileEffect = "relaxes" | "adds" | "requires"

The bucket a quirk falls into when rendered by X12Profile.describe. Mirrors the roadmap's "what this profile relaxes / adds / requires" framing.

  • relaxes - the partner tolerates / emits a structural variation the strict 005010 baseline would flag (e.g. an alternate component delimiter).
  • adds - the partner emits extra spec-optional content (e.g. additional REF segments) a generic consumer might not expect.
  • requires - the partner mandates a normally-situational element be present.

Example

import type { X12ProfileEffect } from "@cosyte/x12";
const effect: X12ProfileEffect = "adds";