Skip to content

Commit c039118

Browse files
sciborrudnickisciborrudnicki
committed
docs(README.md): Remove Partial.
1 parent 4ee9789 commit c039118

2 files changed

Lines changed: 37 additions & 37 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
Useful packages based on the [angular.io](https://angular.io/).
44

5-
| Package | Description | Status | Readme |
6-
|------------------|------------------------------------------------------------------------------------------|---------------|-------------|
7-
| change-detection | Improve application performance. | *In Progress* | [Readme][cd-readme-github] |
8-
| prism | `Prism` highlighter module. | *In Progress* | [Readme][prism-readme-github] |
9-
| property | Features to handle properties. | *In Progress* | [Readme][property-readme-github] |
10-
| ui | User interface based on **[Spectre.css](https://github.com/picturepan2/spectre)**. | *In Progress* | [Github][ui-readme-github] |
11-
| type | Common types, type guards and checkers. | [![npm version][type-npm-svg]][type-npm-badge] | [Github][type-readme-github] \| [npm][type-readme-npm] |
5+
| Package | Description | Status | Readme |
6+
|------------------|-----------------------------------------------------------------------------------------|---------------|-------------|
7+
| change-detection | Improve application performance. | *In Progress* | [Readme][cd-readme-github] |
8+
| prism | `Prism` highlighter module. | *In Progress* | [Readme][prism-readme-github] |
9+
| property | Features to handle properties. | *In Progress* | [Readme][property-readme-github] |
10+
| ui | User interface based on **[Spectre.css](https://github.com/picturepan2/spectre)**. | *In Progress* | [Github][ui-readme-github] |
11+
| type | Common types, type guards and checkers. | [![npm version][type-npm-svg]][type-npm-badge] | [Github][type-readme-github] \| [npm][type-readme-npm] |
1212

1313
## angular-package/type
1414

15-
Common types, type guards and checkers.
15+
Common types, type guards and type checkers.
1616

1717
[![npm version](https://badge.fury.io/js/%40angular-package%2Ftype.svg)](https://badge.fury.io/js/%40angular-package%2Ftype)
1818
[![GitHub issues](https://img.shields.io/github/issues/angular-package/type)](https://github.com/angular-package/type/issues)
@@ -76,7 +76,7 @@ import { are, guard, is } from '@angular-package/type';
7676

7777
```typescript
7878
// Types.
79-
import { Constructor, CycleHook, Func, Partial, Primitive, Primitives, Types } from '@angular-package/type';
79+
import { Constructor, CycleHook, Func, Primitive, Primitives, Types } from '@angular-package/type';
8080
```
8181

8282
## Features
@@ -105,7 +105,7 @@ import { Constructor, CycleHook, Func, Partial, Primitive, Primitives, Types } f
105105
* a `'number'` type with [isNotNumber](#isNotNumber)
106106
* a `'string'` type with [isNotString](#isNotString)
107107
* a `'undefined'` type with [isNotUndefined](#isNotUndefined)
108-
* Guard the value to be
108+
* Guard the value to be
109109
* an `Array` of generic type with [guardArray](#guardArray).
110110
* a `function` type with [guardFunction](#guardFunction).
111111
* a `number` type with [guardNumber](#guardNumber).
@@ -155,17 +155,17 @@ npm i --save @angular-package/type
155155

156156
## are Object
157157

158-
Partial object `are` with some of **check are** functions.
158+
Object `are` with some of **check are** functions.
159159

160160
```typescript
161-
const are: Partial<Are> = {
161+
const are: Are = {
162162
string: areString
163163
};
164164
```
165165

166166
## guard Object
167167

168-
Partial object `guard` with all **guard** functions.
168+
Object `guard` with all **guard** functions.
169169

170170
```typescript
171171
const guardIs: GuardIs = {
@@ -178,18 +178,18 @@ const guardIs: GuardIs = {
178178
string: guardString,
179179
type: guardType
180180
};
181-
const guard: Partial<Guard> = {
181+
const guard: Guard = {
182182
is: guardIs
183183
};
184184

185185
```
186186

187187
## is Object
188188

189-
Partial object `is` with all **check is** functions and **check is not** in `not` property.
189+
Object `is` with all **check is** functions and **check is not** in `not` property.
190190

191191
```typescript
192-
const is: Partial<Is> = {
192+
const is: Is = {
193193
array: isArray,
194194
bigInt: isBigInt,
195195
boolean: isBoolean,
@@ -209,10 +209,10 @@ const is: Partial<Is> = {
209209

210210
## isNot Object
211211

212-
Partial object `isNot` with all **check is not** functions.
212+
Object `isNot` with all **check is not** functions.
213213

214214
```typescript
215-
const isNot: Partial<IsNot> = {
215+
const isNot: IsNot = {
216216
boolean: isNotBoolean,
217217
defined: isNotDefined,
218218
function: isNotFunction,
@@ -409,7 +409,7 @@ const isObject: IsObject = <Obj>(value: any, key?: string): value is Obj =>
409409
typeof value === 'object' &&
410410
value instanceof Object === true
411411
? isString(key) === true
412-
? key in value === true && (value as Obj).hasOwnProperty(key) === true
412+
? value.hasOwnProperty(key) === true
413413
: true
414414
: false;
415415
```

‎packages/type/README.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
Useful packages based on the [angular.io](https://angular.io/).
44

5-
| Package | Description | Status | Readme |
6-
|------------------|------------------------------------------------------------------------------------------|---------------|-------------|
7-
| change-detection | Improve application performance. | *In Progress* | [Readme][cd-readme-github] |
8-
| prism | `Prism` highlighter module. | *In Progress* | [Readme][prism-readme-github] |
9-
| property | Features to handle properties. | *In Progress* | [Readme][property-readme-github] |
10-
| ui | User interface based on **[Spectre.css](https://github.com/picturepan2/spectre)**. | *In Progress* | [Github][ui-readme-github] |
11-
| type | Common types, type guards and type checkers. | [![npm version][type-npm-svg]][type-npm-badge] | [Github][type-readme-github] \| [npm][type-readme-npm] |
5+
| Package | Description | Status | Readme |
6+
|------------------|-----------------------------------------------------------------------------------------|---------------|-------------|
7+
| change-detection | Improve application performance. | *In Progress* | [Readme][cd-readme-github] |
8+
| prism | `Prism` highlighter module. | *In Progress* | [Readme][prism-readme-github] |
9+
| property | Features to handle properties. | *In Progress* | [Readme][property-readme-github] |
10+
| ui | User interface based on **[Spectre.css](https://github.com/picturepan2/spectre)**. | *In Progress* | [Github][ui-readme-github] |
11+
| type | Common types, type guards and checkers. | [![npm version][type-npm-svg]][type-npm-badge] | [Github][type-readme-github] \| [npm][type-readme-npm] |
1212

1313
## angular-package/type
1414

@@ -76,7 +76,7 @@ import { are, guard, is } from '@angular-package/type';
7676

7777
```typescript
7878
// Types.
79-
import { Constructor, CycleHook, Func, Partial, Primitive, Primitives, Types } from '@angular-package/type';
79+
import { Constructor, CycleHook, Func, Primitive, Primitives, Types } from '@angular-package/type';
8080
```
8181

8282
## Features
@@ -105,7 +105,7 @@ import { Constructor, CycleHook, Func, Partial, Primitive, Primitives, Types } f
105105
* a `'number'` type with [isNotNumber](#isNotNumber)
106106
* a `'string'` type with [isNotString](#isNotString)
107107
* a `'undefined'` type with [isNotUndefined](#isNotUndefined)
108-
* Guard the value to be
108+
* Guard the value to be
109109
* an `Array` of generic type with [guardArray](#guardArray).
110110
* a `function` type with [guardFunction](#guardFunction).
111111
* a `number` type with [guardNumber](#guardNumber).
@@ -155,17 +155,17 @@ npm i --save @angular-package/type
155155

156156
## are Object
157157

158-
Partial object `are` with some of **check are** functions.
158+
Object `are` with some of **check are** functions.
159159

160160
```typescript
161-
const are: Partial<Are> = {
161+
const are: Are = {
162162
string: areString
163163
};
164164
```
165165

166166
## guard Object
167167

168-
Partial object `guard` with all **guard** functions.
168+
Object `guard` with all **guard** functions.
169169

170170
```typescript
171171
const guardIs: GuardIs = {
@@ -178,18 +178,18 @@ const guardIs: GuardIs = {
178178
string: guardString,
179179
type: guardType
180180
};
181-
const guard: Partial<Guard> = {
181+
const guard: Guard = {
182182
is: guardIs
183183
};
184184

185185
```
186186

187187
## is Object
188188

189-
Partial object `is` with all **check is** functions and **check is not** in `not` property.
189+
Object `is` with all **check is** functions and **check is not** in `not` property.
190190

191191
```typescript
192-
const is: Partial<Is> = {
192+
const is: Is = {
193193
array: isArray,
194194
bigInt: isBigInt,
195195
boolean: isBoolean,
@@ -209,10 +209,10 @@ const is: Partial<Is> = {
209209

210210
## isNot Object
211211

212-
Partial object `isNot` with all **check is not** functions.
212+
Object `isNot` with all **check is not** functions.
213213

214214
```typescript
215-
const isNot: Partial<IsNot> = {
215+
const isNot: IsNot = {
216216
boolean: isNotBoolean,
217217
defined: isNotDefined,
218218
function: isNotFunction,
@@ -409,7 +409,7 @@ const isObject: IsObject = <Obj>(value: any, key?: string): value is Obj =>
409409
typeof value === 'object' &&
410410
value instanceof Object === true
411411
? isString(key) === true
412-
? key in value === true && (value as Obj).hasOwnProperty(key) === true
412+
? value.hasOwnProperty(key) === true
413413
: true
414414
: false;
415415
```

0 commit comments

Comments
 (0)