Interface: TechnicalElementMetadata
Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/technical-element.ts:101
Interface representing common metadata for all technical elements.
Remarks
This interface defines the standard metadata that should be present in all technical elements. It includes fields for version information, analysis dates, analysts/reviewers, approval status, and scope/limitations.
Example
const metadata: TechnicalElementMetadata = {
versionInfo: {
version: "1.0.0",
lastUpdated: "2024-03-30",
schemaVersion: "1.0.0",
deprecatedFields: []
},
analysisDate: "2023-03-15",
analysts: ["John Doe"],
reviewers: ["Jane Smith"],
approvalStatus: "APPROVED",
scope: "Full plant analysis",
limitations: ["Limited to normal operating conditions"],
lastModifiedDate: "2023-03-20",
lastModifiedBy: "John Doe"
};Properties
analysisDate
analysisDate:
string
Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/technical-element.ts:106
Date when the analysis was performed
analysts
analysts:
string[]
Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/technical-element.ts:109
List of analysts who performed the analysis
approvalStatus
approvalStatus:
"REJECTED"|"DRAFT"|"APPROVED"|"IN_REVIEW"
Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/technical-element.ts:115
Current approval status of the analysis
lastModifiedBy
lastModifiedBy:
string
Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/technical-element.ts:127
User who last modified the element
lastModifiedDate
lastModifiedDate:
string
Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/technical-element.ts:124
Date when the element was last modified
limitations
limitations:
string[]
Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/technical-element.ts:121
List of limitations or assumptions
reviewers
reviewers:
string[]
Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/technical-element.ts:112
List of reviewers who reviewed the analysis
scope
scope:
string
Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/technical-element.ts:118
Scope of the analysis
versionInfo
versionInfo:
VersionInfo
Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/technical-element.ts:103
Version information for the technical element
