Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aldipermanaetikaputra committed Apr 4, 2023
1 parent f602c11 commit 68674ca
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@ while (!reader.isClosed) {

The options you can pass are:

| Name | Type | Default | Description |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| filePath | `string` | none | The path or location of your file _(required)_ |
| bufferSize | `number` | `1024` | Chunk/buffer size in bytes |
| bufferEncoding | `'ascii' \| 'utf8' \| 'utf-8' \| 'utf16le' \| 'ucs2' \| 'ucs-2' \| 'base64' \| 'latin1' \| 'binary' \| 'hex'` | `'utf8'` | Character encoding to use on `read()` operation |
| removeInvisibleUnicode | `boolean` | `false` | Remove all (or perhaps just "common") non-printable Unicode characters except line breaks. Using regex: `/[\x00-\x09\x0B-\x0C\x0E-\x1F\x7F-\x9F]/g` |
| Name | Type | Default | Description |
| ---------------------- | --------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| filePath | `string` | none | The path or location of your file _(required)_ |
| bufferSize | `number` | `1024` | Chunk/buffer size in bytes |
| bufferEncoding | `'ascii' \| 'utf8' \| 'utf-8' \| 'utf16le' \| 'ucs2' \| 'ucs-2' \| 'base64' \| 'latin1' \| 'binary' \| 'hex'` | `'utf8'` | Character encoding to use on `read()` operation |
| removeInvisibleUnicode | `boolean` | `false` | Remove all (or perhaps just "common") non-printable Unicode characters except line breaks. Using regex: `/[\x00-\x09\x0B-\x0C\x0E-\x1F\x7F-\x9F]/g` |

### Instance Methods

Expand Down

0 comments on commit 68674ca

Please sign in to comment.