Documents / @faasjs/utils / objectToStream

Function: objectToStream()

objectToStream<T>(object): ReadableStream<Uint8Array<ArrayBufferLike>>

Encode a JSON-serializable value into a UTF-8 byte stream.

Type Parameters

T

T = any

JSON-serializable value type to encode.

Parameters

object

T

Value to serialize as JSON.

Returns

ReadableStream<Uint8Array<ArrayBufferLike>>

Readable stream containing the JSON payload.

Throws

If JSON.stringify cannot serialize the value, such as circular objects.

Values follow native JSON.stringify semantics. Unsupported top-level values such as undefined can serialize to an empty stream.

Example

import { objectToStream } from '@faasjs/utils'

const stream = objectToStream({ ok: true })