Interface: NcpdpProfileDescription

Structured describe() output: the "what this profile relaxes / adds / requires" record published with the package. Returned as DATA (not a formatted string) so downstream tooling: docs generators, the pathways engine: can consume it programmatically.

Example

import { profiles } from "@cosyte/ncpdp/profiles";
const d = profiles.pbm.describe();
d.requires.map((q) => q.id);   // ["person-code-required"]
d.expectedWarnings;            // readonly NcpdpWarningCode[]

Properties

adds

readonly adds: readonly NcpdpProfileQuirk[]

---

description?

readonly optional description?: string

---

expectedWarnings

readonly expectedWarnings: readonly NcpdpWarningCode[]

Sorted, de-duplicated union of every quirk's expectedWarnings.

---

lineage

readonly lineage: readonly string[]

---

name

readonly name: string

---

relaxes

readonly relaxes: readonly NcpdpProfileQuirk[]

---

requires

readonly requires: readonly NcpdpProfileQuirk[]

---

standards

readonly standards: readonly NcpdpStandard[]

Standards this profile's quirks touch (sorted, de-duplicated).