[doc] Add a note about parameter validation

websockets · May 19, 2024 · 1bc6647 · 1bc6647
1 parent 9023b6b
commit 1bc6647
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -20,7 +20,8 @@ key.
 
 ## API
 
-The module exports two functions.
+The module exports two functions. To maximize performance, parameters are not
+validated. It is the caller's responsibility to ensure that they are correct.
 
 ### `bufferUtil.mask(source, mask, output, offset, length)`