@typedly/configurable-collection

A TypeScript type definitions package for configurable collections with configuration based on @typedly/collection.

Features

• Adapter: The default interface for adapters in collections.
• Constructor: The constructor type for initialization with custom storage (e.g. Set, Array).
• Shape: The shape of element-based collection built on @typedly/data.
• Customizable Storage: Support for various storage types (Set<T>, T[], etc.) via generics with add/remove/iterate.
• Iteration & Symbols: Built-in [Symbol.iterator] for spread/for-of, with [Symbol.toStringTag] for debugging.
• TypeScript-Only: Zero runtime, pure type definitions for type-safe collections.

Table of contents

• Related packages
• Installation
• Api
  • Adapter
    • ConfigurableCollectionAdapter
  • Constructor
    • ConfigurableCollectionAdapterConstructor
    • ConfigurableCollectionConstructor
  • Main
    • ConfigurableCollectionShape
• Contributing
• Support
• Code of Conduct
• Git
  • Commit
  • Versioning
• License
• Packages

Related packages

Peer dependencies

• @typedly/collection: A TypeScript type definitions package for data collections with customizable storage.
• @typedly/configurable-data: A TypeScript type definitions package for configurable, composable, trait-driven data models.

Collection

• @typedly/adaptable-collection: A TypeScript type definitions package for adaptable data collections with configuration, adapter support based on @typedly/configurable-collection.

General

• @typedly/adaptable-data: A TypeScript type definitions for data adapter.
• @typedly/data-traits: A TypeScript type definitions package for configurable data traits, providing various kinds of configurable data interfaces.
• @typedly/data: A TypeScript type definitions for @typescript-package/data.
• @typescript-package/data: A lightweight TypeScript library for basic data management.
• @typescript-package/collection: A lightweight TypeScript library for data collection.

Installation

npm install @typedly/configurable-collection --save-peer

Api

import {
  // Adapter.
  ConfigurableCollectionAdapter,
  // Constructor.
  ConfigurableCollectionConstructor,
  ConfigurableCollectionAdapterConstructor,
  // Interface.
  ConfigurableCollectionShape,
} from '@typedly/configurable-collection';

Adapter

ConfigurableCollectionAdapter

The ConfigurableCollectionAdapter interface defines a adapter collection data structure that can be configured based on the provided settings.

import { ConfigurableCollectionAdapter } from '@typedly/configurable-collection';

Constructor

ConfigurableCollectionAdapterConstructor

The configurable collection adapter constructor type, which defines the structure for creating instances of configurable collection adapters.

import { ConfigurableCollectionAdapterConstructor } from '@typedly/configurable-collection';

ConfigurableCollectionConstructor

The constructor type for ConfigurableCollection.

import { ConfigurableCollectionConstructor } from '@typedly/configurable-collection';

Main

ConfigurableCollectionShape

The shape of configurable collection data structure, which can be implemented by various types of collections such as sets, arrays, or maps.

import { ConfigurableCollectionShape } from '@typedly/configurable-collection';

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

Code of Conduct

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

GIT

Commit

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

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 © typedly (license)

Packages

• @typedly/array: A TypeScript type definitions package to handle array-related operations.
• @typedly/callback: A TypeScript type definitions package for asynchronous and synchronous callback functions of various types.
• @typedly/character: A TypeScript type definitions package for various character types.
• @typedly/context: A TypeScript type definitions package for context data structures.
• @typedly/descriptor: A TypeScript type definitions package for property descriptor.
• @typedly/digit: A TypeScript type definitions package for digit types.
• @typedly/letter: A TypeScript type definitions package for handling letter types.
• @typedly/object: A TypeScript type definitions package to handle object-related operations.
• @typedly/payload: A TypeScript type definitions package for payload data structures.
• @typedly/property: A TypeScript type definitions package to handle object property-related operations.
• @typedly/regexp: A TypeScript type definitions package for RegExp.
• @typedly/symbol: A TypeScript type definitions package for various symbols.