diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d5f90a6..5de2228 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,7 @@ If you're on Windows, we recommend the [Windows Subsystem for Linux]. First, some JavaScript tooling: -- Node.js 18+ +- Node.js 12+ - Yarn 1.x Next, install npm dependencies: diff --git a/README.md b/README.md index e836b0e..08a9a01 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![GitHub Release](https://github.com/seek-oss/koala/workflows/Release/badge.svg?branch=master)](https://github.com/seek-oss/koala/actions?query=workflow%3ARelease) [![GitHub Validate](https://github.com/seek-oss/koala/workflows/Validate/badge.svg?branch=master)](https://github.com/seek-oss/koala/actions?query=workflow%3AValidate) -[![Node.js version](https://img.shields.io/badge/node-%3E%3D%2018.0-brightgreen)](https://nodejs.org/en/) +[![Node.js version](https://img.shields.io/badge/node-%3E%3D%2012.17-brightgreen)](https://nodejs.org/en/) [![npm package](https://img.shields.io/npm/v/seek-koala)](https://www.npmjs.com/package/seek-koala) [![Powered by skuba](https://img.shields.io/badge/🤿%20skuba-powered-009DC4)](https://github.com/seek-oss/skuba) diff --git a/src/requestLogging/README.md b/src/requestLogging/README.md index c8f3e8f..8ecd192 100644 --- a/src/requestLogging/README.md +++ b/src/requestLogging/README.md @@ -13,7 +13,7 @@ It provides three main features: ## Context Logging -`createContextStorage` returns a logger context storage instance with two methods: `createContextMiddleware` and `mixin`. This is simply a wrapper over an [AsyncLocalStorage](https://nodejs.org/docs/latest-v18.x/api/async_context.html#class-asynclocalstorage) instance. +`createContextStorage` returns a logger context storage instance with two methods: `createContextMiddleware` and `mixin`. This is simply a wrapper over an [AsyncLocalStorage](https://nodejs.org/docs/latest-v16.x/api/async_context.html#class-asynclocalstorage) instance. Please note: for performance reasons it is recommended that you use Node.js version v16.2.0+ if you intend to use this. `createContextMiddleware` is a function which returns a Koa Middleware that injects the logger context into an AsyncLocalStorage instance. It must be added early in the Koa Middleware chain if you want logger calls to contain request context fields. It also provides an optional