Skip to content

Commit a0706b5

Browse files
docs(README.md): update
1 parent d811468 commit a0706b5

2 files changed

Lines changed: 184 additions & 180 deletions

File tree

README.md

Lines changed: 92 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@ Guard
172172
* [is](#is)
173173
* [isNot](#isnot)
174174
* [Guard](#guard)
175+
* [Common types](#common-types)
175176
* [Experimental](#Experimental)
176177
* [BigIntObject](#bigintobject)
177178
* [BooleanObject](#booleanobject)
@@ -180,7 +181,6 @@ Guard
180181
* [StringObject](#stringobject)
181182
* [SymbolObject](#symbolobject)
182183
* [isParam()](#isparam)
183-
* [Common types](#common-types)
184184
* [Git](#git)
185185
* [Commit](#commit)
186186
* [Versioning](#versioning)
@@ -402,7 +402,7 @@ isBoolean(BOOLEAN_INSTANCE); // true
402402
Use `isBooleanObject()` or `is.booleanObject()` to check if **any** `value` is an `object` type and instance of [`Boolean`][boolean] and [`Object`][object].
403403

404404
```typescript
405-
const isBooleanObject: IsBooleanObject = (value: any, callback: ResultCallback = resultCallback): value is boolean =>
405+
const isBooleanObject: IsBooleanObject = (value: any, callback: ResultCallback = resultCallback): value is Boolean =>
406406
callback(typeof value === 'object' && value instanceof Boolean === true && value instanceof Object === true, value);
407407
```
408408

@@ -683,7 +683,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is a `
683683
Use `isNumberObject()` or `is.numberObject()` to check if **any** `value` is an `object` type and instance of [`Number`][Number] and [`Object`][object].
684684

685685
```typescript
686-
const isNumberObject: IsNumberObject = (value: any, callback: ResultCallback = resultCallback): value is number =>
686+
const isNumberObject: IsNumberObject = (value: any, callback: ResultCallback = resultCallback): value is Number =>
687687
callback(typeof value === 'object' && value instanceof Number === true && value instanceof Object === true, value);
688688
```
689689

@@ -1852,6 +1852,95 @@ The **return value** is a `boolean` indicating whether or not the `value` is `un
18521852

18531853
----
18541854

1855+
## Common types
1856+
1857+
### AnyBoolean
1858+
1859+
```typescript
1860+
type AnyBoolean = Exclude<boolean | Boolean, true | false>;
1861+
```
1862+
1863+
### AnyNumber
1864+
1865+
```typescript
1866+
type AnyNumber = number | Number;
1867+
```
1868+
1869+
### AnyString
1870+
1871+
```typescript
1872+
type AnyString = string | String;
1873+
```
1874+
1875+
### Constructor
1876+
1877+
```typescript
1878+
type Constructor<Type> = new (...args: any[]) => Type;
1879+
```
1880+
1881+
### CycleHook
1882+
1883+
```typescript
1884+
type CycleHook = 'ngAfterContentInit' | 'ngAfterContentChecked' | 'ngAfterViewInit' | 'ngAfterViewChecked'
1885+
| 'ngAfterViewChecked' | 'ngOnInit' | 'ngOnDestroy' | 'ngOnChanges';
1886+
```
1887+
1888+
### Func
1889+
1890+
Function type.
1891+
1892+
```typescript
1893+
type Func = (...param: any) => any;
1894+
```
1895+
1896+
### Key
1897+
1898+
Name of the `object` property.
1899+
1900+
```typescript
1901+
type Key = number | string | symbol;
1902+
```
1903+
1904+
### Primitive
1905+
1906+
All [`Primitive`][primitive] types.
1907+
1908+
```typescript
1909+
type Primitive = bigint | boolean | null | number | string | symbol | undefined;
1910+
```
1911+
1912+
### Primitives
1913+
1914+
All [`Primitive`](#primitive) types as `string`.
1915+
1916+
```typescript
1917+
type Primitives = 'bigint' | 'boolean' | 'null' | 'number' | 'symbol' | 'string' | 'undefined';
1918+
```
1919+
1920+
### ResultCallback
1921+
1922+
```typescript
1923+
type ResultCallback = <Obj>(result: boolean, value?: any) => boolean;
1924+
```
1925+
1926+
### Type
1927+
1928+
Main types.
1929+
1930+
```typescript
1931+
type Type = Func | object | Primitive;
1932+
```
1933+
1934+
### Types
1935+
1936+
Main types as `string`.
1937+
1938+
```typescript
1939+
type Types<Obj> = Constructor<Obj> | 'function' | 'object' | Primitives;
1940+
```
1941+
1942+
----
1943+
18551944
## Experimental
18561945

18571946
### BigIntObject
@@ -2095,93 +2184,6 @@ resultTRUE === {
20952184

20962185
----
20972186

2098-
## Common types
2099-
2100-
### AnyBoolean
2101-
2102-
```typescript
2103-
type AnyBoolean = Exclude<boolean | Boolean, true | false>;
2104-
```
2105-
2106-
### AnyNumber
2107-
2108-
```typescript
2109-
type AnyNumber = number | Number;
2110-
```
2111-
2112-
### AnyString
2113-
2114-
```typescript
2115-
type AnyString = string | String;
2116-
```
2117-
2118-
### Constructor
2119-
2120-
```typescript
2121-
type Constructor<Type> = new (...args: any[]) => Type;
2122-
```
2123-
2124-
### CycleHook
2125-
2126-
```typescript
2127-
type CycleHook = 'ngAfterContentInit' | 'ngAfterContentChecked' | 'ngAfterViewInit' | 'ngAfterViewChecked'
2128-
| 'ngAfterViewChecked' | 'ngOnInit' | 'ngOnDestroy' | 'ngOnChanges';
2129-
```
2130-
2131-
### Func
2132-
2133-
Function type.
2134-
2135-
```typescript
2136-
type Func = (...param: any) => any;
2137-
```
2138-
2139-
### Key
2140-
2141-
Name of the `object` property.
2142-
2143-
```typescript
2144-
type Key = number | string | symbol;
2145-
```
2146-
2147-
### Primitive
2148-
2149-
All [`Primitive`][primitive] types.
2150-
2151-
```typescript
2152-
type Primitive = bigint | boolean | null | number | string | symbol | undefined;
2153-
```
2154-
2155-
### Primitives
2156-
2157-
All [`Primitive`](#primitive) types as `string`.
2158-
2159-
```typescript
2160-
type Primitives = 'bigint' | 'boolean' | 'null' | 'number' | 'symbol' | 'string' | 'undefined';
2161-
```
2162-
2163-
### ResultCallback
2164-
2165-
```typescript
2166-
type ResultCallback = <Obj>(result: boolean, value?: any) => boolean;
2167-
```
2168-
2169-
### Type
2170-
2171-
Main types.
2172-
2173-
```typescript
2174-
type Type = Func | object | Primitive;
2175-
```
2176-
2177-
### Types
2178-
2179-
Main types as `string`.
2180-
2181-
```typescript
2182-
type Types<Obj> = Constructor<Obj> | 'function' | 'object' | Primitives;
2183-
```
2184-
21852187
## GIT
21862188

21872189
### Commit

0 commit comments

Comments
 (0)