KayKitGuideRoleCoverage
Defined in: src/scenario/catalog.ts:577
Coverage record that maps one public asset role back to guide pages, APIs, and assets.
Properties
Section titled “Properties”assetCounts
Section titled “assetCounts”assetCounts:
KayKitGuideAssetCoverageCounts
Defined in: src/scenario/catalog.ts:591
Unique and repeated asset counts for this role across matching guide pages.
assetIds
Section titled “assetIds”assetIds: readonly
string[]
Defined in: src/scenario/catalog.ts:587
Asset ids whose treatment uses this role.
docs: readonly
string[]
Defined in: src/scenario/catalog.ts:593
Documentation pages linked by the matching guide scenarios.
editions
Section titled “editions”editions: readonly
KayKitGuideScenarioEdition[]
Defined in: src/scenario/catalog.ts:585
Edition scopes represented by the guide scenarios.
pages: readonly
number[]
Defined in: src/scenario/catalog.ts:583
One-based extracted guide pages that exercise this role.
publicApi
Section titled “publicApi”publicApi: readonly
string[]
Defined in: src/scenario/catalog.ts:589
Public helper/API entries attached to assets with this role.
role:
KayKitAssetPublicRole
Defined in: src/scenario/catalog.ts:579
Public treatment role assigned to the covered asset group.
scenarioIds
Section titled “scenarioIds”scenarioIds: readonly
string[]
Defined in: src/scenario/catalog.ts:581
Guide scenario ids that list or inherit this public role.
visualArtifacts
Section titled “visualArtifacts”visualArtifacts: readonly
string[]
Defined in: src/scenario/catalog.ts:595
Visual artifacts linked by the matching guide scenarios.