Class APIClient

constructor

• new APIClient(sdk: FilenSDK): APIClient

  Parameters

  • sdk: FilenSDK

  Returns APIClient

Readonlysdk

downloadChunkToBuffer

• downloadChunkToBuffer(
      param0: {
          abortSignal?: AbortSignal;
          bucket: string;
          chunk: number;
          maxRetries?: number;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          region: string;
          retryTimeout?: number;
          timeout?: number;
          uuid: string;
      },
  ): 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;
    }

  Returns Promise<Buffer>

  Async

downloadChunkToLocal

• downloadChunkToLocal(
      param0: {
          abortSignal?: AbortSignal;
          bucket: string;
          chunk: number;
          maxRetries?: number;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          region: string;
          retryTimeout?: number;
          timeout?: number;
          to: string;
          uuid: string;
      },
  ): 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;
    }

  Returns Promise<void>

  Async

downloadChunkToStream

• downloadChunkToStream(
      param0: {
          abortSignal?: AbortSignal;
          bucket: string;
          chunk: number;
          maxRetries?: number;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          region: string;
          retryTimeout?: number;
          timeout?: number;
          uuid: string;
      },
  ): 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;
    }

  Returns Promise<ReadableStream<any> | ReadStream>

  Async

request

• request<T>(params: RequestParameters): 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: {
          abortSignal?: AbortSignal;
          buffer: Buffer;
          index: number;
          maxRetries?: number;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          parent: string;
          retryTimeout?: number;
          timeout?: number;
          uploadKey: string;
          uuid: string;
      },
  ): 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;
    }

  Returns Promise<UploadChunkResponse>

  Async