From 592fac7b28f8741798d30c728e8816bb8d64076f Mon Sep 17 00:00:00 2001 From: Paulo Vieira Date: Tue, 8 Aug 2023 12:09:51 +0100 Subject: [PATCH] readme - improve the customRequest*Message options - The readme suggests that the user should use `function (req) => { /* returns message string */ }`, which is invalid javascript syntax. I believe the "function" keyword was meant to be outside of the markdown backticks. - Also make it more clear how the default functions are defined --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2465b29..9096bd9 100644 --- a/README.md +++ b/README.md @@ -135,9 +135,9 @@ events"](#hapievents) section. ### `options.customRequestStartMessage` - **Default**: 'request start' + **Default**: `(request) => { return 'request start' }` - Set to a `function (request) => { /* returns message string */ }`. This function will be invoked at each request received, setting "msg" property to returned string. If not set, default value will be used. + Set to a function `(request) => { /* returns message string */ }`. This function will be invoked at each request received, setting the "msg" property to the returned string. If not set, default value will be used. ### `options.logRequestComplete: boolean | (Request) => Boolean` @@ -149,15 +149,15 @@ events"](#hapievents) section. ### `options.customRequestCompleteMessage` - **Default**: `` `[response] ${request.method} ${request.path} ${request.raw.res.statusCode} (${responseTime}ms)` `` + **Default**: `` (request, responseTime) => { return `[response] ${request.method} ${request.path} ${request.raw.res.statusCode} (${responseTime}ms)` } `` - Set to a `function (request, responseTime) => { /* returns message string */ }`. This function will be invoked at each completed request, setting "msg" property to returned string. If not set, default value will be used. + Set to a function `(request, responseTime) => { /* returns message string */ }`. This function will be invoked at each completed request, setting the "msg" property to the returned string. If not set, default value will be used. ### `options.customRequestErrorMessage` - **Default**: `error.message` + **Default**: `(request, err) => { return err.message }` - Set to a `function (request, err) => { /* returns message string */ }`. This function will be invoked at each failed request, setting "msg" property to returned string. If not set, default value will be used. + Set to a function `(request, err) => { /* returns message string */ }`. This function will be invoked at each failed request, setting the "msg" property to the returned string. If not set, default value will be used. ### `options.customRequestStartLevel: pino.Level`