Skip to content

typescript-package/storage

Repository files navigation

typescript-package/storage

npm version GitHub issues GitHub license

A lightweight TypeScript library for basic storage management.

Table of contents

Installation

1. Install peer dependencies

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

2. Install main package

npm install @typescript-package/storage --save-peer

Api

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.

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.

import { WeakStorage } from '@typescript-package/storage';

// Define a class that extends WeakStorage
export class ProfileData extends WeakStorage<number, 'age' | 'score'> {}

// 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:

Thanks for your support!

Code of Conduct

By participating in this project, you agree to follow Code of Conduct.

GIT

Commit

Versioning

Semantic Versioning 2.0.0

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)

Packages

About

The storage of data under allowed names.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published