Skip to content

typedly/iterable

Repository files navigation

@typedly/iterable

npm version GitHub issues GitHub license

GitHub issues GitHub forks GitHub stars GitHub license

GitHub Sponsors Patreon Sponsors

A TypeScript type definitions package for iterables.

Table of contents

Related packages

Installation

npm install @typedly/iterable --save-peer

Api

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';

Source

AnyIterableElement

The element type of an iterable or async iterable.

import { AnyIterableElement } from '@typedly/iterable';

Source

AnyIterable

Represents any iterable collection, either synchronous or asynchronous.

import { AnyIterable } from '@typedly/iterable';

Source

AsyncIterableElement

The async iterate element type.

import { AsyncIterableElement } from '@typedly/iterable';

Source

IterValue

The element type of an iterable.

import { IterValue } from '@typedly/iterable';

Source

IterableConstructor

Iterable constructor, defining how to create instances of iterables.

import { IterableConstructor } from '@typedly/iterable';

Source

IterableElement

The iterated value type.

import { IterableElement } from '@typedly/iterable';

Source

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

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

About

A TypeScript type definitions package for iterables.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors