Skip to content

Commit

Permalink
Add clarification on differences of is.convert
Browse files Browse the repository at this point in the history
Closes GH-13.

Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com>
Co-authored-by: Titus Wormer <tituswormer@gmail.com>
  • Loading branch information
Roang-zero1 and wooorm committed Dec 8, 2019
1 parent ae71834 commit 8c0a649
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ Create a test function from `test`, that can later be called with a `node`,
Useful if you’re going to test many nodes, for example when creating a utility
where something else passes an is-compatible test.

The created function is slightly faster because it expects valid input only.
Therefore, passing invalid input, yields unexpected results.

Can also be accessed with `require('unist-util-is/convert')`.

For example:
Expand Down

0 comments on commit 8c0a649

Please sign in to comment.