Class FileOperator

constructor

• new FileOperator(
      client: GboxClient,
      boxId: string,
      data: GboxClient.V1.Boxes.FListResponse.File,
  ): FileOperator

  Parameters

  • client: GboxClient
  • boxId: string
  • data: GboxClient.V1.Boxes.FListResponse.File

  Returns FileOperator

data

read

• read(
      body?: Omit<GboxClient.V1.Boxes.FReadParams, "path">,
  ): Promise<GboxClient.V1.Boxes.FReadResponse>

  Parameters

  • body: Omit<GboxClient.V1.Boxes.FReadParams, "path"> = {}

  Returns Promise<GboxClient.V1.Boxes.FReadResponse>

  Example

  const response = await myFile.read();
  Copy

rename

• rename(
      body: Omit<GboxClient.V1.Boxes.FRenameParams, "oldPath">,
  ): Promise<GboxClient.V1.Boxes.FRenameResponse>

  Parameters

  • body: Omit<GboxClient.V1.Boxes.FRenameParams, "oldPath">

  Returns Promise<GboxClient.V1.Boxes.FRenameResponse>

  Example

  const response = await myFile.rename({ newPath: '/tmp/file2.txt' });
  Copy

write

• write(
      body: Omit<GboxClient.V1.Boxes.FWriteParams, "path">,
  ): Promise<GboxClient.V1.Boxes.FWriteResponse>

  Parameters

  • body: Omit<GboxClient.V1.Boxes.FWriteParams, "path">

  Returns Promise<GboxClient.V1.Boxes.FWriteResponse>

  Example

  const response = await myFile.write({ content: 'Hello, World!' });
  Copy