apache-arrow/io/stream.d.ts

Apache Arrow columnar in-memory format

/// <reference types="node" />
import { Readable, Writable, AsyncQueue } from './interfaces.js';
import { ArrayBufferViewInput } from '../util/buffer.js';
/** @ignore */
export type WritableSink<T> = Writable<T> | WritableStream<T> | NodeJS.WritableStream | null;
/** @ignore */
export type ReadableSource<T> = Readable<T> | PromiseLike<T> | AsyncIterable<T> | ReadableStream<T> | NodeJS.ReadableStream | null;
/** @ignore */
export declare class AsyncByteQueue<T extends ArrayBufferViewInput = Uint8Array> extends AsyncQueue<Uint8Array, T> {
    write(value: ArrayBufferViewInput | Uint8Array): void;
    toString(sync: true): string;
    toString(sync?: false): Promise<string>;
    toUint8Array(sync: true): Uint8Array;
    toUint8Array(sync?: false): Promise<Uint8Array>;
}
/** @ignore */
export declare class ByteStream implements IterableIterator<Uint8Array> {
    private source;
    constructor(source?: Iterable<ArrayBufferViewInput> | ArrayBufferViewInput);
    [Symbol.iterator](): this;
    next(value?: any): IteratorResult<Uint8Array, null>;
    throw(value?: any): any;
    return(value?: any): any;
    peek(size?: number | null): Uint8Array | null;
    read(size?: number | null): Uint8Array | null;
}
/** @ignore */
export declare class AsyncByteStream implements Readable<Uint8Array>, AsyncIterableIterator<Uint8Array> {
    private source;
    constructor(source?: PromiseLike<ArrayBufferViewInput> | Response | ReadableStream<ArrayBufferViewInput> | NodeJS.ReadableStream | AsyncIterable<ArrayBufferViewInput> | Iterable<ArrayBufferViewInput>);
    [Symbol.asyncIterator](): this;
    next(value?: any): Promise<IteratorResult<Uint8Array, null>>;
    throw(value?: any): Promise<any>;
    return(value?: any): Promise<any>;
    get closed(): Promise<void>;
    cancel(reason?: any): Promise<void>;
    peek(size?: number | null): Promise<Uint8Array | null>;
    read(size?: number | null): Promise<Uint8Array | null>;
}