Shoalrun documentation frameworkMenu
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Code API reference

openRestContentSource

Open a REST inventory and pin subsequent resource reads to its revision.

Updated
Read as Markdown

Function shoalrun.content.openRestContentSource

openRestContentSource(options: RestContentSourceOptions): Promise<ContentSnapshot>

Open a REST inventory and pin subsequent resource reads to its revision.

Parameters

Parameter Type / default Description
options RestContentSourceOptions REST mount, exact publication, optional revision, and request settings.

Returns

Promise<ContentSnapshot>

A snapshot with the same list/get/dispose interface as the manifest source.