Class APIClient

APIClient

Date

2/1/2024 - 2:45:15 AM

Export

Index

Constructors

constructor

new APIClient(params): APIClient
Creates an instance of APIClient.
Parameters
- params: APIClientConfig
Returns APIClient
Date
1/31/2024 - 4:09:17 PM
- Defined in src/api/client.ts:113

Properties

`Readonly` apiKey

apiKey: string

`Readonly` sdk

sdk: FilenSDK

Methods

`Private` buildHeaders

buildHeaders(params?): Record<string, string>
Private
Build API request headers.
Parameters
- Optional params: {
  apiKey?: string;
  }
  - Optional apiKey?: string
Returns Record<string, string>
Date
2/21/2024 - 8:42:27 AM
- Defined in src/api/client.ts:126

downloadChunkToBuffer

downloadChunkToBuffer(param0): Promise<Buffer>
Download a chunk buffer.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      bucket: string;
      chunk: number;
      maxRetries?: number;
      onProgress?: ProgressCallback;
      region: string;
      retryTimeout?: number;
      timeout?: number;
      uuid: string;
  }
  - Optional abortSignal?: AbortSignal
  - bucket: string
  - chunk: number
  - Optional maxRetries?: number
  - Optional onProgress?: ProgressCallback
  - region: string
  - Optional retryTimeout?: number
  - Optional timeout?: number
  - uuid: string
Returns Promise<Buffer>
Date
2/17/2024 - 6:40:21 AM

Async
- Defined in src/api/client.ts:767

downloadChunkToLocal

downloadChunkToLocal(param0): Promise<void>
Downloads a file chunk to a local path.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      bucket: string;
      chunk: number;
      maxRetries?: number;
      onProgress?: ProgressCallback;
      region: string;
      retryTimeout?: number;
      timeout?: number;
      to: string;
      uuid: string;
  }
  - Optional abortSignal?: AbortSignal
  - bucket: string
  - chunk: number
  - Optional maxRetries?: number
  - Optional onProgress?: ProgressCallback
  - region: string
  - Optional retryTimeout?: number
  - Optional timeout?: number
  - to: string
  - uuid: string
Returns Promise<void>
Date
2/17/2024 - 6:40:58 AM

Async
- Defined in src/api/client.ts:631

downloadChunkToStream

downloadChunkToStream(param0): Promise<ReadableStream<any> | ReadStream>
Downloads a file chunk and returns a readable stream.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      bucket: string;
      chunk: number;
      maxRetries?: number;
      onProgress?: ProgressCallback;
      region: string;
      retryTimeout?: number;
      timeout?: number;
      uuid: string;
  }
  - Optional abortSignal?: AbortSignal
  - bucket: string
  - chunk: number
  - Optional maxRetries?: number
  - Optional onProgress?: ProgressCallback
  - region: string
  - Optional retryTimeout?: number
  - Optional timeout?: number
  - uuid: string
Returns Promise<ReadableStream<any> | ReadStream>
Date
2/17/2024 - 6:40:44 AM

Async
- Defined in src/api/client.ts:703

`Private` get

get(params): Promise<AxiosResponse<any, any>>
Private
Send a GET request.
Parameters
- params: GetRequestParameters
Returns Promise<AxiosResponse<any, any>>
Date
2/1/2024 - 2:49:04 AM

Async
- Defined in src/api/client.ts:341

`Private` post

post(params): Promise<AxiosResponse<any, any>>
Private
Send a POST request.
Parameters
- params: PostRequestParameters
Returns Promise<AxiosResponse<any, any>>
Date
2/1/2024 - 2:48:57 AM

Async
- Defined in src/api/client.ts:143

request

request<T>(params): Promise<T>
Sends the request to the API.
Type Parameters
- T
Parameters
- params: RequestParameters
Returns Promise<T>
Date
2/1/2024 - 2:49:20 AM

Async
- Defined in src/api/client.ts:528

uploadChunkBuffer

uploadChunkBuffer(param0): Promise<UploadChunkResponse>
Upload a chunk buffer.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      buffer: Buffer;
      index: number;
      maxRetries?: number;
      onProgress?: ProgressCallback;
      parent: string;
      retryTimeout?: number;
      timeout?: number;
      uploadKey: string;
      uuid: string;
  }
  - Optional abortSignal?: AbortSignal
  - buffer: Buffer
  - index: number
  - Optional maxRetries?: number
  - Optional onProgress?: ProgressCallback
  - parent: string
  - Optional retryTimeout?: number
  - Optional timeout?: number
  - uploadKey: string
  - uuid: string
