Skip to content
This repository has been archived by the owner on Nov 18, 2019. It is now read-only.

async-generators/to-array

Repository files navigation

to-array

logo

consume an iterable and return an array of all items.

NPM version Travis Status Travis Status

Usage

package requires a system that supports async-iteration, either natively or via down-compiling

Install

npm install @async-generators/to-array --save
yarn add @async-generators/to-array

This package's main entry points to a commonjs distribution.

Additionally, the module entry points to a es2015 distribution, which can be used by build systems, such as webpack, to directly use es2015 modules.

Api

toArray(source)

toArray() iterates source, adds each item to an array and returns the array when the source() iterator completes.

Example

example.js

const toArray = require('@async-generators/to-array').default;

async function main() {

  let source = async function* () {   
    yield 1; yield 2; yield 3; yield 4;
  }

  let result = await toArray(source());

  console.log(result);
}

main();

Execute with the latest node.js:

node --harmony-async-iteration example.js

output:

[ 1, 2, 3, 4 ]

Typescript

This library is fully typed and can be imported using:

import toArray from '@async-generators/to-array');

It is also possible to directly execute your properly configured typescript with ts-node:

ts-node --harmony_async_iteration example.ts

About

consume an iterable and return all items as an array

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published