<commit_before>
# Extensible Iterable class utilities

## Requirements

Node v5.0.0 or later
 - Flag `--es-staging` is required

## Some examples

 * Read [documentation](https://github.com/ksxnodemodules/x-iterable-documentation) for more examples

### Create an extended iterable class based an iterable class

 - Function: [`createClass`](https://github.com/ksxnodemodules/x-iterable-documentation/blob/master/references/create-class/readme.md)

 - Usage: `createClass(optional class Super)`

```javascript
var createClass = require('x-iterable/create-class');
var Iterable = createClass(Array);
var iterable = new Iterable(12, -4, 5, 66, 4);
var strlist = iterable.map(String);
console.log(strlist);
```

### Create an iterable class based on generator

 - Function: [`createClass.fromGenerator`](https://github.com/ksxnodemodules/x-iterable-documentation/blob/master/references/create-class/readme.md#function-createclassfromgenerator)

 - Usage: `createClass.fromGenerator(function generator)`

```javascript
var createClass = require('x-iterable/create-class');
var Iterable = createClass.fromGenerator(function * () {
	yield * "Hello, World!!";
});
var iterable = new Iterable();
for (let element of iterable) {
	console.log(element); // display each character of "Hello, World!!"
}
```

### Find min, max of an iterable

 - Method: `get Iterable::max`, `get Iterable::min`

*They're two applications of method [`XIterable::most`](https://github.com/ksxnodemodules/x-iterable-documentation/blob/master/references/create-class/x-iterable.md#method-most)*

```javascript
var SubSet = require('x-iterable').createClass(Set);
var set = new SubSet([12, 3, -5, 6, 88, 1]);
console.log({
	min: set.min,
	max: set.max
});
```

## Documentation: User Manual, API References
 - [Documentation](https://github.com/ksxnodemodules/x-iterable-documentation)
<commit_msg>update example<commit_after>
# Extensible Iterable class utilities

## Requirements

Node v5.0.0 or later
 - Flag `--es-staging` is required

## Some examples

 * Read [documentation](https://github.com/ksxnodemodules/x-iterable-documentation) for more examples

### Create an extended iterable class based an iterable class

 - Function: [`createClass`](https://github.com/ksxnodemodules/x-iterable-documentation/blob/master/references/create-class/readme.md)

 - Usage: `createClass(optional class Super)`

```javascript
var createClass = require('x-iterable/create-class');
var Iterable = createClass(Set);
var iterable = new Iterable([12, -4, 5, 66, 4]);
var strlist = iterable.map(String);
console.log(strlist);
```

### Create an iterable class based on generator

 - Function: [`createClass.fromGenerator`](https://github.com/ksxnodemodules/x-iterable-documentation/blob/master/references/create-class/readme.md#function-createclassfromgenerator)

 - Usage: `createClass.fromGenerator(function generator)`

```javascript
var createClass = require('x-iterable/create-class');
var Iterable = createClass.fromGenerator(function * () {
	yield * "Hello, World!!";
});
var iterable = new Iterable();
for (let element of iterable) {
	console.log(element); // display each character of "Hello, World!!"
}
```

### Find min, max of an iterable

 - Method: `get Iterable::max`, `get Iterable::min`

*They're two applications of method [`XIterable::most`](https://github.com/ksxnodemodules/x-iterable-documentation/blob/master/references/create-class/x-iterable.md#method-most)*

```javascript
var SubSet = require('x-iterable').createClass(Set);
var set = new SubSet([12, 3, -5, 6, 88, 1]);
console.log({
	min: set.min,
	max: set.max
});
```

## Documentation: User Manual, API References
 - [Documentation](https://github.com/ksxnodemodules/x-iterable-documentation)

{'fraction_non_alphanumeric': 0.15339233038348082, 'fraction_numerical': 0.009654062751407884, 'mean_word_length': 5.386986301369863, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1906382', 'n_tokens_mistral': 1246, 'n_tokens_neox': 1171, 'n_words': 269}