Skip to main content
Version: 5.10.0

useQueueState

About​

A React hook that manages state in the form of a queue

Installation​

npm install --save rooks

Importing the hook​

import { useQueueState } from "rooks";

Usage​

function Demo() {
// here list is still 1,2,3
// controls contains utils to change the queue;
const [list, controls] = useQueueState([1, 2, 3]);
const { enqueue, peek, dequeue, length } = controls;

// enqueue(1)
// dequeue()
// peek()

// This will render items in FIFO order
return (
<div>
{list.map((item) => (
<span>{item}</span>
))}
</div>
);
}

render(<Demo />);

Arguments​

ArgumentsTypeDescriptionDefault value
initialListany[]An arrayundefind

Returned array items​

Returned itemsTypeDescription
enqueuefunctionPut an item to the end of the queue
dequeuefunctionRemove the first item in the queue
peekfunctionReturn the item at the front of the queue
lengthnumberNumber of items in the queue

Codesandbox Examples​

Basic Usage​

Join Bhargav's discord server​

You can click on the floating discord icon at the bottom right of the screen and talk to us in our server.