Skip to content

Commit 7385298

Browse files
committed
Add TOC to README, and update CHANGELOG. Simple Log
1 parent db6c605 commit 7385298

12 files changed

+358
-91
lines changed

CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
# Version 0.23.0-alpha.1
22

3+
## Breaking Changes
4+
5+
- The library nows logs with the simplified `ZBSimpleLogger` by default, for friendly human-readable logs. To get the previous structured log behaviour, pass in `stdout: ZBJsonLogger` to the `ZBClient` constructor options. See the "Logging" section in the README.
6+
37
## New Features
48

9+
- `ZBClient.createWorker` has a new, additional, method signature that elides the `id` for the worker. You can now create a worker with just a task type and a job handler. A UUID is assigned as the worker id. This is the equivalent of passing in `null` as the first parameter to the original signature. The previous method signature still works, allowing you to specify an id if you want.
510
- There is now a `ZBLogMessage` interface to help you implement a custom logger [#127](https://github.com/creditsenseau/zeebe-client-node-js/issues/127). For an example of a custom logger, see the [Zeebe GitHub Action implementation](https://github.com/jwulf/zeebe-action/blob/master/src/log/logger.ts).
11+
- There is new custom logger implementation `ZBSimpleLogger` that produces flat string output. If you are not interested in structured logs for analysis, this log is easier for humans to read.
12+
- The README now contains a section "Writing Strongly-typed Job Workers", on writing typed workers in TypeScript.
13+
- The README also has a shiny TOC. It has grown in size such that one is needed.
614

715
# Version 0.22.1
816

0 commit comments

Comments
 (0)