Interface GenerateEnvArtifactsResult

The result of a completed generateEnvArtifacts run.

interface GenerateEnvArtifactsResult {
    docs: GenerateDocumentationResult | undefined;
    evidence: EvidenceModel;
    manifest: GenerateEnvManifestResult | undefined;
    usage: GenerateUsageReportResult | undefined;
}

Index

Properties

docs evidence manifest usage

Properties

`Readonly`docs

docs: GenerateDocumentationResult | undefined

Set only when options.docs wasn't false.

`Readonly`evidence

evidence: EvidenceModel

Always populated, regardless of options.evidence -- see that option's own doc comment.

`Readonly`manifest

manifest: GenerateEnvManifestResult | undefined

Set only when options.manifest wasn't false.

`Readonly`usage

usage: GenerateUsageReportResult | undefined

Set only when options.usage wasn't false.