effect-io-ai

Package: effect
Module: Queue

Queue.isFullUnsafe

Checks whether the queue is full synchronously.

When to use

Use when an immediate Queue capacity snapshot is needed outside effectful code and racing queue changes are acceptable.

Example (Checking fullness synchronously)

import { Cause, Effect, Option, Queue } from "effect"

const program = Effect.gen(function*() {
  const queue = yield* Queue.bounded<number, Cause.Done>(3)

  console.log(Queue.isFullUnsafe(queue)) // false

  // Add some messages
  yield* Queue.offerAll(queue, [1, 2, 3])

  console.log(Queue.isFullUnsafe(queue)) // true
})

Signature

declare const isFullUnsafe: <A, E>(self: Dequeue<A, E>) => boolean

Source

Since v4.0.0