npmpackage.info

Gathering detailed insights and metrics for p-fifo

Other packages similar to p-fifo

p-queue

8.1.0

Promise queue with concurrency control

p-queue-compat

1.0.229

Compatible version of p-queue

@types/p-fifo

1.0.2

TypeScript definitions for p-fifo

@hysc/p-queue

6.3.0

Promise queue with concurrency control

Gathering detailed insights and metrics for p-fifo

p-fifo - 1.0.0 | npmpackage.info

p-fifo

🚦 Promised First-In-First-Out buffer. Await on push to be told when a value is consumed and await on shift for a value to consume when the buffer is empty.

1.0.0

MIT

JavaScript

1.7

Installations

npm install p-fifo

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.2.0

NPM Version

6.9.0 Pull Requests

Open

5

Total

16

Closed

2

Merged

9

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

alanshaw

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

3 Stars

14 Commits

1 Forks

2 Watchers

6 Branches

1 Contributors

Updated on Nov 23, 2021

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.0.0

Package Id

p-fifo@1.0.0

Size

2.76 kB

NPM Version

6.9.0

Node Version

12.2.0

Published on

Jul 31, 2019

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

fast-fifo p-defer

Dev Dependencies

ava nyc standard

p-fifo

Promised First-In-First-Out buffer. Await on push to be told when a value is consumed and await on shift for a value to consume when the buffer is empty

Install

1npm i p-fifo

Usage

Await on push

await on push to be told when your pushed value is consumed:

1const Fifo = require('p-fifo')
2const fifo = new Fifo()
3
4// Consume a value from the buffer after 1 second
5setTimeout(() => fifo.shift(), 1000)
6
7console.time('push')
8// Nothing in the buffer, push a value and wait for it to be consumed
9await fifo.push('hello')
10console.log('"hello" was consumed')
11console.timeEnd('push')
12
13// Output:
14// "hello" was consumed
15// push: 1006.723ms

Await on shift

If the buffer is empty, you can await on a value to be pushed:

1const Fifo = require('p-fifo')
2const fifo = new Fifo()
3
4// Push a value into the buffer after 1 second
5setTimeout(() => fifo.push('hello'), 1000)
6
7console.time('shift')
8// Nothing in the buffer, wait for something to arrive
9const value = await fifo.shift()
10console.log(`consumed "${value}" from the buffer`)
11console.timeEnd('shift')
12
13// Output:
14// consumed "hello" from the buffer
15// shift: 1002.652ms

API

1const fifo = new Fifo()

`fifo.push(value): Promise`

Add a value to the end of the FIFO buffer.

Returns a promise that is resolved when the pushed value is shifted off the start of the buffer.

`fifo.shift(): Promise<Any>`

Remove the first value from the FIFO buffer and return that removed value in a promise.

Returns a promise that resolves to a value from start of the FIFO buffer. If there are no values in the buffer the promise will resolve when a value is next pushed.

Note that multiple calls to shift when the buffer is empty will not resolve to the same value i.e. a corresponding number of calls to push will need to be made to resolve all the promises returned by calls to shift.

`fifo.isEmpty(): Boolean`

Returns true if the FIFO buffer is empty and false otherwise.

Contribute

Feel free to dive in! Open an issue or submit PRs.

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More