LumeWeb
/
chardet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Bump README

This commit is contained in:
Eliott Vincent 2022-10-07 10:23:13 +02:00
parent d085d275b3
commit bab1db0a77
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -37,7 +37,7 @@ import chardet from 'chardet';
chardet.analyse(Buffer.from('hello there!'));
```
Returned value is an array of objects sorted by confidence value in decending order
Returned value is an array of objects sorted by confidence value in descending order
```javascript
[
@ -48,8 +48,8 @@ Returned value is an array of objects sorted by confidence value in decending or
## Working with large data sets
Sometimes, when data set is huge and you want to optimize performace (with a tradeoff of less accuracy),
you can sample only first N bytes of the buffer:
Sometimes, when data set is huge and you want to optimize performance (with a tradeoff of less accuracy),
you can sample only the first N bytes of the buffer:
```javascript
chardet
@ -57,6 +57,14 @@ chardet
.then(encoding => console.log(encoding));
```
You can also specify where to begin reading from in the buffer:
```javascript
chardet
.detectFile('/path/to/file', { sampleSize: 32, offset: 128 })
.then(encoding => console.log(encoding));
```
## Supported Encodings:
- UTF-8