strman.slugify - npm Package Compare versions

Comparing version 2.0.0-pre-release-0 to 2.0.0

index.js

@@ -11,9 +11,26 @@ var toLowerCase = require('strman.tolowercase')
 /**
+ * @module slugify
+ * @description
  * Converts a value to a slug.
- * @playground
- * var slugify = require('strman').slugify
- * let title = "A Javascript string manipulation library."
- * let value = slugify(title)
- * @param {String} value - The value to slugify
- * @return {String} - The slugified value
+ * ## Install
+ * Install all functions of strman
+ * ```sh
+ * yarn add strman
+ * ```
+ * or just the slugify function
+ * ```sh
+ * yarn add strman.slugify
+ * ```
+ * ## Usage
+ * ```javascript
+ * import { slugify } from 'strman'
+ * // OR
+ * import slugify from 'strman.slugify'
+ * ```
+ * @param {String} value The value to slugify
+ * @example
+ * const title = 'A Javascript string manipulation library.'
+ * slugify(title)
+ * // => 'a-javascript-string-manipulation-library'
+ * @returns {String} The slugified value
  */
@@ -20,0 +37,0 @@ exports.default = function (value) {

package.json

 
   {
     "name": "strman.slugify",
-    "version": "2.0.0-pre-release-0",
+    "version": "2.0.0",
     "description": "The [strman](https://github.com/dleitee/strman) method `slugify` exported as a [Node.js](https://nodejs.org/) module.",
@@ -20,7 +20,7 @@ "main": "index.js",
     "dependencies": {
-    	"strman.tolowercase":"2.0.0-pre-release-0",
-	"strman.trim":"2.0.0-pre-release-0",
-	"strman.removespaces":"2.0.0-pre-release-0",
-	"strman.replace":"2.0.0-pre-release-0",
-	"strman.transliterate":"2.0.0-pre-release-0"
+    	"strman.tolowercase":"2.0.0",
+	"strman.trim":"2.0.0",
+	"strman.removespaces":"2.0.0",
+	"strman.replace":"2.0.0",
+	"strman.transliterate":"2.0.0"
     },
@@ -27,0 +27,0 @@ "author": "Daniel Leite de Oliveira <[e-mail]>",

readme.md

 
-# strman.slugify v2.0.0-pre-release-0
+# strman.slugify v2.0.0
 
@@ -4,0 +4,0 @@ The [strman](https://github.com/dleitee/strman) method `slugify` exported as a [Node.js](https://nodejs.org/) module.

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3717

increased by5.99%

Lines of code

43

increased by65.38%

Number of low quality alerts

0

decreased by-100%

Dependency changes

• + Addedstrman.ascii@2.0.0(transitive)

• + Addedstrman.lefttrim@2.0.0(transitive)

• + Addedstrman.removespaces@2.0.0(transitive)

• + Addedstrman.replace@2.0.0(transitive)

• + Addedstrman.righttrim@2.0.0(transitive)

• + Addedstrman.tolowercase@2.0.0(transitive)

• + Addedstrman.transliterate@2.0.0(transitive)

• + Addedstrman.trim@2.0.0(transitive)

• - Removedstrman.ascii@2.0.0-pre-release-0(transitive)

• - Removedstrman.lefttrim@2.0.0-pre-release-0(transitive)

• - Removedstrman.removespaces@2.0.0-pre-release-0(transitive)

• - Removedstrman.replace@2.0.0-pre-release-0(transitive)

• - Removedstrman.righttrim@2.0.0-pre-release-0(transitive)

• - Removedstrman.tolowercase@2.0.0-pre-release-0(transitive)

• - Removedstrman.transliterate@2.0.0-pre-release-0(transitive)

• - Removedstrman.trim@2.0.0-pre-release-0(transitive)

• Updatedstrman.removespaces@2.0.0

• Updatedstrman.replace@2.0.0

• Updatedstrman.tolowercase@2.0.0

• Updatedstrman.transliterate@2.0.0

• Updatedstrman.trim@2.0.0