QueueNodeBoundTag<Self, F, HSelf, Success, Error>QueueTag for a node-bound queue (its own transport).
modelsQueueTag
Source src/WorkPool.ts:100812 lines
export type type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never> = Hyperlink.NodeBoundTag<Self, {
add: Hyperlink.Method<Schema.Union<readonly [Schema.Struct<F>, Schema.$Array<Schema.Struct<F>>]>, Schema.Void, Schema.Never, false, Hyperlink.MethodAnnotations & {
description: string;
}, {
(item: PrettifyPayload<Schema.Struct.View<F, "Type", Schema.Struct.TypeOptionalKeys<F>, Schema.Struct.TypeMutableKeys<F>>>): Effect.Effect<void>;
(items: readonly PrettifyPayload<Schema.Struct.View<F, "Type", Schema.Struct.TypeOptionalKeys<F>, Schema.Struct.TypeMutableKeys<...>>>[]): Effect.Effect<void>;
(itemOrItems: PrettifyPayload<...> | readonly PrettifyPayload<...>[]): Effect.Effect<void>;
}>;
... 16 more ...;
metrics: {
...;
};
}, HSelf, WorkPool<...>>
QueueTag
for a node-bound queue (its own transport).
QueueNodeBoundTag<
function (type parameter) Self in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>Self,
function (type parameter) F in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>F extends import SchemaSchema.Struct.type Struct<Fields extends Struct.Fields>.Fields = {
readonly [x: string]: Schema.Constraint;
readonly [x: number]: Schema.Constraint;
readonly [x: symbol]: Schema.Constraint;
}
Constraint for a struct field map: an object whose values are schemas.
Fields,
function (type parameter) HSelf in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>HSelf,
function (type parameter) Success in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>Success extends import SchemaSchema.Top = typeof import SchemaSchema.const Void: Voidconst Void: {
Rebuild: Rebuild;
Iso: Iso;
ast: Ast;
Type: T;
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
annotate: (annotations: Schema.Annotations.Bottom<void, readonly []>) => Schema.Void;
annotateKey: (annotations: Schema.Annotations.Key<void>) => Schema.Void;
check: (checks_0: Check<void>, ...checks: Array<Check<void>>) => Schema.Void;
rebuild: (ast: Void) => Schema.Void;
make: (input: void, options?: MakeOptions) => void;
makeOption: (input: void, options?: MakeOptions) => Option_.Option<void>;
makeEffect: (input: void, options?: MakeOptions) => Effect.Effect<void, SchemaError, never>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
Type-level representation of
Void
.
Schema for a TypeScript void return value.
When to use
Use when you need to model the return value of a function, RPC, or endpoint
whose result is intentionally ignored.
Details
Runtime parsing accepts any present value and discards it, producing
undefined. The public decoded and encoded TypeScript representation remains
void, so typed construction, decoding, and encoding APIs are still modeled
as void.
Void,
function (type parameter) Error in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>Error extends import SchemaSchema.Top = typeof import SchemaSchema.const Never: Neverconst Never: {
Rebuild: Rebuild;
Iso: Iso;
ast: Ast;
Type: T;
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
annotate: (annotations: Schema.Annotations.Bottom<never, readonly []>) => Schema.Never;
annotateKey: (annotations: Schema.Annotations.Key<never>) => Schema.Never;
check: (checks_0: Check<never>, ...checks: Array<Check<never>>) => Schema.Never;
rebuild: (ast: Never) => Schema.Never;
make: (input: never, options?: MakeOptions) => never;
makeOption: (input: never, options?: MakeOptions) => Option_.Option<never>;
makeEffect: (input: never, options?: MakeOptions) => Effect.Effect<never, SchemaError, never>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
Type-level representation of
Never
.
Schema for the never type. Always fails validation — no value satisfies it.
Never,
> = interface NodeBoundTag<Self, S extends Spec, HSelf, Svc = Simplify<{ readonly [K in keyof S]: S[K] extends FromLocalMethod<infer M> ? InjectLocal<M, Self> : S[K] extends LocalMethod<infer T> ? LocalEffect<...> : S[K] extends DefaultMethod<...> ? F : S[K] extends { ...; } ? SuccessOf<...> : S[K] extends { ...; } ? Subscribable<...> : S[K] extends { ...; } ? ClientMethod<...> : S[K] extends Spec ? Simplify<...> : never; }>>A
HyperlinkTag
bound to a concrete
Node
— its [nodeSym] narrowed to that node's
NodeKey<HSelf>, which is how
Hyperlink.client
discriminates the node-aware path. Returned
by the node-bearing tag constructors. It's a named type (not an inline & { [nodeSym] }) so a
consumer can export a node-bearing tag without leaking the internal symbol (TS4020).
NodeBoundTag<
function (type parameter) Self in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>Self,
type QueueInstanceSpec<F extends Schema.Struct.Fields, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never> = {
add: Hyperlink.Method<Schema.Union<readonly [Schema.Struct<F>, Schema.$Array<Schema.Struct<F>>]>, Schema.Void, Schema.Never, false, Hyperlink.MethodAnnotations & {
description: string;
}, {
(item: PrettifyPayload<Schema.Struct.View<F, "Type", Schema.Struct.TypeOptionalKeys<F>, Schema.Struct.TypeMutableKeys<F>>>): Effect.Effect<void>;
(items: readonly PrettifyPayload<Schema.Struct.View<F, "Type", Schema.Struct.TypeOptionalKeys<F>, Schema.Struct.TypeMutableKeys<F>>>[]): Effect.Effect<void>;
(itemOrItems: PrettifyPayload<...> | readonly PrettifyPayload<...>[]): Effect.Effect<void>;
}>;
... 16 more ...;
metrics: {
...;
};
}
The spec of a queue instance whose item is Schema.Struct<F> — control surface + data plane.
Success/Error are the tag's declared wire slots (default Void/Never), threaded so the
contract's events carry the real Cause<E> / Completed.success rather than erasing to the
loose default.
QueueInstanceSpec<function (type parameter) F in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>F, function (type parameter) Success in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>Success, function (type parameter) Error in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>Error>,
function (type parameter) HSelf in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>HSelf,
interface WorkPool<Payload, Success = void, Error = never, Requirements = never>A queue handle — the value yield* MyQueue produces. The named compact form of a queue's
service (both the light Tag path and the engine-included Service path yield this one type), so
it hovers as WorkPool<EmailJob> instead of an expanded member wall; prettify-ts / the docs
D3 popover expand it to the full shape on demand.
WorkPool<type QueueItemOf<F extends Schema.Struct.Fields> = Schema.Struct.View<F, "Type", Schema.Struct.TypeOptionalKeys<F>, Schema.Struct.TypeMutableKeys<F>> extends readonly unknown[] ? number extends (readonly unknown[] & Schema.Struct.View<F, "Type", Schema.Struct.TypeOptionalKeys<F>, Schema.Struct.TypeMutableKeys<F>>)["length"] ? readonly unknown[] & Schema.Struct.View<F, "Type", Schema.Struct.TypeOptionalKeys<F>, Schema.Struct.TypeMutableKeys<F>> extends readonly (infer E)[] ? readonly PrettyObject<E>[] : readonly unknown[] & Schema.Struct.View<...> : readonly unknown[] & Schema.Struct.View<...> : PrettyObject<...>This queue's decoded item type — the Payload of its
WorkPool
handle.
QueueItemOf<function (type parameter) F in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>F>, function (type parameter) Success in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>Success["Type"], function (type parameter) Error in type QueueNodeBoundTag<Self, F extends Schema.Struct.Fields, HSelf, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never>Error["Type"]>
>;