@@ -19,18 +19,16 @@ Install the peer dependencies:
1919yarn add ramda
2020```
2121
22+
23+ ## List of Pure Functions
24+
2225<table >
2326<thead >
2427<tr >
2528<th >
2629
2730Name
2831
29- </th >
30- <th >
31-
32- Category
33-
3432</th >
3533</tr >
3634</thead >
@@ -81,11 +79,6 @@ Category
8179- [ isNot (alias notEquals)] ( ./docs/pure/general.md#isnot_alias_notequals )
8280- [ isNotEqualDeep (alias notEqualsDeep)] ( ./docs/pure/general.md#isnotequaldeep_alias_notequalsdeep )
8381
84- </td >
85- <td style =" vertical-align : top ;" >
86-
87- [ Pure utility functions] ( ./docs/pure/README.md )
88-
8982</td >
9083</tr >
9184
@@ -103,10 +96,23 @@ yarn add "@bigbinary/neeto-cist@latest"
10396
10497## Usage
10598
106- This package exports five different sets of functions and components. Click on
107- them to read more:
99+ You can import all functions from ` @bigbinary/neeto-cist ` .
100+
101+ ``` js
102+ import { slugify } from " @bigbinary/neeto-cist" ;
103+ ```
104+
105+ Exports several general utility functions that are used throughout neeto
106+ products. The functions are designed in a similar fashion as ramda so that they
107+ can easily interoperate with each other.
108+
109+ Pure functions were designed to be fail fast. If you call ` findById(10, null) ` ,
110+ it will throw error saying that it can't iterate through ` null ` .
108111
109- 3 . [ Pure utility functions] ( ./docs/pure/README.md )
112+ But for most such pure functions, there is a failsafe alternative available. The
113+ failsafe alternative function will be prefixed with ` _ ` . Example:
114+ ` _findById(10, null) ` returns ` null ` , ` _findById(10, undefined) ` returns
115+ ` undefined ` and ` _findById(10, [{ id: 10 }]) ` returns ` { id: 10 } ` .
110116
111117## Other references
112118
0 commit comments