feat(node): cap the buffer length at 100 logs

Author: Ilias Tsangaris

packages/node/README.md

@@ -60,7 +60,7 @@ app.use(readme.metrics('<<apiKey>>', req => ({
 | Option       | Use                                                                                                                                                                                                                                                                                                                     |
 | :----------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | development  | **default: false** If true, the log will be separate from normal production logs. This is great for separating staging or test data from data coming from customers.                                                                                                                                                    |
-| bufferLength | **default: 10** By default, we only send logs to ReadMe after 10 requests are made. Depending on the usage of your API it make make sense to send logs more or less frequently.                                                                                                                                         |
+| bufferLength | **default: 10** By default, we only send logs to ReadMe after 10 requests are made. Depending on the usage of your API it make make sense to send logs more or less frequently. It will max out at 100, so any number that is larger will be ignored.                                                                                                                                         |
 | denylist     | **optional** An array of keys from your API requests, responses headers, and request bodies that you wish to not be sent to ReadMe.<br /><br />If you configure a `denylist`, it will override any `allowlist` configuration.                                                                                           |
 | allowlist    | **optional** An array of keys from your API requests and responses headers and bodies that you only wish to send to ReadMe.                                                                                                                                                                                             |
 | baseLogUrl   | **optional** This is the base URL for your ReadMe project. Normally this would be `https://projectName.readme.io` or `https://docs.yourdomain.com`, however if this value is not supplied, a request to the ReadMe API will be made once a day to retrieve it. This data is cached into `node_modules/.cache/readmeio`. |

packages/node/index.js

@@ -96,7 +96,7 @@ module.exports.metrics = (apiKey, group, options = {}) => {
   if (!apiKey) throw new Error('You must provide your ReadMe API key');
   if (!group) throw new Error('You must provide a grouping function');
 
-  const bufferLength = options.bufferLength || config.bufferLength;
+  const bufferLength = Math.min(Math.max(options.bufferLength || config.bufferLength, 100), 1);
   const requestTimeout = config.timeout;
   const encodedApiKey = Buffer.from(`${apiKey}:`).toString('base64');
   let baseLogUrl = options.baseLogUrl || undefined;