Skip to content

Commit

Permalink
Improved readme doc to add method parameters and returns.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Jojo-craft
Jojo-craft committed Aug 17, 2023
1 parent 0369f42 commit f2674d2
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,24 +53,24 @@ String.EMPTY;

### Methods

| Name | Description |
|:-------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| [`isEmpty`](#isEmpty) | Indicates whether the specified string is an empty string ("") (reverse with `isNotEmpty` method). |
| [`isNullOrEmpty`](#isNullOrEmpty) | Indicates whether the specified string is null, undefined or an empty string ("") (reverse with `isNotNullOrEmpty` method). |
| [`isBlank`](#isBlank) | Indicates whether a specified string is empty, or consists only of white-space characters (reverse with `isNotBlank` method). |
| [`isNullOrBlank`](#isNullOrBlank) | Indicates whether a specified string is null, undefined, empty, or consists only of white-space characters (reverse with `isNotNullOrBlank` method). |
| [`isNumber`](#isNumber) | Indicates whether the specified string is a valid numeric string (reverse with `isNotNumber` method). |
| [`isAlpha`](#isAlpha) | Indicates whether a given value consists only of alphabetic characters (reverse with `isNotAlpha` method). |
| [`isAlphaNumber`](#isAlphaNumber) | Indicates whether the specified string contains only alphabetic characters and numbers (reverse with `isNotAlphaNumber` method). |
| [`isBasicStrongPassword`](#isBasicStrongPassword) | Indicates whether the specified string contains at least 1 uppercase letter, 1 lowercase letter, 1 number, 1 special character and a minimum length of 12 characters. |
| [`containsNumber`](#containsNumber) | Indicates whether the specified string contains at least one numeric digit (reverse with `notContainsNumber` method). |
| [`containsAlpha`](#containsAlpha) | Indicates whether the specified string contains at least one alphabetic character (reverse with `notContainsAlpha` method). |
| [`containsSpecialCharacter`](#containsSpecialCharacter) | Indicates whether a given string contains at least one special character (reverse with `notContainsSpecialCharacter` method). |
| [`containsUpperCase`](#containsUpperCase) | Indicates whether the specified string contains at least one uppercase letter. |
| [`containsLowerCase`](#containsLowerCase) | Indicates whether the specified string contains at least one lowercase letter. |
| [`removeAccents`](#removeAccents) | Removes accents from a given string. |
| [`join`](#join) | Concatenates an array of strings using the specified separator between each member. |
| [`countWords`](#countWords) | Counts the number of words in a sentence. |
| Name | Description | Input parameters | Return |
|:-------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------:|:---------:|
| [`isEmpty`](#isEmpty) | Indicates whether the specified string is an empty string ("") (reverse with `isNotEmpty` method). | value: `string` | `boolean` |
| [`isNullOrEmpty`](#isNullOrEmpty) | Indicates whether the specified string is null, undefined or an empty string ("") (reverse with `isNotNullOrEmpty` method). | value: `string` | `null` | `undefined` | | `boolean`
| [`isBlank`](#isBlank) | Indicates whether a specified string is empty, or consists only of white-space characters (reverse with `isNotBlank` method). | value: `string` | `boolean` |
| [`isNullOrBlank`](#isNullOrBlank) | Indicates whether a specified string is null, undefined, empty, or consists only of white-space characters (reverse with `isNotNullOrBlank` method). | value: `string` | `null` | `undefined` | | `boolean`
| [`isNumber`](#isNumber) | Indicates whether the specified string is a valid numeric string (reverse with `isNotNumber` method). | value: `string` | `null` | `undefined` | `boolean` |
| [`isAlpha`](#isAlpha) | Indicates whether a given value consists only of alphabetic characters (reverse with `isNotAlpha` method). | value: `string` | `null` | `undefined` | `boolean` |
| [`isAlphaNumber`](#isAlphaNumber) | Indicates whether the specified string contains only alphabetic characters and numbers (reverse with `isNotAlphaNumber` method). | value: `string` | `null` | `undefined` | `boolean` |
| [`isBasicStrongPassword`](#isBasicStrongPassword) | Indicates whether the specified string contains at least 1 uppercase letter, 1 lowercase letter, 1 number, 1 special character and a minimum length of 12 characters. | value: `string` | `null` | `undefined` | `boolean` |
| [`containsNumber`](#containsNumber) | Indicates whether the specified string contains at least one numeric digit (reverse with `notContainsNumber` method). | value: `string` | `null` | `undefined` | `boolean` |
| [`containsAlpha`](#containsAlpha) | Indicates whether the specified string contains at least one alphabetic character (reverse with `notContainsAlpha` method). | value: `string` | `null` | `undefined` | `boolean` |
| [`containsSpecialCharacter`](#containsSpecialCharacter) | Indicates whether a given string contains at least one special character (reverse with `notContainsSpecialCharacter` method). | value: `string` | `null` | `undefined` | `boolean` |
| [`containsUpperCase`](#containsUpperCase) | Indicates whether the specified string contains at least one uppercase letter. | value: `string` | `null` | `undefined` | `boolean` |
| [`containsLowerCase`](#containsLowerCase) | Indicates whether the specified string contains at least one lowercase letter. | value: `string` | `null` | `undefined` | `boolean` |
| [`removeAccents`](#removeAccents) | Removes accents from a given string. | value: `string` | `string` |
| [`join`](#join) | Concatenates an array of strings using the specified separator between each member. | separator: `string`, values: (`string` | `null` | `undefined`)[] | `string` |
| [`countWords`](#countWords) | Counts the number of words in a sentence. | sentence: `string` | `null` | `undefined` | `number` |


#### <a id="isEmpty"/> isEmpty
Expand Down

0 comments on commit f2674d2

Please sign in to comment.