@push-stream-std/push-sort (0.0.5)

Published 2026-07-20 19:00:10 +00:00 by Dvorak

Set up this registry in your project .npmrc file:

@push-stream-std:registry=https://hub.kl1.tenere.ai/api/packages/push-stream-std/npm/

To install the package using npm, run the following command:

npm install @push-stream-std/push-sort@0.0.5

or add it to the package.json file:

"@push-stream-std/push-sort": "0.0.5"

For more information on the npm registry, see the documentation.

push-sort

Buffer an entire push-stream, then emit values in sorted order.

Published as @push-stream-std/push-sort.

Synopsis

import { sort } from '@push-stream-std/push-sort';
import { values } from '@push-stream-std/push-values';
import { collect } from '@push-stream-std/push-collect';

values([3, 1, 4, 1, 5, 9])
  .pipe(sort((a, b) => a - b))
  .pipe(collect((err, results) => {
    console.log(results); // [1, 1, 3, 4, 5, 9]
  }));

With max buffer size limit:

values([3, 1, 4, 1, 5, 9])
  .pipe(sort((a, b) => a - b, { maxSize: 1000 }))
  .pipe(collect((err, results) => {
    if (err) console.error('buffer exceeded:', err.message);
    else console.log(results);
  }));

Install

npm config set @push-stream-std:registry https://hub.kl1.tenere.ai/api/packages/push-stream-std/npm/
npm config set -- //hub.kl1.tenere.ai/api/packages/push-stream-std/npm/:_authToken "$PACKAGE_TOKEN"
npm install @push-stream-std/push-sort

Description

A push-stream through operator that accumulates all incoming values into an internal buffer. When the source ends successfully, the buffer is sorted using the provided comparator and each value is emitted in sorted order to the sink. An optional maxSize limit prevents unbounded memory growth — exceeding the limit causes the stream to end with an error with code MAX_SIZE_EXCEEDED. Values arriving after the stream has ended are ignored.

API

`sort(comparator, [options])`

comparator — function(a, b) — Standard sort comparison function. Should return a negative number if a < b, positive if a > b, zero if equal.
options.maxSize (number, default Infinity) — Maximum number of items to buffer. When exceeded, the stream ends with new Error('Max size exceeded') with .code === 'MAX_SIZE_EXCEEDED'.

Returns a push-stream through. All writes buffer data; sorting and emission happen when end() is called without an error.

Tests

npm test

Tests cover numeric sorting, reverse sorting, maxSize limit enforcement, error propagation on abort, and empty stream handling.

Requirements

Node.js 18 or later. ESM only.

License

MIT

push-stream stream sort buffer order

Details

npm

2026-07-20 19:00:10 +00:00

0

SEE LICENSE IN LICENSE

3.5 KiB

Assets (1)

push-sort-0.0.5.tgz 3.5 KiB

Versions (5) View all

0.0.7

2026-07-21

0.0.6

2026-07-20

0.0.5

2026-07-20

0.0.4

2026-07-19

0.0.3