Skip to content

Commit 089fce1

Browse files
committed
Fix typos in doc
1 parent 56e941a commit 089fce1

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@ time and effort to write). Supported data types are:
2121
- [Arrays](#arrayname-options) (supports user-defined element type,
2222
fixed-length and variable-length)
2323
- [Choices](##choicename-options)
24+
- [Pointers](##pointername-options)
2425
- User defined types
2526

26-
Binary-parser is insipired by [BinData](https://github.com/dmendel/bindata)
27+
Binary-parser is inspired by [BinData](https://github.com/dmendel/bindata)
2728
and [binary](https://github.com/substack/node-binary).
2829

2930
## Installation
@@ -93,11 +94,11 @@ Parse bytes as an integer and store it in a variable named `name`. `name`
9394
should consist only of alphanumeric characters and start with an alphabet.
9495
Number of bits can be chosen from 8, 16, 32 and 64. Byte-ordering can be either
9596
`l` for little endian or `b` for big endian. With no prefix, it parses as a
96-
signed number, with `u` prefixed as an unsigned number. The runtime type
97-
returned by the 8, 16, 32 bit methods is `number` while the type
98-
returned by the 64 bit is `bigint`.
99-
100-
**NOTE:** [u]int64{be,le} methods only work if your runtime is Nodejs v12.0.0 or
97+
signed number, with `u` prefixed as an unsigned number. The runtime type
98+
returned by the 8, 16, 32 bit methods is `number` while the type
99+
returned by the 64 bit is `bigint`.
100+
101+
**NOTE:** [u]int64{be,le} methods only work if your runtime is node v12.0.0 or
101102
greater. Lower version will throw a runtime error.
102103

103104
```javascript
@@ -281,10 +282,10 @@ current object. `options` is an object which can have the following keys:
281282
- `type` - (Required) A `Parser` object.
282283

283284
### pointer(name [,options])
284-
Jump to `offset`, execute parser for `type` and rewind to current offset.
285+
Jump to `offset`, execute parser for `type` and rewind to previous offset.
285286

286287
- `type` - (Required) A `Parser` object.
287-
- `offset` - (Required) Note that this is abosolute offset
288+
- `offset` - (Required) Note that this is absolute offset
288289
Type of the array element. Can be a string or an user defined Parser
289290
object. If it's a string, you have to choose from [u]int{8, 16, 32}{le,
290291
be}.

0 commit comments

Comments
 (0)