Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/angular-package/property
Features to handle object properties.
https://github.com/angular-package/property
accessor-descriptor angular data-descriptor descriptor-interface javascript objects property property-descriptor property-descriptors typescript
Last synced: about 2 months ago
JSON representation
Features to handle object properties.
- Host: GitHub
- URL: https://github.com/angular-package/property
- Owner: angular-package
- License: mit
- Created: 2021-03-01T20:44:20.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-01T06:47:46.000Z (about 2 months ago)
- Last Synced: 2024-11-01T07:25:33.042Z (about 2 months ago)
- Topics: accessor-descriptor, angular, data-descriptor, descriptor-interface, javascript, objects, property, property-descriptor, property-descriptors, typescript
- Language: TypeScript
- Homepage:
- Size: 1.15 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.YML
- License: LICENSE
Awesome Lists containing this project
README
# angular-package
The angular-package supports the development process of [angular](https://angular.io)-based applications in varied ways through the thoughtful, reusable, easy-to-use small pieces of code called packages.
## angular-package/property
Features to handle properties.
[![npm version][property-npm-badge-svg]][property-npm-badge]
[![GitHub issues][property-badge-issues]][property-issues]
[![GitHub forks][property-badge-forks]][property-forks]
[![GitHub stars][property-badge-stars]][property-stars]
[![GitHub license][property-badge-license]][property-license]
[![GitHub sponsors][github-badge-sponsor]][github-sponsor-link]
[![Support me on Patreon][patreon-badge]][patreon-link]
```typescript
export {
// Class.
Property,
WrapProperty,
} from './lib';
export {
// Class.
Descriptor,
Descriptors,
// Interface.
AccessorDescriptor,
CommonDescriptor,
DataDescriptor,
// Type.
ThisAccessorDescriptor,
} from './descriptor';
export { GetterCallback, SetterCallback } from './type';
```
[Previous README.md](https://github.com/angular-package/property/blob/44608671696872ea163b8b6cfa704471fafd8ac3/README.md)
## Table of contents
* [Skeleton](#skeleton)
* [Installation](#installation)
* [Callback](#callback)
* [Package](#package)
* [Descriptor](#descriptor-package)
* Class
* [`Descriptor`](#descriptor)
* [`AccessorDescriptors`](#accessordescriptors)
* [`DataDescriptors`](#datadescriptors)
* [Interface](#descriptor-interface)
* [Type](#descriptor-type)
* [Descriptors](#descriptors)
* [Git](#git)
* [Commit](#commit)
* [Versioning](#versioning)
* [License](#license)
* [Packages](#packages)
## How angular-package understands
Checks
> Is 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
> Is a **combination** of both above, **constrains** the type of the parameter in the **code editor**, and checks its argument.
Sets
> Sets the provided value in the `object`.
Defines
> Returns defined value from the method, instead of storing it in the `object`.
## Skeleton
This package was generated by the [skeleton workspace][skeleton] with [Angular CLI](https://github.com/angular/angular-cli) version `14.2.0`.
Copy this package to the `packages/property` folder of the [skeleton workspace][skeleton] then run the commands below.
## Code scaffolding
Run `ng generate component component-name --project property` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project property`.
> Note: Don't forget to add `--project property` or else it will be added to the default project in your `angular.json` file.
### Build
Run `ng build property` to build the project. The build artifacts will be stored in the `dist/` directory.
### Publishing
After building your library with `ng build property`, go to the dist folder `cd dist/property` and run `npm publish`.
## Running unit tests
Run `ng test property` to execute the unit tests via [Karma](https://karma-runner.github.io).
## Further help
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
## Installation
Install `@angular-package/property` package with command:
```bash
npm i --save @angular-package/property
```
----
## Callback
Wrapper for the [`ResultCallback`][package-type-resultcallback] type function to throw an [`Error`][js-error] with the specified message on the specified `false` or `true` state.
```typescript
export const errorCallback: ErrorCallback = (
message: string,
on: boolean = false
): ResultCallback => {
return (result: boolean, value: any): boolean => {
if (result === on) {
throw new Error(
`${message}, got value ${
typeof value === 'object' ? JSON.stringify(value) : value
}`
);
}
return result;
};
};
```
----
## Package
### Descriptor package
Descriptor features to import.
```typescript
// Class.
export {
Descriptor,
Descriptors
} from './lib';
// Interface.
export {
AccessorDescriptor,
CommonDescriptor,
DataDescriptor
} from './interface';
// Type.
export {
ThisAccessorDescriptor
} from './type';
```
----
### `Descriptor`
Handles object property descriptor.
**Features:**
* Strictly defines accessor and data descriptor with the [`defineAccessor()`][descriptor-defineaccessor] and [`defineData()`][descriptor-definedata] static methods.
* Strictly sets, and stores accessor and data descriptor with the `Descriptor` instance respectively `set.accessor()` and `set.data()` methods of the instance.
* Get privately stored accessor descriptor defined by the `set.accessor()` method by using `get.accessor` property of the instance.
* Get privately stored data descriptor defined by the `set.data()` method by using `get.data` property of the instance.
> Strictly means, it guards provided descriptor by checking it against its unique keys and by picking only properties that belong to the appropriate descriptor.
```typescript
Descriptor { ... }
```
### Descriptor static methods
### `Descriptor.defineAccessor()`
Returns defined accessor descriptor of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type, on `get` or `set` property detected.
```typescript
static defineAccessor(
descriptor: ThisAccessorDescriptor,
callback?: ResultCallback
): ThisAccessorDescriptor { ... }
```
**Generic type variables:**
| Name | Description |
| :------ | :---------- |
| `Value` | Guards the value type of the `get()` and `set()` methods of the `descriptor` object, and in the return type `ThisAccessorDescriptor` |
| `Obj` | Gives the possibility to use the `this` keyword that refers to the `Obj` variable inside the `get()` and `set()` methods of the `descriptor` object, and in the return type `ThisAccessorDescriptor` |
**Parameters:**
| Name: `type` | Description |
| :----------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| descriptor: `ThisAccessorDescriptor` | An `object` of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type to define with the default values of the [`CommonDescriptor`][common-descriptor] |
| callback?: `ResultCallback` | An optional [`ResultCallback`][package-type-resultcallback] function to handle the result of the check whether or not the `descriptor` is an `object` with `get` or `set` property, by default it uses [`accessorCallback()`][accessordescriptors-accessorcallback] function |
**Throws:**
Throws an [`Error`][js-error] if the `descriptor` is not an `object` of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type, which means it doesn't contain `get` or `set` property.
**Returns:**
The **return value** is an `object` of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type.
**Usage:**
```typescript
// Example usage.
import { Descriptor } from '@angular-package/property';
interface PersonShape {
firstName: string;
}
class Person implements PersonShape {
firstName = '';
}
class People {
firstName!: string;
}
const person: Person = new Person();
const people: People = new People();
const firstNameDescriptor = Descriptor.defineAccessor({
configurable: false,
enumerable: false,
get(): string {
return people.firstName;
},
set(value: string): void {
people.firstName = value;
},
});
// Define the property `firstName` in the `person` object to link with the same property in the `people` object.
// Changes to the property `firstName` in the `person` object affect the property `firstName` in the `people` object.
Object.defineProperty(person, 'firstName', firstNameDescriptor);
```
### `Descriptor.defineData()`
Returns defined data descriptor of a [`DataDescriptor`][data-descriptor] [interface][ts-interface], on `writable` or `value` property detected.
```typescript
static defineData(
descriptor: DataDescriptor,
callback: ResultCallback = dataCallback
): DataDescriptor { ... }
```
**Generic type variables:**
| Name | Description |
| :------ | :---------- |
| `Value` | Guards the `value` property from the `descriptor` object, and the return type of a [`DataDescriptor`][data-descriptor] [interface][ts-interface] |
**Parameters:**
| Name: `type` | Description |
| :---------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| descriptor: `DataDescriptor` | An `object` of a [`DataDescriptor`][data-descriptor] [interface][ts-interface] to define with the default values of the [`CommonDescriptor`][common-descriptor] |
| callback?: `ResultCallback` | An optional [`ResultCallback`][package-type-resultcallback] function to handle the result of the check whether or not the `descriptor` is an `object` with `writable` or `value` property, by default it uses [`dataCallback()`](#datacallback) function |
**Throws:**
Throws an [`Error`][js-error] if the `descriptor` is not an `object` of a [`DataDescriptor`][data-descriptor] type, which means it doesn't contain `writable` or `value` property.
**Returns:**
The **return value** is an `object` of a [`DataDescriptor`][data-descriptor] [interface][ts-interface].
**Usage:**
```typescript
// Example usage.
import { Descriptor } from '@angular-package/property';
interface PersonShape {
firstName: string;
}
class Person implements PersonShape {
firstName = '';
}
class People {
firstName!: string;
}
const person: Person = new Person();
const people: People = new People();
const firstNameDescriptor = Descriptor.defineData({
configurable: false,
enumerable: false,
writable: false,
value: people.firstName
});
// Defines the property `firstName` of a type string in the `person` object with the same value as the property in the `people` object.
Object.defineProperty(person, 'firstName', firstNameDescriptor);
```
### `Descriptor.get()`
Returns property descriptor from the property of the specified detected object.
```typescript
public static get(
object: Obj,
name: Name
): PropertyDescriptor | undefined { ... }
````
### `Descriptor.getAll()`
Returns property descriptors from the specified detected object.
```typescript
public static getAll(
object: Obj
): ObjectPropertyDescriptors { ... }
```
----
### `AccessorDescriptors`
Strictly defines, sets, and stores privately property accessor descriptor of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type.
> Strictly means, methods picks `configurable`, `enumerable`, `get`, `set` properties from the provided `descriptor` object.
**Features:**
* Guarded process of defining the object descriptor, but properties are not being checked against proper values.
* Strictly defines property accessor descriptor.
* Strictly sets, and stores at the same time property accessor descriptor.
* Accessor descriptor is of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type:
The return value of the `get()` function is of a generic `Value` type.
The parameter of the `set()` function is of a generic `Value` type.
Keyword `this` refers to an `Obj` variable in both `get()` and `set()` functions.
* Method [`set()`][accessordescriptors-prototype-set] of the instance and static [`define()`][accessordescriptors-define] picks `configurable`, `enumerable`, `get`, `set` properties from the provided data.
* Get privately stored accessor descriptor defined by the [`set()`][accessordescriptors-prototype-set] method of the instance.
```typescript
AccessorDescriptors { ... }
```
### `AccessorDescriptors` static methods
### `AccessorDescriptors.define()`
Returns defined accessor descriptor of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type, on `get` or `set` property detected.
```typescript
static define(
descriptor: ThisAccessorDescriptor,
callback?: ResultCallback
): ThisAccessorDescriptor { ... }
```
**Generic type variables:**
| Name | Description |
| :------ | :---------- |
| `Value` | Guards the value type of the `get()` and `set()` functions of the `descriptor` object, and the return type [`ThisAccessorDescriptor`][this-accessor-descriptor] |
| `Obj` | Gives the possibility to use the `this` keyword that refers to the `Obj` variable inside the `get()` and `set()` functions of the `descriptor` object, and in the return type [`ThisAccessorDescriptor`][this-accessor-descriptor] |
**Parameters:**
| Name: `type` | Description |
| :----------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `descriptor: ThisAccessorDescriptor` | An `object` of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type to define with the default values of the [`CommonDescriptor`][common-descriptor] |
| `callback?: ResultCallback` | An optional [`ResultCallback`][package-type-resultcallback] function to handle the result of the check whether or not the `descriptor` is an `object` with `get` or `set` property, by default it uses [`accessorCallback()`][accessordescriptors-accessorcallback] function |
**Throws:**
Throws an [`Error`][js-error] if the `descriptor` is not an `object` of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type, which means it doesn't contain `get` or `set` property.
**Returns:**
The **return value** is an `object` of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type.
**Usage:**
```typescript
// Example usage.
import { AccessorDescriptors } from '@angular-package/property';
interface PersonShape {
firstName: string;
}
class Person implements PersonShape {
firstName = '';
}
class People {
firstName!: string;
}
const person: Person = new Person();
const people: People = new People();
const firstNameDescriptor = AccessorDescriptors.define({
get(): string {
return people.firstName;
},
set(value: string): void {
people.firstName = value;
},
});
// Define the property `firstName` in the `person` object to link with the same property in the `people` object.
// Changes to the property `firstName` in the `person` object affect the property `firstName` in the `people` object.
Object.defineProperty(person, 'firstName', firstNameDescriptor);
```
### `AccessorDescriptors` Constructor
### `AccessorDescriptors()`
Creates an instance, and optionally sets an accessor descriptor of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type.
```typescript
AccessorDescriptors(descriptor?: ThisAccessorDescriptor)
```
**Generic type variables:**
| Name | Description |
| :------ | :---------- |
| `Value` | Guards the value type of the `get()` and `set()` functions of the `descriptor` object |
| `Obj` | Gives the possibility to use the `this` keyword that refers to the `Obj` variable inside the `get()` and `set()` functions of the `descriptor` object |
**Parameters:**
| Name: `type` | Description |
| :------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------- |
| `descriptor?: ThisAccessorDescriptor` | An optional `object` of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type to initially set accessor descriptor |
**Usage:**
```typescript
// Example usage.
import { AccessorDescriptors } from '@angular-package/property';
interface PersonShape {
firstName: string;
}
class Person implements PersonShape {
firstName = '';
}
class People {
firstName!: string;
}
const person: Person = new Person();
const people: People = new People();
const firstNameDescriptor = new AccessorDescriptors({
get(): string {
return people.firstName;
},
set(value: string): void {
people.firstName = value;
},
});
```
### `AccessorDescriptors` instance methods
### `AccessorDescriptors.prototype.set()`
[Strictly][accessordescriptors] sets with the last saved descriptor values, and stores privately accessor descriptor of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type.
```typescript
set(
descriptor: ThisAccessorDescriptor,
callback?: ResultCallback
): this { ... }
```
**Parameters:**
| Name: `type` | Description |
| :----------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `descriptor: ThisAccessorDescriptor` | An `object` of a [`ThisAccessorDescriptor`][this-accessor-descriptor] [interface][ts-interface], to set with the last saved descriptor values |
| `callback?: ResultCallback` | An optional [`ResultCallback`][package-type-resultcallback] function to handle the result of the check whether or not the `descriptor` is an `object` containing the `get` or `set` property, by default it uses [`accessorCallback()`][accessordescriptors-accessorcallback] from the static `guard()` method |
**Throws:**
Throws an [`Error`][js-error] if the `descriptor` is not an `object` of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type, which means doesn't contain `get` or `set` property.
**Returns:**
The **return value** is the [`AccessorDescriptors`][accessordescriptors] instance for the chaining.
**Usage:**
```typescript
// Example usage.
import { AccessorDescriptors } from '@angular-package/property';
interface PersonShape {
firstName: string;
}
class Person implements PersonShape {
firstName = '';
}
class People {
firstName!: string;
}
const person: Person = new Person();
const people: People = new People();
const firstNameDescriptor = new AccessorDescriptors().set({
configurable: false,
enumerable: false,
get(): string {
return people.firstName;
},
set(value: string): void {
people.firstName = value;
},
});
```
### `AccessorDescriptors` instance properties
### `AccessorDescriptors.prototype.get`
Get privately stored accessor descriptor of a [`ThisAccessorDescriptor`][this-accessor-descriptor] type defined by the [`set()`][accessordescriptors-prototype-set] method.
```typescript
get get(): ThisAccessorDescriptor { ... }
```
**Usage:**
```typescript
// Example usage.
import { AccessorDescriptors } from '@angular-package/property';
interface PersonShape {
firstName: string;
}
class Person implements PersonShape {
firstName = '';
}
class People {
firstName!: string;
}
const person: Person = new Person();
const people: People = new People();
const firstNameDescriptor = new AccessorDescriptors().set({
configurable: false,
enumerable: false,
get(): string {
return people.firstName;
},
set(value: string): void {
people.firstName = value;
},
});
// Define the property `firstName` in the `person` object to link with the same property in the `people` object.
// Changes to the property `firstName` in the `person` object affect the property `firstName` in the `people` object.
Object.defineProperty(person, 'firstName', firstNameDescriptor.get);
```
----
### `DataDescriptors`
Strictly defines, sets, and stores privately property data descriptor of a [`DataDescriptor`][data-descriptor] interface.
> Strictly means, data descriptor of a [`DataDescriptor`][data-descriptor] is type guarded and methods picks `configurable`, `enumerable`, `writable`, `value` properties from the provided `descriptor` object.
**Features:**
* Data descriptor is of a [`DataDescriptor`][data-descriptor] [interface][ts-interface]:
The `value` property is of a generic `Value` type.
* Guarded process of defining the object descriptor, but properties are not being checked against proper values.
* Strictly defines property data descriptor.
* Strictly sets, and stores at the same time property data descriptor.
* Method [`set()`][datadescriptors-prototype-set] of the instance and static [`define()`](datadescriptorsdefine) picks `configurable`, `enumerable`, `writable`, `value` properties from the provided data.
* Get privately stored data descriptor defined by the [`set()`][datadescriptors-prototype-set] method of the instance.
```typescript
DataDescriptors { ... }
```
### `DataDescriptors` static methods
### `DataDescriptors.define()`
Returns [**strictly**][datadescriptors] defined data descriptor of a [`DataDescriptor`][data-descriptor] [interface][ts-interface], on `writable` or `value` property detected.
```typescript
static define(
descriptor: DataDescriptor,
callback?: ResultCallback
): DataDescriptor { ... }
```
**Generic type variables:**
| Name | Description |
| :------ | :---------- |
| `Value` | Constrains the `value` property from the `descriptor` object, and the return type of a [`DataDescriptor`][data-descriptor] [interface][ts-interface] |
**Parameters:**
| Name: `type` | Description |
| :---------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| descriptor: `DataDescriptor` | An `object` of a [`DataDescriptor`][data-descriptor] [interface][ts-interface], to set with the default values of the [`CommonDescriptor`][common-descriptor] |
| callback?: `ResultCallback` | An optional [`ResultCallback`][package-type-resultcallback] function to handle the result of the check whether or not the `descriptor` is an `object` with `writable` or `value` property, by default it uses [`dataCallback()`][datadescriptors-datacallback] function from the static `guard()` method |
**Throws:**
Throws an [`Error`][js-error] if the `descriptor` is not an `object` of a [`DataDescriptor`][data-descriptor] [interface][ts-interface], which means it doesn't contain `writable` or `value` property.
**Returns:**
The **return value** is an `object` of a [`DataDescriptor`][data-descriptor] [interface][ts-interface].
**Usage:**
```typescript
// Example usage.
import { DataDescriptors } from '@angular-package/property';
interface PersonShape {
firstName: string;
}
class Person implements PersonShape {
firstName = '';
}
class People {
firstName!: string;
}
const person: Person = new Person();
const people: People = new People();
const firstNameDescriptor = DataDescriptor.define({
get(): string {
return people.firstName;
},
set(value: string): void {
people.firstName = value;
},
});
// Define the property `firstName` in the `person` object to link with the same property in the `people` object.
// Changes to the property `firstName` in the `person` object affect the property `firstName` in the `people` object.
Object.defineProperty(person, 'firstName', firstNameDescriptor);
```
### `DataDescriptors` Constructor
### `DataDescriptors()`
Creates an instance, and optionally sets a data descriptor of a [`DataDescriptor`][data-descriptor] [interface][ts-interface].
```typescript
DataDescriptors(descriptor?: DataDescriptor)
```
**Generic type variables:**
| Name | Description |
| :------ | :---------- |
| `Value` | Guards the `value` property from the `descriptor` object |
**Parameters:**
| Name: `type` | Description |
| :----------------------------------- | :------------------------------------------------------------------------------------------------------------------------------ |
| `descriptor?: DataDescriptor` | An optional `object` of a [`DataDescriptor`][data-descriptor] [interface][ts-interface] to initially set data descriptor |
**Usage:**
```typescript
// Example usage.
import { DataDescriptors } from '@angular-package/property';
interface PersonShape {
firstName: string;
}
class Person implements PersonShape {
firstName = '';
}
class People {
firstName!: string;
}
const person: Person = new Person();
const people: People = new People();
const firstNameDescriptor = new DataDescriptors({ // Initialize
writable: false,
value: 'not writable'
});
```
### `DataDescriptors` instance methods
### `DataDescriptors.prototype.set()`
[Strictly][datadescriptors] sets with the last saved descriptor values, and stores privately data descriptor of a [`DataDescriptor`][data-descriptor] [interface][ts-interface].
```typescript
set(
descriptor: DataDescriptor,
callback?: ResultCallback
): this { ... }
```
**Generic type variables:**
| Name | Description |
| :------ | :------------------------------------------------------- |
| `Value` | Guards the `value` property from the `descriptor` object |
**Parameters:**
| Name: `type` | Description |
| :---------------------------------- | :--------------------------------------------------------------------------------------------------------------------------- |
| `descriptor: DataDescriptor` | An `object` of a [`DataDescriptor`][data-descriptor] [interface][ts-interface], to set with the last saved descriptor |
| `callback?: ResultCallback` | An optional [`ResultCallback`][package-type-resultcallback] function to handle the result of the check whether or not the `descriptor` is an `object` containing the `writable` or `value` property, by default it uses [`dataCallback()`][datadescriptors-datacallback] function from the static `guard()` method |
**Throws:**
Throws an [`Error`][js-error] if the `descriptor` is not an `object` of a [`DataDescriptor`][data-descriptor] type, which means doesn't contain `writable` or `value` property.
**Returns:**
The **return value** is the [`DataDescriptors`][datadescriptors] instance for the chaining.
**Usage:**
```typescript
// Example usage.
import { DataDescriptors } from '@angular-package/property';
interface PersonShape {
firstName: string;
}
class Person implements PersonShape {
firstName = '';
}
class People {
firstName!: string;
}
const person: Person = new Person();
const people: People = new People();
const firstNameDescriptor = new DataDescriptors()
.set({
configurable: false,
enumerable: false,
writable: false,
value: people.firstName
});
// Defines the property `firstName` in the `person` object with the same value as the property in the `people` object.
Object.defineProperty(person, 'firstName', firstNameDescriptor.get);
```
### `DataDescriptors` instance properties
### `DataDescriptors.prototype.get`
Get privately stored data descriptor of a [`DataDescriptor`][data-descriptor] [interface][ts-interface] defined by the instance [`set()`][datadescriptors-prototype-set] method.
```typescript
get get(): DataDescriptor { ... }
```
**Usage:**
```typescript
// Example usage.
import { DataDescriptors } from '@angular-package/property';
interface PersonShape {
firstName: string;
}
class Person implements PersonShape {
firstName = '';
}
class People {
firstName!: string;
}
const person: Person = new Person();
const people: People = new People();
const firstNameDescriptor = new DataDescriptors()
.set({
configurable: false,
enumerable: false,
writable: false,
value: people.firstName
})
// After set, get the value.
.get;
// Defines the property `firstName` in the `person` object with the same value as the property in the `people` object.
Object.defineProperty(person, 'firstName', firstNameDescriptor);
```
----
### Descriptor interface
### AccessorDescriptor
Descriptor with its unique optional `get()` and `set()` functions, of the `Value` type. For the accessor descriptor with also the object type, please use the type [`ThisAccessorDescriptor`](#thisaccessordescriptor). More about property descriptors [here][js-object-define-property].
```typescript
interface AccessorDescriptor extends CommonDescriptor {
get?: () => Value;
set?: (value: Value) => void;
}
```
### CommonDescriptor
Common keys `configurable` and `enumerable` of a `boolean` type for [accessor][this-accessor-descriptor] and [data descriptor][data-descriptor], picked from the default `PropertyDescriptor`. More about property descriptors [here][js-object-define-property].
```typescript
interface CommonDescriptor
extends Pick {}
```
### DataDescriptor
Descriptor with its unique optional keys, `writable` of a `boolean` type and `value` of a generic `Value` type. More about property descriptors [here][js-object-define-property].
```typescript
interface DataDescriptor extends CommonDescriptor {
writable?: boolean;
value?: Value;
}
```
----
### Descriptor type
### ThisAccessorDescriptor
[`AccessorDescriptor`][accessor-descriptor] [interface][ts-interface] as a type cause of ease of use `this` of an `Obj` type in the `get()` and `set()` functions. More about property descriptors [here][js-object-define-property].
```typescript
type ThisAccessorDescriptor = AccessorDescriptor &
ThisType;
```
### Descriptors
Property descriptors container.
```typescript
export class Descriptors<
Obj extends object | Function,
Keys extends keyof Obj
> { ... }
```
## GIT
### Commit
* [AngularJS Git Commit Message Conventions][git-commit-angular]
* [Karma Git Commit Msg][git-commit-karma]
* [Conventional Commits][git-commit-conventional]
### Versioning
[Semantic Versioning 2.0.0][git-semver]
**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][property-license])
## Packages
Useful and simple to use packages.
| Package | Description | Status |
| :------------------------------------------- | :---------------------------------------------------------------- | -----: |
| [callback][callback-github-readme] | Manages the callback [`function`][js-function]. | [![npm version][callback-npm-badge-png]][callback-npm-badge] |
| [change-detection][cd-github-readme] | Improves application performance. | [![npm version][cd-npm-badge-png]][cd-npm-badge] |
| [component-loader][cl-github-readme] | Handles dynamic loading components. | [![npm version][cl-npm-badge-png]][cl-npm-badge] |
| [core][core-github-readme] | Core features. | [![npm version][core-npm-badge-png]][core-npm-badge] |
| [error][error-github-readme] | Manages an [`Error`][js-error]. | [![npm version][error-npm-badge-png]][error-npm-badge] |
| [indexeddb][indexeddb-github-readme] | Wrapper to IndexedDB client-side storage. | [![npm version][indexeddb-npm-badge-png]][indexeddb-npm-badge] |
| name | The name with prefix and suffix. | ![inprogress] |
| preferences | Preferences, settings, options, configuration and setup in steps. | ![inprogress] |
| [prism][prism-github-readme] | [`Prism`][prism-js] highlighter module. | [![npm version][prism-npm-badge-png]][prism-npm-badge] |
| [property][property-github-readme] | Handles object properties. | [![npm version][property-npm-badge-png]][property-npm-badge] |
| [range][range-github-readme] | The range between a minimum and maximum. | [![npm version][range-npm-badge-png]][range-npm-badge] |
| [reactive][reactive-github-readme] | Automatize the process of creating some rxjs features. | [![npm version][reactive-npm-badge-png]][reactive-npm-badge] |
| [sass][sass-github-readme] | Extension for sass modules and new modules. | [![npm version][sass-npm-badge-png]][sass-npm-badge] |
| [sass-list][sass-list-github-readme] | Modified list Sass module. | [![npm version][sass-list-npm-badge-png]][sass-list-npm-badge] |
| [sass-string][sass-string-github-readme] | Modified string Sass module. | [![npm version][sass-string-npm-badge-png]][sass-string-npm-badge] |
| [spectre.css][spectrecss-github-readme] | Modified Spectre.css - a lightweight, responsive, and modern CSS framework originally designed by Yan Zhu. | [![npm version][spectrecss-npm-badge-png]][spectrecss-npm-badge] |
| storage | The storage of data under allowed names. | ![inprogress] |
| tag | Any tag with optional attributes. | ![inprogress] |
| [testing][testing-github-readme] | Support for testing other packages. | [![npm version][testing-npm-badge-png]][testing-npm-badge] |
| text | Text on the template with replaceable tags. | ![inprogress] |
| [type][type-github-readme] | Common types, type guards, and type checkers. | [![npm version][type-npm-badge-png]][type-npm-badge] |
| [ui][ui-github-readme] | User interface. | [![npm version][ui-npm-badge-png]][ui-npm-badge] |
| [wrapper][wrapper-github-readme] | Wrap the text with the opening and closing chars. | [![npm version][wrapper-npm-badge-png]][wrapper-npm-badge] |
> Click on the package name to visit the package GitHub README.md
[github-badge-sponsor]: https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&link=https://github.com/sponsors/angular-package
[github-sponsor-link]: https://github.com/sponsors/angular-package
[patreon-badge]: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dsciborrudnicki%26type%3Dpatrons&style=flat
[patreon-link]: https://patreon.com/sciborrudnicki
[angulario]: https://angular.io
[skeleton]: https://github.com/angular-package/skeleton
[fix]: https://img.shields.io/badge/-fix-red
[new]: https://img.shields.io/badge/-new-green
[update]: https://img.shields.io/badge/-update-red
[inprogress]: https://img.shields.io/badge/-In%20progress-gray
[git-semver]: http://semver.org/
[git-commit-angular]: https://gist.github.com/stephenparish/9941e89d80e2bc58a153
[git-commit-karma]: http://karma-runner.github.io/0.10/dev/git-commit-msg.html
[git-commit-conventional]: https://www.conventionalcommits.org/en/v1.0.0/
[property-badge-issues]: https://img.shields.io/github/issues/angular-package/property
[property-badge-forks]: https://img.shields.io/github/forks/angular-package/property
[property-badge-stars]: https://img.shields.io/github/stars/angular-package/property
[property-badge-license]: https://img.shields.io/github/license/angular-package/property
[property-issues]: https://github.com/angular-package/property/issues
[property-forks]: https://github.com/angular-package/property/network
[property-license]: https://github.com/angular-package/property/blob/master/LICENSE
[property-stars]: https://github.com/angular-package/property/stargazers
[callback-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fcallback.svg
[callback-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fcallback.png
[callback-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fcallback
[callback-npm-readme]: https://www.npmjs.com/package/@angular-package/callback#readme
[callback-github-readme]: https://github.com/angular-package/callback#readme
[package-callback-callbackpayload]: https://github.com/angular-package/callback#callbackpayload
[package-callback-resultcallback]: https://github.com/angular-package/callback#resultcallback
[cd-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fchange-detection.svg
[cd-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fchange-detection.png
[cd-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fchange-detection
[cd-npm-readme]: https://www.npmjs.com/package/@angular-package/change-detection#readme
[cd-github-readme]: https://github.com/angular-package/change-detection#readme
[cl-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fcomponent-loader.svg
[cl-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fcomponent-loader.png
[cl-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fcomponent-loader
[cl-npm-readme]: https://www.npmjs.com/package/@angular-package/component-loader#readme
[cl-github-readme]: https://github.com/angular-package/component-loader#readme
[core-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fcore.svg
[core-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fcore.png
[core-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fcore
[core-npm-readme]: https://www.npmjs.com/package/@angular-package/core#readme
[core-github-readme]: https://github.com/angular-package/core#readme
[error-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Ferror.svg
[error-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Ferror.png
[error-npm-badge]: https://badge.fury.io/js/%40angular-package%2Ferror
[error-npm-readme]: https://www.npmjs.com/package/@angular-package/error#readme
[error-github-readme]: https://github.com/angular-package/error#readme
[indexeddb-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Findexeddb.svg
[indexeddb-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Findexeddb.png
[indexeddb-npm-badge]: https://badge.fury.io/js/%40angular-package%2Findexeddb
[indexeddb-npm-readme]: https://www.npmjs.com/package/@angular-package/indexeddb#readme
[indexeddb-github-readme]: https://github.com/angular-package/indexeddb#readme
[name-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fname.svg
[name-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fname.png
[name-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fname
[name-npm-readme]: https://www.npmjs.com/package/@angular-package/name#readme
[name-github-readme]: https://github.com/angular-package/name#readme
[preferences-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fpreferences.svg
[preferences-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fpreferences.png
[preferences-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fpreferences
[preferences-npm-readme]: https://www.npmjs.com/package/@angular-package/preferences#readme
[preferences-github-readme]: https://github.com/angular-package/preferences#readme
[prism-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fprism.svg
[prism-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fprism.png
[prism-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fprism
[prism-npm-readme]: https://www.npmjs.com/package/@angular-package/prism#readme
[prism-github-readme]: https://github.com/angular-package/prism#readme
[property-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fproperty.svg
[property-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fproperty.png
[property-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fproperty
[property-npm-readme]: https://www.npmjs.com/package/@angular-package/property#readme
[property-github-readme]: https://github.com/angular-package/property#readme
[range-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Frange.svg
[range-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Frange.png
[range-npm-badge]: https://badge.fury.io/js/%40angular-package%2Frange
[range-npm-readme]: https://www.npmjs.com/package/@angular-package/range#readme
[range-github-readme]: https://github.com/angular-package/range#readme
[reactive-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Freactive.svg
[reactive-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Freactive.png
[reactive-npm-badge]: https://badge.fury.io/js/%40angular-package%2Freactive
[reactive-npm-readme]: https://www.npmjs.com/package/@angular-package/reactive#readme
[reactive-github-readme]: https://github.com/angular-package/reactive#readme
[sass-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fsass.svg
[sass-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fsass.png
[sass-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fsass
[sass-npm-readme]: https://www.npmjs.com/package/@angular-package/sass#readme
[sass-github-readme]: https://github.com/angular-package/sass#readme
[sass-list-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fsass-list.svg
[sass-list-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fsass-list.png
[sass-list-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fsass-list
[sass-list-npm-readme]: https://www.npmjs.com/package/@angular-package/sass-list#readme
[sass-list-github-readme]: https://github.com/angular-package/sass-string#readme
[sass-string-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fsass-string.svg
[sass-string-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fsass-string.png
[sass-string-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fsass-string
[sass-string-npm-readme]: https://www.npmjs.com/package/@angular-package/sass-string#readme
[sass-string-github-readme]: https://github.com/angular-package/sass-string#readme
[spectrecss-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fspectrecss.svg
[spectrecss-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fspectrecss.png
[spectrecss-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fspectre.css
[spectrecss-npm-readme]: https://www.npmjs.com/package/@angular-package/spectre.css#readme
[spectrecss-github-readme]: https://github.com/angular-package/spectre.css#readme
[storage-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fstorage.svg
[storage-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fstorage.png
[storage-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fstorage
[storage-npm-readme]: https://www.npmjs.com/package/@angular-package/storage#readme
[storage-github-readme]: https://github.com/angular-package/storage#readme
[tag-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Ftag.svg
[tag-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Ftag.png
[tag-npm-badge]: https://badge.fury.io/js/%40angular-package%2Ftag
[tag-npm-readme]: https://www.npmjs.com/package/@angular-package/tag#readme
[tag-github-readme]: https://github.com/angular-package/tag#readme
[testing-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Ftesting.svg
[testing-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Ftesting.png
[testing-npm-badge]: https://badge.fury.io/js/%40angular-package%2Ftesting
[testing-npm-readme]: https://www.npmjs.com/package/@angular-package/testing#readme
[testing-github-readme]: https://github.com/angular-package/testing#readme
[text-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Ftext.svg
[text-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Ftext.png
[text-npm-badge]: https://badge.fury.io/js/%40angular-package%2Ftext
[text-npm-readme]: https://www.npmjs.com/package/@angular-package/text#readme
[text-github-readme]: https://github.com/angular-package/text#readme
[type-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Ftype.svg
[type-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Ftype.png
[type-npm-badge]: https://badge.fury.io/js/%40angular-package%2Ftype
[type-npm-readme]: https://www.npmjs.com/package/@angular-package/type#readme
[package-type-resultcallback]: https://github.com/angular-package/type#resultcallback
[type-github-readme]: https://github.com/angular-package/type#readme
[ui-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fui.svg
[ui-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fui.png
[ui-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fui
[ui-npm-readme]: https://www.npmjs.com/package/@angular-package/ui#readme
[ui-github-readme]: https://github.com/angular-package/ui#readme
[wrapper-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fwrapper.png
[wrapper-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fwrapper
[wrapper-npm-readme]: https://www.npmjs.com/package/@angular-package/wrapper#readme
[wrapper-github-readme]: https://github.com/angular-package/wrapper#readme
[accessor-descriptor]: #accessordescriptor
[common-descriptor]: #commondescriptor
[data-descriptor]: #datadescriptor
[this-accessor-descriptor]: #thisaccessordescriptor
[accessordescriptors]: #accessordescriptors
[accessordescriptors-define]: #accessordescriptorsdefine
[accessordescriptors-accessorcallback]: https://github.com/angular-package/property/blob/master/src/callback/src/callback.object.ts
[accessordescriptors-prototype-set]: #accessordescriptorsprototypeset
[datadescriptors]: #datadescriptors
[datadescriptors-datacallback]: https://github.com/angular-package/property/blob/master/src/callback/src/callback.object.ts
[datadescriptors-prototype-set]: #datadescriptorsprototypeset
[descriptor-defineaccessor]: #descriptordefineaccessor
[descriptor-definedata]: #descriptordefinedata
[prism-js]: https://prismjs.com/
[js-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
[array-every]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every
[array-some]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some
[classes]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes
[bigint]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt
[bigintconstructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt/BigInt
[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[booleanconstructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean/Boolean
[js-error]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
[js-function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Functions
[function-rest-parameter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/rest_parameters
[js-getter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get
[js-object-getownpropertydescriptor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor
[js-object-getOwnpropertydescriptors]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptors
[js-setter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/set
[js-hasownproperty]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty
[js-in-operator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/in
[js-number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number
[numberconstructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/Number
[js-object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
[js-object-define-property]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty
[primitive]: https://developer.mozilla.org/en-US/docs/Glossary/Primitive
[js-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp
[js-string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String
[stringconstructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/String
[js-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
[js-undefined]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined
[ts-classes]: https://www.typescriptlang.org/docs/handbook/2/classes.html
[ts-function]: https://www.typescriptlang.org/docs/handbook/2/functions.html
[ts-interface]: https://www.typescriptlang.org/docs/handbook/interfaces.html#our-first-interface