Class FileSystemApi

packages/nodebox/src/modules/fs.ts:85–196

type WriteFileOptions = BufferEncoding | { encoding?: BufferEncoding; recursive?: boolean };

export class FileSystemApi {
  constructor(private readonly channel: MessageSender) {}

  /**
   * Initialize the File System worker with the files.
   */
  public async init(files: FilesMap): Promise<void> {
    // Await the sent event to know when the worker
    // is done writing the files.
    await this.channel.send('fs/init', { files });
  }

  /**
   * Read a file at the given path.
   */
  public async readFile(path: string, encoding?: undefined): Promise<Uint8Array>;
  public async readFile(path: string, encoding: 'buffer'): Promise<Uint8Array>;
  public async readFile(path: string, encoding: BufferEncoding): Promise<string>;

  public async readFile(path: string, encoding?: FSEncoding): Promise<FileContent> {
    const response = await this.channel.send('fs/readFile', { path, encoding }).catch((error) => {
      throw new Error(format('Failed to read file at path "%s"', path), { cause: error });
    });
    if (!response) {
      throw new Error('File not found');
    }
    return response.data;
  }

  /**
   * Write a file at the given path.
   * Replaces the file content if the file already exists.
   */
  public async writeFile(path: string, content: FileContent): Promise<void>;
  public async writeFile(path: string, content: FileContent, options: WriteFileOptions): Promise<void>;

  public async writeFile(path: string, content: FileContent, options?: WriteFileOptions): Promise<void> {
    let encoding = undefined;
    let recursive = false;

    if (typeof options === 'object') {
      encoding = options.encoding;
      recursive = !!options.recursive;
    } else if (typeof options === 'string') {
      encoding = options;
    }

    await this.channel.send('fs/writeFile', { path, content, encoding, recursive }).catch((error) => {
      throw new Error(format('Failed to write file at path "%s"', path), { cause: error });
    });
  }

  public async readdir(path: string): Promise<string[]> {
    const response = await this.channel.send('fs/readdir', { path }).catch((error) => {
      throw new Error(format('Failed to read directory at path "%s"', path), { cause: error });
    });
    if (!response) {
      throw new Error('Directory not found');