@typescript-package/data/README.md

A lightweight TypeScript library for basic data management.

<a href="https://www.typescriptlang.org/">
  <img
    src="https://avatars.githubusercontent.com/u/189666396?s=150&u=9d55b1eb4ce258974ead76bf07ccf49ef0eb0ea7&v=4"
    title="The typescript package enhances the development of typescript-based applications by providing well-structured, reusable, easy-to-use packages."
  />
</a>

## typescript-package/data

<!-- npm badge -->
[![npm version][typescript-package-npm-badge-svg]][typescript-package-npm-badge]
[![GitHub issues][typescript-package-badge-issues]][typescript-package-issues]
[![GitHub license][typescript-package-badge-license]][typescript-package-license]

A lightweight **TypeScript** library for basic data management.

## Table of contents

- [Installation](#installation)
- [Api](#api)
  - Abstract
    - [`Immutability`](#immutability)
    - [`DataCore`](#datacore)
  - Base
    - [`Data`](#data)
    - [`Value`](#value)
    - [`ImmutableData`](#immutabledata)
    - [`ReadonlyData`](#readonlydata)
  - WeakData
    - [`IndexedWeakData`](#indexedweakdata)
    - [`WeakData`](#weakdata)
- [Immutability](#immutability)
  - [Sealed](#sealed)
  - [Frozen](#frozen)
  - [Locked](#locked)
- [Contributing](#contributing)
- [Support](#support)
- [Code of Conduct](#code-of-conduct)
- [Git](#git)
  - [Commit](#commit)
  - [Versioning](#versioning)
- [License](#license)

## 📦 Related Packages

| Package                   | Description                                       |
|---------------------------|---------------------------------------------------|
| [`@typescript-package/map`](https://github.com/typescript-package/map) | A lightweight **TypeScript** library for enhanced `map` management. |
| [`@typescript-package/set`](https://github.com/typescript-package/set) | A lightweight **TypeScript** library for enhanced `set` management. |

## Installation

```bash
npm install @typescript-package/data --save-peer
```

## Api

Base.

```typescript
import {
  // Abstract.
  DataCore,
  Immutability,

  // Class.
  Data,
  ImmutableData,
  ReadonlyData,
  Value,

  // `WeakData`.
  NamedWeakData,
  // Indexed.
  IndexedWeakData,
  // Basic.
  WeakData,
} from '@typescript-package/data';
```

Constant

```typescript
// Constant.
import { SymbolValue  } from '@typescript-package/data';
```

Interface

```typescript
// Interface.
import {
  DataConstructor,
  MapTypeConstructor,
  SetTypeConstructor,
  WeakMapTypeConstructor
} from '@typescript-package/data';
```

Type

```typescript
// Type.
import {
  DataConstructorInput,
  ImmutableArray,
} from '@typescript-package/data';
```

### Abstract

### `Immutability`

Manages the immutability states of `this` current instance.

```typescript
import { Immutability } from '@typescript-package/data';
```

### `DataCore`

The base abstraction with immutability for handling data-related classes.

```typescript
import { DataCore } from '@typescript-package/data';
```

### Base

### `Data`

The `Data` class is a concrete class that wraps a value and provides methods for setting, retrieving, and destroying the value.

```typescript
import { Data } from '@typescript-package/data';

// Example subclass of Data
class StringData extends Data<string> {
  constructor(value: string) {
    super(value);
  }
}

const data = new StringData("Hello, world!");

// Access the current value
console.log(data.value); // ➝ Hello, world!

// Update the value
data.set("New value");
console.log(data.value); // ➝ New value

// Destroy the value
data.destroy();
console.log(data.value); // Throws error or undefined (based on how it's handled)
```

### `Value`

The class to manage the value of generic type variable `Type`.

```typescript
import { Value } from '@typescript-package/data';

// Create a Value instance to hold a number
const numValue = new Value<number>(10);

console.log(numValue.value); // ➝ 10
console.log(numValue.tag);   // ➝ "Value"

// Update the stored number
numValue.set(42);

console.log(numValue.value); // ➝ 42
```

### `ImmutableData`

```typescript
import { ImmutableData } from '@typescript-package/data';

const immutableData = new ImmutableData(['string', 27, false]);

// immutableData.value[0] = 'new string'; // Cannot assign to '0' because it is a read-only property.
try {
  (immutableData.value[0] as any) = 'new string' // Cannot assign to read only property '0' of object '[object Array]'
} catch(e) {}

console.debug(`immutableData.value: `, immutableData.value); // ➝ ['string', 27, false]
```

### `ReadonlyData`

```typescript
import { ReadonlyData } from '@typescript-package/data';

let readonlyData = new ReadonlyData(['string', 27, false]);

console.log(`readonlyData: `, readonlyData);

// readonlyData.value[0] = 'new string'; // Cannot assign to '0' because it is a read-only property.
(readonlyData.value[0] as any) = 'new string' // Can assign with using `any`.

console.log(`readonlyData.value: `, readonlyData.value); // ➝ ['new string', 27, false]
```

### WeakData

### `IndexedWeakData`

```typescript
import { IndexedWeakData } from '@typescript-package/data';

// Create an interface.
export interface Profile {
  id: number,
  age: number;
  score: number;
}

// Initialize multiple instances of `IndexedWeakData`.
export const profileData1 = new IndexedWeakData({ id: 1, age: 27, score: 1100 } as Profile, 'id');
export const profileData2 = new IndexedWeakData({ id: 2, age: 127, score: 1200 } as Profile, 'id');
export const profileData3 = new IndexedWeakData({ id: 3, age: 227, score: 1300 } as Profile, 'id');
export const profileData4 = new IndexedWeakData({ id: 4, age: 327, score: 1400 } as Profile, 'id');

// Get the value by using index.
console.log(`profileData1: `, profileData1.getByIndex(1)); // ➝ {id: 1, age: 27, score: 1100}
console.log(`profileData3: `, profileData3.getByIndex(3)); // ➝ {id: 3, age: 227, score: 1300}
```

### `WeakData`

The `WeakData` class is a concrete class that stores data in a static `WeakMap`.

```typescript
import { WeakData } from '@typescript-package/data';

// Example subclass of WeakData
export class StringWeakData extends WeakData<string> {
  constructor(value: string) {
    super(value);
  }
}

// Create a new instance of StringWeakData
export const data = new StringWeakData("Hello, world!");

// Access the current value
console.log(data.value); // ➝ Hello, world!

// Update the value
data.set("New value");
console.log(data.value); // ➝ New value

// Destroy the value
data.destroy();
```

## Immutability

### Sealed

Provides structural immutability, but not value immutability. The least strict form of immutability.
Sealing an object prevents adding or removing properties, but it does not restrict modifying the values of existing properties.

### Frozen

Provides structural and shallow immutability. Stricter than seal.
Freezing an object prevents changes to the object’s properties at the top level. This means that you cannot modify, add, or delete properties, but nested objects can still be mutated.

### Locked

Combines the features of `freeze`, but extends immutability to nested structures(deep immutability).
Locking(deep) an object prevents changing any properties at any level, including properties within nested objects.

## Contributing

Your contributions are valued! If you'd like to contribute, please feel free to submit a pull request. Help is always appreciated.

## Support

If you find this package useful and would like to support its and general development, you can contribute through one of the following payment methods. Your support helps maintain the packages and continue adding new.

Support via:

- [Stripe](https://donate.stripe.com/dR614hfDZcJE3wAcMM)
- [Revolut](https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29)

Thanks for your support!

## Code of Conduct

By participating in this project, you agree to follow **[Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)**.

## 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 © typescript-package ([license][typescript-package-license])

## Packages

- **[@typescript-package/affix](https://github.com/typescript-package/affix)**: A **lightweight TypeScript** library for the affix - prefix and suffix.
- **[@typescript-package/are](https://github.com/typescript-package/are)**: Type-safe `are` checkers for validating value types in TypeScript.


- **[@typescript-package/descriptor](https://github.com/typescript-package/descriptor)**: A **lightweight TypeScript** library for property descriptor.
- **[@typescript-package/guard](https://github.com/typescript-package/guard)**: Type-safe guards for guarding the value types in TypeScript.c
- **[@typescript-package/history](https://github.com/typescript-package/history)**: A **TypeScript** package for tracking history of values.
- **[@typescript-package/is](https://github.com/typescript-package/is)**: Type-safe is checkers for validating value types in TypeScript.
- **[@typescript-package/name](https://github.com/typescript-package/name)**: A **lightweight TypeScript** library for the name with prefix and suffix.
- **[@typescript-package/property](https://github.com/typescript-package/property)**: A **lightweight TypeScript** package with features to handle object properties.
- **[@typescript-package/queue](https://github.com/typescript-package/queue)**: A **lightweight TypeScript** library for managing various queue and stack structures.
- **[@typescript-package/range](https://github.com/typescript-package/range)**: A **lightweight TypeScript** library for managing various types of ranges.
- **[@typescript-package/regexp](https://github.com/typescript-package/regexp)**: A **lightweight TypeScript** library for **RegExp**.
- **[@typescript-package/state](https://github.com/typescript-package/state)**: Simple state management for different types in **TypeScript**.
- **[@typescript-package/storage](https://github.com/typescript-package/storage)**: The storage of data under allowed names.
- **[@typescript-package/type](https://github.com/typescript-package/type)**: Utility types to enhance and simplify **TypeScript** development.
- **[@typescript-package/wrapper](https://github.com/typescript-package/wrapper)**: A **lightweight TypeScript** library to wrap the text with the opening and closing chars.

<!-- This package: typescript-package  -->
  <!-- GitHub: badges -->
  [typescript-package-badge-issues]: https://img.shields.io/github/issues/typescript-package/data
  [isscript-package-badge-forks]: https://img.shields.io/github/forks/typescript-package/data
  [typescript-package-badge-stars]: https://img.shields.io/github/stars/typescript-package/data
  [typescript-package-badge-license]: https://img.shields.io/github/license/typescript-package/data
  <!-- GitHub: badges links -->
  [typescript-package-issues]: https://github.com/typescript-package/data/issues
  [typescript-package-forks]: https://github.com/typescript-package/data/network
  [typescript-package-license]: https://github.com/typescript-package/data/blob/master/LICENSE
  [typescript-package-stars]: https://github.com/typescript-package/data/stargazers
<!-- This package -->

<!-- Package: typescript-package -->
  <!-- npm -->
  [typescript-package-npm-badge-svg]: https://badge.fury.io/js/@typescript-package%2Fdata.svg
  [typescript-package-npm-badge]: https://badge.fury.io/js/@typescript-package%2Fdata

<!-- GIT -->
[git-semver]: http://semver.org/

<!-- GIT: commit -->
[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/