Class APIClient

constructor

• new APIClient(params): APIClient

• Creates an instance of APIClient.

  Parameters

  • params: APIClientConfig

  Returns APIClient

  Date

  1/31/2024 - 4:09:17 PM

Readonly apiKey

Readonly sdk

downloadChunkToBuffer

• downloadChunkToBuffer(param0): Promise<Buffer>

• Download a chunk buffer.

  Parameters

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

    • Optional abortSignal?: AbortSignal

    • bucket: string

    • chunk: number

    • Optional maxRetries?: number

    • Optional onProgress?: ProgressCallback

    • Optional onProgressId?: string

    • region: string

    • Optional retryTimeout?: number

    • Optional timeout?: number

    • uuid: string

  Returns Promise<Buffer>

  Async

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;
        onProgressId?: string;
        region: string;
        retryTimeout?: number;
        timeout?: number;
        to: string;
        uuid: string;
    }

    • Optional abortSignal?: AbortSignal

    • bucket: string

    • chunk: number

    • Optional maxRetries?: number

    • Optional onProgress?: ProgressCallback

    • Optional onProgressId?: string

    • region: string

    • Optional retryTimeout?: number

    • Optional timeout?: number

    • to: string

    • uuid: string

  Returns Promise<void>

  Async

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;
        onProgressId?: string;
        region: string;
        retryTimeout?: number;
        timeout?: number;
        uuid: string;
    }

    • Optional abortSignal?: AbortSignal

    • bucket: string

    • chunk: number

    • Optional maxRetries?: number

    • Optional onProgress?: ProgressCallback

    • Optional onProgressId?: string

    • region: string

    • Optional retryTimeout?: number

    • Optional timeout?: number

    • uuid: string

  Returns Promise<ReadableStream<any> | ReadStream>

  Async

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

uploadChunkBuffer

• uploadChunkBuffer(param0): Promise<UploadChunkResponse>

• Upload a chunk buffer.

  Parameters

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

    • Optional abortSignal?: AbortSignal

    • buffer: Buffer

    • index: number

    • Optional maxRetries?: number

    • Optional onProgress?: ProgressCallback

    • Optional onProgressId?: string

    • parent: string

    • Optional retryTimeout?: number

    • Optional timeout?: number

    • uploadKey: string

    • uuid: string

  Returns Promise<UploadChunkResponse>

  Async