WorkPoolServiceDefinition<Self, Id, T, E, EEnqueue, R>Class-based queue service declaration from WorkPool.Service.
export interface interface WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>Class-based queue service declaration from
WorkPool.Service
.
WorkPoolServiceDefinition<
function (type parameter) Self in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>Self,
function (type parameter) Id in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>Id extends string,
function (type parameter) T in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>T,
function (type parameter) E in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>E = never,
function (type parameter) EEnqueue in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>EEnqueue = never,
function (type parameter) R in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>R = never,
> extends import ContextContext.interface ServiceClass<in out Self, in out Identifier extends string, in out Shape>Class-style service key produced by Context.Service<Self, Shape>()("Id").
When to use
Use when declaring a service as a class so the class value can serve as the
Context key.
Details
The class itself is the Context key, and its string key identifies the
service at runtime.
Namespace containing helper types for class-style Context.Service
declarations.
ServiceClass<function (type parameter) Self in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>Self, function (type parameter) Id in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>Id, type EngineQueueHandle<
T,
E = never,
EEnqueue = never,
R = never,
A = void
> = QueueHandleApi<T, E, EEnqueue, R, A> &
QueueHandlePhantomWorkerFailures<E>
Priority queue surface for yield*able queue services (T, E, enqueue errors EEnqueue, requirements R last).
EngineQueueHandle<function (type parameter) T in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>T, function (type parameter) E in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>E, function (type parameter) EEnqueue in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>EEnqueue, function (type parameter) R in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>R>>,
type Omit<T, K extends keyof any> = {
[P in Exclude<keyof T, K>]: T[P]
}
Construct a type with the properties of T except for those in type K.
Omit<interface WorkPoolMetadata<Id extends string, T, E = never, EEnqueue = never, R = never>Queue declaration metadata for
WorkPoolDefinition
and
WorkPoolServiceDefinition
.
WorkPoolMetadata<function (type parameter) Id in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>Id, function (type parameter) T in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>T, function (type parameter) E in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>E, function (type parameter) EEnqueue in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>EEnqueue, function (type parameter) R in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>R>, "tag"> {
readonly WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>.tag: Context.Key<Self, EngineQueueHandle<T, E, EEnqueue, R>>(property) WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>.tag: {
Identifier: Identifier;
Service: Shape;
key: string;
stack: string | undefined;
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; <…;
toString: () => string;
toJSON: () => unknown;
}
import ContextContext.interface Key<out Identifier, out Shape>Typed identifier for a service stored in a Context.
When to use
Use as the typed handle for storing, retrieving, and requiring a specific
service in a Context.
Details
Identifier tracks the requirement in Effect types, while Shape is the
service implementation retrieved by the key. A key is also an Effect value,
so yielding it inside Effect.gen retrieves the service from the current
fiber context.
Key<function (type parameter) Self in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>Self, type EngineQueueHandle<
T,
E = never,
EEnqueue = never,
R = never,
A = void
> = QueueHandleApi<T, E, EEnqueue, R, A> &
QueueHandlePhantomWorkerFailures<E>
Priority queue surface for yield*able queue services (T, E, enqueue errors EEnqueue, requirements R last).
EngineQueueHandle<function (type parameter) T in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>T, function (type parameter) E in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>E, function (type parameter) EEnqueue in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>EEnqueue, function (type parameter) R in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>R>>;
readonly WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>.layer: Layer.Layer<Self, never, R>(property) WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>.layer: {
build: (memoMap: MemoMap, scope: Scope.Scope) => Effect<Context.Context<Self>, never, R>;
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; <…;
}
import LayerLayer.interface Layer<in ROut, out E = never, out RIn = never>A Layer describes how to build one or more services for dependency injection.
When to use
Use to model construction of application services for dependency injection,
especially when services have dependencies, can fail during construction, or
need scoped setup and release.
Details
A Layer<ROut, E, RIn> represents ROut as the services this layer
provides, E as the possible errors during layer construction, and RIn as
the services this layer requires as dependencies.
Layer<function (type parameter) Self in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>Self, never, function (type parameter) R in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>R>;
/** Factory defaults before configure layers (`HyperlinkConfigure` module). */
readonly WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>.defaultSpec: WorkPoolConfig<T, E, R>Factory defaults before configure layers (HyperlinkConfigure module).
defaultSpec: type WorkPoolConfig<T, E, R, A = void> =
| WorkPoolConfigWithoutItemSchema<T, E, R>
| WorkPoolConfigWithItemSchema<T, E, R, A>
Configuration for
WorkPool.make
.
WorkPoolConfig<function (type parameter) T in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>T, function (type parameter) E in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>E, function (type parameter) R in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>R>;
/**
* Append a configure patch; merge with {@link layer} before scope acquisition.
*/
readonly WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>.configure: (patch: ConfigPatch<WorkPoolConfig<T, E, R>>) => Layer.Layer<never>Append a configure patch; merge with
layer
before scope acquisition.
configure: (
patch: ConfigPatch<WorkPoolConfig<T, E, R>>patch: type ConfigPatch<T> = PartialConfigPatch<T> | ((previous: T) => T)Patch for a hyperlink or daemon spec.
- Partial object — shallow-merge fields; use a function value to replace a field.
effect field — a unary function (previous) => next updates the prior worker /
supervised body; a multi-argument function value replaces effect outright (queue workers
stay two-argument).- Full reducer —
(previous) => next over the whole spec (see
configureLayer
).
ConfigPatch<type WorkPoolConfig<T, E, R, A = void> =
| WorkPoolConfigWithoutItemSchema<T, E, R>
| WorkPoolConfigWithItemSchema<T, E, R, A>
Configuration for
WorkPool.make
.
WorkPoolConfig<function (type parameter) T in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>T, function (type parameter) E in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>E, function (type parameter) R in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>R>>,
) => import LayerLayer.interface Layer<in ROut, out E = never, out RIn = never>A Layer describes how to build one or more services for dependency injection.
When to use
Use to model construction of application services for dependency injection,
especially when services have dependencies, can fail during construction, or
need scoped setup and release.
Details
A Layer<ROut, E, RIn> represents ROut as the services this layer
provides, E as the possible errors during layer construction, and RIn as
the services this layer requires as dependencies.
Layer<never>;
/**
* Patch only the worker `effect`: `fn(previous) => next` (item + {@link EffectContext}).
*/
readonly WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>.wrapWorker: (fn: (previous: WorkPoolConfig<T, E, R>["effect"]) => WorkPoolConfig<T, E, R>["effect"]) => Layer.Layer<never>Patch only the worker effect: fn(previous) => next (item +
EffectContext
).
wrapWorker: (
fn: (
previous: WorkPoolConfig<T, E, R>["effect"]
) => WorkPoolConfig<T, E, R>["effect"]
previous: WorkPoolConfig<T, E, R>["effect"]previous: type WorkPoolConfig<T, E, R, A = void> =
| WorkPoolConfigWithoutItemSchema<T, E, R>
| WorkPoolConfigWithItemSchema<T, E, R, A>
Configuration for
WorkPool.make
.
WorkPoolConfig<function (type parameter) T in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>T, function (type parameter) E in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>E, function (type parameter) R in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>R>["effect"],
) => type WorkPoolConfig<T, E, R, A = void> =
| WorkPoolConfigWithoutItemSchema<T, E, R>
| WorkPoolConfigWithItemSchema<T, E, R, A>
Configuration for
WorkPool.make
.
WorkPoolConfig<function (type parameter) T in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>T, function (type parameter) E in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>E, function (type parameter) R in WorkPoolServiceDefinition<Self, Id extends string, T, E = never, EEnqueue = never, R = never>R>["effect"],
) => import LayerLayer.interface Layer<in ROut, out E = never, out RIn = never>A Layer describes how to build one or more services for dependency injection.
When to use
Use to model construction of application services for dependency injection,
especially when services have dependencies, can fail during construction, or
need scoped setup and release.
Details
A Layer<ROut, E, RIn> represents ROut as the services this layer
provides, E as the possible errors during layer construction, and RIn as
the services this layer requires as dependencies.
Layer<never>;
}