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

ContentFile

Export-relative file path, byte length, and SHA-256 digest.

Updated
Read as Markdown

Type shoalrun.content.ContentFile

type ContentFile = {
    path: string;
    bytes: number;
    digest: string;
};

Export-relative file path, byte length, and SHA-256 digest.

Fields

Name Type Required / default Description
bytes number Required —
digest string Required —
path string Required —

shoalrun.content.ContentFile.bytes

Property shoalrun.content.ContentFile.bytes

bytes: number

Type: number

Required

shoalrun.content.ContentFile.digest

Property shoalrun.content.ContentFile.digest

digest: string

Type: string

Required

shoalrun.content.ContentFile.path

Property shoalrun.content.ContentFile.path

path: string

Type: string

Required