Skip to content

Commit 4671f7d

Browse files
committed
Defined fromFile & fromStream as the main module (API) methods.
Added lint checks.
1 parent 287a5eb commit 4671f7d

File tree

12 files changed

+3300
-301
lines changed

12 files changed

+3300
-301
lines changed

.travis.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ node_js:
66
install:
77
- npm install
88
script:
9-
- npm test
9+
- npm run lint
10+
- npm test

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,33 @@ A basic set of *token types* can be found here: [token-types](https://github.com
1919
Below is an example of parsing the the first byte from a readable stream as an unsigned-integer:
2020

2121
```TypeScript
22-
import {ReadStreamTokenizer} from "strtok3";
22+
import * as strtok3 from "strtok3";
2323
import * as stream from "stream";
2424
import * as Token from "token-types";
2525

2626
let readableStream: stream.Readable;
2727
// Assign readable
2828

29-
const streamTokenizer = new ReadStreamTokenizer(readableStream);
29+
strtok3.fromStream(readableStream).then((tokenizer) => {
30+
return tokenizer.readToken<number>(Token.UINT8).then((myUint8Number) => {
31+
console.log("My number: %s", myUint8Number);
32+
});
33+
})
34+
```
35+
36+
```JavaScript
37+
var strtok3 = require('strtok3');
38+
var Token = require('token-types');
39+
40+
var readableStream;
41+
// Assign readable
42+
3043

31-
return streamTokenizer.readToken<number>(Token.UINT8).then((myUint8Number) => {
32-
console.log("My number: %s", myUint8Number);
33-
});
44+
strtok3.fromStream(readableStream).then( function(streamTokenizer) {
45+
return streamTokenizer.readToken(Token.UINT8).then( function(myUint8Number {
46+
console.log("My number: %s", myUint8Number);
47+
});
48+
})
3449
```
3550
3651
### Reading from a file
@@ -39,16 +54,16 @@ The same can be done from a file:
3954
4055
```TypeScript
4156
import * as fs from "fs-extra";
42-
import {FileTokenizer} from "strtok3";
57+
import * as strtok3 from "strtok3";
4358
import * as Token from "token-types";
4459

45-
return fs.open("somefile.bin", "r").then((fd) => {
46-
const fileTokenizer = new FileTokenizer(fd);
60+
strtok3.fromFile("somefile.bin").then((tokenizer) => {
61+
return tokenizer.readToken<number>(Token.UINT8).then((myUint8Number) => {
62+
console.log("My number: %s", myUint8Number);
63+
});
64+
})
65+
4766

48-
return fileTokenizer.readToken<number>(Token.UINT8).then((myUint8Number) => {
49-
console.log("My number: %s", myUint8Number);
50-
});
51-
});
5267
```
5368
5469
[npm-url]: https://npmjs.org/package/strtok3

0 commit comments

Comments
 (0)