Skip to content

Commit 694d21b

Browse files
authored
docs(README): add phoneUS documentation
1 parent 11bbdff commit 694d21b

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -50,20 +50,21 @@ Bunch of useful filters for AngularJS *(with no external dependencies!)*
5050
- [xor](#xor)
5151
- [String](#string)
5252
- [endsWith](#endswith)
53+
- [latinize](#latinize)
5354
- [repeat](#repeat)
5455
- [reverse](#reverse-1)
5556
- [slugify](#slugify)
56-
- [latinize](#latinize)
57+
- [split](#split)
5758
- [startsWith](#startswith)
5859
- [stripTags](#striptags)
5960
- [stringular](#stringular)
60-
- [test](#test)
6161
- [match](#match)
62+
- [phoneUS](#phoneus)
63+
- [test](#test)
6264
- [trim](#trim)
6365
- [ltrim](#ltrim)
6466
- [rtrim](#rtrim)
6567
- [truncate](#truncate)
66-
- [split](#split)
6768
- [ucfirst](#ucfirst)
6869
- [uriEncode](#uriencode)
6970
- [uriComponentEncode](#uricomponentencode)
@@ -1080,6 +1081,16 @@ get string with {n} and replace match with enumeration values
10801081
<!--result:
10811082
<p>lorem {0} dolor sit amet</p>
10821083
```
1084+
1085+
### phoneUS
1086+
Format a string or a number into a us-style phone number
1087+
```html
1088+
<p>{{ 1234567890 | phoneUS }}</p>
1089+
1090+
<!--result:
1091+
<p>(123) 456-7890</p>
1092+
```
1093+
10831094
###truncate
10841095
truncates a string given a specified length, providing a custom string to denote an omission.<br/>
10851096
usage: ``` | truncate: [length]: [suffix-optional]: [preserve-optinal]```<br/>

0 commit comments

Comments
 (0)