@@ -8,7 +8,9 @@ objects or log entries. It uses a simple newline character between each
88individual record and as such can be both used for efficient persistence and
99simple append-style operations. This also allows it to be used in a streaming
1010context, such as a simple inter-process commmunication (IPC) protocol or for a
11- remote procedure call (RPC) mechanism.
11+ remote procedure call (RPC) mechanism. This library provides a simple
12+ streaming API to process very large NDJSON files with thousands or even millions
13+ of rows efficiently without having to load the whole file into memory at once.
1214
1315* ** Standard interfaces** -
1416 Allows easy integration with existing higher-level components by implementing
@@ -18,14 +20,14 @@ remote procedure call (RPC) mechanism.
1820 and does not get in your way.
1921 Builds on top of well-tested components and well-established concepts instead of reinventing the wheel.
2022* ** Good test coverage** -
21- Comes with an [ automated tests suite] ( #tests ) and is regularly tested in the * real world*
23+ Comes with an [ automated tests suite] ( #tests ) and is regularly tested in the * real world* .
2224
2325** Table of contents**
2426
2527* [ NDJSON format] ( #ndjson-format )
2628* [ Usage] ( #usage )
27- * [ Decoder] ( #decoder )
28- * [ Encoder] ( #encoder )
29+ * [ Decoder] ( #decoder )
30+ * [ Encoder] ( #encoder )
2931* [ Install] ( #install )
3032* [ Tests] ( #tests )
3133* [ License] ( #license )
@@ -136,7 +138,7 @@ element may be broken up into multiple chunks.
136138This class reassembles these elements by buffering incomplete ones.
137139
138140The ` Decoder ` supports the same optional parameters as the underlying
139- [ ` json_decode() ` ] ( http ://php.net/json_decode ) function.
141+ [ ` json_decode() ` ] ( https ://www. php.net/manual/en/function.json-decode.php ) function.
140142This means that, by default, JSON objects will be emitted as a ` stdClass ` .
141143This behavior can be controlled through the optional constructor parameters:
142144
@@ -231,7 +233,7 @@ $stream->write(array('name' => 'hello wörld', 'active' => true));
231233```
232234
233235The ` Encoder ` supports the same parameters as the underlying
234- [ ` json_encode() ` ] ( http ://php.net/json_encode ) function.
236+ [ ` json_encode() ` ] ( https ://www. php.net/manual/en/function.json-encode.php ) function.
235237This means that, by default, unicode characters will be escaped in the output.
236238This behavior can be controlled through the optional constructor parameters:
237239
@@ -293,7 +295,7 @@ This project follows [SemVer](https://semver.org/).
293295This will install the latest supported version:
294296
295297``` bash
296- $ composer require clue/ndjson-react:^1.0
298+ $ composer require clue/ndjson-react:^1.1
297299```
298300
299301See also the [ CHANGELOG] ( CHANGELOG.md ) for details about version upgrades.
0 commit comments