Skip to content

Commit bd5c395

Browse files
committed
Merge pull request #32 from heyjustin/patch-1
doc(README.md): Update headings to be consistent with usage
2 parents f146992 + 9e46b1f commit bd5c395

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ William 20
181181
Clive 30
182182
183183
```
184-
###filterby
184+
###filterBy
185185
Filter a collection by a specific property.<br/>
186186
**Usage:** ```collection | filterBy: [prop, nested.prop, etc..]: search```<br/>
187187
**Note:** You can even use compound properties (e.g: ```|filterBy: [property + property]: model```)<br/>
@@ -360,7 +360,7 @@ $scope.books = [
360360
{{ book.title }}
361361
</li>
362362
```
363-
###fuzzyby
363+
###fuzzyBy
364364
fuzzy string searching(approximate string matching) by property(nested to). [Ream more](http://en.wikipedia.org/wiki/Approximate_string_matching)<br/>
365365
usage: ```collection | fuzzyBy: 'property': search: caseSensitive[optional]```
366366
```js
@@ -382,7 +382,7 @@ $scope.books = [
382382
{{ book.title }}
383383
</li>
384384
```
385-
###groupby
385+
###groupBy
386386
Create an object composed of keys generated from the result of running each element of a collection,<br/>
387387
each key is an array of the elements.<br/>
388388
**usage:** ```(key, value) in collection | groupBy: 'property'``` or ```... | groupBy: 'nested.property'```
@@ -412,7 +412,7 @@ $scope.players = [
412412
* player: Steve
413413
* player: Scruath
414414
```
415-
###countby
415+
###countBy
416416
Create an object composed of keys generated from the result of running each element of a collection,<br/>
417417
each key is the count of objects in each group<br/>
418418
**usage:** ```(key, value) in collection | countBy: 'property'``` or ```... | countBy: 'nested.property'```
@@ -541,7 +541,7 @@ $scope.collection = [
541541
<!-- result:
542542
{ "name": "bar" }
543543
```
544-
###remove-with
544+
###removeWith
545545
comparison for each element in a collection to the given properties object,<br/>
546546
returning an array without all elements that have equivalent property values.
547547
```js
@@ -566,7 +566,7 @@ returning an array without all elements that have equivalent property values.
566566
bar
567567
baz
568568
```
569-
###searchfield
569+
###searchField
570570
if you want to use the filter in angular and want to filter for multiple values<br/>
571571
so searchField filter return new collection with property called searchField<br/>
572572
**support nested properties with dot notation i.e:** ``` collection | searchFiled: 'prop': 'nested.prop' ```
@@ -673,7 +673,7 @@ $scope.orders = [
673673
-->
674674
```
675675

676-
###reverse collection
676+
###reverse
677677
Reverse the order of the elements in a collection
678678

679679
```js
@@ -694,7 +694,7 @@ $scope.users = [
694694
-->
695695
```
696696

697-
###isempty
697+
###isEmpty
698698
get collection or string and return if it empty[Bollean]
699699

700700
```html
@@ -790,7 +790,7 @@ $scope.users2 = [
790790
<!--result:
791791
2, foo bag
792792
```
793-
###toarray
793+
###toArray
794794
Convert objects into stable arrays. <br/>
795795
**Usage:** ```object | toArray: addKey[optional]```<br/>
796796
if addKey set to true,the filter also attaches a new property $key to the value containing the original key that was used in the object we are iterating over to reference the property
@@ -849,7 +849,7 @@ Foo Bar Baz
849849
-->
850850
```
851851

852-
###uriencode
852+
###uriEncode
853853
get string as parameter and return encoded uri
854854

855855
```html
@@ -870,7 +870,7 @@ result:
870870
<a ng-href="http://domain.com/fetch/some=string=with=spaces">Link</a>
871871
-->
872872
```
873-
###startswith
873+
###startsWith
874874
return whether string starts with the starts parameter.<br/>
875875
usage: ```string | startsWith: 'start': case-sensitive[optional]```<br/>
876876
```html
@@ -880,7 +880,7 @@ usage: ```string | startsWith: 'start': case-sensitive[optional]```<br/>
880880
true
881881
false
882882
```
883-
###endswith
883+
###endsWith
884884
return whether string ends with the ends parameter.<br/>
885885
usage: ```string | endsWith: 'ends': case-sensitive[optional]```<br/>
886886
```html
@@ -890,7 +890,7 @@ usage: ```string | endsWith: 'ends': case-sensitive[optional]```<br/>
890890
true
891891
false
892892
```
893-
###striptags
893+
###stripTags
894894
strip out html tags from string<br/>
895895
**Important: this filter jobs it's not to replace ng-bind-html directive, it's only for tiny plain text
896896
@@ -939,7 +939,7 @@ lorem ipsum...
939939
lorem ipsum d...
940940
lorem ipsum dolor sit amet
941941
```
942-
###reverse string
942+
###reverse
943943
Reverses a string
944944
```js
945945
$scope.text = 'lorem ipsum dolor sit amet';
@@ -1069,7 +1069,7 @@ Converts degrees into radians<br/>
10691069
0.79
10701070
3.14159
10711071
```
1072-
###shortfmt
1072+
###shortFmt
10731073
Converts numbers into formatted display<br/>
10741074
**Usage:** ```number | shortFmt: round-to-decimal```,
10751075
```html
@@ -1079,7 +1079,7 @@ Converts numbers into formatted display<br/>
10791079
45 k
10801080
18.2 m
10811081
```
1082-
###bytefmt
1082+
###byteFmt
10831083
Converts bytes into formatted display<br/>
10841084
**Usage:** ```number | byteFmt: round-to-decimal```,
10851085
```html
@@ -1089,7 +1089,7 @@ Converts bytes into formatted display<br/>
10891089
1.95 KB
10901090
1.24726 GB
10911091
```
1092-
###kbfmt
1092+
###kbFmt
10931093
Converts kilobytes into formatted display<br/>
10941094
**Usage:** ```number | kbFmt: round-to-decimal```,
10951095
```html

0 commit comments

Comments
 (0)