/// <reference types="node" />

import {Duplex} from 'node:stream';
import type {StreamBaseOptions} from '../core/streamers/stream-base.js';
import type {StreamObjectItem as CoreStreamObjectItem} from '../core/streamers/stream-object.js';
import type parser from '../core/parser.js';

/**
 * Streams top-level properties of a JSON object as `{key, value}` objects.
 *
 * Node-flavored entry: the returned factory has both `streamObject.asStream(options)`
 * (Node Duplex) and `streamObject.asWebStream(options)` (Web `{readable, writable}` pair) attached,
 * plus `withParserAsStream` / `withParserAsWebStream` parser-included variants.
 *
 * @param options - Streamer options (assembler settings, `objectFilter`).
 */
declare function streamObject<T = unknown>(options?: StreamBaseOptions): ReturnType<typeof import('../core/streamers/stream-object.js').default<T>>;

declare namespace streamObject {
  /** An item emitted by `streamObject`. Generic in `T` — declare `StreamObjectItem<MyValue>` to type `value`. */
  export type StreamObjectItem<T = unknown> = CoreStreamObjectItem<T>;
  /** Creates a streamObject wrapped as a Node Duplex stream. */
  export function asStream(options?: StreamBaseOptions): Duplex;
  /** Creates a streamObject wrapped as a Web `TransformStream`-shaped pair. */
  export function asWebStream(options?: StreamBaseOptions): {readable: ReadableStream; writable: WritableStream};
  /** Creates a `parser() + streamObject()` pipeline as a flushable function. */
  export function withParser<T = unknown>(
    options?: StreamBaseOptions & parser.ParserOptions
  ): ReturnType<typeof import('../core/streamers/stream-object.js').default.withParser<T>>;
  /** Creates a `parser() + streamObject()` pipeline as a Node Duplex stream. */
  export function withParserAsStream(options?: StreamBaseOptions & parser.ParserOptions): Duplex;
  /** Creates a `parser() + streamObject()` pipeline as a Web `TransformStream`-shaped pair. */
  export function withParserAsWebStream(options?: StreamBaseOptions & parser.ParserOptions): {readable: ReadableStream; writable: WritableStream};
  /** Self-reference for `streamObject.streamObject === streamObject`. */
  export const streamObject: typeof import('./stream-object.js').default;
}

type StreamObjectItem = streamObject.StreamObjectItem;

export default streamObject;
export {streamObject};
export type {StreamObjectItem};