From 37b12b6e1c173bd56bcccad45eb4c857963355e4 Mon Sep 17 00:00:00 2001 From: Chris M <821688+tebriel@users.noreply.github.com> Date: Fri, 6 Sep 2024 23:14:17 -0400 Subject: [PATCH] Fix typo in README.md (#267) updSocketOptions are set when protocol is `udp` not `uds`. Simple fix! --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4e4179c..b7823d8 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Parameters (specified as one object passed into hot-shots): * `udsGracefulErrorHandling`: Used only when the protocol is `uds`. Boolean indicating whether to handle socket errors gracefully. Defaults to true. * `udsGracefulRestartRateLimit`: Used only when the protocol is `uds`. Time (ms) between re-creating the socket. Defaults to `1000`. * `closingFlushInterval`: Before closing, StatsD will check for inflight messages. Time (ms) between each check. Defaults to `50`. -* `udpSocketOptions`: Used only when the protocol is `uds`. Specify the options passed into dgram.createSocket(). Defaults to `{ type: 'udp4' }` +* `udpSocketOptions`: Used only when the protocol is `udp`. Specify the options passed into dgram.createSocket(). Defaults to `{ type: 'udp4' }` ### StatsD methods All StatsD methods other than `event`, `close`, and `check` have the same API: