Variable encoders`Const`

encoders: {
    ndjson: {
        mediaType: string;
        encode(
            items: AsyncIterable<unknown>,
        ): AsyncIterable<Uint8Array<ArrayBufferLike>>;
    };
    jsonSequence: {
        mediaType: string;
        encode(
            items: AsyncIterable<unknown>,
        ): AsyncIterable<Uint8Array<ArrayBufferLike>>;
    };
    sse: {
        mediaType: string;
        encode(
            items: AsyncIterable<unknown>,
        ): AsyncIterable<Uint8Array<ArrayBufferLike>>;
    };
} = ...

Built-in stream encoders for common incremental representations.

Type Declaration

Readonlyndjson: {
    mediaType: string;
    encode(
        items: AsyncIterable<unknown>,
    ): AsyncIterable<Uint8Array<ArrayBufferLike>>;
}
application/x-ndjson: JSON-serializes each item and appends a newline.
ReadonlyjsonSequence: {
    mediaType: string;
    encode(
        items: AsyncIterable<unknown>,
    ): AsyncIterable<Uint8Array<ArrayBufferLike>>;
}
application/json-seq: RFC 7464 record separator + JSON + line feed.
Readonlysse: {
    mediaType: string;
    encode(
        items: AsyncIterable<unknown>,
    ): AsyncIterable<Uint8Array<ArrayBufferLike>>;
}
text/event-stream: Server-Sent Events fields with a blank-line separator between events. Each item is emitted as a data: field.

Variable encoders`Const`

Type Declaration

`Readonly`ndjson: {
    mediaType: string;
    encode(
        items: AsyncIterable<unknown>,
    ): AsyncIterable<Uint8Array<ArrayBufferLike>>;
}

`Readonly`jsonSequence: {
    mediaType: string;
    encode(
        items: AsyncIterable<unknown>,
    ): AsyncIterable<Uint8Array<ArrayBufferLike>>;
}

`Readonly`sse: {
    mediaType: string;
    encode(
        items: AsyncIterable<unknown>,
    ): AsyncIterable<Uint8Array<ArrayBufferLike>>;
}

Settings

Variable encodersConst

Type Declaration

Readonlyndjson: { mediaType: string; encode( items: AsyncIterable<unknown>, ): AsyncIterable<Uint8Array<ArrayBufferLike>>;}

ReadonlyjsonSequence: { mediaType: string; encode( items: AsyncIterable<unknown>, ): AsyncIterable<Uint8Array<ArrayBufferLike>>;}

Readonlysse: { mediaType: string; encode( items: AsyncIterable<unknown>, ): AsyncIterable<Uint8Array<ArrayBufferLike>>;}

Settings

Variable encoders`Const`

`Readonly`ndjson: {
mediaType: string;
encode(
items: AsyncIterable<unknown>,
): AsyncIterable<Uint8Array<ArrayBufferLike>>;
}

`Readonly`jsonSequence: {
mediaType: string;
encode(
items: AsyncIterable<unknown>,
): AsyncIterable<Uint8Array<ArrayBufferLike>>;
}

`Readonly`sse: {
mediaType: string;
encode(
items: AsyncIterable<unknown>,
): AsyncIterable<Uint8Array<ArrayBufferLike>>;
}