ndjson parser for Dart #

Tiny and simple ndjson parser library for Dart. No external dependencies.

Installation #

dependencies:
  ndjson: ^<latest-version>

Import:

import 'package:ndjson/ndjson.dart';

Usage #

The usage is pretty straightforward:

import 'package:ndjson/ndjson.dart';

// Your ndjson stream.
final ndjsonStream = ...

// A new stream that will parse all chunks and emit events 
// for each new json object (not ndjson chunks).
final parsedNdjson = ndjsonStream.parseNdjsonBytesAsMap();

// If your ndjson stream is a stream of string, use [parseNdjsonStringAsMap] instead.
final parsedNdjson = ndjsonStream.parseNdjsonStringAsMap();

// If you wanna parse already:
final parsedNdjson = ndjsonStream.parseNdjsonString(converter: MyClass.fromJson);

Supported ndjson types are:

• Stream<List<int>>.
• Stream<Uint8List>.
• Stream<String>.

Any list-like ndjson source can be converted to Stream using:

Stream.fromIterable(ndjsonList);

You must be aware that using ndjson as list is the same as a regular json (you lose all ndjson performance benefits).