MutableQueue
Constructors
Getters
The maximum number of elements that a queue can hold.
Note: unbounded queues can still implement this interface with capacity = Infinity.
Signature
declare function capacity<A>(self: MutableQueue<A>): number;Returns true if the queue is empty, false otherwise.
Signature
declare function isEmpty<A>(self: MutableQueue<A>): boolean;Returns true if the queue is full, false otherwise.
Signature
declare function isFull<A>(self: MutableQueue<A>): boolean;Returns the current number of elements in the queue.
Signature
declare function length<A>(self: MutableQueue<A>): number;Model
MutableQueue interface
Signature
interface MutableQueue<out A> extends Iterable<A>, Pipeable, Inspectable {
readonly [TypeId]: typeof TypeId;
}Other
MutableQueue
Offers an element to the queue.
Returns whether the enqueue was successful or not.
Signature
declare const offer: {
<A>(self: MutableQueue<A>, value: A): boolean;
<A>(value: A): (self: MutableQueue<A>) => boolean;
};Enqueues a collection of values into the queue.
Returns a Chunk of the values that were not able to be enqueued.
Signature
declare const offerAll: {
<A>(values: Iterable<A>): (self: MutableQueue<A>) => Chunk<A>;
<A>(self: MutableQueue<A>, values: Iterable<A>): Chunk<A>;
};Dequeues an element from the queue.
Returns either an element from the queue, or the def param.
Note: if there is no meaningful default for your type, you can always use poll(MutableQueue.EmptyMutableQueue).
Signature
declare const poll: {
<D>(def: D): <A>(self: MutableQueue<A>) => D | A;
<A, D>(self: MutableQueue<A>, def: D): A | D;
};Dequeues up to n elements from the queue.
Returns a List of up to n elements.
Signature
declare const pollUpTo: {
(n: number): <A>(self: MutableQueue<A>) => Chunk<A>;
<A>(self: MutableQueue<A>, n: number): Chunk<A>;
};Symbol
EmptyMutableQueue
Signature
declare const EmptyMutableQueue: typeof EmptyMutableQueue;Signature
type TypeId = typeof TypeId;
Creates a new bounded
MutableQueue.