Skip to content

Commit

Permalink
updated docs for readBufferNT
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshGlazebrook committed Apr 12, 2016
1 parent 0495c78 commit 422fb8f
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,14 @@ returns `Buffer`
> Note: This function uses `slice` to retrieve the Buffer.

### SmartBuffer.readBufferNT()

returns `Buffer`

> Note: This reads the next sequence of bytes in the buffer until a null (0x00) value is found. (Null terminated buffer)
> Note: This function uses `slice` to retrieve the Buffer.

## Writing Data

smart-buffer supports all of the common write functions you will find in the vanilla Buffer class. The only difference is, you do not need to specify which location to write to in your Buffer by default. You do however have the option of **inserting** a piece of data into your smart-buffer at a given location.
Expand Down

0 comments on commit 422fb8f

Please sign in to comment.