Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@n1ru4l/push-pull-async-iterable-iterator
Advanced tools
[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/) [![npm version](https://img.shields.io/npm/v/@n1ru4l/push-pull-async-iterable-iterator)](https://www.npmjs.com/package/@n1ru4l/push-pull-async
@n1ru4l/push-pull-async-iterable-iterator is a utility library for creating and working with async iterable iterators in a push-pull fashion. It allows you to easily create async iterators that can be pushed to and pulled from, making it useful for scenarios like handling streams of data, event handling, and more.
Creating a Push-Pull Async Iterable Iterator
This feature allows you to create an async iterable iterator that you can push values to and pull values from. The example demonstrates creating an iterator, pushing values to it, and iterating over those values asynchronously.
const { createPushPullAsyncIterableIterator } = require('@n1ru4l/push-pull-async-iterable-iterator');
const { asyncIterableIterator, pushValue, stop } = createPushPullAsyncIterableIterator();
(async () => {
for await (const value of asyncIterableIterator) {
console.log(value);
}
})();
pushValue(1);
pushValue(2);
pushValue(3);
stop();
Handling Errors
This feature allows you to handle errors within the async iterable iterator. The example demonstrates pushing an error to the iterator and handling it within the async iteration loop.
const { createPushPullAsyncIterableIterator } = require('@n1ru4l/push-pull-async-iterable-iterator');
const { asyncIterableIterator, pushValue, pushError, stop } = createPushPullAsyncIterableIterator();
(async () => {
try {
for await (const value of asyncIterableIterator) {
console.log(value);
}
} catch (error) {
console.error('Error:', error);
}
})();
pushValue(1);
pushError(new Error('Something went wrong!'));
stop();
Stopping the Iterator
This feature allows you to stop the async iterable iterator. The example demonstrates pushing values to the iterator and then stopping it, which ends the iteration loop.
const { createPushPullAsyncIterableIterator } = require('@n1ru4l/push-pull-async-iterable-iterator');
const { asyncIterableIterator, pushValue, stop } = createPushPullAsyncIterableIterator();
(async () => {
for await (const value of asyncIterableIterator) {
console.log(value);
}
console.log('Iterator stopped');
})();
pushValue(1);
pushValue(2);
stop();
RxJS is a library for reactive programming using Observables, to make it easier to compose asynchronous or callback-based code. It provides similar functionality to @n1ru4l/push-pull-async-iterable-iterator in terms of handling streams of data and events, but it is more comprehensive and includes a wide range of operators for transforming and combining streams.
Most.js is a high-performance FRP (Functional Reactive Programming) library. It provides a similar push-pull mechanism for handling streams of data and events. Compared to @n1ru4l/push-pull-async-iterable-iterator, Most.js focuses on performance and offers a rich set of operators for stream manipulation.
Bacon.js is a small functional reactive programming library for JavaScript. It provides similar functionality for handling streams of data and events. Bacon.js offers a more functional approach compared to @n1ru4l/push-pull-async-iterable-iterator and includes a variety of combinators and operators for working with streams.
@n1ru4l/push-pull-async-iterable-iterator
Create an AsyncIterableIterator from anything (on any modern platform) while handling back-pressure!
yarn install -E @n1ru4l/push-pull-async-iterable-iterator
Standalone Usage
import { makePushPullAsyncIterableIterator } from "@n1ru4l/push-pull-async-iterable-iterator";
const {
pushValue,
asyncIterableIterator
} = makePushPullAsyncIterableIterator();
pushValue(1);
pushValue(2);
pushValue(3);
// prints 1, 2, 3
for await (const value of asyncIterableIterator) {
console.log(value);
}
Check if something is an AsyncIterable
import { isAsyncIterable } from "@n1ru4l/push-pull-async-iterable-iterator";
if (isAsyncIterable(something)) {
for await (const value of something) {
console.log(value);
}
}
Note: On Safari iOS Symbol.asyncIterator
is not available, therefore all async iterators used must be build using AsyncGenerators.
If a AsyncIterable that is NO AsyncGenerator is passed to isAsyncIterable
on the Safari iOS environment, it will return the value false
.
Wrap a Sink
import { makeAsyncIterableIteratorFromSink } from "@n1ru4l/push-pull-async-iterable-iterator";
// let's use some GraphQL client :)
import { createClient } from "graphql-ws/lib/use/ws";
const client = createClient({
url: "ws://localhost:3000/graphql"
});
const asyncIterableIterator = makeAsyncIterableIteratorFromSink(sink => {
const dispose = client.subscribe(
{
query: "{ hello }"
},
{
next: sink.next,
error: sink.error,
complete: sink.complete
}
);
return () => dispose();
});
for await (const value of asyncIterableIterator) {
console.log(value);
}
Apply an AsyncIterableIterator to a sink
import Observable from "zen-observable";
import {
makePushPullAsyncIterableIterator,
applyAsyncIterableIteratorToSink
} from "@n1ru4l/push-pull-async-iterable-iterator";
const { asyncIterableIterator } = makePushPullAsyncIterableIterator();
const observable = new Observable(sink => {
const dispose = applyAsyncIterableIteratorToSink(asyncIterableIterator, sink);
// dispose will be called when the observable subscription got destroyed
// the dispose call will ensure that the async iterator is completed.
return () => dispose();
});
const subscription = observable.subscribe({
next: console.log,
complete: () => console.log("done."),
error: () => console.log("error.")
});
const interval = setInterval(() => {
iterator.push("hi");
}, 1000);
setTimeout(() => {
subscription.unsubscribe();
clearInterval(interval);
}, 5000);
Put it all together
import { Observable, RequestParameters, Variables } from "relay-runtime";
import { createClient } from "graphql-ws/lib/use/ws";
import {
makeAsyncIterableFromSink,
applyAsyncIterableIteratorToSink
} from "@n1ru4l/push-pull-async-iterable-iterator";
import { createApplyLiveQueryPatch } from "@n1ru4l/graphql-live-query-patch";
const client = createClient({
url: "ws://localhost:3000/graphql"
});
export const execute = (request: RequestParameters, variables: Variables) => {
if (!request.text) {
throw new Error("Missing document.");
}
const query = request.text;
return Observable.create<GraphQLResponse>(sink => {
// Create our asyncIterator from a Sink
const executionResultIterator = makeAsyncIterableFromSink(wsSink => {
const dispose = client.subscribe({ query }, wsSink);
return () => dispose();
});
const applyLiveQueryPatch = createApplyLiveQueryPatch();
// apply some middleware to our asyncIterator
const compositeIterator = applyLiveQueryPatch(executionResultIterator);
// Apply our async iterable to the relay sink
// unfortunately relay cannot consume an async iterable right now.
const dispose = applyAsyncIterableIteratorToSink(compositeIterator, sink);
// dispose will be called by relay when the observable is disposed
// the dispose call will ensure that the async iterator is completed.
return () => dispose();
});
};
3.0.0
FAQs
[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/) [![npm version](https://img.shields.io/npm/v/@n1ru4l/push-pull-async-iterable-iterator)](https://www.npmjs.com/package/@n1ru4l/push-pull-async
The npm package @n1ru4l/push-pull-async-iterable-iterator receives a total of 280,796 weekly downloads. As such, @n1ru4l/push-pull-async-iterable-iterator popularity was classified as popular.
We found that @n1ru4l/push-pull-async-iterable-iterator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.