Class Fs

Hierarchy

APIResource
- Fs

Index

Constructors

constructor

new Fs(client: GboxClient): GboxClient.V1.Boxes.Fs
Parameters
- client: GboxClient
Returns GboxClient.V1.Boxes.Fs
Inherited from APIResource.constructor
- Defined in src/core/resource.ts:8

Properties

`Protected`_client

_client: GboxClient

Methods

exists

exists(
    boxID: string,
    body: GboxClient.V1.Boxes.FExistsParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.FExistsResponse>
Check if file/dir exists
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.FExistsParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.FExistsResponse>
Example
```
const response = await client.v1.boxes.fs.exists(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { path: '/home/user/documents/output.txt' },
);
```
- Defined in src/resources/v1/boxes/fs.ts:37

info

info(
    boxID: string,
    query: GboxClient.V1.Boxes.FInfoParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.FInfoResponse>
Get file/dir
Parameters
- boxID: string
- query: GboxClient.V1.Boxes.FInfoParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.FInfoResponse>
Example
```
const response = await client.v1.boxes.fs.info(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { path: '/home/user/documents/output.txt' },
);
```
- Defined in src/resources/v1/boxes/fs.ts:52

list

list(
    boxID: string,
    query: GboxClient.V1.Boxes.FListParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.FListResponse>
List box files
Parameters
- boxID: string
- query: GboxClient.V1.Boxes.FListParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.FListResponse>
Example
```
const fs = await client.v1.boxes.fs.list(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { path: '/home/user/documents' },
);
```
- Defined in src/resources/v1/boxes/fs.ts:22

read

read(
    boxID: string,
    query: GboxClient.V1.Boxes.FReadParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.FReadResponse>
Read box file
Parameters
- boxID: string
- query: GboxClient.V1.Boxes.FReadParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.FReadResponse>
Example
```
const response = await client.v1.boxes.fs.read(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { path: '/home/user/documents/config.json' },
);
```
- Defined in src/resources/v1/boxes/fs.ts:67

remove

remove(
    boxID: string,
    body: GboxClient.V1.Boxes.FRemoveParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.FRemoveResponse>
Delete a file or dir. If target path is not exists, the delete will be failed.
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.FRemoveParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.FRemoveResponse>
Example
```
const f = await client.v1.boxes.fs.remove(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { path: '/home/user/documents/output.txt' },
);
```
- Defined in src/resources/v1/boxes/fs.ts:82

rename

rename(
    boxID: string,
    body: GboxClient.V1.Boxes.FRenameParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.FRenameResponse>
Rename a file or dir. If target newPath is already exists, the rename will be failed.
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.FRenameParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.FRenameResponse>
Example
```
const response = await client.v1.boxes.fs.rename(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  {
    newPath: '/home/user/documents/new-name.txt',
    oldPath: '/home/user/documents/output.txt',
  },
);
```
- Defined in src/resources/v1/boxes/fs.ts:101

write

write(
    boxID: string,
    body: GboxClient.V1.Boxes.FWriteParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.FWriteResponse>
Creates or overwrites a file. Creates necessary directories in the path if they don't exist. If target path is already exists, the write will be failed.
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.FWriteParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.FWriteResponse>
Example
```
const response = await client.v1.boxes.fs.write(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  {
    content: 'Hello, World!\nThis is file content.',
    path: '/home/user/documents/output.txt',
  },
);
```
- Defined in src/resources/v1/boxes/fs.ts:120

Class Fs

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GboxClient.V1.Boxes.Fs

Properties

Protected_client

Methods

exists

Parameters

Returns APIPromise<GboxClient.V1.Boxes.FExistsResponse>

Example

info

Parameters

Returns APIPromise<GboxClient.V1.Boxes.FInfoResponse>

Example

list

Parameters

Returns APIPromise<GboxClient.V1.Boxes.FListResponse>

Example

read

Parameters

Returns APIPromise<GboxClient.V1.Boxes.FReadResponse>

Example

remove

Parameters

Returns APIPromise<GboxClient.V1.Boxes.FRemoveResponse>

Example

rename

Parameters

Returns APIPromise<GboxClient.V1.Boxes.FRenameResponse>

Example

write

Parameters

Returns APIPromise<GboxClient.V1.Boxes.FWriteResponse>

Example

Settings

On This Page

`Protected`_client