Skip to content

Commit 524017b

Browse files
authored
Merge pull request #192 from keichi/document-sizeof
Add documentation for sizeOf() in README
2 parents 866329d + 37a1cac commit 524017b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,9 @@ const mainParser = Parser.start()
480480
mainParser.parse(buffer);
481481
```
482482

483+
### sizeOf()
484+
Returns how many bytes this parser consumes. If the size of the parser cannot
485+
be statically determined, a `NaN` is returned.
483486

484487
### compile()
485488
Compile this parser on-the-fly and cache its result. Usually, there is no need

0 commit comments

Comments
 (0)