Skip to main content
Version: v0.0.3

Interface: DefineCcdaProfileOptions

Options accepted by defineCcdaProfile. Mirrors the CcdaProfile shape minus the derived lineage/describe, plus the extends input key. Every field except name is optional.

Example

import { defineCcdaProfile, type DefineCcdaProfileOptions } from "@cosyte/ccda";
const opts: DefineCcdaProfileOptions = {
name: "my-site",
extends: ccdaProfiles.smartScorecard,
tolerate: [{ code: "UNKNOWN_SECTION_CODE", rationale: "site-local sections" }],
};
const p = defineCcdaProfile(opts);

Properties

description?

readonly optional description?: string


extends?

readonly optional extends?: CcdaProfile | readonly CcdaProfile[]


name

readonly name: string


provenance?

readonly optional provenance?: ProfileProvenance


tolerate?

readonly optional tolerate?: readonly QuirkTolerance[]