@typescript-package/collection

A lightweight TypeScript package for data collection.

Table of contents

• Installation
• Api
  • Abstract
    • CollectionBase
    • ConfigurableCollectionBase
  • Concrete
    • Collection
    • ConfigurableCollection
    • HybridCollection
• Contributing
• Code of Conduct
• Git
  • Commit
  • Versioning
• License

Installation

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

Api

import {
  // Abstract.
  CollectionBase,
  ConfigurableCollectionBase,
  // Concrete.
  Collection,
  ConfigurableCollection,
  HybridCollection
} from '@typescript-package/collection';

Abstract

CollectionBase

The base functionality abstraction for collections.

import { CollectionBase } from '@typescript-package/collection';

Return types for collection methods

| Method | Returns this for chaining? | Uses asyncReturn helper? | Returns adapter result? | |-------------|:----------------------------:|:--------------------------:|:-----------------------:| | add | ✓ | ✓ | ✗ | | forEach | ✓ | ✓ | ✗ | | delete | ✗ | ✓ | ✓ | | has | ✗ | ✓ | ✓ | | lock | ✓ | ✗ | ✗ | | toArray | ✓ | ✓ | ✓ |

All methods that can be asynchronous make use of the asyncReturn helper, which adapts return types to be synchronous (this) or asynchronous (Promise<this>) depending on the collection's mode (R).

CollectionBase

ConfigurableCollectionBase

The base functionality abstraction for collections.

import { SetAdapter } from '@typescript-package/collection-adapter';
import { ConfigurableCollection } from '@typescript-package/collection';

export class ConfigurableSetAdapter<
  const C extends CollectionSettings<E, T, false>,
  E,
  T extends Set<E>,
  R
> extends SetAdapter<E, T> {
  constructor(settings: C, ...elements: E[]) {
    super(...elements);
  }
}

// Initialize.s
const collection = new ConfigurableCollection(
  {async: false},
  ConfigurableSetAdapter,
  1, 2, '3' as string | number
);

// Adds.
collection.add(27, 29, 31);
// Deletes.
collection.delete(29, 31, 22);

for (const element of collection) {
  console.log(`element: `, element);
}

console.log(`size: `, collection.size); // Output: 4

ConfigurableCollectionBase

Concrete

Collection

The collection concrete class with adapter support.

import { SetAdapter } from '@typescript-package/collection-adapter';
import { Collection } from '@typescript-package/collection';

// Initialize.
const collection = new Collection(
  SetAdapter,
  1, 2, '3' as string | number
);

// Adds.
collection.add(27, 29, 31);
// Deletes.
collection.delete(29, 31, 22);

for (const element of collection) {
  console.log(`element: `, element);
}

console.log(`size: `, collection.size); // Output: 4

Collection

ConfigurableCollection

The configurable collection concrete class with adapter support.

import { ConfigurableCollection } from '@typescript-package/collection';
import { CollectionSettings } from "@typedly/collection";
import { SetAdapter } from '@typescript-package/collection-adapter';

export class ConfigurableSetAdapter<
  const C extends CollectionSettings<E, T, false>,
  E,
  T extends Set<E>,
  R
> extends SetAdapter<E, T> {
  configuration: C;
  constructor(settings: C, ...elements: E[]) {
    super(...elements);
    this.configuration = settings;
  }
}

const collection = new ConfigurableCollection(
  {async: false, capacity: 10 as number},
  ConfigurableSetAdapter,
  1, 2, '3' as string | number
);

// Adds.
collection.add(27, 29, 31);
// Deletes.
collection.delete(29, 31, 22);

for (const element of collection) {
  console.log(`element: `, element);
}

console.log(`size: `, collection.size); // Output: 4

const capacityCollection = collection.with({async: false, capacity: 20});

console.log(`capacityCollection.configuration: `, capacityCollection.configuration); // Output: { async: false, capacity: 20 }
console.log(`collection.configuration: `, collection.configuration); // Output: { async: false, capacity: 10 }

ConfigurableCollection

HybridCollection

The hybrid collection concrete class adapter support for switchable asynchronous state.

import { HybridCollection } from '@typescript-package/collection';
import { SetAdapter } from '@typescript-package/collection-adapter';

// Initialize.
const collection = new HybridCollection(
  false as boolean,
  SetAdapter,
  1, 2, '3' as string | number
);

// Adds.
collection.add(27, 29, 31);
// Deletes.
collection.delete(29, 31, 22);

for (const element of collection) {
  console.log(`element: `, element);
}

// For proper hybrid collection, we can switch to async mode and perform async operations.
const asyncCollection = collection.with(true)
asyncCollection.add(42, 43, 44);

HybridCollection

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:

• 4Fund
• DonorBox
• GitHub
• Ko-fi
• OpenCollective
• Patreon
• PayPal
• Stripe
• ~~Revolut~~

or via Trust Wallet

• BNB
• BTC
• ETH
• USDT (BEP20)
• XLM

Thanks for your support!

Code of Conduct

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

GIT

Commit

Please follow the following commit message conventions:

• AngularJS Git Commit Message Conventions
• Karma Git Commit Msg
• Conventional Commits

Versioning

The package follows Semantic Versioning 2.0.0 for all releases. The versioning format is:

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)