Dataset file client.

Hierarchy (view full)

Constructors

Methods

  • Attaches a file.

    Parameters

    • datasetId: string
    • fileId: string
    • request: {}

      Returns Promise<{}>

    • Type Parameters

      • T
      • U

      Parameters

      • path: string
      • Optional options: {
            buffer?: ArrayBuffer;
            endpoint?: string;
            external?: boolean;
            fetchFn?: FetchFunction;
            file?: {
                data: string | ArrayBuffer;
                name?: string;
                type?: string;
            };
            headers?: Record<string, any>;
            method?: string;
            query?: Record<string, any>;
            record?: Record<string, any>;
            retries?: number;
            retryDelay?: number;
            retryTimeout?: boolean;
            timeout?: number;
        }
        • Optional buffer?: ArrayBuffer
        • Optional endpoint?: string
        • Optional external?: boolean
        • Optional fetchFn?: FetchFunction
        • Optional file?: {
              data: string | ArrayBuffer;
              name?: string;
              type?: string;
          }
          • data: string | ArrayBuffer
          • Optional name?: string
          • Optional type?: string
        • Optional headers?: Record<string, any>
        • Optional method?: string
        • Optional query?: Record<string, any>
        • Optional record?: Record<string, any>
        • Optional retries?: number
        • Optional retryDelay?: number
        • Optional retryTimeout?: boolean
        • Optional timeout?: number

      Returns ResponsePromise<T, U>

    • Detach a file.

      Parameters

      • datasetId: string
      • fileId: string
      • request: {}

        Returns Promise<{}>

      • Sync a file.

        Parameters

        • datasetId: string
        • fileId: string
        • request: Record<string, never>

        Returns Promise<{}>