Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bostrt/wordcount.js
Calculate file newlines, word, and byte counts on client side using HTML5 File API. (Emulates Linux's wc command)
https://github.com/bostrt/wordcount.js
Last synced: 2 months ago
JSON representation
Calculate file newlines, word, and byte counts on client side using HTML5 File API. (Emulates Linux's wc command)
- Host: GitHub
- URL: https://github.com/bostrt/wordcount.js
- Owner: bostrt
- License: mit
- Created: 2013-11-01T01:23:16.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2014-01-24T13:17:04.000Z (almost 11 years ago)
- Last Synced: 2024-04-25T04:11:57.892Z (9 months ago)
- Language: JavaScript
- Homepage: http://bostrt.github.io/wordcount.js/
- Size: 320 KB
- Stars: 109
- Watchers: 7
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
WordCount.js [](https://travis-ci.org/bostrt/wordcount.js) 
============
*© 2013 Robert Bost*
**Author:** Robert Bost
**Demo:** http://bostrt.github.io/wordcount.js/
WordCount.js is a client-side JS and Node.js library that counts bytes, words, lines
chars, and calculates the longest line of a file using the HTML5 File API.
Install
=======
bower install wordcount.js
Examples
========
```
...
WordCount.bytes("input", function(size, file, inputSelector) {
console.log("Number of bytes: " + size);
});
WordCount.chars("input", function(chars) {
console.log("Number of characters: " + chars);
});
```
Tests
=====
npm install -g mocha
mocha
# Callbacks
Callbacks are passed into each of WordCount's
functions. Each callback should accept 3 parameters, (1) the value that the
function is calculating or finding, (2) the File object that was uploaded,
(3) and the ID selector of the file input element.
`callback(value, file, selector)`
API
===
WordCount.bytes(selector, callback)
-----------------------------------
When a file is uploaded using the file input element with the given input
selector then the number of the bytes in the uploaded file is calculated
and then callback is called.
**Parameters**
**selector**: *String*, - The ID selector for a file input element.
**callback**: *Function*, - Called when a file has been completely uploaded and bytes have been calculated.
WordCount.longest(selector, callback)
-------------------------------------
When a file is uploaded using the file input element with the given input
selector then the longest line in the file is located and the callback
is called.
**Parameters**
**selector**: *String*, - The ID selector for a file input element.
**callback**: *Function*, - Called when a file has been completely uploaded and the longest line has been found.
WordCount.words(selector, callback)
-----------------------------------
When a file is uploaded using the file input element with the given input
selector then the number of words in the file is calculated and the
callback is called. A word is a non-zero-length sequence of characters
delimited by white space.
**Parameters**
**selector**: *String*, - The ID selector for a file input element.
**callback**: *Function*, - Called after a file is available and the number of words have been calculated.
WordCount.chars(selector, callback)
-----------------------------------
When a file is uploaded using the file input element with the given input
selector then the number of chars in the file are calculated and the
callback is called.
**Parameters**
**selector**: *String*, - The ID selector for a file input element.
**callback**: *Function*, - Called after a file is available and the number of chars in that file have been calculated.
WordCount.lines(selector, callback)
-----------------------------------
When a file is uploaded using the file input element with the given input
selector then the number of lines in the file are calculated and the
callback is called.
**Parameters**
**selector**: *String*, - The ID selector for a file input element.
**callback**: *Function*, - Called after a file is available and the number of lines in that file have been calculated.