strman.lefttrim - npm Package Compare versions

Comparing version 2.0.0-pre-release-0 to 2.0.0

index.js

@@ -7,10 +7,27 @@ var replace = require('strman.replace')
 /**
+ * @module leftTrim
+ * @description
  * Remove all spaces on left.
- * @playground
- * var leftTrim = require('strman').leftTrim;
- * let title = "   strman";
- * let result = leftTrim(title);
- * @param {String} value - The String!.
- * @params {String = ' '} char - if you need remove other char on left boarders.
- * @return {String} - String without left boarders spaces.
+ * ## Install
+ * Install all functions of strman
+ * ```sh
+ * yarn add strman
+ * ```
+ * or just the leftTrim function
+ * ```sh
+ * yarn add strman.lefttrim
+ * ```
+ * ## Usage
+ * ```javascript
+ * import { leftTrim } from 'strman'
+ * // OR
+ * import leftTrim from 'strman.lefttrim'
+ * ```
+ * @param {String} value The String!
+ * @param {String} [char = ''] if you need remove other char on left boarders.
+ * @example
+ * const title = '   strman'
+ * leftTrim(title)
+ * // => 'strman'
+ * @returns {String} String without left boarders spaces.
  */
@@ -17,0 +34,0 @@ exports.default = function (value) {

package.json

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

readme.md

 
-# strman.lefttrim v2.0.0-pre-release-0
+# strman.lefttrim v2.0.0
 
@@ -4,0 +4,0 @@ The [strman](https://github.com/dleitee/strman) method `lefttrim` 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

3214

increased by7.67%

Lines of code

35

increased by94.44%

Number of low quality alerts

0

decreased by-100%

Dependency changes

• + Addedstrman.replace@2.0.0(transitive)

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

• Updatedstrman.replace@2.0.0