Skip to content

Commit 767ec95

Browse files
committed
Prepare v1.1.0 release
1 parent 14f74f6 commit 767ec95

File tree

3 files changed

+27
-8
lines changed

3 files changed

+27
-8
lines changed

CHANGELOG.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
# Changelog
22

3+
## 1.1.0 (2020-02-04)
4+
5+
* Feature: Improve error reporting and add parsing error message to Exception and
6+
ignore `JSON_THROW_ON_ERROR` option (available as of PHP 7.3).
7+
(#14 by @clue)
8+
9+
* Feature: Add bechmarking script and import all global function references.
10+
(#16 by @clue)
11+
12+
* Improve documentation and add NDJSON format description and
13+
add support / sponsorship info.
14+
(#12 and #17 by @clue)
15+
16+
* Improve test suite to run tests on PHP 7.4 and simplify test matrix and
17+
apply minor code style adjustments to make phpstan happy.
18+
(#13 and #16 by @clue)
19+
320
## 1.0.0 (2018-05-17)
421

522
* First stable release, now following SemVer

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ objects or log entries. It uses a simple newline character between each
88
individual record and as such can be both used for efficient persistence and
99
simple append-style operations. This also allows it to be used in a streaming
1010
context, 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.
136138
This class reassembles these elements by buffering incomplete ones.
137139

138140
The `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.
140142
This means that, by default, JSON objects will be emitted as a `stdClass`.
141143
This 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

233235
The `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.
235237
This means that, by default, unicode characters will be escaped in the output.
236238
This behavior can be controlled through the optional constructor parameters:
237239

@@ -293,7 +295,7 @@ This project follows [SemVer](https://semver.org/).
293295
This 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

299301
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"authors": [
88
{
99
"name": "Christian Lück",
10-
"email": "christian@lueck.tv"
10+
"email": "christian@clue.engineering"
1111
}
1212
],
1313
"autoload": {

0 commit comments

Comments
 (0)