nvrng - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

coverage.lcov

package.json

		{
		"name": "nvrng",
		"version": "1.1.0",
		"version": "1.1.1",
		"description": "Not very random temporary name generator",
		@@ -13,4 +13,5 @@ "main": "index.js",
		"cover": "nyc mocha tests",
		"report": "nyc report --reporter=text-lcov > coverage.lcov && codecov -t $TOKEN"
		"report": "nyc report --reporter=text-lcov > coverage.lcov && codecov -t %TOKEN%"
		},
		"keywords": "random, temporary, readable, name, generator",
		"author": "Sypachev S.S.",
		@@ -17,0 +18,0 @@ "license": "ISC",

README.md

		@@ -22,3 +22,3 @@ [![Codecov Coverage](https://img.shields.io/codecov/c/github/ssypachev/nvrng/master.svg?style=flat-square)](https://codecov.io/gh/ssypachev/nvrng/)
		gen.upload('./file.json');
		let nameset = gen.getSet(5);
		let [err, nameset] = gen.getSet(5);

		@@ -30,13 +30,15 @@ ```

		### `constructor({ limit = 100000 })`
		#### `constructor({ limit = 100000 })`

		`limit` - max number of attempts to create set

		### `upload(filename, { shuffle = true }) => err`
		#### `upload(filename, { shuffle = true }) => err`

		Setup vocabulary. Returns error. If everything is ok, then returns `null`;

		`filename` - path to `json` vocabulary

		`shuffle` - to shuffle vocabulary after upload

		### `getSet(size, { gender = Genders.Any, output = OutputFormat.Set, include, exclude, delimiter = ' ', format = StringFormat.NoFormat }) => [err, set]`
		#### `getSet(size, { gender = Genders.Any, output = OutputFormat.Set, include, exclude, delimiter = ' ', format = StringFormat.NoFormat }) => [err, set]`
		Generate set of random names. Returns array. First element is error (`null` if ok), second is a set of names;
		@@ -83,3 +85,3 @@

		Returns one string. Same options as in `getSet`.
		Returns one string. Same options as in `getSet` (except `include` and `output`).

		@@ -144,3 +146,5 @@ ## Vocabulary
		Clone repository and run

		`npm run test`

		`npm run cover`
		@@ -147,0 +151,0 @@

New alerts