Class FileDownloadChunkStream

FileDownloadChunkStream

Date

2/15/2024 - 4:38:09 AM

Export

Index

Constructors

constructor

new FileDownloadChunkStream(param0): FileDownloadChunkStream
Creates an instance of FileDownloadChunkStream.
Parameters
- param0: {
  apiClient: APIClient;
  }
  - apiClient: APIClient
Returns FileDownloadChunkStream
Date
2/15/2024 - 4:39:25 AM
- Defined in src/api/v3/file/download/chunk/stream.ts:25

Properties

`Private` `Readonly` apiClient

apiClient: APIClient

Methods

fetch

fetch(param0): Promise<ReadStream | ReadableStream<any>>
Download a file chunk.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      bucket: string;
      chunk: number;
      onProgress?: ProgressCallback;
      region: string;
      timeout?: number;
      uuid: string;
  }
  - Optional abortSignal?: AbortSignal
  - bucket: string
  - chunk: number
  - Optional onProgress?: ProgressCallback
  - region: string
  - Optional timeout?: number
  - uuid: string
Returns Promise<ReadStream | ReadableStream<any>>
Date
2/17/2024 - 6:39:39 AM

Async
- Defined in src/api/v3/file/download/chunk/stream.ts:53

Class FileDownloadChunkStream

Date

Export

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

param0: {
apiClient: APIClient;
}

apiClient: APIClient

Returns FileDownloadChunkStream

Date

Properties

`Private` `Readonly` apiClient

Methods

fetch

Parameters

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

`Optional` abortSignal?: AbortSignal

bucket: string

chunk: number

`Optional` onProgress?: ProgressCallback

region: string

`Optional` timeout?: number

uuid: string

Returns Promise<ReadStream | ReadableStream<any>>

Date

Async

Settings

Member Visibility

Theme

On This Page

Class FileDownloadChunkStream

Date

Export

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

param0: { apiClient: APIClient; }

apiClient: APIClient

Returns FileDownloadChunkStream

Date

Properties

Private Readonly apiClient

Methods

fetch

Parameters

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

Optional abortSignal?: AbortSignal

bucket: string

chunk: number

Optional onProgress?: ProgressCallback

region: string

Optional timeout?: number

uuid: string

Returns Promise<ReadStream | ReadableStream<any>>

Date

Async

Settings

Member Visibility

Theme

On This Page

param0: {
apiClient: APIClient;
}

`Private` `Readonly` apiClient

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

`Optional` abortSignal?: AbortSignal

`Optional` onProgress?: ProgressCallback

`Optional` timeout?: number