HistoryModule
PackageFsLiveDocs.Core
Loads and verifies immutable inputs for a multi-version documentation build.
Summary
| Name | Signature | Synopsis |
|---|---|---|
| ApiModelSchemaVersion | ApiModelSchemaVersion | No description available. |
| SemanticSchemaVersion | SemanticSchemaVersion | No description available. |
| ManifestSchemaVersion | ManifestSchemaVersion | No description available. |
| sha256 | sha256 path | Computes the lowercase SHA-256 digest of a file. |
| loadArtifact | loadArtifact expectedVersion expectedSha256 path | Loads an API artifact after checking its checksum, schema, and declared version. |
| loadSemanticArtifact | loadSemanticArtifact expectedSha256 path | Loads renderer-neutral semantic documentation after checksum and schema validation. |
| loadManifest | loadManifest path | Loads a history manifest and resolves entry paths relative to the manifest. |
Computes the lowercase SHA-256 digest of a file.
Parameters
| Name | Type | Description |
|---|---|---|
| path | string |
Returns
string
Loads an API artifact after checking its checksum, schema, and declared version.
Parameters
| Name | Type | Description |
|---|---|---|
| expectedVersion | string | |
| expectedSha256 | string | |
| path | string |
Returns
PackageModel
Loads renderer-neutral semantic documentation after checksum and schema validation.
Parameters
| Name | Type | Description |
|---|---|---|
| expectedSha256 | string | |
| path | string |
Returns
SemanticDocumentationArtifact