Skip to content

Commit

Permalink
[doc] Add a note about parameter validation
Browse files Browse the repository at this point in the history
  • Loading branch information
@lpinca
lpinca committed Oct 26, 2024
1 parent dbab3ca commit 4f2e1fa
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)`

Expand Down

0 comments on commit 4f2e1fa

Please # to comment.