strman.transliterate - npm Package Compare versions

Comparing version 2.0.0-pre-release-0 to 2.0.0

index.js

@@ -8,9 +8,26 @@ var ascii = require('strman.ascii')
 /**
+ * @module transliterate
+ * @description
  * Remove all non valid characters. Example: change á => a or ẽ => e.
- * @playground
- * var transliterate = require('strman').transliterate;
- * let title = "strmáñ";
- * let result = transliterate(title);
- * @param {String} value - The String!.
- * @return {String} - String without non valid characters.
+ * ## Install
+ * Install all functions of strman
+ * ```sh
+ * yarn add strman
+ * ```
+ * or just the transliterate function
+ * ```sh
+ * yarn add strman.transliterate
+ * ```
+ * ## Usage
+ * ```javascript
+ * import { transliterate } from 'strman'
+ * // OR
+ * import transliterate from 'strman.transliterate'
+ * ```
+ * @param {String} value - The String!
+ * @example
+ * const title = 'strmáñ'
+ * transliterate(title)
+ * // => 'strman'
+ * @returns {String}  String without non valid characters.
  */
@@ -17,0 +34,0 @@ exports.default = function (value) {

package.json

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

readme.md

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

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

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

3413

increased by7.56%

Lines of code

38

increased by80.95%

Number of low quality alerts

0

decreased by-100%

Dependency changes

• + Addedstrman.ascii@2.0.0(transitive)

• + Addedstrman.replace@2.0.0(transitive)

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

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

• Updatedstrman.ascii@2.0.0

• Updatedstrman.replace@2.0.0