nanolith/build/types/streams.d.ts

Multi-threading in no time with seamless TypeScript support.

/// <reference types="node" resolution-mode="require"/>
import type { ReadableFromPort } from '../streams/index.js';
import type { StreamMessageType } from '../constants/streams.js';
import type { Awaitable } from './utilities.js';
export type OnStreamCallback<Sender extends Messagable> = (stream: ReadableFromPort<Sender>) => Awaitable<void>;
export type AcceptStreamFunction<Sender extends Messagable> = () => ReadableFromPort<Sender>;
export type DeclineStreamFunction = () => void;
export type ConfirmStreamCallback<Sender extends Messagable> = (data: {
    metaData: Record<any, any>;
    accept: AcceptStreamFunction<Sender>;
}) => Awaitable<void>;
export interface Messagable {
    on(event: 'message', callback: (value: any) => void): any;
    off(event: 'message', callback: (value: any) => void): any;
    postMessage(value: any): void;
}
export type StreamBaseMessageBody<Type = StreamMessageType> = {
    type: Type;
};
export type StreamStartMessageBody<MetaData = Record<any, any>> = {
    id: string;
    meta: MetaData;
} & StreamBaseMessageBody<StreamMessageType.Start>;
export type StreamReadyMessageBody = {
    id: string;
} & StreamBaseMessageBody<StreamMessageType.Ready>;
export type StreamChunkMessageBody = {
    id: string;
    data: Buffer;
} & StreamBaseMessageBody<StreamMessageType.Chunk>;
export type StreamEndMessageBody = {
    id: string;
} & StreamBaseMessageBody<StreamMessageType.End>;