@typedly/iterable
v1.2.0
Published
A TypeScript type definitions package for iterables.
Downloads
63
Maintainers
Readme
@typedly/iterable
A TypeScript type definitions package for iterables.
Table of contents
Related packages
- @typedly/adaptable-data: A TypeScript type definitions for data adapter.
- @typedly/collection: A TypeScript type definitions package for data collections with customizable storage.
- @typedly/configurable-data: A TypeScript type definitions for configurable data.
- @typedly/data-adapter: A TypeScript type definitions for data adapter.
- @typedly/data-traits: A TypeScript type definitions for data traits.
- @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/iterable --save-peerApi
import {
AnyIterable,
AnyIterableConstructor,
AnyIterableElement,
AsyncIterableElement,
IterValue,
IterableConstructor,
IterableElement,
} from '@typedly/iterable';AnyIterableConstructor
Any iterable constructor, defining how to create instances of any iterables, including both synchronous and asynchronous iterables.
import { AnyIterableConstructor } from '@typedly/iterable';AnyIterableElement
The element type of an iterable or async iterable.
import { AnyIterableElement } from '@typedly/iterable';AnyIterable
Represents any iterable collection, either synchronous or asynchronous.
import { AnyIterable } from '@typedly/iterable';AsyncIterableElement
The async iterate element type.
import { AsyncIterableElement } from '@typedly/iterable';IterValue
The element type of an iterable.
import { IterValue } from '@typedly/iterable';IterableConstructor
Iterable constructor, defining how to create instances of iterables.
import { IterableConstructor } from '@typedly/iterable';IterableElement
The iterated value type.
import { IterableElement } from '@typedly/iterable';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:
or via Trust Wallet
Thanks for your support!
Code of Conduct
By participating in this project, you agree to follow Code of Conduct.
GIT
Commit
Versioning
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
- @typescript-package/chain-descriptor: A TypeScript library for chain property descriptor.
- @typescript-package/controlled-descriptor: A TypeScript library for controlled property descriptor.
- @typescript-package/controller: A TypeScript package with for various kind of controllers.
- @typescript-package/descriptor-chain: A TypeScript library for property descriptor chain.
- @typescript-package/descriptor: A TypeScript library for property descriptor.
- @typescript-package/descriptors: A TypeScript library for property descriptors.
- @typescript-package/property: A TypeScript package with features to handle object properties.
- @typescript-package/wrap-descriptor: A TypeScript package for wrapping object descriptors.
- @typescript-package/wrap-property: A TypeScript package for wrapping object properties.
- @typescript-package/wrapped-descriptor: A lightweight TypeScript library for wrapped property descriptor.
- @xtypescript/property - A comprehensive, reactive TypeScript library for precise and extensible object property control.
