h4l / json_seq

Deno module for streams of individual JSON objects. RFC 7464 format. WHATWG Streams API.

json_seq

A Deno module for working with streams of individual JSON objects, using the json-seq format described in RFC 7464.

Usage

// examples/print_stream_contents.ts
import { JsonSequenceDecoderStream } from "https://deno.land/x/[email protected]/mod.ts";
import { readableStreamFromReader } from "https://deno.land/[email protected]/streams/conversion.ts";

const jsonStream = readableStreamFromReader(Deno.stdin)
  .pipeThrough(new JsonSequenceDecoderStream());

for await (const json of jsonStream) {
  console.log(`JSON value: ${Deno.inspect(json)}`);
}

$ echo -e '\x1E{"message": "hi"}\n\x1E{"message": "bye"}\n' \
  | deno run examples/print_stream_contents.ts
JSON value: { message: "hi" }
JSON value: { message: "bye" }

Roadmap

• Publish on deno.land
• Implement stream encoding
• Review the non-strict decoding behaviour and more closely follow the lenient handling of malformed streams described in the RFC
  • Maybe allow visibility of/control over malformed stream recovery actions

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT