@uwdata/flechette/dist/types/encode/table-to-ipc.d.ts

Fast, lightweight access to Apache Arrow data.

/**
 * Encode an Arrow table into Arrow IPC binary format.
 * @param {Table} table The Arrow table to encode.
 * @param {object} options Encoding options.
 * @param {Sink} [options.sink] IPC byte consumer.
 * @param {'stream' | 'file'} [options.format] Arrow stream or file format.
 * @param {CompressionType_ | null} [options.codec] Compression codec to apply.
 * @returns {Uint8Array | null} The generated bytes (for an in-memory sink)
 *  or null (if using a sink that writes bytes elsewhere).
 */
export function tableToIPC(table: Table, options: {
    sink?: Sink;
    format?: "stream" | "file";
    codec?: CompressionType_ | null;
}): Uint8Array | null;
import type { Table } from '../table.js';
import type { Sink } from './sink.js';
import type { CompressionType_ } from '../types.js';