Interface FileReadSuccess

Successful response from file.read.

interface FileReadSuccess {
    content: string;
    encoding?: string;
    size: number;
    success: true;
}

Properties

content: string

The file's text; for a binary read, its bytes as plain Base64 without a base64: prefix.

encoding?: string

Present only for a binary read, and then always base64.

size: number

Size of the file on disk in bytes; for a text read it can differ from the length of content.

success: true

Always true here; a failed call resolves with ApiFailure instead.