Returns Promise<UploadChunkResponse>
Date
2/17/2024 - 5:08:04 AM

Async
- Defined in src/api/client.ts:833

Class APIClient

Date

Export

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: APIClientConfig

Returns APIClient

Date

Properties

Readonly apiKey

Readonly sdk

Methods

Private buildHeaders

Parameters

Optional params: { apiKey?: string; }

Optional apiKey?: string

Returns Record<string, string>

Date

downloadChunkToBuffer

Parameters

param0: { abortSignal?: AbortSignal; bucket: string; chunk: number; maxRetries?: number; onProgress?: ProgressCallback; region: string; retryTimeout?: number; timeout?: number; uuid: string; }

Optional abortSignal?: AbortSignal

bucket: string

chunk: number

Optional maxRetries?: number

Optional onProgress?: ProgressCallback

region: string

Optional retryTimeout?: number

Optional timeout?: number

uuid: string

Returns Promise<Buffer>

Date

Async

downloadChunkToLocal

Parameters

param0: { abortSignal?: AbortSignal; bucket: string; chunk: number; maxRetries?: number; onProgress?: ProgressCallback; region: string; retryTimeout?: number; timeout?: number; to: string; uuid: string; }

Optional abortSignal?: AbortSignal

bucket: string

chunk: number

Optional maxRetries?: number

Optional onProgress?: ProgressCallback

region: string

Optional retryTimeout?: number

Optional timeout?: number

to: string

uuid: string

Returns Promise<void>

Date

Async

downloadChunkToStream

Parameters

param0: { abortSignal?: AbortSignal; bucket: string; chunk: number; maxRetries?: number; onProgress?: ProgressCallback; region: string; retryTimeout?: number; timeout?: number; uuid: string; }

Optional abortSignal?: AbortSignal

bucket: string

chunk: number

Optional maxRetries?: number

Optional onProgress?: ProgressCallback

region: string

Optional retryTimeout?: number

Optional timeout?: number

uuid: string

Returns Promise<ReadableStream<any> | ReadStream>

Date

Async

Private get

Parameters

params: GetRequestParameters

Returns Promise<AxiosResponse<any, any>>

Date

Async

Private post

Parameters

params: PostRequestParameters

Returns Promise<AxiosResponse<any, any>>

Date

`Readonly` apiKey

`Readonly` sdk

`Private` buildHeaders

`Optional` params: {
apiKey?: string;
}

`Optional` apiKey?: string

param0: {
abortSignal?: AbortSignal;
bucket: string;
chunk: number;
maxRetries?: number;
onProgress?: ProgressCallback;
region: string;
retryTimeout?: number;
timeout?: number;
uuid: string;
}

`Optional` abortSignal?: AbortSignal

`Optional` maxRetries?: number

`Optional` onProgress?: ProgressCallback

`Optional` retryTimeout?: number

`Optional` timeout?: number

param0: {
abortSignal?: AbortSignal;
bucket: string;
chunk: number;
maxRetries?: number;
onProgress?: ProgressCallback;
region: string;
retryTimeout?: number;
timeout?: number;
to: string;
uuid: string;
}

`Optional` abortSignal?: AbortSignal

`Optional` maxRetries?: number

`Optional` onProgress?: ProgressCallback

`Optional` retryTimeout?: number

`Optional` timeout?: number

param0: {
abortSignal?: AbortSignal;
bucket: string;
chunk: number;
maxRetries?: number;
onProgress?: ProgressCallback;
region: string;
retryTimeout?: number;
timeout?: number;
uuid: string;
}

`Optional` abortSignal?: AbortSignal

`Optional` maxRetries?: number

`Optional` onProgress?: ProgressCallback

`Optional` retryTimeout?: number

`Optional` timeout?: number

`Private` get

`Private` post

param0: {
abortSignal?: AbortSignal;
buffer: Buffer;
index: number;
maxRetries?: number;
onProgress?: ProgressCallback;
parent: string;
retryTimeout?: number;
timeout?: number;
uploadKey: string;
uuid: string;
}

`Optional` abortSignal?: AbortSignal

`Optional` maxRetries?: number

`Optional` onProgress?: ProgressCallback

`Optional` retryTimeout?: number

`Optional` timeout?: number