Skip to content

Commit 4f2e1fa

Browse files
committed
[doc] Add a note about parameter validation
1 parent dbab3ca commit 4f2e1fa

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ key.
1818

1919
## API
2020

21-
The module exports a single function which takes one argument.
21+
The module exports a single function that takes one argument. To maximize
22+
performance, the argument is not validated. It is the caller's responsibility to
23+
ensure that it is correct.
2224

2325
### `isValidUTF8(buffer)`
2426

0 commit comments

Comments
 (0)