diff --git a/README.md b/README.md index 2fce6030..6dadc8f2 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,11 @@ Useful packages based on the [angular.io](https://angular.io/). Common types, type guards and type checkers. -[![npm version](https://badge.fury.io/js/%40angular-package%2Ftype.svg)](https://badge.fury.io/js/%40angular-package%2Ftype) -[![GitHub issues](https://img.shields.io/github/issues/angular-package/type)](https://github.com/angular-package/type/issues) -[![GitHub forks](https://img.shields.io/github/forks/angular-package/type)](https://github.com/angular-package/type/network) -[![GitHub stars](https://img.shields.io/github/stars/angular-package/type)](https://github.com/angular-package/type/stargazers) -[![GitHub license](https://img.shields.io/github/license/angular-package/type)](https://github.com/angular-package/type/blob/main/LICENSE) +[![npm version][type-npm-svg]][type-npm-badge] +[![GitHub issues](https://img.shields.io/github/issues/angular-package/type)][issues] +[![GitHub forks](https://img.shields.io/github/forks/angular-package/type)][forks] +[![GitHub stars](https://img.shields.io/github/stars/angular-package/type)][stars] +[![GitHub license](https://img.shields.io/github/license/angular-package/type)][license] ```typescript // `guard` prefix functions. @@ -935,7 +935,7 @@ Use `isObjectKey()` or `is.objectKey()` to check if **any** `value` is an `objec The function uses [`hasOwnProperty`][hasownproperty] [`Object`][object] method to finds enumerable and non-enumerable [`Key`][key] as `string`, `number`, `symbol` unlike `Object.keys()` but it can't find accessor descriptor property unlike `in` operator which can. ```typescript -const isObjectKey: IsObjectKey = ( +const isObjectKey: IsObjectKey = ( value: any, key: Key | Key[], callback: ResultCallback = resultCallback @@ -1075,7 +1075,7 @@ isObjectKey(CLASS, [SYMBOL_NUMBER, SYMBOL_STRING]); // false Use `isObjectKeyIn()` or `is.objectKeyIn()` to check if **any** `value` is an [`Object`][object] with the `key` of the [`Key`][key] type by using the `in` operator. The function uses operator [`in`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/in) to find the key. ```typescript -const isObjectKeyIn: IsObjectKeyIn = ( +const isObjectKeyIn: IsObjectKeyIn = ( value: any, key: Key | Key[], callback: ResultCallback = resultCallback @@ -1825,13 +1825,13 @@ The **return value** is a `boolean` indicating whether or not the `value` is a ` Use `guardObject()` or `guard.is.object()` to guard the `value` to be an `object` of a generic `Obj` type. ```typescript -const guardObject: GuardObject = (value: Obj, callback?: ResultCallback): value is Obj => +const guardObject: GuardObject = (value: Obj, callback?: ResultCallback): value is Obj => isObject(value, callback); ``` | Parameter | Type | Description | | :-------- | :--------------------------------: | :------------------------------------ | -| value | `Obj` extends `object` | A generic `Obj` type `value` to guard | +| value | `Obj` | A generic `Obj` type `value` to guard | | callback? | [`ResultCallback`][resultcallback] | An Optional [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` | The **return value** is a `boolean` indicating whether or not the `value` is an `object` of a generic `Obj`. @@ -1852,14 +1852,14 @@ Use `guardObjectKey()` or `guard.is.objectKey()` to guard the `value` to be an ` ```typescript const guardObjectKey: GuardObjectKey = - (value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback): value is Obj => + (value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback): value is Obj => isObjectKey(value, key, callback); ``` | Parameter | Type | Description | | :---------- | :--------------------------------: | :--------------------------------------------------------------------- | | value | `Obj` | A generic `Obj` type `value` that contains the `key` to guard | -| key | `keyof Obj` \| `(keyof Obj)[]` | A key of `Obj` or an array key of `Obj` type as the name of the property that the `value` contains | +| key | `keyof Obj` \| `(keyof Obj)[]` | A key of `Obj` or an array key of `Obj` type as the name of the property that the `value` contains | | callback? | [`ResultCallback`][resultcallback] | An Optional [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` | The **return value** is a `boolean` indicating whether or not the `value` is an `object` of a generic `Obj` containing the `key`. @@ -2312,13 +2312,13 @@ resultTRUE === { ### Commit -* [AngularJS Git Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153) -* [Karma Git Commit Msg](http://karma-runner.github.io/0.10/dev/git-commit-msg.html) -* [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) +* [AngularJS Git Commit Message Conventions][angular-commit] +* [Karma Git Commit Msg][karma-commit] +* [Conventional Commits][conventional-commit] ### Versioning -[Semantic Versioning 2.0.0](http://semver.org/) +[Semantic Versioning 2.0.0][semver] **Given a version number MAJOR.MINOR.PATCH, increment the:** @@ -2338,14 +2338,46 @@ How do I know when to release 1.0.0? ## License -MIT © angular-package ([license](https://github.com/angular-package/type/blob/main/LICENSE)) +MIT © angular-package ([license][license]) +---- + + +[new]: https://img.shields.io/badge/-new-green +[update]: https://img.shields.io/badge/-update-red + + +[type-npm-svg]: https://badge.fury.io/js/%40angular-package%2Ftype.svg +[type-npm-badge]: https://badge.fury.io/js/%40angular-package%2Ftype + + +[cd-readme-github]: https://github.com/angular-package/change-detection#readme +[prism-readme-github]: https://github.com/angular-package/prism#readme +[property-readme-github]: https://github.com/angular-package/property#readme +[ui-readme-github]: https://github.com/angular-package/ui#readme +[type-readme-github]: https://github.com/angular-package/type#readme +[type-readme-npm]: https://www.npmjs.com/package/@angular-package/type#readme + + +[forks]: https://github.com/angular-package/type/network +[issues]: https://github.com/angular-package/type/issues +[license]: https://github.com/angular-package/type/blob/main/LICENSE +[stars]: https://github.com/angular-package/type/stargazers + + +[angular-commit]: https://gist.github.com/stephenparish/9941e89d80e2bc58a153 +[conventional-commit]: https://www.conventionalcommits.org/en/v1.0.0/ +[karma-commit]: http://karma-runner.github.io/0.10/dev/git-commit-msg.html +[semver]: http://semver.org/ + + [callback]: #callback [defined]: #defined [resultcallback]: #resultcallback [key]: #key [type]: #type + [array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array [classes]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes @@ -2372,21 +2404,10 @@ MIT © angular-package ([license](https://github.com/angular-package/type/blob/m [symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol [symbolconstructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/Symbol -[new]: https://img.shields.io/badge/-new-green -[update]: https://img.shields.io/badge/-update-red - -[type-npm-svg]: https://badge.fury.io/js/%40angular-package%2Ftype.svg -[type-npm-badge]: https://badge.fury.io/js/%40angular-package%2Ftype - -[cd-readme-github]: https://github.com/angular-package/change-detection#readme -[prism-readme-github]: https://github.com/angular-package/prism#readme -[property-readme-github]: https://github.com/angular-package/property#readme -[ui-readme-github]: https://github.com/angular-package/ui#readme -[type-readme-github]: https://github.com/angular-package/type#readme -[type-readme-npm]: https://www.npmjs.com/package/@angular-package/type#readme - + [are-string]: https://www.typescriptlang.org/play?jsx=0#code/C4TwDgpgBAkgzgZWAJwJYDsDmUC8UAUAbgIYA2ArhAFxTHogCUuAfFCRdKnFHChpgG4AUKEhQACmgC2qYKkIRueAOQAjVJgzBlUAD5Q1Ae0OkIdHfuXpyU1RGQWDcELZOPlvNFnfl0AEwgAMwwIP2VhAGNDdF4oLiQvTBp4BP5cAnZKGjpGGkzObk80nFZ8uJjgOgiIQ0CoVKw9fVEaurKcDqc+b0jo2IiACwgIgGt0-BaaSVQZOQU4ABooADpV4mRMOGz6BhpVY1M6FigAbyEoKFNgKGRFclJrvBRKYQurqCkIYAHDP2TEbqCc48ADuskGBBaTDOFwuEWIcGgHkByhon2+v3S8UBAigqluxBGr1hAUCxHuwDRXx+fixAMSuPxZiJwIAvsDAoZkAQohVaBsoLV+ZtocCLrc4BT0uiafh1pgGMSLqg6vgJVKOngyaREaLYbCmYSlVB2RdTTcvuRkOgLZKHsJWb0+esIA1sHh8KtlvKtrQdnsDmYbSUoINhiN8MjEsoll6fYqhEIAPRJqAANXWqGIqlMcCEvNiCAAKgAlGAAOQA4gB9NMAQQAMgBVACi6WUDa5ECkcTAkqkAH5wvm+tdy02ALIAIRbJdrjdb6QATAB2J2xKcAeU3DZbdfL8+bba1ZER6+uTfLABEWwAxCstq+H1vVosAdU36V8pJCfmE70vG973LR9nxbYQRxiEwIGWUhDEwOVbjdfBALvB8n3rI8lmLMsqzApZx2nWd8KgLcdz3A9MNbBhFSgFMoG1RFILgaDYPgxDXUBfAcIrGsqJbbDS14sCaNxejnggZjWLghCXWQni8P4wTcL4hcBNI7dd33ETaPoxjJILaT2LkriFNUrCNPI7SlPqITFLU0S6NTfSgA + [detect-bigint]: https://www.typescriptlang.org/play?target=7&jsx=0#code/MYewdgzgLgBAQgSQOIIHIBUBcMCGYCeMAvDAJwAM5A7AIymkBMArACxUvn01gDcMMAegEwo+AA4BTEADNiREgHIARgEsA5irBQFAKFCQQAGwkA6QyDUAKAAaIUGEeKmz5JACQBvUZJnxkadABfawBKHj1wCCNTcytbfwdNaDxgZ3h1BC1rABo-e3QYJKgUtLgMrTCIg2MzCxs7AMLIYrBU31QAVwBbJQkAJxy8xqKS9u7evsr9KJrY+oSCkda0gHklACsJYChBhsTm0dk1ze3KqpmYuutQ8OnYPfQAfTQAZXQAQVQAYQBRbDxCCQympMlBLAoKNQ6IxWOxOKQaAowoJhN40q4YMp1JptOdorU4g9nqg3p9fo4fC55DBPGjfETXh9vj9glNIvi5vF8sTScymsllvTyjtcgySUzyUs2rJgaC2dVLoSFjyJT9+S1pTBOj1+rtlYyyWqpWltRN5RcCfNuQa+cbfMctiKhhgVYb1YcYA7TuEgA [detect-boolean]: https://www.typescriptlang.org/play?target=7&jsx=0#code/MYewdgzgLgBAYgQQDIGUCiAuGBDMBPGAXhgDNsAbCAUwG4YB6emKPABypBKMOIHIAjECHJVcvAFChIwqgDpyIAOYAKAAaJUaZmw5cexACQBvFu07xk6AL6qAlDUngIM+UrUb0MAJaQouYLowAEJCIriqADQWmt6+-oEhMrj2jtIirirqllo+0PHmAPL8AFZUwFCR0Z65fmABhSVlUCmpzukKmXYOUtAwACoASgCqmDj4RMwATgCutAxMpoH6MAKhomASPS4daoMj2mZ6PDDGi+Z7aDYpW+1uqhexeXUJa+FRDzX5XIlhYNdO2zuHzizwapXKlWBT3qXCK4OaDlagM6-18VTQAH0AJIAORQfQQOIAwqNcARiGAqAB3YKvMDKMiUKj2eaPWow2lJMBI26ZDyY3H4wkkg5LY6nHTmfnYvEE4mXLo8uQ7LKaGVC+Vsr6c36VaWCuUiz6g7501FtZV3fWy4U5EEcuFNPXZdWGu3QwKO8otG6WlHdJywC6u21YMkTSk0n7rZRQGbMuis40c6O4JUZXbDAU2zVnI6GEySrjBg22q4BtJ+zMjEOa5MvLmQrO1o32hu-c3I6vZjWtj1gp3vZuluttgfehxAA [detect-function]: https://www.typescriptlang.org/play?target=7&jsx=0#code/C4TwDgpgBAYgrgOwMZQLxQBQDodgIYBOeAtgFxR4IgCUaAfBVQNwBQLSA9ggM7CwCqAOQDCAFQCSAeUHl4yNJgAe5BHGIAjCAQA0UEOV4EAlggDm1cpRD0oiqAGo9rTjw4AbCFjcdTGAAYwQmJSglCgkBwAZmio6ADkACQA3uEQUQIiEtIAvnF+utTOXNzunt6+AUFZoSa8lEhp0XJIwEZc+RnB0lC1wPWNsIgtbQjU7MWlXj7+gZkhPTx9yAOS6gBWEC0ds101i-3pqxstY0A @@ -2398,6 +2419,7 @@ MIT © angular-package ([license](https://github.com/angular-package/type/blob/m [detect-symbol]: https://www.typescriptlang.org/play?target=7&jsx=0#code/MYewdgzgLgBAcgVQLICECiAlAXDAhmATxgF4YBGABgGYKAWCgVgoG4AoUSWAZQE1UB5ADIB9RKkw58RUlwIBbAEYgANgAox6DAEo2HCCoCmAOmUgA5qoAGvASI2YYUAgAcDIAGYlipAOQASAG8nVw8YGxQhUWRNAF8fSx12cH1lY1MLaz4Iu2iHAEtOfGA3TxQQQ3xLABowrMj7DBgC6CKSmDKKsES9QxNzK3D63MbmqFbQgDEAVzBgKDzwatrbKPERwtm26dn58G7k3vSBupy1po3i0LgpxQMAJyXB081zls2rm4V7-chD-syVg1XmN3p5+AoAFYGOaPE6rF6jcZgyHQqA6GBJX6pPoZJ7w-IXNpcKB3ApmWGA4bApFhElkn4pNL-PFAxGgsLyJTKCnZfHrN6XTyyRQqRKYxk4qwJXTJbgAFQwAEk4ABxSSEEgwHwAQgAAgBiPwAUgAegAyABUqi0uAUwAAJgZ3GYABZ5CEAa2UcjAIGcd2gUwA7gQAF4+GWcZa8rgK5VqvAamSclSqWNK1UMv64uHp+OOFxtby+QLBIm5uOquLS8XZ44rPOq6nsjqpSo1PGNlXNwXtcptrqRiVHAExyvdtm97ZzBZgHmRLs9rYzGd7Id10cL8dLj63B4disZieE3dfO5Z7EjzvbydtcFQmEHhs3k-Ih9o9eX5mH-O30LE0kwHJJ8xyPHchTpICLyZHNnzAv8hRTbkQK3eDXw5EVlESIA [detect-undefined]: https://www.typescriptlang.org/play?target=7&jsx=0#code/MYewdgzgLgBAqgOQCIFEBiBJBKkC4YCGYAnjALwwCuYAJgKYBmAlmHTQNwBQokIANnQB0fEAHMAFAANEqTNiQwoxAA50QDcmQoByACQBvJavXxk6LDgC+2yQEouPCPyEiJ0s3JwwW0IsDUaaNTAUEzgkgA0prIWCj5QfgEwQWAhYWD23OBOAsJiUjLm8t6QCalJCJQAtgBGdABOkdFFXvGJJpW1DZmOznluhZ5xpe0aAPI1AFZ0IU2DsSW+5SYT0yH2MFm8ua4FHgttyxoAylD1LKJz+8WH-ian52CimVs5LvmSdlwCsGAgUEhGCw2PgiMQHNk+rtJH8AUDWDRFCoklodAYjElYYDmAjrF9XlCPlj4WxFmU7oFgqFwlFiTjSbckik0uAepCdkT-tjgYjGR1qnVGrSuSTeSMjjBOoK2dt3m46TyyaMYKsZlAmgqEUqJar1hDZf0pJqGeKKTAHhcNSL6WKlmaLU9MkA + [is-array]: https://www.typescriptlang.org/play?jsx=0#code/MYewdgzgLgBFCeAHApgeQGYwLwwBQDcBDAGwFdkAuGQseASiugCcBLMAc2wD4ZUAjAFbJgUAHSImIKFKTJR0gMpRWHUcBLECJcnVERiLYMlwAOADQwAtAEZd0gDIgA7siYBhQhGN0A3ACgEFBgABVYAWxYoFnxkbBg+EBBiZBoYAB94lnY2WAywUmJidJh8sL5XYuY2TgyIeDKk4tIwABNkdDZkFv9A2IBJCABBJiZCeDitMkpqWjpuGCIpmBYIGGHR+AAeGnguf1BIWBX1saoBk-GcTYAVWS5J8iodhgXtWJW1kbGbu+4-GDgsgwD2Qcyw4JgAHJCF94JCYAAyBH-T4bUTHWEgsEQ5TkRHIgGLPFsaA0IwgTAXbA4ph4pEo3oU15LcE4SEgQTCKCQ-bgaAwBTXABKfQAcgBxOKQxxMZBhZaICCkMIAfh5fgO-NFAFUALIAIQAokK4gAmADsvMOMH1qFQ9kNg1FcXQJC8Vv52tFABFDQAxMWG71xZptDpgLoe2CDIVCwYATUFIolVAumyqHB4OAA2tDIRZIXx81DgJCALpRtaxhM6g3G1OwzalcpMLMwbPWCymiwAZgrGr50er8eCIt1fWufQAaoaGxtNqEWBEojE29moRn2MWLRZcbF+5rYAApBSoUUAfSng3s2sNcQA3uhElRrKaewBfD1JOTEEDsXAAAZJmK4oARYGIbLgwESnQvgwAA9PBMCusQXgDpA36iL+-4AbWRpCmByxDJieHGrBPgIUhKFeDA6EQJh2GAba9qOqKhEQWMuDMQ6TrkZRyFusgdEMX+gFer6AaikG7HEZB4n+oG3p8YhAmoUJmoiThMZxomwogTJFy4NpCbQeKylIXuwnJFhokAcZ8akQR4GyZx9mOeZcC0upfKaYB9mjn046TjOBmYv5Y4TtOhoeZZGnWYxAEnmel7XreoWQUlF5Xje0VwSp1FCUAA [is-bigint]: https://www.typescriptlang.org/play?target=7&jsx=0#code/MYewdgzgLgBFCeAHApgeQGYwLwwBQDcBDAGwFdkAuGQseASiugCcBLMAc2wD4ZUAjAFbJgUAHSImIKFKTJR0gMpRWHUcBLECJcnVERiLYMlwAOADQwAtAEZd0gDIgA7siYBhQhGN0A3ACgEFBgASQgAIRZ2YLBYHC0ySmpaOm4YIgSYFggYPki2KH9QSFgsiKiYqlCy6Ni8dPIqGnoqeuRM7Nz2fO4-GDhZDHidbCwcAHJO-LGYADIZ3v6UEExWkfHJmLHC8GgYBQAVACVggDkAcWwYMccmZABbTMQIUjuAfi2-It2TgFUAWTCAFFDpcAEwAdm2xRgYVQqHsgIAgidLugSF4obswsEzqd9pcAJwABiJ4OsBIJoIArAAWcE0okU6xgTEgYhyYggdi4AAGB2O5x5FlKkRquH5pzOdF8MAA9LKYGjiF5Pjs2RyubzfgDgUL2tUYrhtUDDtKfHKFUqVV91aJOdyebD4UiTnqReUoLgnQjkWaLYr0chVZBbfbedjcSd9m7wqLDRG8X75XAmOQ-EA [is-boolean]: https://www.typescriptlang.org/play?target=7&jsx=0#code/MYewdgzgLgBFCeAHApgeQGYwLwwBQDcBDAGwFdkAuGQseASiugCcBLMAc2wD4ZUAjAFbJgUAHSImIKFKTJR0gMpRWHUcBLECJcnVERiLYMlwAOADQwAtAEZd0gDIgA7siYBhQhGN0A3ACgEFBgASQgAIRAQYmQabDwiMkpqWjpuGATyGBYIGD5I6Jp-UEhYbIiomLAqUPKCsDitRKoaeioM5CycvIrYrC4-GDhZDEadbCwcAHJuusmYADJ5gbxlwdxVwaGUEEx28amQQWEoOcWNwb22aBojHZhayv24Jkyzzc3LkpvkO-4hESeynIGzoGwAPmCNut3hdtB0rlBvncHr0JjB0CQvAsljD0nCsl8wLdMH9jk8McQsW8YYEfrt8RMpjNKqccTDRh1Gc9MhC8YlyZjkKD3sKYL4-MVoDAFAAVABKwQAcgBxOKTRxMZAAWyyiAgpC1AH5JkVwFLFQBVACyYQAonK4gAmADsppK91QqHstoAgoq4hSvG6pWFPd6-QB9eUW21xIHIYOwUNe32KiNK2V+tyxnBgZBOe75Sq4QNC4MVUTEEDsXAAA1lCpVtYsZSLNFwDaVyrovhgAHo++jBRKzRWqzXa5abfbm50UWBcFO7XKez5+4PSyPIGPq3Xk+HFbPWz0F-vU6v19zkFuIDuJ2fI9HbUfwm3T2HU1G5TGLwOrze7z3D9IwzGUs2fFtXxPXAHzTUDwN-Qd4z8IA @@ -2412,6 +2434,7 @@ MIT © angular-package ([license](https://github.com/angular-package/type/blob/m [is-type]: https://www.typescriptlang.org/play?target=7&jsx=0#code/FAFwngDgpgBAwgewHYGcQCcCuBjED0A8AKpFAHwwC8MSUA7jABQB0rAhugOYoBcMbSMAG0AugEoqFEtADcoUjAAK6AJYBbFSBUA3KCiowA5ACMVnFUhCGYAHyPGECADZQB1u4aSY1xqOndGKGA+zgGGaKpInGGYSAAmUABmFlBxhnLg0DAAYrHYBiysEBxsanwCYBKUFBUZCtJ6BADyxgBWFNSIqBg4eIQt7bZGiXlayGEIbVC4Acrqmjp6dVkAkigNBsSkZIzabE6YUOWCADQwmUcwDShb0GRVFHsHsCr6DXIWIH6JbNiwTSsYABvGAADz4Xh8fhgAF8PpZvr9-gDgTAwHwIhZOLC5PJVigAEJmFaWApPQ7HSqSGDkl76UzmSzLWBrAmOFwCMn7Cn8QQPGncukwBzOVxIZkwNa5JC4FTILnPSn82kwV45PIStYktACP6bAY7WmUs4WHUyy5dCK9fDNNr3akqtUDTUoABy3l86AVPIqysFqv0kM9LoG0xA+rtu0FxpgAGsoGAAPwYjBYv3PAMwZ14lkoADKqai3suvod-rVmKiLrzwQcTmLSrLGYrtecLoAqvEkik4g3eVTqgLm-pYglkrQ4rjsMg0AGiZwSSA+KziaTqFHFf2xHxHfSzJ9qRcEIkh4cqJRqCZ95Z0sBp905+yxcvCU-OeujVud+X6W+kNSNzPU0QF1KBjxgNlRU5AAyaDTxebpQPA0NcAkGw7EYQDYAvagelgdD4PPagficFAoAkWDzlIcCVRw+w-0MMQ5HvWdXmlWVkBfdixn-D9oy-Qi1XYw9qJPWiL2GUY5SQaxKMdRDzXA7jpJgOTywUv5kKmXBmJncNXm1EDzRfQzQIjdosJjYDQL4S0elwG0DW3QT9AGAD5LNTST2s81VLg14C0iThGB8v5mAgdAEDwC5mBY+y+mYJBSnIvyAxQkBbQs2kxCYu89IDd0oXQF9Cs9PtfW-YcaA9aFByPMT-Tozwav8GBEwDbILE0KAsIkSqgI0sCT1K6E1ObQatNaMNdIfV50pfdLzMNfiKjOeMkxTILnN3LM2hE6AaMaiTDEmKaZlSjyjK83azvDMazwAQgkrwnHrdqAsLYL1okdr1tVf8VT4PCYD4EiyJm1j80+l9Aqxcq+X6oVK2xQdGHqwimtOsNZLgy6kJPRb7oQzyhpgWGojQux0fEy9kdvOKAxrEInBh1t6z4zcKpcmAgmZ-bSZpwI2fp-LXk7McexfcXuwneHKkRzNRxl1ImzPOilfHFXKOpo7Lw1ntbzy2b1lIF8NmoW5yEs-szguPhrkt+4FbVc2KCBYAYFVE8QqhoK0dIHLgQ9z2eboTRsAACyYC4JHdkOQ+wNgyPsa8rD4dAoBATB0H-V550XXq5Hjz3E+TkwGPTzPs9z18oKQQvg-j0vYEMEYZR4wxK6znOOqk5AG+LmBm6MIM-E7mAM+7muRvQAfi+Hk7tLTieq57ual8duem6Tlu6a76vGc+reE53oXmfHyeD4Ctnj5L0-DH1icL9Xmvpc1uJj5hYOv89y+e4uNqAZTLmk3rSW2AcQYwDBlAOQcJgB3icEnfQeYEBqCgHARBKB9AglBAYAAjDIWEQ9MHINQVAIgdAEAYKQaiMABgABMhCv4MzgE0V0eYiAACV2xwCIE0ThBhaAMBQWg6hWDGC5RYWwjh3DeH8KIAAdSaII+gZMyEUKoSQiRENwwEiaE0AAMgAUQAIKugMNAnREEVgAHEViuiIAYAAnAABhcQAdjwU4px9CACsAAWdx-iXHeLweKI2s5sjtldHAPgwl1zgmqkVfkuCADUMACERPDK6dsABZAkRiBHUDwfQ9xVimgEgAFJGN4XwFE1AcF8DwTiLJWYqk1L4UQAAEoUup9TaF8BOrQawcCGYyPsTYgwhhcl0NHl6V4IsHx5gAJr5MMQYJmdZGCGDUGARiVjokABEjHZHsUYw5BhH6pCnDOUUzAnAIGCgAA1YewrhPC+GcKeSaE20ACAiPQSQnYryZEfPkUos4AKxEoByoQgA9HCqB+wyIRLuQ855ejDGmNdN8gMDQCAig5EgHYmLjFmLOOXOujEmIwARecLAUBUUuHuY8xgTyCS2PsUQXFrx8XIxJZyhxFKGSfGpfCxFeEmVQBZc8nJ+TCk8t+VAAgcydhyoKZwilcyxW0olQyqVMq2VRJiYq-F7EdjGrgBStuHEZKwt1fSw4Br0VsvGa6GxprSAEH5YwN1NiKV03tXSyVLE0WsqeRU6pvDPV-P0SsHYkaOkUqxjMINeqnWhuZS6p5Ky1kGJjcqn1ua9EGIDcLNNjrGWZuldmo5JyzmHILYwOtpzXTnIpVctIFbJVAA [is-undefined]: https://www.typescriptlang.org/play?jsx=0#code/MYewdgzgLgBFCeAHApgeQGYwLwwBQDcBDAGwFdkAuGQseASiugCcBLMAc2wD4ZUAjAFbJgUAHSImIKFKTJR0gMpRWHUcBLECJcnVERiLYMlwAOADQwAtAEZd0gDIgA7siYBhQhGN0A3ACgEFBgASQgAVTAAE2R0NmRI7DwiMkpqWjpuGGTyGBYIGFIomLjI-1BIWDyI6NiweKpQ6uK6hJwtFKoaeips5Fz8wpqS7j8YOFkMdp1sLBwAckHm+LmYADJV0fGUEExemfnF2uW1jbG92ZxDkv8-cugYBQAVACVggDkAcUS5xyZkAFtcogIKR-gB+OZlcD3N5hACyACEAKLPRIAJgA7FCKjAEahUPYkQBBN6JdAkLz+YjIWDUqBXFrY+5hN4AESRADF3kjWYkGfEbncQNTRMQQOxcAADJ6vT6SixVIpHSK4GXvD50XwwAD02pg5OIXlu0OFcjFEslsMRKPl-SaytwVuRz01Ph1eoNRqFIvNUrxBOJb1tiqGLVw-sJJNd7v1FOQxsgptF4qldP5kWD4SVJVwaezLWjurgTHICYgSd9kpZ7K5bx5mftOernO5rMLHrjfiAA + [guard-array]: https://www.typescriptlang.org/play?jsx=0#code/C4TwDgpgBACgTgSwLYOAgbtAvFARge3wBsIBDAOygB88EBzBc4aqcgVyKJfaVwjhYBnYInJ0hIXsRZtyAEwgAzRhDkBuAFChIUAJKCAgnDikQUHAB4AKuAgA+ABTpSRNhABcUCiACU5u1DOrtAIglBGJiDWtnaa2tAA4mykcHIRpuZQ0ZCOQW6e6VE2OX5YAXkhYYXZ9poaAMb45MJQoYWe+oWZNbku+V7kvp4VrVXGpj3+4eMgAHRtM059EH4AZKuBy63NwBT1EPiK05GajTtQdMmp7VBJKWkz3cX2S8EFMz0+w1uhxxPPATKo2qANebh8dTOLQAylYAEq6AByCUyAHIADL4OAQJCtMCCNhIAD8qNOTRaiIAqgBZABCAFE4ZkAEwAdjJ51pAHkuej6QZEZlFC5BBAOS1KYiACL0gBiSPpUsysgUynIqnFzAMcLhBgAmgB9WEI5HvSIWYSiOiAqAAbVRpFRABooKjcM7XfVUQBdTXhHX6g1UumMs0THh8OA221sl0AZlZ8bjvoa5K1AcNMAR1N0Vl0ADV6WGovBkKgMPZMrbXZbGHQPbGoCI3FAU1D07rDZKZfLEYrixYVUoVHJo0O1aoXeOR1P5MP1XI22moAApaFcwU4ADeikIngAjMy4wBfSHk4gQWZEfB0BwAA21nYNWd0ObzhbvLsu92qpZQaEwRxH0DF83wLekfAhKAAHpoKbOA3FTZoLyvG972Aw1gwZOFPwuK4HnNCN+CAjMgxpbDILUGC4ObCAkMEFDr1vB9SONJEElw79rg+WsxBIp82ORSjqPgxCoUYtCWKfbs5QVKVOPw6ppwXfjAxk3tFWE2DRLo+iJOYwSOK-RSeJEOtHEMrS4OFIhRT0khUOYrDGQUn8PiIqMHGcuErKgGy7PEhymPvbleX5RFXO480CAvChHFCvkBV8-y6MCy9grvdS5MigiJmU1RHCyvspWSkVUvPILJLXDccuqfBcAAKwgepgEcarEVK2y6KAA [guard-function]: https://www.typescriptlang.org/play?target=7&jsx=0#code/C4TwDgpgBAYgrgOwMZQLxQBQDodgIYBOeAtgFxR4IgCUaAfBVQNwBQokUAkgM7zLABLAPYI0mAG54ANnAjlKNelEkzoA7rERJWSEd2BR1fJIJHkex06PQYVs+VWrk7ajcfosoUdhCEAzZWlZNFR0AHI-LSswqAAyWMDVQwR9SiRfAMthUXjE4IEU4DSMqAB5ACMAKwgTVh8oAHE4QgATLJExDEjkcmNaVAZulHVNZB09AwBzZoI2qOzyJtb260wh3q0nKCHDNy0lI3mRLs3WFl1CqAAhUtKAGQBRAEEAOTE-aW4IccurzgbOC8ACpiACcAAZwQB2ACMoNBACYAKwAFihKPB8JhCB++igLwAqgBZK4PABKYhhCKhuIMAGUgWTAQ0xGEiSAoAg4MRyhACLswmcLniYASXgBhIGcUovAD6QIAmgAFB4bZCdAAe5C5PL5WwUSgA3lACBBgHACKINVAANRQJFMKAAX3OUjw3A04omBDgJiEBHFbo9UGN1vQDud5wmUHFMoZZIJktKZNl4ruTzpdLECAgAHcY97fcB-YH3dwMNQhXohFIIFgpEJJhgAAaiiVSmXy5UPZsAGig02WRwQGDbkulcsVKuolagAHo594fRAoyka3WG03m17Cj6-QGg9w+wOZnN+NkMDv9HviweyzPHQul8FynADAJ3xoEEIDO4geAV2Fdd60bDAwljF540TIFk1TdNMzCftB1mFZLzjRloNgtMMzpB950XD4pC+VduGAzcwJue5njlAA1J47gJB5EJPIdz2OSjHlePCn0I4igNrECmzCQkSXJWU6IYpikNPVCRNJMluIIz4VyAA [guard-number]: https://www.typescriptlang.org/play?jsx=0#code/C4TwDgpgBA4grgQwE4BMBycC2AjCSoC8UAFAG4IA2cEAXFAHZa5ICUhAfFOVdAJYDODJngDcAKFCQoASX4YceQiW7U6CeiDYFOKvoMYKk4gMYB7ev2BQB85nVm3FRMpVVR1muruv7h+bVCSEKYAZlyu0ARRUADkBswxUAD8PgBivPS8wBAuPGxeEdYWwOrGwWGO+ABkVeE8RZal5VAA8tgAVhDGwCbmllAA5oiolXTwyOh+Srlu8XgsBfUCQoYcPpUzECziYmbFUGgAqgCyAEIAogBKAPotaOdKAEwA7L37R2dX1wAqAOotSgAjC83v0Phcbt8ABKXc4PIiPEG7PpWcFfVItQ6XJQxADMLxiOz2-FMFAgADoKKYBsQAAZom53c60gA0g2Gk0MxAZt3uLG2yIspIpVJp9JOEJ+-1Z7ImGx5fxa-NBwsp1LpCphcJlQzlfm5Eq+0Nh52VgpJZLVYp5GKxOo58sNN1tl2VUAA9O7ZagoAB3UxIADW-DEQA diff --git a/packages/type/README.md b/packages/type/README.md index 2fce6030..6dadc8f2 100644 --- a/packages/type/README.md +++ b/packages/type/README.md @@ -14,11 +14,11 @@ Useful packages based on the [angular.io](https://angular.io/). Common types, type guards and type checkers. -[![npm version](https://badge.fury.io/js/%40angular-package%2Ftype.svg)](https://badge.fury.io/js/%40angular-package%2Ftype) -[![GitHub issues](https://img.shields.io/github/issues/angular-package/type)](https://github.com/angular-package/type/issues) -[![GitHub forks](https://img.shields.io/github/forks/angular-package/type)](https://github.com/angular-package/type/network) -[![GitHub stars](https://img.shields.io/github/stars/angular-package/type)](https://github.com/angular-package/type/stargazers) -[![GitHub license](https://img.shields.io/github/license/angular-package/type)](https://github.com/angular-package/type/blob/main/LICENSE) +[![npm version][type-npm-svg]][type-npm-badge] +[![GitHub issues](https://img.shields.io/github/issues/angular-package/type)][issues] +[![GitHub forks](https://img.shields.io/github/forks/angular-package/type)][forks] +[![GitHub stars](https://img.shields.io/github/stars/angular-package/type)][stars] +[![GitHub license](https://img.shields.io/github/license/angular-package/type)][license] ```typescript // `guard` prefix functions. @@ -935,7 +935,7 @@ Use `isObjectKey()` or `is.objectKey()` to check if **any** `value` is an `objec The function uses [`hasOwnProperty`][hasownproperty] [`Object`][object] method to finds enumerable and non-enumerable [`Key`][key] as `string`, `number`, `symbol` unlike `Object.keys()` but it can't find accessor descriptor property unlike `in` operator which can. ```typescript -const isObjectKey: IsObjectKey = ( +const isObjectKey: IsObjectKey = ( value: any, key: Key | Key[], callback: ResultCallback = resultCallback @@ -1075,7 +1075,7 @@ isObjectKey(CLASS, [SYMBOL_NUMBER, SYMBOL_STRING]); // false Use `isObjectKeyIn()` or `is.objectKeyIn()` to check if **any** `value` is an [`Object`][object] with the `key` of the [`Key`][key] type by using the `in` operator. The function uses operator [`in`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/in) to find the key. ```typescript -const isObjectKeyIn: IsObjectKeyIn = ( +const isObjectKeyIn: IsObjectKeyIn = ( value: any, key: Key | Key[], callback: ResultCallback = resultCallback @@ -1825,13 +1825,13 @@ The **return value** is a `boolean` indicating whether or not the `value` is a ` Use `guardObject()` or `guard.is.object()` to guard the `value` to be an `object` of a generic `Obj` type. ```typescript -const guardObject: GuardObject = (value: Obj, callback?: ResultCallback): value is Obj => +const guardObject: GuardObject = (value: Obj, callback?: ResultCallback): value is Obj => isObject(value, callback); ``` | Parameter | Type | Description | | :-------- | :--------------------------------: | :------------------------------------ | -| value | `Obj` extends `object` | A generic `Obj` type `value` to guard | +| value | `Obj` | A generic `Obj` type `value` to guard | | callback? | [`ResultCallback`][resultcallback] | An Optional [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` | The **return value** is a `boolean` indicating whether or not the `value` is an `object` of a generic `Obj`. @@ -1852,14 +1852,14 @@ Use `guardObjectKey()` or `guard.is.objectKey()` to guard the `value` to be an ` ```typescript const guardObjectKey: GuardObjectKey = - (value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback): value is Obj => + (value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback): value is Obj => isObjectKey(value, key, callback); ``` | Parameter | Type | Description | | :---------- | :--------------------------------: | :--------------------------------------------------------------------- | | value | `Obj` | A generic `Obj` type `value` that contains the `key` to guard | -| key | `keyof Obj` \| `(keyof Obj)[]` | A key of `Obj` or an array key of `Obj` type as the name of the property that the `value` contains | +| key | `keyof Obj` \| `(keyof Obj)[]` | A key of `Obj` or an array key of `Obj` type as the name of the property that the `value` contains | | callback? | [`ResultCallback`][resultcallback] | An Optional [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` | The **return value** is a `boolean` indicating whether or not the `value` is an `object` of a generic `Obj` containing the `key`. @@ -2312,13 +2312,13 @@ resultTRUE === { ### Commit -* [AngularJS Git Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153) -* [Karma Git Commit Msg](http://karma-runner.github.io/0.10/dev/git-commit-msg.html) -* [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) +* [AngularJS Git Commit Message Conventions][angular-commit] +* [Karma Git Commit Msg][karma-commit] +* [Conventional Commits][conventional-commit] ### Versioning -[Semantic Versioning 2.0.0](http://semver.org/) +[Semantic Versioning 2.0.0][semver] **Given a version number MAJOR.MINOR.PATCH, increment the:** @@ -2338,14 +2338,46 @@ How do I know when to release 1.0.0? ## License -MIT © angular-package ([license](https://github.com/angular-package/type/blob/main/LICENSE)) +MIT © angular-package ([license][license]) +---- + + +[new]: https://img.shields.io/badge/-new-green +[update]: https://img.shields.io/badge/-update-red + + +[type-npm-svg]: https://badge.fury.io/js/%40angular-package%2Ftype.svg +[type-npm-badge]: https://badge.fury.io/js/%40angular-package%2Ftype + + +[cd-readme-github]: https://github.com/angular-package/change-detection#readme +[prism-readme-github]: https://github.com/angular-package/prism#readme +[property-readme-github]: https://github.com/angular-package/property#readme +[ui-readme-github]: https://github.com/angular-package/ui#readme +[type-readme-github]: https://github.com/angular-package/type#readme +[type-readme-npm]: https://www.npmjs.com/package/@angular-package/type#readme + + +[forks]: https://github.com/angular-package/type/network +[issues]: https://github.com/angular-package/type/issues +[license]: https://github.com/angular-package/type/blob/main/LICENSE +[stars]: https://github.com/angular-package/type/stargazers + + +[angular-commit]: https://gist.github.com/stephenparish/9941e89d80e2bc58a153 +[conventional-commit]: https://www.conventionalcommits.org/en/v1.0.0/ +[karma-commit]: http://karma-runner.github.io/0.10/dev/git-commit-msg.html +[semver]: http://semver.org/ + + [callback]: #callback [defined]: #defined [resultcallback]: #resultcallback [key]: #key [type]: #type + [array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array [classes]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes @@ -2372,21 +2404,10 @@ MIT © angular-package ([license](https://github.com/angular-package/type/blob/m [symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol [symbolconstructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/Symbol -[new]: https://img.shields.io/badge/-new-green -[update]: https://img.shields.io/badge/-update-red - -[type-npm-svg]: https://badge.fury.io/js/%40angular-package%2Ftype.svg -[type-npm-badge]: https://badge.fury.io/js/%40angular-package%2Ftype - -[cd-readme-github]: https://github.com/angular-package/change-detection#readme -[prism-readme-github]: https://github.com/angular-package/prism#readme -[property-readme-github]: https://github.com/angular-package/property#readme -[ui-readme-github]: https://github.com/angular-package/ui#readme -[type-readme-github]: https://github.com/angular-package/type#readme -[type-readme-npm]: https://www.npmjs.com/package/@angular-package/type#readme - + [are-string]: https://www.typescriptlang.org/play?jsx=0#code/C4TwDgpgBAkgzgZWAJwJYDsDmUC8UAUAbgIYA2ArhAFxTHogCUuAfFCRdKnFHChpgG4AUKEhQACmgC2qYKkIRueAOQAjVJgzBlUAD5Q1Ae0OkIdHfuXpyU1RGQWDcELZOPlvNFnfl0AEwgAMwwIP2VhAGNDdF4oLiQvTBp4BP5cAnZKGjpGGkzObk80nFZ8uJjgOgiIQ0CoVKw9fVEaurKcDqc+b0jo2IiACwgIgGt0-BaaSVQZOQU4ABooADpV4mRMOGz6BhpVY1M6FigAbyEoKFNgKGRFclJrvBRKYQurqCkIYAHDP2TEbqCc48ADuskGBBaTDOFwuEWIcGgHkByhon2+v3S8UBAigqluxBGr1hAUCxHuwDRXx+fixAMSuPxZiJwIAvsDAoZkAQohVaBsoLV+ZtocCLrc4BT0uiafh1pgGMSLqg6vgJVKOngyaREaLYbCmYSlVB2RdTTcvuRkOgLZKHsJWb0+esIA1sHh8KtlvKtrQdnsDmYbSUoINhiN8MjEsoll6fYqhEIAPRJqAANXWqGIqlMcCEvNiCAAKgAlGAAOQA4gB9NMAQQAMgBVACi6WUDa5ECkcTAkqkAH5wvm+tdy02ALIAIRbJdrjdb6QATAB2J2xKcAeU3DZbdfL8+bba1ZER6+uTfLABEWwAxCstq+H1vVosAdU36V8pJCfmE70vG973LR9nxbYQRxiEwIGWUhDEwOVbjdfBALvB8n3rI8lmLMsqzApZx2nWd8KgLcdz3A9MNbBhFSgFMoG1RFILgaDYPgxDXUBfAcIrGsqJbbDS14sCaNxejnggZjWLghCXWQni8P4wTcL4hcBNI7dd33ETaPoxjJILaT2LkriFNUrCNPI7SlPqITFLU0S6NTfSgA + [detect-bigint]: https://www.typescriptlang.org/play?target=7&jsx=0#code/MYewdgzgLgBAQgSQOIIHIBUBcMCGYCeMAvDAJwAM5A7AIymkBMArACxUvn01gDcMMAegEwo+AA4BTEADNiREgHIARgEsA5irBQFAKFCQQAGwkA6QyDUAKAAaIUGEeKmz5JACQBvUZJnxkadABfawBKHj1wCCNTcytbfwdNaDxgZ3h1BC1rABo-e3QYJKgUtLgMrTCIg2MzCxs7AMLIYrBU31QAVwBbJQkAJxy8xqKS9u7evsr9KJrY+oSCkda0gHklACsJYChBhsTm0dk1ze3KqpmYuutQ8OnYPfQAfTQAZXQAQVQAYQBRbDxCCQympMlBLAoKNQ6IxWOxOKQaAowoJhN40q4YMp1JptOdorU4g9nqg3p9fo4fC55DBPGjfETXh9vj9glNIvi5vF8sTScymsllvTyjtcgySUzyUs2rJgaC2dVLoSFjyJT9+S1pTBOj1+rtlYyyWqpWltRN5RcCfNuQa+cbfMctiKhhgVYb1YcYA7TuEgA [detect-boolean]: https://www.typescriptlang.org/play?target=7&jsx=0#code/MYewdgzgLgBAYgQQDIGUCiAuGBDMBPGAXhgDNsAbCAUwG4YB6emKPABypBKMOIHIAjECHJVcvAFChIwqgDpyIAOYAKAAaJUaZmw5cexACQBvFu07xk6AL6qAlDUngIM+UrUb0MAJaQouYLowAEJCIriqADQWmt6+-oEhMrj2jtIirirqllo+0PHmAPL8AFZUwFCR0Z65fmABhSVlUCmpzukKmXYOUtAwACoASgCqmDj4RMwATgCutAxMpoH6MAKhomASPS4daoMj2mZ6PDDGi+Z7aDYpW+1uqhexeXUJa+FRDzX5XIlhYNdO2zuHzizwapXKlWBT3qXCK4OaDlagM6-18VTQAH0AJIAORQfQQOIAwqNcARiGAqAB3YKvMDKMiUKj2eaPWow2lJMBI26ZDyY3H4wkkg5LY6nHTmfnYvEE4mXLo8uQ7LKaGVC+Vsr6c36VaWCuUiz6g7501FtZV3fWy4U5EEcuFNPXZdWGu3QwKO8otG6WlHdJywC6u21YMkTSk0n7rZRQGbMuis40c6O4JUZXbDAU2zVnI6GEySrjBg22q4BtJ+zMjEOa5MvLmQrO1o32hu-c3I6vZjWtj1gp3vZuluttgfehxAA [detect-function]: https://www.typescriptlang.org/play?target=7&jsx=0#code/C4TwDgpgBAYgrgOwMZQLxQBQDodgIYBOeAtgFxR4IgCUaAfBVQNwBQLSA9ggM7CwCqAOQDCAFQCSAeUHl4yNJgAe5BHGIAjCAQA0UEOV4EAlggDm1cpRD0oiqAGo9rTjw4AbCFjcdTGAAYwQmJSglCgkBwAZmio6ADkACQA3uEQUQIiEtIAvnF+utTOXNzunt6+AUFZoSa8lEhp0XJIwEZc+RnB0lC1wPWNsIgtbQjU7MWlXj7+gZkhPTx9yAOS6gBWEC0ds101i-3pqxstY0A @@ -2398,6 +2419,7 @@ MIT © angular-package ([license](https://github.com/angular-package/type/blob/m [detect-symbol]: https://www.typescriptlang.org/play?target=7&jsx=0#code/MYewdgzgLgBAcgVQLICECiAlAXDAhmATxgF4YBGABgGYKAWCgVgoG4AoUSWAZQE1UB5ADIB9RKkw58RUlwIBbAEYgANgAox6DAEo2HCCoCmAOmUgA5qoAGvASI2YYUAgAcDIAGYlipAOQASAG8nVw8YGxQhUWRNAF8fSx12cH1lY1MLaz4Iu2iHAEtOfGA3TxQQQ3xLABowrMj7DBgC6CKSmDKKsES9QxNzK3D63MbmqFbQgDEAVzBgKDzwatrbKPERwtm26dn58G7k3vSBupy1po3i0LgpxQMAJyXB081zls2rm4V7-chD-syVg1XmN3p5+AoAFYGOaPE6rF6jcZgyHQqA6GBJX6pPoZJ7w-IXNpcKB3ApmWGA4bApFhElkn4pNL-PFAxGgsLyJTKCnZfHrN6XTyyRQqRKYxk4qwJXTJbgAFQwAEk4ABxSSEEgwHwAQgAAgBiPwAUgAegAyABUqi0uAUwAAJgZ3GYABZ5CEAa2UcjAIGcd2gUwA7gQAF4+GWcZa8rgK5VqvAamSclSqWNK1UMv64uHp+OOFxtby+QLBIm5uOquLS8XZ44rPOq6nsjqpSo1PGNlXNwXtcptrqRiVHAExyvdtm97ZzBZgHmRLs9rYzGd7Id10cL8dLj63B4disZieE3dfO5Z7EjzvbydtcFQmEHhs3k-Ih9o9eX5mH-O30LE0kwHJJ8xyPHchTpICLyZHNnzAv8hRTbkQK3eDXw5EVlESIA [detect-undefined]: https://www.typescriptlang.org/play?target=7&jsx=0#code/MYewdgzgLgBAqgOQCIFEBiBJBKkC4YCGYAnjALwwCuYAJgKYBmAlmHTQNwBQokIANnQB0fEAHMAFAANEqTNiQwoxAA50QDcmQoByACQBvJavXxk6LDgC+2yQEouPCPyEiJ0s3JwwW0IsDUaaNTAUEzgkgA0prIWCj5QfgEwQWAhYWD23OBOAsJiUjLm8t6QCalJCJQAtgBGdABOkdFFXvGJJpW1DZmOznluhZ5xpe0aAPI1AFZ0IU2DsSW+5SYT0yH2MFm8ua4FHgttyxoAylD1LKJz+8WH-ian52CimVs5LvmSdlwCsGAgUEhGCw2PgiMQHNk+rtJH8AUDWDRFCoklodAYjElYYDmAjrF9XlCPlj4WxFmU7oFgqFwlFiTjSbckik0uAepCdkT-tjgYjGR1qnVGrSuSTeSMjjBOoK2dt3m46TyyaMYKsZlAmgqEUqJar1hDZf0pJqGeKKTAHhcNSL6WKlmaLU9MkA + [is-array]: https://www.typescriptlang.org/play?jsx=0#code/MYewdgzgLgBFCeAHApgeQGYwLwwBQDcBDAGwFdkAuGQseASiugCcBLMAc2wD4ZUAjAFbJgUAHSImIKFKTJR0gMpRWHUcBLECJcnVERiLYMlwAOADQwAtAEZd0gDIgA7siYBhQhGN0A3ACgEFBgABVYAWxYoFnxkbBg+EBBiZBoYAB94lnY2WAywUmJidJh8sL5XYuY2TgyIeDKk4tIwABNkdDZkFv9A2IBJCABBJiZCeDitMkpqWjpuGCIpmBYIGGHR+AAeGnguf1BIWBX1saoBk-GcTYAVWS5J8iodhgXtWJW1kbGbu+4-GDgsgwD2Qcyw4JgAHJCF94JCYAAyBH-T4bUTHWEgsEQ5TkRHIgGLPFsaA0IwgTAXbA4ph4pEo3oU15LcE4SEgQTCKCQ-bgaAwBTXABKfQAcgBxOKQxxMZBhZaICCkMIAfh5fgO-NFAFUALIAIQAokK4gAmADsvMOMH1qFQ9kNg1FcXQJC8Vv52tFABFDQAxMWG71xZptDpgLoe2CDIVCwYATUFIolVAumyqHB4OAA2tDIRZIXx81DgJCALpRtaxhM6g3G1OwzalcpMLMwbPWCymiwAZgrGr50er8eCIt1fWufQAaoaGxtNqEWBEojE29moRn2MWLRZcbF+5rYAApBSoUUAfSng3s2sNcQA3uhElRrKaewBfD1JOTEEDsXAAAZJmK4oARYGIbLgwESnQvgwAA9PBMCusQXgDpA36iL+-4AbWRpCmByxDJieHGrBPgIUhKFeDA6EQJh2GAba9qOqKhEQWMuDMQ6TrkZRyFusgdEMX+gFer6AaikG7HEZB4n+oG3p8YhAmoUJmoiThMZxomwogTJFy4NpCbQeKylIXuwnJFhokAcZ8akQR4GyZx9mOeZcC0upfKaYB9mjn046TjOBmYv5Y4TtOhoeZZGnWYxAEnmel7XreoWQUlF5Xje0VwSp1FCUAA [is-bigint]: https://www.typescriptlang.org/play?target=7&jsx=0#code/MYewdgzgLgBFCeAHApgeQGYwLwwBQDcBDAGwFdkAuGQseASiugCcBLMAc2wD4ZUAjAFbJgUAHSImIKFKTJR0gMpRWHUcBLECJcnVERiLYMlwAOADQwAtAEZd0gDIgA7siYBhQhGN0A3ACgEFBgASQgAIRZ2YLBYHC0ySmpaOm4YIgSYFggYPki2KH9QSFgsiKiYqlCy6Ni8dPIqGnoqeuRM7Nz2fO4-GDhZDHidbCwcAHJO-LGYADIZ3v6UEExWkfHJmLHC8GgYBQAVACVggDkAcWwYMccmZABbTMQIUjuAfi2-It2TgFUAWTCAFFDpcAEwAdm2xRgYVQqHsgIAgidLugSF4obswsEzqd9pcAJwABiJ4OsBIJoIArAAWcE0okU6xgTEgYhyYggdi4AAGB2O5x5FlKkRquH5pzOdF8MAA9LKYGjiF5Pjs2RyubzfgDgUL2tUYrhtUDDtKfHKFUqVV91aJOdyebD4UiTnqReUoLgnQjkWaLYr0chVZBbfbedjcSd9m7wqLDRG8X75XAmOQ-EA [is-boolean]: https://www.typescriptlang.org/play?target=7&jsx=0#code/MYewdgzgLgBFCeAHApgeQGYwLwwBQDcBDAGwFdkAuGQseASiugCcBLMAc2wD4ZUAjAFbJgUAHSImIKFKTJR0gMpRWHUcBLECJcnVERiLYMlwAOADQwAtAEZd0gDIgA7siYBhQhGN0A3ACgEFBgASQgAIRAQYmQabDwiMkpqWjpuGATyGBYIGD5I6Jp-UEhYbIiomLAqUPKCsDitRKoaeioM5CycvIrYrC4-GDhZDEadbCwcAHJuusmYADJ5gbxlwdxVwaGUEEx28amQQWEoOcWNwb22aBojHZhayv24Jkyzzc3LkpvkO-4hESeynIGzoGwAPmCNut3hdtB0rlBvncHr0JjB0CQvAsljD0nCsl8wLdMH9jk8McQsW8YYEfrt8RMpjNKqccTDRh1Gc9MhC8YlyZjkKD3sKYL4-MVoDAFAAVABKwQAcgBxOKTRxMZAAWyyiAgpC1AH5JkVwFLFQBVACyYQAonK4gAmADsppK91QqHstoAgoq4hSvG6pWFPd6-QB9eUW21xIHIYOwUNe32KiNK2V+tyxnBgZBOe75Sq4QNC4MVUTEEDsXAAA1lCpVtYsZSLNFwDaVyrovhgAHo++jBRKzRWqzXa5abfbm50UWBcFO7XKez5+4PSyPIGPq3Xk+HFbPWz0F-vU6v19zkFuIDuJ2fI9HbUfwm3T2HU1G5TGLwOrze7z3D9IwzGUs2fFtXxPXAHzTUDwN-Qd4z8IA @@ -2412,6 +2434,7 @@ MIT © angular-package ([license](https://github.com/angular-package/type/blob/m [is-type]: https://www.typescriptlang.org/play?target=7&jsx=0#code/FAFwngDgpgBAwgewHYGcQCcCuBjED0A8AKpFAHwwC8MSUA7jABQB0rAhugOYoBcMbSMAG0AugEoqFEtADcoUjAAK6AJYBbFSBUA3KCiowA5ACMVnFUhCGYAHyPGECADZQB1u4aSY1xqOndGKGA+zgGGaKpInGGYSAAmUABmFlBxhnLg0DAAYrHYBiysEBxsanwCYBKUFBUZCtJ6BADyxgBWFNSIqBg4eIQt7bZGiXlayGEIbVC4Acrqmjp6dVkAkigNBsSkZIzabE6YUOWCADQwmUcwDShb0GRVFHsHsCr6DXIWIH6JbNiwTSsYABvGAADz4Xh8fhgAF8PpZvr9-gDgTAwHwIhZOLC5PJVigAEJmFaWApPQ7HSqSGDkl76UzmSzLWBrAmOFwCMn7Cn8QQPGncukwBzOVxIZkwNa5JC4FTILnPSn82kwV45PIStYktACP6bAY7WmUs4WHUyy5dCK9fDNNr3akqtUDTUoABy3l86AVPIqysFqv0kM9LoG0xA+rtu0FxpgAGsoGAAPwYjBYv3PAMwZ14lkoADKqai3suvod-rVmKiLrzwQcTmLSrLGYrtecLoAqvEkik4g3eVTqgLm-pYglkrQ4rjsMg0AGiZwSSA+KziaTqFHFf2xHxHfSzJ9qRcEIkh4cqJRqCZ95Z0sBp905+yxcvCU-OeujVud+X6W+kNSNzPU0QF1KBjxgNlRU5AAyaDTxebpQPA0NcAkGw7EYQDYAvagelgdD4PPagficFAoAkWDzlIcCVRw+w-0MMQ5HvWdXmlWVkBfdixn-D9oy-Qi1XYw9qJPWiL2GUY5SQaxKMdRDzXA7jpJgOTywUv5kKmXBmJncNXm1EDzRfQzQIjdosJjYDQL4S0elwG0DW3QT9AGAD5LNTST2s81VLg14C0iThGB8v5mAgdAEDwC5mBY+y+mYJBSnIvyAxQkBbQs2kxCYu89IDd0oXQF9Cs9PtfW-YcaA9aFByPMT-Tozwav8GBEwDbILE0KAsIkSqgI0sCT1K6E1ObQatNaMNdIfV50pfdLzMNfiKjOeMkxTILnN3LM2hE6AaMaiTDEmKaZlSjyjK83azvDMazwAQgkrwnHrdqAsLYL1okdr1tVf8VT4PCYD4EiyJm1j80+l9Aqxcq+X6oVK2xQdGHqwimtOsNZLgy6kJPRb7oQzyhpgWGojQux0fEy9kdvOKAxrEInBh1t6z4zcKpcmAgmZ-bSZpwI2fp-LXk7McexfcXuwneHKkRzNRxl1ImzPOilfHFXKOpo7Lw1ntbzy2b1lIF8NmoW5yEs-szguPhrkt+4FbVc2KCBYAYFVE8QqhoK0dIHLgQ9z2eboTRsAACyYC4JHdkOQ+wNgyPsa8rD4dAoBATB0H-V550XXq5Hjz3E+TkwGPTzPs9z18oKQQvg-j0vYEMEYZR4wxK6znOOqk5AG+LmBm6MIM-E7mAM+7muRvQAfi+Hk7tLTieq57ual8duem6Tlu6a76vGc+reE53oXmfHyeD4Ctnj5L0-DH1icL9Xmvpc1uJj5hYOv89y+e4uNqAZTLmk3rSW2AcQYwDBlAOQcJgB3icEnfQeYEBqCgHARBKB9AglBAYAAjDIWEQ9MHINQVAIgdAEAYKQaiMABgABMhCv4MzgE0V0eYiAACV2xwCIE0ThBhaAMBQWg6hWDGC5RYWwjh3DeH8KIAAdSaII+gZMyEUKoSQiRENwwEiaE0AAMgAUQAIKugMNAnREEVgAHEViuiIAYAAnAABhcQAdjwU4px9CACsAAWdx-iXHeLweKI2s5sjtldHAPgwl1zgmqkVfkuCADUMACERPDK6dsABZAkRiBHUDwfQ9xVimgEgAFJGN4XwFE1AcF8DwTiLJWYqk1L4UQAAEoUup9TaF8BOrQawcCGYyPsTYgwhhcl0NHl6V4IsHx5gAJr5MMQYJmdZGCGDUGARiVjokABEjHZHsUYw5BhH6pCnDOUUzAnAIGCgAA1YewrhPC+GcKeSaE20ACAiPQSQnYryZEfPkUos4AKxEoByoQgA9HCqB+wyIRLuQ855ejDGmNdN8gMDQCAig5EgHYmLjFmLOOXOujEmIwARecLAUBUUuHuY8xgTyCS2PsUQXFrx8XIxJZyhxFKGSfGpfCxFeEmVQBZc8nJ+TCk8t+VAAgcydhyoKZwilcyxW0olQyqVMq2VRJiYq-F7EdjGrgBStuHEZKwt1fSw4Br0VsvGa6GxprSAEH5YwN1NiKV03tXSyVLE0WsqeRU6pvDPV-P0SsHYkaOkUqxjMINeqnWhuZS6p5Ky1kGJjcqn1ua9EGIDcLNNjrGWZuldmo5JyzmHILYwOtpzXTnIpVctIFbJVAA [is-undefined]: https://www.typescriptlang.org/play?jsx=0#code/MYewdgzgLgBFCeAHApgeQGYwLwwBQDcBDAGwFdkAuGQseASiugCcBLMAc2wD4ZUAjAFbJgUAHSImIKFKTJR0gMpRWHUcBLECJcnVERiLYMlwAOADQwAtAEZd0gDIgA7siYBhQhGN0A3ACgEFBgASQgAVTAAE2R0NmRI7DwiMkpqWjpuGGTyGBYIGFIomLjI-1BIWDyI6NiweKpQ6uK6hJwtFKoaeips5Fz8wpqS7j8YOFkMdp1sLBwAckHm+LmYADJV0fGUEExemfnF2uW1jbG92ZxDkv8-cugYBQAVACVggDkAcUS5xyZkAFtcogIKR-gB+OZlcD3N5hACyACEAKLPRIAJgA7FCKjAEahUPYkQBBN6JdAkLz+YjIWDUqBXFrY+5hN4AESRADF3kjWYkGfEbncQNTRMQQOxcAADJ6vT6SixVIpHSK4GXvD50XwwAD02pg5OIXlu0OFcjFEslsMRKPl-SaytwVuRz01Ph1eoNRqFIvNUrxBOJb1tiqGLVw-sJJNd7v1FOQxsgptF4qldP5kWD4SVJVwaezLWjurgTHICYgSd9kpZ7K5bx5mftOernO5rMLHrjfiAA + [guard-array]: https://www.typescriptlang.org/play?jsx=0#code/C4TwDgpgBACgTgSwLYOAgbtAvFARge3wBsIBDAOygB88EBzBc4aqcgVyKJfaVwjhYBnYInJ0hIXsRZtyAEwgAzRhDkBuAFChIUAJKCAgnDikQUHAB4AKuAgA+ABTpSRNhABcUCiACU5u1DOrtAIglBGJiDWtnaa2tAA4mykcHIRpuZQ0ZCOQW6e6VE2OX5YAXkhYYXZ9poaAMb45MJQoYWe+oWZNbku+V7kvp4VrVXGpj3+4eMgAHRtM059EH4AZKuBy63NwBT1EPiK05GajTtQdMmp7VBJKWkz3cX2S8EFMz0+w1uhxxPPATKo2qANebh8dTOLQAylYAEq6AByCUyAHIADL4OAQJCtMCCNhIAD8qNOTRaiIAqgBZABCAFE4ZkAEwAdjJ51pAHkuej6QZEZlFC5BBAOS1KYiACL0gBiSPpUsysgUynIqnFzAMcLhBgAmgB9WEI5HvSIWYSiOiAqAAbVRpFRABooKjcM7XfVUQBdTXhHX6g1UumMs0THh8OA221sl0AZlZ8bjvoa5K1AcNMAR1N0Vl0ADV6WGovBkKgMPZMrbXZbGHQPbGoCI3FAU1D07rDZKZfLEYrixYVUoVHJo0O1aoXeOR1P5MP1XI22moAApaFcwU4ADeikIngAjMy4wBfSHk4gQWZEfB0BwAA21nYNWd0ObzhbvLsu92qpZQaEwRxH0DF83wLekfAhKAAHpoKbOA3FTZoLyvG972Aw1gwZOFPwuK4HnNCN+CAjMgxpbDILUGC4ObCAkMEFDr1vB9SONJEElw79rg+WsxBIp82ORSjqPgxCoUYtCWKfbs5QVKVOPw6ppwXfjAxk3tFWE2DRLo+iJOYwSOK-RSeJEOtHEMrS4OFIhRT0khUOYrDGQUn8PiIqMHGcuErKgGy7PEhymPvbleX5RFXO480CAvChHFCvkBV8-y6MCy9grvdS5MigiJmU1RHCyvspWSkVUvPILJLXDccuqfBcAAKwgepgEcarEVK2y6KAA [guard-function]: https://www.typescriptlang.org/play?target=7&jsx=0#code/C4TwDgpgBAYgrgOwMZQLxQBQDodgIYBOeAtgFxR4IgCUaAfBVQNwBQokUAkgM7zLABLAPYI0mAG54ANnAjlKNelEkzoA7rERJWSEd2BR1fJIJHkex06PQYVs+VWrk7ajcfosoUdhCEAzZWlZNFR0AHI-LSswqAAyWMDVQwR9SiRfAMthUXjE4IEU4DSMqAB5ACMAKwgTVh8oAHE4QgATLJExDEjkcmNaVAZulHVNZB09AwBzZoI2qOzyJtb260wh3q0nKCHDNy0lI3mRLs3WFl1CqAAhUtKAGQBRAEEAOTE-aW4IccurzgbOC8ACpiACcAAZwQB2ACMoNBACYAKwAFihKPB8JhCB++igLwAqgBZK4PABKYhhCKhuIMAGUgWTAQ0xGEiSAoAg4MRyhACLswmcLniYASXgBhIGcUovAD6QIAmgAFB4bZCdAAe5C5PL5WwUSgA3lACBBgHACKINVAANRQJFMKAAX3OUjw3A04omBDgJiEBHFbo9UGN1vQDud5wmUHFMoZZIJktKZNl4ruTzpdLECAgAHcY97fcB-YH3dwMNQhXohFIIFgpEJJhgAAaiiVSmXy5UPZsAGig02WRwQGDbkulcsVKuolagAHo594fRAoyka3WG03m17Cj6-QGg9w+wOZnN+NkMDv9HviweyzPHQul8FynADAJ3xoEEIDO4geAV2Fdd60bDAwljF540TIFk1TdNMzCftB1mFZLzjRloNgtMMzpB950XD4pC+VduGAzcwJue5njlAA1J47gJB5EJPIdz2OSjHlePCn0I4igNrECmzCQkSXJWU6IYpikNPVCRNJMluIIz4VyAA [guard-number]: https://www.typescriptlang.org/play?jsx=0#code/C4TwDgpgBA4grgQwE4BMBycC2AjCSoC8UAFAG4IA2cEAXFAHZa5ICUhAfFOVdAJYDODJngDcAKFCQoASX4YceQiW7U6CeiDYFOKvoMYKk4gMYB7ev2BQB85nVm3FRMpVVR1muruv7h+bVCSEKYAZlyu0ARRUADkBswxUAD8PgBivPS8wBAuPGxeEdYWwOrGwWGO+ABkVeE8RZal5VAA8tgAVhDGwCbmllAA5oiolXTwyOh+Srlu8XgsBfUCQoYcPpUzECziYmbFUGgAqgCyAEIAogBKAPotaOdKAEwA7L37R2dX1wAqAOotSgAjC83v0Phcbt8ABKXc4PIiPEG7PpWcFfVItQ6XJQxADMLxiOz2-FMFAgADoKKYBsQAAZom53c60gA0g2Gk0MxAZt3uLG2yIspIpVJp9JOEJ+-1Z7ImGx5fxa-NBwsp1LpCphcJlQzlfm5Eq+0Nh52VgpJZLVYp5GKxOo58sNN1tl2VUAA9O7ZagoAB3UxIADW-DEQA diff --git a/packages/type/package-lock.json b/packages/type/package-lock.json index 9a564181..20ca6022 100644 --- a/packages/type/package-lock.json +++ b/packages/type/package-lock.json @@ -1,12 +1,12 @@ { "name": "@angular-package/type", - "version": "4.0.1", + "version": "4.0.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@angular-package/type", - "version": "4.0.1", + "version": "4.0.2", "license": "MIT", "dependencies": { "tslib": "^2.1.0" diff --git a/packages/type/package.json b/packages/type/package.json index fedbd3d6..47af67e7 100644 --- a/packages/type/package.json +++ b/packages/type/package.json @@ -1,6 +1,6 @@ { "name": "@angular-package/type", - "version": "4.0.1", + "version": "4.0.2", "description": "Common types, type guards and type checkers.", "author": "Angular Package (https://wvvw.dev)", "homepage": "https://github.com/angular-package/type#readme", diff --git a/packages/type/src/guard/lib/guard-object-key.func.ts b/packages/type/src/guard/lib/guard-object-key.func.ts index df585bbb..a81fcd60 100644 --- a/packages/type/src/guard/lib/guard-object-key.func.ts +++ b/packages/type/src/guard/lib/guard-object-key.func.ts @@ -11,5 +11,5 @@ import { ResultCallback } from '../../type/result-callback.type'; * @returns A `boolean` indicating whether or not the `value` is an `object` of a generic `Obj` containing the `key`. */ export const guardObjectKey: GuardObjectKey = - (value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback): value is Obj => + (value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback): value is Obj => isObjectKey(value, key, callback); diff --git a/packages/type/src/guard/lib/guard-object.func.ts b/packages/type/src/guard/lib/guard-object.func.ts index 502112e3..86e1469c 100644 --- a/packages/type/src/guard/lib/guard-object.func.ts +++ b/packages/type/src/guard/lib/guard-object.func.ts @@ -9,5 +9,5 @@ import { ResultCallback } from '../../type/result-callback.type'; * @param callback An optional `ResultCallback` function to handle result before returns. * @returns A `boolean` indicating whether or not the `value` is an `object` of a generic `Obj`. */ -export const guardObject: GuardObject = (value: Obj, callback?: ResultCallback): value is Obj => +export const guardObject: GuardObject = (value: Obj, callback?: ResultCallback): value is Obj => isObject(value, callback); diff --git a/packages/type/src/guard/test/guard-boolean.spec.ts b/packages/type/src/guard/test/guard-boolean.spec.ts index 709378a1..3f0cf55f 100644 --- a/packages/type/src/guard/test/guard-boolean.spec.ts +++ b/packages/type/src/guard/test/guard-boolean.spec.ts @@ -8,7 +8,7 @@ describe(guardBoolean.name, () => { it('is DEFINED', () => expect(guardBoolean).toBeDefined()); // Checks ... - describe(`checks`, () => { + describe(`guards`, () => { it('callback', () => { guardBoolean(TRUE, (result: boolean, value: boolean) => { expect(result).toBe(TRUE); diff --git a/packages/type/src/guard/test/guard-defined.spec.ts b/packages/type/src/guard/test/guard-defined.spec.ts index 755559bc..2fb874c9 100644 --- a/packages/type/src/guard/test/guard-defined.spec.ts +++ b/packages/type/src/guard/test/guard-defined.spec.ts @@ -9,7 +9,7 @@ describe(guardDefined.name, () => { it('is DEFINED', () => expect(guardDefined).toBeDefined()); // Checks ... - describe(`checks`, () => { + describe(`guards`, () => { it('callback', () => { guardDefined(UNDEFINED, (result: boolean, value: undefined) => { expect(result).toBe(FALSE); diff --git a/packages/type/src/guard/test/guard-instance.spec.ts b/packages/type/src/guard/test/guard-instance.spec.ts index 4234f97b..e48adb3c 100644 --- a/packages/type/src/guard/test/guard-instance.spec.ts +++ b/packages/type/src/guard/test/guard-instance.spec.ts @@ -14,7 +14,7 @@ describe(guardInstance.name , () => { it('is DEFINED', () => expect(guardInstance).toBeDefined()); // Checks ... - describe(`checks`, () => { + describe(`guards`, () => { it('callback', () => { guardInstance(CLASS, Class, (result: boolean, value: Class) => { expect(result).toBe(TRUE); diff --git a/packages/type/src/guard/test/guard-key.spec.ts b/packages/type/src/guard/test/guard-key.spec.ts index 05e9e4cc..14f912db 100644 --- a/packages/type/src/guard/test/guard-key.spec.ts +++ b/packages/type/src/guard/test/guard-key.spec.ts @@ -13,7 +13,7 @@ describe(guardKey.name, () => { it('is DEFINED', () => expect(guardKey).toBeDefined()); // Checks ... - describe(`checks`, () => { + describe(`guards`, () => { it('callback', () => { guardKey(STRING, (result: boolean, value: Key) => { expect(result).toBe(TRUE); diff --git a/packages/type/src/guard/test/guard-null.spec.ts b/packages/type/src/guard/test/guard-null.spec.ts index c888b1e0..4915dac6 100644 --- a/packages/type/src/guard/test/guard-null.spec.ts +++ b/packages/type/src/guard/test/guard-null.spec.ts @@ -9,7 +9,7 @@ describe(guardNull.name, () => { it('is DEFINED', () => expect(guardNull).toBeDefined()); // Checks ... - describe(`checks`, () => { + describe(`guards`, () => { it('callback', () => { guardNull(NULL, (result: boolean, value: null) => { expect(result).toBe(TRUE); diff --git a/packages/type/src/guard/test/guard-number.spec.ts b/packages/type/src/guard/test/guard-number.spec.ts index d520e744..ff7d3a74 100644 --- a/packages/type/src/guard/test/guard-number.spec.ts +++ b/packages/type/src/guard/test/guard-number.spec.ts @@ -9,7 +9,7 @@ describe(guardNumber.name, () => { it('is DEFINED', () => expect(guardNumber).toBeDefined()); // Checks ... - describe(`checks`, () => { + describe(`guards`, () => { it('callback', () => { guardNumber(NUMBER, (result: boolean, value: number) => { expect(result).toBe(TRUE); diff --git a/packages/type/src/guard/test/guard-object-key.spec.ts b/packages/type/src/guard/test/guard-object-key.spec.ts index 5faa64c7..afd1bff9 100644 --- a/packages/type/src/guard/test/guard-object-key.spec.ts +++ b/packages/type/src/guard/test/guard-object-key.spec.ts @@ -12,7 +12,7 @@ describe(guardObjectKey.name , () => { it('is DEFINED', () => expect(guardObjectKey).toBeDefined()); // Checks ... - describe(`checks`, () => { + describe(`guards`, () => { it('callback', () => { guardObjectKey(TEST_CLASS, ['firstName', 'surname'], (result: boolean, value: TestClass) => { expect(result).toBe(TRUE); diff --git a/packages/type/src/guard/test/guard-object.spec.ts b/packages/type/src/guard/test/guard-object.spec.ts index 236fc80d..33fd534d 100644 --- a/packages/type/src/guard/test/guard-object.spec.ts +++ b/packages/type/src/guard/test/guard-object.spec.ts @@ -10,7 +10,7 @@ describe(guardObject.name, () => { it('is DEFINED', () => expect(guardObject).toBeDefined()); // Checks ... - describe(`checks`, () => { + describe(`guards`, () => { it('callback', () => { guardObject(OBJECT_ONE, (result: boolean, value: any) => { expect(result).toBe(TRUE); diff --git a/packages/type/src/guard/test/guard-primitive.spec.ts b/packages/type/src/guard/test/guard-primitive.spec.ts index da6f97db..14fd2b3e 100644 --- a/packages/type/src/guard/test/guard-primitive.spec.ts +++ b/packages/type/src/guard/test/guard-primitive.spec.ts @@ -14,7 +14,7 @@ describe(guardPrimitive.name, () => { it('is DEFINED', () => expect(guardPrimitive).toBeDefined()); // Checks ... - describe(`checks`, () => { + describe(`guards`, () => { it('callback', () => { guardPrimitive(STRING, 'string' , (result: boolean, value: string) => { expect(result).toBe(TRUE); diff --git a/packages/type/src/guard/test/guard-string.spec.ts b/packages/type/src/guard/test/guard-string.spec.ts index 2a76c02e..8b21b209 100644 --- a/packages/type/src/guard/test/guard-string.spec.ts +++ b/packages/type/src/guard/test/guard-string.spec.ts @@ -9,7 +9,7 @@ describe(guardString.name, () => { it('is DEFINED', () => expect(guardString).toBeDefined()); // Checks ... - describe(`checks`, () => { + describe(`guards`, () => { it('callback', () => { guardString(STRING, (result: boolean, value: string) => { expect(result).toBe(TRUE); diff --git a/packages/type/src/guard/test/guard-symbol.spec.ts b/packages/type/src/guard/test/guard-symbol.spec.ts index 2c5463dc..d55f39d6 100644 --- a/packages/type/src/guard/test/guard-symbol.spec.ts +++ b/packages/type/src/guard/test/guard-symbol.spec.ts @@ -11,7 +11,7 @@ describe(guardSymbol.name, () => { it('is DEFINED', () => expect(guardSymbol).toBeDefined()); // Checks ... - describe(`checks`, () => { + describe(`guards`, () => { it('callback', () => { guardSymbol(SYMBOL_STRING, (result: boolean, value: symbol) => { expect(result).toBe(TRUE); diff --git a/packages/type/src/guard/test/guard-undefined.spec.ts b/packages/type/src/guard/test/guard-undefined.spec.ts index 74638a5d..89a94898 100644 --- a/packages/type/src/guard/test/guard-undefined.spec.ts +++ b/packages/type/src/guard/test/guard-undefined.spec.ts @@ -9,7 +9,7 @@ describe(guardUndefined.name, () => { it('is DEFINED', () => expect(guardUndefined).toBeDefined()); // Checks ... - describe(`checks`, () => { + describe(`guards`, () => { it('callback', () => { guardUndefined(UNDEFINED, (result: boolean, value: undefined) => { expect(result).toBe(TRUE); diff --git a/packages/type/src/guard/type/guard-object-key.type.ts b/packages/type/src/guard/type/guard-object-key.type.ts index 7cbab0d6..919fa4bb 100644 --- a/packages/type/src/guard/type/guard-object-key.type.ts +++ b/packages/type/src/guard/type/guard-object-key.type.ts @@ -1,4 +1,4 @@ import { ResultCallback } from '../../type/result-callback.type'; -export type GuardObjectKey = (value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback) => value is Obj; +export type GuardObjectKey = (value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback) => value is Obj; diff --git a/packages/type/src/guard/type/guard-object.type.ts b/packages/type/src/guard/type/guard-object.type.ts index 761a5e83..76f4fb98 100644 --- a/packages/type/src/guard/type/guard-object.type.ts +++ b/packages/type/src/guard/type/guard-object.type.ts @@ -1,2 +1,2 @@ import { ResultCallback } from '../../type/result-callback.type'; -export type GuardObject = (value: Obj, callback?: ResultCallback) => value is Obj; +export type GuardObject = (value: Obj, callback?: ResultCallback) => value is Obj; diff --git a/packages/type/src/is/lib/is-object-key-in.func.ts b/packages/type/src/is/lib/is-object-key-in.func.ts index b9ff93aa..338efd66 100644 --- a/packages/type/src/is/lib/is-object-key-in.func.ts +++ b/packages/type/src/is/lib/is-object-key-in.func.ts @@ -15,7 +15,7 @@ import { ResultCallback } from '../../type/result-callback.type'; * @callback `resultCallback`. * @returns A `boolean` indicating whether or not the `value` is an `object` with the keys. */ -export const isObjectKeyIn: IsObjectKeyIn = ( +export const isObjectKeyIn: IsObjectKeyIn = ( value: any, key: Key | Key[], callback: ResultCallback = resultCallback diff --git a/packages/type/src/is/lib/is-object-key.func.ts b/packages/type/src/is/lib/is-object-key.func.ts index e168c1e2..9783c1c8 100644 --- a/packages/type/src/is/lib/is-object-key.func.ts +++ b/packages/type/src/is/lib/is-object-key.func.ts @@ -15,7 +15,7 @@ import { ResultCallback } from '../../type/result-callback.type'; * @callback `resultCallback`. * @returns A `boolean` indicating whether or not the `value` is an `object` with its own specified keys. */ -export const isObjectKey: IsObjectKey = ( +export const isObjectKey: IsObjectKey = ( value: any, key: Key | Key[], callback: ResultCallback = resultCallback diff --git a/packages/type/src/is/type/is-object-key-in.type.ts b/packages/type/src/is/type/is-object-key-in.type.ts index 96c60696..98969b13 100644 --- a/packages/type/src/is/type/is-object-key-in.type.ts +++ b/packages/type/src/is/type/is-object-key-in.type.ts @@ -1,3 +1,3 @@ import { Key } from '../../type/key.type'; import { ResultCallback } from '../../type/result-callback.type'; -export type IsObjectKeyIn = (value: any, key: Key | Key[], callback?: ResultCallback) => value is Type; +export type IsObjectKeyIn = (value: any, key: Key | Key[], callback?: ResultCallback) => value is Type; diff --git a/packages/type/src/is/type/is-object-key.type.ts b/packages/type/src/is/type/is-object-key.type.ts index 413db995..d01faa2e 100644 --- a/packages/type/src/is/type/is-object-key.type.ts +++ b/packages/type/src/is/type/is-object-key.type.ts @@ -1,3 +1,3 @@ import { Key } from '../../type/key.type'; import { ResultCallback } from '../../type/result-callback.type'; -export type IsObjectKey = (value: any, key: Key | Key[], callback?: ResultCallback) => value is Type; +export type IsObjectKey = (value: any, key: Key | Key[], callback?: ResultCallback) => value is Type;