Skip to content

Commit 22c80c1

Browse files
authored
Update api.md
Read() returns different data depending on how it's used.
1 parent ad026a5 commit 22c80c1

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/api.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -571,7 +571,11 @@ file.read(buf, len)
571571

572572
#### Returns
573573

574-
The next byte (or character), or -1 if none is available.
574+
When used as `file.read()`
575+
The next byte (or character), or -1 if none is available.
576+
577+
When used as `file.read(buf, len)`
578+
The amount of bytes read, or -1 if an error occured.
575579

576580
#### See also
577581

0 commit comments

Comments
 (0)