From 4f2e1fa9883ac9a53a13e8cc925cf2cd278919ab Mon Sep 17 00:00:00 2001 From: Luigi Pinca Date: Sat, 26 Oct 2024 20:36:51 +0200 Subject: [PATCH] [doc] Add a note about parameter validation --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 72a596b..6c7852b 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,9 @@ key. ## API -The module exports a single function which takes one argument. +The module exports a single function that takes one argument. To maximize +performance, the argument is not validated. It is the caller's responsibility to +ensure that it is correct. ### `isValidUTF8(buffer)`