Class DirectoryOperator

constructor

• new DirectoryOperator(
      client: GboxClient,
      boxId: string,
      data: GboxClient.V1.Boxes.FListResponse.Dir,
  ): DirectoryOperator

  Parameters

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

  Returns DirectoryOperator

data

list

• list(
      body?: Omit<GboxClient.V1.Boxes.FListParams, "path">,
  ): Promise<(FileOperator | DirectoryOperator)[]>

  Parameters

  • Optionalbody: Omit<GboxClient.V1.Boxes.FListParams, "path">

  Returns Promise<(FileOperator | DirectoryOperator)[]>

  Example

  const response = await myDir.list();
  or
  const response = await myDir.list({ depth: 1 });
  Copy

listInfo

• listInfo(
      body?: Omit<GboxClient.V1.Boxes.FListParams, "path">,
  ): Promise<GboxClient.V1.Boxes.FListResponse>

  Parameters

  • Optionalbody: Omit<GboxClient.V1.Boxes.FListParams, "path">

  Returns Promise<GboxClient.V1.Boxes.FListResponse>

  Example

  const response = await myDir.listInfo();
  or
  const response = await myDir.listInfo({ depth: 1 });
  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 myDir.rename({ newPath: '/tmp/dir2' });
  Copy