Skip to main content

read

client.fileRead.read(params?: FileReadParams): Promise<unknown>

Reads the content of a file.

Retrieves the full content of a file at the specified path. Returns the raw file data suitable for display or further processing.

Parameters

ParameterTypeRequiredDescription
paramsFileReadParamsNoOptional parameters specifying which file to read

Returns

Promise<unknown> — A promise that resolves to the file content

Example

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.fileRead.read();
console.log(result);