Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
CJGlitter committed May 29, 2024
1 parent 69f7739 commit 733d151
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ The `cvv` validation by default tests for a numeric string of 3 characters in le

#### `valid.postalCode(value: string, [options: object]): object`

The `postalCode` validation essentially tests for a valid string greater than 3 characters in length.
The `postalCode` validation essentially ignores leading whitespace and tests for a valid string greater than 3 characters in length. It also verifies that the first 3 letters are alphanumeric.

```javascript
{
Expand All @@ -354,7 +354,7 @@ The `postalCode` validation essentially tests for a valid string greater than 3
}
```

You can optionally pass `minLength` as a property of an object as a second argument. This will override the default min length of 3.
You can optionally pass `minLength` as a property of an object as a second argument. This will override the default min length of 3 and verify that the characters for the specified length are all alphanumeric.

```javascript
valid.postalCode('123', {minLength: 5});
Expand Down

0 comments on commit 733d151

Please sign in to comment.