Skip to content
This repository was archived by the owner on Feb 23, 2023. It is now read-only.

Commit 291562c

Browse files
committed
Update boolean pipe names in documentation
1 parent 1e996f2 commit 291562c

File tree

2 files changed

+47
-59
lines changed

2 files changed

+47
-59
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,15 @@ You can find the documentations in the [`docs`](./docs) folder.
6161
* [`notEqual`](./docs/boolean.md#notequal)
6262
* [`identical`](./docs/boolean.md#identical)
6363
* [`notIdentical`](./docs/boolean.md#notidentical)
64-
* [`null`](./docs/boolean.md#null)
65-
* [`undefined`](./docs/boolean.md#undefined)
66-
* [`nil`](./docs/boolean.md#nil)
67-
* [`number`](./docs/boolean.md#number)
68-
* [`string`](./docs/boolean.md#string)
69-
* [`function`](./docs/boolean.md#function)
70-
* [`array`](./docs/boolean.md#array)
71-
* [`object`](./docs/boolean.md#object)
72-
* [`defined`](./docs/boolean.md#defined)
64+
* [`isNull`](./docs/boolean.md#isnull)
65+
* [`isUndefined`](./docs/boolean.md#isundefined)
66+
* [`isNil`](./docs/boolean.md#isnil)
67+
* [`isNumber`](./docs/boolean.md#isnumber)
68+
* [`isString`](./docs/boolean.md#isstring)
69+
* [`isFunction`](./docs/boolean.md#isfunction)
70+
* [`isArray`](./docs/boolean.md#isarray)
71+
* [`isObject`](./docs/boolean.md#isobject)
72+
* [`isDefined`](./docs/boolean.md#isdefined)
7373

7474
### Math
7575

docs/boolean.md

Lines changed: 38 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88
* [`notEqual`](#notequal)
99
* [`identical`](#identical)
1010
* [`notIdentical`](#notidentical)
11-
* [`null`](#null)
12-
* [`undefined`](#undefined)
13-
* [`nil`](#nil)
14-
* [`number`](#number)
15-
* [`string`](#string)
16-
* [`function`](#function)
17-
* [`array`](#array)
18-
* [`object`](#object)
19-
* [`defined`](#defined)
11+
* [`isNull`](#isnull)
12+
* [`isUndefined`](#isundefined)
13+
* [`isNil`](#isnil)
14+
* [`isNumber`](#isnumber)
15+
* [`isString`](#isstring)
16+
* [`isFunction`](#isfunction)
17+
* [`isArray`](#isarray)
18+
* [`isObject`](#isobject)
19+
* [`isDefined`](#isdefined)
2020

2121
You can check the module import [`here`](./modules.md).
2222

@@ -167,7 +167,7 @@ import { IsNotIdenticalPipe } from 'angular-pipes/src/boolean/conditions.pipe';
167167
```
168168

169169

170-
####null
170+
####isnull
171171

172172
Returns true if the value if null.
173173

@@ -180,17 +180,11 @@ import { IsNullPipe } from 'angular-pipes/src/boolean/types.pipe';
180180
##### Usage
181181

182182
```html
183-
{{ null | null }} <!-- true -->
184-
{{ 1 | null }} <!-- false -->
183+
{{ null | isNull }} <!-- true -->
184+
{{ 1 | isNull }} <!-- false -->
185185
```
186186

187-
##### Notes
188-
189-
I actually need to make sure that `null` is not parsed as the JS keyword instead of the pipe.
190-
I'll update this soon.
191-
192-
193-
####undefined
187+
####isundefined
194188

195189
Returns true if the value if undefined.
196190

@@ -203,17 +197,11 @@ import { IsUndefinedPipe } from 'angular-pipes/src/boolean/types.pipe';
203197
##### Usage
204198

205199
```html
206-
{{ a | undefined }} <!-- true if a does not exists -->
207-
{{ 1 | undefined }} <!-- false -->
200+
{{ a | isUndefined }} <!-- true if a does not exists -->
201+
{{ 1 | isUndefined }} <!-- false -->
208202
```
209203

210-
##### Notes
211-
212-
I actually need to make sure that `undefined` is not parsed as the JS variable instead of the pipe.
213-
I'll update this soon.
214-
215-
216-
####nil
204+
####isnil
217205

218206
Returns true if the value if null or undefined.
219207

@@ -226,13 +214,13 @@ import { IsNilPipe } from 'angular-pipes/src/boolean/types.pipe';
226214
##### Usage
227215

228216
```html
229-
{{ a | nil }} <!-- true if a does not exists -->
230-
{{ null | nil }} <!-- true -->
231-
{{ 1 | nil }} <!-- false -->
217+
{{ a | isNil }} <!-- true if a does not exists -->
218+
{{ null | isNil }} <!-- true -->
219+
{{ 1 | isNil }} <!-- false -->
232220
```
233221

234222

235-
####number
223+
####isnumber
236224

237225
Returns true if the value is a number.
238226

@@ -245,11 +233,11 @@ import { IsNumberPipe } from 'angular-pipes/src/boolean/types.pipe';
245233
##### Usage
246234

247235
```html
248-
{{ 'a' | number }} <!-- false -->
249-
{{ 1 | number }} <!-- true -->
236+
{{ 'a' | isNumber }} <!-- false -->
237+
{{ 1 | isNumber }} <!-- true -->
250238
```
251239

252-
####string
240+
####isstring
253241

254242
Returns true if the value is a string.
255243

@@ -262,12 +250,12 @@ import { IsStringPipe } from 'angular-pipes/src/boolean/types.pipe';
262250
##### Usage
263251

264252
```html
265-
{{ 'a' | string }} <!-- true -->
266-
{{ 1 | string }} <!-- false -->
253+
{{ 'a' | isString }} <!-- true -->
254+
{{ 1 | isString }} <!-- false -->
267255
```
268256

269257

270-
####function
258+
####isfunction
271259

272260
Returns true if the value is a function.
273261

@@ -286,12 +274,12 @@ myFn() {
286274
```
287275

288276
```html
289-
{{ 'a' | function }} <!-- false -->
290-
{{ myFn | function }} <!-- true -->
277+
{{ 'a' | isFunction }} <!-- false -->
278+
{{ myFn | isFunction }} <!-- true -->
291279
```
292280

293281

294-
####array
282+
####isarray
295283

296284
Returns true if the value is an array.
297285

@@ -305,12 +293,12 @@ import { IsArrayPipe } from 'angular-pipes/src/boolean/types.pipe';
305293

306294

307295
```html
308-
{{ 'a' | array }} <!-- false -->
309-
{{ [] | array }} <!-- true -->
296+
{{ 'a' | isArray }} <!-- false -->
297+
{{ [] | isArray }} <!-- true -->
310298
```
311299

312300

313-
####object
301+
####isobject
314302

315303
Returns true if the value is an object.
316304

@@ -324,12 +312,12 @@ import { IsObjectPipe } from 'angular-pipes/src/boolean/types.pipe';
324312

325313

326314
```html
327-
{{ 'a' | object }} <!-- false -->
328-
{{ {} | object }} <!-- true -->
315+
{{ 'a' | isObject }} <!-- false -->
316+
{{ {} | isObject }} <!-- true -->
329317
```
330318

331319

332-
####defined
320+
####isdefined
333321

334322
Returns true if the value is defined (nor null nor undefined).
335323

@@ -343,7 +331,7 @@ import { IsDefinedPipe } from 'angular-pipes/src/boolean/types.pipe';
343331

344332

345333
```html
346-
{{ 'a' | defined }} <!-- true -->
347-
{{ null | defined }} <!-- false -->
348-
{{ a | defined }} <!-- false if a does not exists -->
334+
{{ 'a' | isDefined }} <!-- true -->
335+
{{ null | isDefined }} <!-- false -->
336+
{{ a | isDefined }} <!-- false if a does not exists -->
349337
```

0 commit comments

Comments
 (0)