Skip to main content

ReadAttachmentOutput

@forge/monorepo


@forge/monorepo / backend/src / ReadAttachmentOutput

Type Alias: ReadAttachmentOutput

ReadAttachmentOutput = object

Defined in: backend/src/files/read-tool.ts:55

Properties

byteOffset

readonly byteOffset: number

Defined in: backend/src/files/read-tool.ts:60


bytesReturned

readonly bytesReturned: number

Defined in: backend/src/files/read-tool.ts:61


fileId

readonly fileId: string

Defined in: backend/src/files/read-tool.ts:56


filename

readonly filename: string

Defined in: backend/src/files/read-tool.ts:57


mediaType

readonly mediaType: string

Defined in: backend/src/files/read-tool.ts:58


nextOffset?

readonly optional nextOffset?: number

Defined in: backend/src/files/read-tool.ts:65


text

readonly text: string

Defined in: backend/src/files/read-tool.ts:59


totalBytes

readonly totalBytes: number

Defined in: backend/src/files/read-tool.ts:62


truncated

readonly truncated: boolean

Defined in: backend/src/files/read-tool.ts:64

True when there is more to read. The model pages from nextOffset rather than guessing.