Type shoalrun.content.ContentResult
type ContentResult = {
resource: Readonly<ContentResource>;
representation: Readonly<ContentRepresentation>;
format: ContentFormat;
content: string;
revision: string;
};
A fetched representation together with the metadata needed to render or route it.
Fields
| Name | Type | Required / default | Description |
|---|---|---|---|
content |
string |
Required | Validated UTF-8 HTML or Markdown text. |
format |
ContentFormat |
Required | Representation actually returned by the source. |
representation |
Readonly<ContentRepresentation> |
Required | File, media type, anchors, and typed links for the selected format. |
resource |
Readonly<ContentResource> |
Required | Inventory entry that was selected by the requested reference. |
revision |
string |
Required | Revision shared by this response and its opened content snapshot. |
shoalrun.content.ContentResult.content
Property shoalrun.content.ContentResult.content
content: string
Validated UTF-8 HTML or Markdown text.
Type: string
Required
shoalrun.content.ContentResult.format
Property shoalrun.content.ContentResult.format
format: ContentFormat
Representation actually returned by the source.
Type: ContentFormat
Required
shoalrun.content.ContentResult.representation
Property shoalrun.content.ContentResult.representation
representation: Readonly<ContentRepresentation>
File, media type, anchors, and typed links for the selected format.
Type: Readonly<ContentRepresentation>
Required
shoalrun.content.ContentResult.resource
Property shoalrun.content.ContentResult.resource
resource: Readonly<ContentResource>
Inventory entry that was selected by the requested reference.
Type: Readonly<ContentResource>
Required
shoalrun.content.ContentResult.revision
Property shoalrun.content.ContentResult.revision
revision: string
Revision shared by this response and its opened content snapshot.
Type: string
Required