angular-package
angular-package
The angular-package supports the development process of angular-based applications in varied ways through the thoughtful, reusable, easy-to-use small pieces of code called packages.
Packages
| Package | Description | Status |
|---|---|---|
| callback | Manages the callback function. |
 |
| change-detection | Improves application performance. |  |
| component-loader | Handles dynamic loading components. |  |
| core | Core features. |  |
| error | Manages an Error. |
 |
| name | The name with prefix and suffix. |  |
| preferences | Preferences, settings, options, configuration and setup in steps. |  |
| prism | Prism highlighter module. |
 |
| property | Handles object properties. |  |
| range | The range between a minimum and maximum. |  |
| reactive | Automatize the process of creating some rxjs features. |  |
| storage | The storage of data under allowed names. |  |
| tag | Any tag with optional attributes. |  |
| testing | Support for testing other packages. |  |
| text | Text on the template with replaceable tags. |  |
| type | Common types, type guards, and type checkers. |  |
| ui | User interface. | In Progress |
| wrapper | Wrap the text with the opening and closing chars. |  |
Click on the package name to visit its GitHub page.
angular-package/type
Common types, type guards and type checkers.
Documentation
For the detailed documentation go to https://type.angular-package.dev/
Table of contents
Basic concepts
Checks
It's to check the provided value to be the same as expected.
Type guard (constrain)
Constrains the parameter type to not let input unexpected value in the code editor.
Guards
It's a combination of both above, constrains the type of the parameter in the code editor, and checks its provided argument.
Defines
Returns defined value from a method of an object.
Defines new value in an object and returns a defined value.
Gets
Returns a value from an object.
Sets
Adds or updates an element with a specified key and a value to an object and returns an object.
Skeleton
This package was generated by the library skeleton with Angular CLI version 13.0.0.
Copy this package to the packages/type folder of the library skeleton then run the commands below.
Code scaffolding
Run ng generate component component-name --project type to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project type.
Note: Don't forget to add
--project typeor else it will be added to the default project in yourangular.jsonfile.
Build
Run ng build type to build the project. The build artifacts will be stored in the dist/ directory.
Publishing
After building your library with ng build type, go to the dist folder cd dist/type and run npm publish.
Running unit tests
Install @angular-package/type with command:
npm i @angular-package/testing --no-saveRun ng test type to execute the unit tests via Karma.
Further help
To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.
Installation
Install @angular-package/type package with command:
npm i @angular-package/type --saveApi
// Main.
import {
recognizeValue, // From the `5.0.0` version
typeOf,
} from '@angular-package/type';// `are` prefix functions.
import {
// Function.
areBigInt, // From the `5.0.0` version
areBoolean, // From the `5.0.0` version
areDate, // From the `5.0.0` version
areDefined, // From the `5.0.0` version
areFalse, // From the `5.0.0` version
areNull, // From the `5.0.0` version
areNumber, // From the `5.0.0` version
areRegExp, // From the `5.0.0` version
areString,
areSymbol, // From the `5.0.0` version
areTrue, // From the `5.0.0` version
areUndefined, // From the `5.0.0` version
} from '@angular-package/type';// `guard` prefix functions.
import {
guardArray,
guardBigInt,
guardBoolean,
guardClass,
guardDate, // From the 5.0.0 version
guardDefined,
guardFalse, // From the 5.0.0 version
guardFunction,
guardInstance,
guardKey,
guardNull,
guardNumber,
guardNumberBetween, // From the 5.0.0 version
guardObject,
guardObjectKey,
guardObjectKeyIn, // From the 5.0.0 version
guardObjectKeys,
guardObjectKeysIn, // From the 5.0.0 version
guardObjectSomeKeys, // From the 5.0.0 version
guardPrimitive,
guardRegExp, // From the 5.0.0 version
guardString,
guardStringIncludes, // From the 5.0.0 version
guardStringIncludesSome, // From the 5.0.0 version
guardStringLength, // From the 5.0.0 version
guardStringLengthBetween, // From the 5.0.0 version
guardSymbol,
guardTrue, // From the 5.0.0 version
guardType,
guardUndefined,
} from '@angular-package/type'; // `is` prefix functions.
import {
isArray,
isBigInt,
isBoolean,
isBooleanObject,
isBooleanType,
isClass,
isDate, // From the 4.2.0 version.
isDefined,
isFalse, // From the 4.2.0 version.
isFunction,
isInstance,
isKey,
isNull,
isNumber,
isNumberBetween, // From the 4.2.0 version.
isNumberObject,
isNumberType,
isObject,
isObjectKey,
isObjectKeyIn,
isObjectKeys,
isObjectKeysIn, // From the 5.0.0 version
isObjectSomeKeys, // From the 5.0.0 version
isParam,
isPrimitive,
isRegExp, // From the 4.2.0 version.
isString,
isStringIncludes, // From the 5.0.0 version
isStringIncludesSome, // From the 5.0.0 version
isStringLength, // From the 4.2.0 version.
isStringLengthBetween, // From the 5.0.0 version
isStringObject,
isStringType,
isSymbol,
isTrue, // From the 4.2.0 version.
isType,
isUndefined,
} from '@angular-package/type';// `isNot` prefix functions.
import {
isNotBoolean,
isNotDefined,
isNotFunction,
isNotNull,
isNotNumber,
isNotString,
isNotUndefined
} from '@angular-package/type';// Objects.
import { are, guard, is, isNot, type } from '@angular-package/type';// Interfaces.
import {
MinMax
} from '@angular-package/type';// Types.
import {
AnyBoolean,
AnyNumber,
AnyString,
CallbackPayload, // From the `5.0.0` version.
Constructor,
Defined,
ForEachCallback, // From the `5.0.0` version.
Never,
NotUndefined,
NumberBetween, // From the `4.2.0` version.
Primitive,
Primitives,
ResultCallback, // From the `4.2.0` version
StringOfLength, // From the `4.2.0` version.
Type,
Types,
Undefined
} from '@angular-package/type';Changelog
The changelog of this package is based on keep a changelog. To read it, click on the CHANGELOG.md link.
A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project. - keep a changelog
GIT
Commit
Versioning
Given a version number MAJOR.MINOR.PATCH, increment the:
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards-compatible manner, and
- PATCH version when you make backwards-compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
FAQ How should I deal with revisions in the 0.y.z initial development phase?
The simplest thing to do is start your initial development release at 0.1.0 and then increment the minor version for each subsequent release.
How do I know when to release 1.0.0?
If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backwards compatibility, you should probably already be 1.0.0.
License
MIT © angular-package (license)