https://github.com/typescript-package/storage
The storage of data under allowed names.
https://github.com/typescript-package/storage
Last synced: 20 days ago
JSON representation
The storage of data under allowed names.
- Host: GitHub
- URL: https://github.com/typescript-package/storage
- Owner: typescript-package
- License: mit
- Created: 2024-11-30T09:01:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-15T17:47:57.000Z (10 months ago)
- Last Synced: 2025-10-11T10:25:41.698Z (4 months ago)
- Language: TypeScript
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## typescript-package/storage
[![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 storage management.
## Table of contents
- [Installation](#installation)
- [Api](#api)
- [`IndexedWeakStorage`](#indexedweakstorage)
- [`WeakStorage`](#weakstorage)
- [Contributing](#contributing)
- [Support](#support)
- [Code of Conduct](#code-of-conduct)
- [Git](#git)
- [Commit](#commit)
- [Versioning](#versioning)
- [License](#license)
## Installation
### 1. Install peer dependencies
```bash
npm install @typescript-package/data --save-peer
```
### 2. Install main package
```bash
npm install @typescript-package/storage --save-peer
```
## Api
```typescript
import {
IndexedWeakStorage,
WeakStorage,
} from '@typescript-package/storage';
```
### `IndexedWeakStorage`
The `IndexedWeakStorage` class is a concrete class that manages `IndexedWeakStorage` instance in a static `Map` where data is associated with a specified name in the `WeakMap` and index provided by the given `key`.
```typescript
import { IndexedWeakStorage } from '@typescript-package/storage';
export interface Profile {
id: number,
age: number;
score: number;
firstName: string;
lastName: string;
};
new IndexedWeakStorage(
{ id: 1, firstName: 'first', lastName: 'last', age: 27, score: 1100 } as Profile,
'id',
'profiles1'
);
new IndexedWeakStorage(
{ id: 1, firstName: 'first1', lastName: 'last1', age: 127, score: 1200 } as Profile,
'id',
'profiles2'
);
console.log(
`IndexedWeakStorage.getByIndex(1, 'profiles2'): `,
IndexedWeakStorage.getByIndex(1, 'profiles2') // { id: 1, firstName: 'first1', lastName: 'last1', age: 127, score: 1200 }
);
```
### `WeakStorage`
The `WeakStorage` class is a concrete class that manages `WeakStorage` instance in a static `Map` where data is associated with a specified name in the `WeakMap`.
```typescript
import { WeakStorage } from '@typescript-package/storage';
// Define a class that extends WeakStorage
export class ProfileData extends WeakStorage {}
// Create two instances with different names
const ageData = new ProfileData(25, 'age');
const scoreData = new ProfileData(90, 'score');
// Access the values stored in each instance using their respective names
console.log(ageData.value); // Outputs: 25
console.log(scoreData.value); // Outputs: 90
// You can also retrieve the data from another instance using the static method `getFrom`
console.log(WeakStorage.get('age', ageData)); // Outputs: 25
console.log(WeakStorage.get('score', scoreData)); // Outputs: 90
// Setting new values
ageData.set(30);
console.log(ageData.value); // Outputs: 30
// Destroy an instance and clear its stored data
ageData.destroy();
console.log(WeakStorage.get('age', ageData)); // Outputs: undefined
// Clear all stored values from the map
scoreData.delete();
console.log(WeakStorage.get('score', scoreData)); // Outputs: undefined
```
## 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/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.
[typescript-package-badge-issues]: https://img.shields.io/github/issues/typescript-package/storage
[isscript-package-badge-forks]: https://img.shields.io/github/forks/typescript-package/storage
[typescript-package-badge-stars]: https://img.shields.io/github/stars/typescript-package/storage
[typescript-package-badge-license]: https://img.shields.io/github/license/typescript-package/storage
[typescript-package-issues]: https://github.com/typescript-package/storage/issues
[typescript-package-forks]: https://github.com/typescript-package/storage/network
[typescript-package-license]: https://github.com/typescript-package/storage/blob/master/LICENSE
[typescript-package-stars]: https://github.com/typescript-package/storage/stargazers
[typescript-package-npm-badge-svg]: https://badge.fury.io/js/@typescript-package%2Fstorage.svg
[typescript-package-npm-badge]: https://badge.fury.io/js/@typescript-package%2Fstorage
[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/