QueueHyperlink86
Constructors
Layers & Serving
configureconstA config-patch layer for the queue tag — the toolkit successor to the old QueueHyperlink.Service(...).configure(...).layerconstLocal queue layer — soft-defaults Store.Storage (R fulfilled).layerMemoryconstAlias of layer.rateLimiterLayerconstIn-memory RateLimiterTag + store layers for queues with rateLimit set.serveconstServe this queue and grant its local instance from one materialization — run the worker / refill / persist engine behind the tag, mount its RPC handlers, register into Hyperlink.servedHyperlinksLayer, and grant Self | Local<Self> so co-located code can yield Tag.serveMemoryconstAlias of serve.serveRemoteconstServe this queue remotely (served-only) — run the worker / refill / persist engine behind the tag, mount its RPC handlers, and register into Hyperlink.servedHyperlinksLayer, without granting the local instance (no yield Tag in the serving process).serveRemoteMemoryconstAlias of serveRemote.storefunctionRegister this queue on an app Store.Service — built-in analytics spec with the tag's itemSchema injected.Models
BuiltInTakeAlgorithmtypeBuilt-in lane take algorithms for QueueHyperlinkConfigBase.takeAlgorithm.CustomTakeAlgorithmtypeUser-supplied take algorithm.EffectContextinterfaceContext passed to the effect callback during item processing.InferQueueEnqueueErrortypeEnqueue error channel for a queue configuration (never when no itemSchema).InferQueueItemtypeInfer item type T from an inline { effect: (item, ctx) => … } config.InferQueueWorkerErrortypeInfer worker E (failure channel) from effect's Effect return type.InferQueueWorkerRequirementstypeService requirements for the queue worker: those declared on the effect, unioned with any declared on the optional onFailure control hook.PrioritytypePriority level for queue items.QueueBatchinterfaceQueueConfigFromEffecttypeQueueEncodedEntryinterfaceQueueEnqueueinterfaceEnqueue a single item or a readonly batch of items.QueueEnqueueEntriesinterfaceRe-inject existing QueueEntrys (single or array) — the inverse of release, and the input you get straight off the QueueHandleApi.events stream.QueueEntryinterfaceQueueEntrySelectorinterfaceQueueEntryTimestampsinterfaceQueueErrorCarrierinterfaceA phantom marker intersected onto a Tag to carry the worker error schema (E's schema) at the type level — the mirror of QueueSuccessCarrier.QueueEventtypeThe live lifecycle event union — the element of QueueHandleApi.events.QueueEventSchematypeThe events union schema for a queue item schema Sch, with the worker's success return (on Completed) and error failure (the Cause) wire slots.QueueFailureDispositiontypePer-error disposition returned by QueueHyperlinkConfigWithoutItemSchema.onFailure.QueueHyperlinkinterfaceA queue handle — the value yield MyQueue produces.QueueHyperlinkConfigtypeConfiguration for QueueHyperlink.make.QueueHyperlinkConfigBaseinterfaceShared queue configuration fields (see QueueHyperlinkConfig).QueueHyperlinkConfigWithoutItemSchematypeQueue configuration without QueueHyperlinkConfigBase item schema.QueueHyperlinkDefinitiontypeCanonical queue declaration.QueueHyperlinkMetadatainterfaceQueue declaration metadata for QueueHyperlinkDefinition and QueueHyperlinkServiceDefinition.QueueHyperlinkOptionsWithItemSchematypeQueueHyperlinkOptionsWithoutItemSchematypeQueueHyperlinkRateLimitOptionstypeEffect RateLimiter.consume options for queue workers, with optional key (defaults to queue name) and telemetry controls.QueueHyperlinkServiceDefinitioninterfaceClass-based queue service declaration from QueueHyperlink.Service.QueueItemCodecDescriptorinterfaceJSON-safe metadata for queue item wire encoding and typed group contracts.QueueLayerConfigtypeThe worker config for QueueHyperlink.layer — the engine queue config without itemSchema (the tag already carries it).QueueMetricsinterfaceWindowed metrics — the element of QueueHandleApi.metrics.QueueNodeBoundTagtypeQueueTag for a node-bound queue (its own transport).QueueOnFailureinterfaceOptional inline failure hook — the one legitimate control callback (a stream is after-the-fact and can't decide disposition).QueueReleaseEncodingErrortypeQueueReleaseOptionsinterfaceQueueRouteOptionsinterfaceQueueStatusinterfaceThe current-state snapshot — the element of QueueHandleApi.status.QueueSuccessCarrierinterfaceA phantom marker intersected onto a Tag to carry the worker success schema (A's schema) at the type level, without touching the (invariant, RPC-facing) spec.QueueTagtypeThe queue's Hyperlink.Tag whose service value is the named QueueHyperlink handle (via the Svc seam on HyperlinkTag), so yield MyQueue hovers as QueueHyperlink<EmailJob> rather than the expanded ServiceOf<…> wall.QueueTagConfiginterfaceConfig-object overload of Tag.QueueWorkerEffecttypeTakeAlgorithmtypeLane take algorithm: a built-in name or a custom pick function.TakeAlgorithmPicktypeResult of a custom take pick — which level to dequeue from and updated scheduler state.TakeAlgorithmPickContexttypeContext passed to a CustomTakeAlgorithm on each non-blocking take.Wire Schemas
historyQueryconstPayload fields for the metrics.query history read — newest limit entries within an optional [since, until] window.jsonValueconstRecursive structural JSON value schema — decodes to JsonValue.queueControlSpecconstThe queue control + observation contract: the fixed-schema verbs of a queue handle, shared by every queue instance.queueEncodedEntryconstA queue entry in encoded / wire form — the element returned by releaseEncoded.queueEntryconstA queue entry on the wire, parameterized by the per-instance itemSchema.queueEntryAttributesconstEntry/encoded attributes — a readonly record of arbitrary values, matching the engine's { readonly [key: string]: unknown } on QueueEntry / QueueEncodedEntry.queueEntrySelectorconstSelector for the entry-routing verbs (deadLetter / drop), parameterized by itemSchema (it can match on item).queueEntryTimestampsconstTimestamps carried by a wire queueEntry.queueEventconstBuild the events union schema for a queue item schema Sch with optional success/error wire slots (default Schema.Void / Schema.Never) — the runtime schema behind QueueHyperlink.events, whose decoded type is QueueEventSchema.queueJsonAttributesconstOption attributes — a readonly record of JsonValue, matching the engine's { readonly [key: string]: JsonValue } on QueueReleaseOptions / QueueRouteOptions.queueLogEntryconstLog entry wire schema — alias of LogEntrySchema.queueMetricsconstWindowed queue metrics — the element of the metrics stream, emitted once per window.queuePriorityconstA queue entry's priority level.queueReleaseEncodingErrorconstThe releaseEncoded failure channel — the wire-encodable union of the engine's encode errors (now Schema.TaggedErrorClass, so they are both yieldable and RPC-encodable).queueReleaseOptionsconstOptions for release / releaseEncoded (wire form of QueueReleaseOptions).queueRouteOptionsconstOptions for deadLetter / drop (wire form of QueueRouteOptions).queueSizesconstThe per-priority pending counts returned by sizes.queueSpecconstBuild a queue instance spec (model B): the shared queueControlSpec plus per-instance data-plane procedures typed by itemSchema — the enqueue verbs (add, prioritize, defer, enqueue) and the events stream.queueStatusconstA queue's current-state snapshot — the element of the status stream.Item Codecs
makeQueueItemCodecDescriptorconstBuild a QueueItemCodecDescriptor from a live Effect Schema value.QueueItemCodecDescriptorSchemaconstRuntime schema for a queue item's codec descriptor (id / version / encoding / jsonSchema).schemaVersionAnnotationconstAnnotation key carrying an item schema's version — the anchor for the @vN marker that travels on released / handoff entries and the future upcast/migration history.schemaVersionOfconstRead an item schema's withSchemaVersionversion; defaults to 1 when unannotated.withSchemaVersionconstStamp an item schema with its version.Utils
Errors
QueueBatchValidationErrorclassBatch enqueue failed schema validation under atomic semantics (no items enqueued).QueueItemEncodingErrorclassA queue item failed schema encoding while preparing a wire handoff release.QueueItemValidationErrorclassSingle-item enqueue failed schema validation before the queue mutated.QueueMissingItemSchemaErrorclassEncoded release was requested for a queue without itemSchema.QueueShutdownErrorclassIndicates an enqueue was attempted after the queue was shut down.