ContentSnapshot

Interface shoalrun.content.ContentSnapshot

interface ContentSnapshot

A client pinned to one immutable inventory revision and publication.

Fields

Name	Type	Required / default	Description
`publication`	`Readonly<ContentPublication>`	Required	Publication shared by every resource available from this snapshot.
`revision`	`string`	Required	Content digest identifying this inventory revision.

Name	Kind	Description
`dispose`	`method`	Cancel pending requests and prevent subsequent reads or inventory access.
`get`	`method`	Fetch one available representation of a stable content reference.
`list`	`method`	List the resources in the opened inventory without fetching their bodies.

Method shoalrun.content.ContentSnapshot.dispose

dispose(): void

Cancel pending requests and prevent subsequent reads or inventory access.

void

Method shoalrun.content.ContentSnapshot.get

get(ref: ContentRef, options: { format: ContentFormat; signal?: AbortSignal; }): Promise<ContentResult>

Fetch one available representation of a stable content reference.

Parameter	Type / default	Description
`ref`	`ContentRef`	Page, section, or named snippet instance in this snapshot.
`options`	`{ format:` `ContentFormat; signal?: AbortSignal; }`	Required format and an optional signal for this read.

Validated representation text with its routing and revision metadata.

Method shoalrun.content.ContentSnapshot.list

list(): readonly Readonly<ContentResource>[]

List the resources in the opened inventory without fetching their bodies.

readonly Readonly<ContentResource>[]

Read-only resource entries for this publication and revision.

Property shoalrun.content.ContentSnapshot.publication

readonly publication: Readonly<ContentPublication>

Publication shared by every resource available from this snapshot.

Type: Readonly<ContentPublication>

Required

Property shoalrun.content.ContentSnapshot.revision

readonly revision: string

Content digest identifying this inventory revision.

Type: string

Required