<
Self,
F extends CustomQueueItemFields = CustomQueueItemFields,
E = never,
R = never,
RR = never
>(
tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>,
config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>
): Layer.Layer<
| Self
| Local<Self>
| HandlerContextOf<CustomQueueInstanceSpec<F>>
| Store.Storage,
never,
R | RR
>Serve this custom queue and grant its local instance from one materialization — the
engine-running counterpart to Hyperlink.serve. Mounts the queue's RPC handlers, registers into
Hyperlink.servedHyperlinksLayer, and grants Self | Local<Self> so co-located code
can yield* Tag; the served cells are the in-process instance. A served-only gateway uses
serveRemote.
Soft-defaults Store.Storage. Override with Layer.provide / provideMerge(AppStore).
export const const serve: <
Self,
F extends CustomQueueItemFields = CustomQueueItemFields,
E = never,
R = never,
RR = never
>(
tag: HyperlinkTag<
Self,
CustomQueueInstanceSpec<F>
>,
config: CustomQueueLayerConfig<
Schema.Struct<F>["Type"],
E,
R,
RR
>
) => Layer.Layer<
| Self
| Local<Self>
| HandlerContextOf<CustomQueueInstanceSpec<F>>
| Store.Storage,
never,
R | RR
>
Serve this custom queue and grant its local instance from one materialization — the
engine-running counterpart to
Hyperlink.serve
. Mounts the queue's RPC handlers, registers into
Hyperlink.servedHyperlinksLayer
, and grants Self | Local<Self> so co-located code
can yield* Tag; the served cells are the in-process instance. A served-only gateway uses
Soft-defaults
Store.Storage
. Override with Layer.provide / provideMerge(AppStore).
serve = <
function (type parameter) Self in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>Self,
function (type parameter) F in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>F extends type CustomQueueItemFields = {
[x: string]: Schema.Codec<
unknown,
unknown,
never,
never
>
}
type CustomQueueItemFields = {
[x: string]: Schema.Codec<
unknown,
unknown,
never,
never
>
}
function (type parameter) E in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>E = never,
function (type parameter) R in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>R = never,
function (type parameter) RR in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>RR = never,
>(
tag: HyperlinkTag<
Self,
CustomQueueInstanceSpec<F>
>
import HyperlinkTagHyperlinkTag<function (type parameter) Self in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>Self, type CustomQueueInstanceSpec<
F extends Schema.Struct.Fields
> = Omit<
{
add: any
enqueue: any
release: any
releaseEncoded: any
deadLetter: any
drop: any
events: any
status: any
size: any
isEmpty: any
levelSizes: any
start: any
pause: any
resume: any
shutdown: any
clear: any
metrics: {
stream: any
query: any
}
},
"add"
> & {
readonly add: CustomQueueAddMethod
}
Full custom-queue instance contract for itemSchema F.
CustomQueueInstanceSpec<function (type parameter) F in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>F>>,
config: CustomQueueLayerConfig<
Schema.Struct<F>["Type"],
E,
R,
RR
>
type CustomQueueLayerConfig<
A,
E,
R,
RR = never
> = Omit<
CustomQueueHyperlinkConfigWithItemSchema<
A,
E,
R
>,
"itemSchema" | "refill" | "name"
> & {
readonly refill?: {
readonly onStart?: boolean
readonly onDrained?: boolean
readonly load: (
queue: CustomQueueHandle<
A,
E,
QueueEnqueueErrors,
never
>
) => Effect.Effect<void, never, RR>
}
}
Worker/layer config for a toolkit custom queue (tag carries itemSchema).
CustomQueueLayerConfig<import SchemaSchema.interface Struct<Fields extends Schema.Struct.Fields>Defines a struct schema from a map of field schemas.
Details
Each field value is a schema. Use
optionalKey
or
optional
to
mark fields as optional, and
mutableKey
to mark them as mutable.
The resulting schema's Type is a readonly object type with the fields'
decoded types. The Encoded form mirrors the field schemas' encoded types.
Example (Defining a basic struct)
import { Schema } from "effect"
const Person = Schema.Struct({
name: Schema.String,
age: Schema.Number,
email: Schema.optionalKey(Schema.String)
})
// { readonly name: string; readonly age: number; readonly email?: string }
type Person = typeof Person.Type
const alice = Schema.decodeUnknownSync(Person)({ name: "Alice", age: 30 })
console.log(alice)
// { name: 'Alice', age: 30 }
Namespace for struct field type utilities.
Details
These types compute the decoded Type, encoded Encoded, and constructor
input MakeIn of a
Struct
from its field map, handling optional,
mutable, and other field modifiers automatically.
Struct.Fields — constraint for the field map objectStruct.Type<F> — decoded type of the structStruct.Encoded<F> — encoded type of the structStruct.MakeIn<F> — constructor input (optional/defaulted fields may be omitted)Struct.DecodingServices<F> / Struct.EncodingServices<F> — required services
Type-level representation returned by
Struct
.
Struct<function (type parameter) F in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>F>["Type"], function (type parameter) E in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>E, function (type parameter) R in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>R, function (type parameter) RR in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>RR>,
): 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 <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>Self | import LocalLocal<function (type parameter) Self in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>Self> | import HandlerContextOfHandlerContextOf<type CustomQueueInstanceSpec<
F extends Schema.Struct.Fields
> = Omit<
{
add: any
enqueue: any
release: any
releaseEncoded: any
deadLetter: any
drop: any
events: any
status: any
size: any
isEmpty: any
levelSizes: any
start: any
pause: any
resume: any
shutdown: any
clear: any
metrics: {
stream: any
query: any
}
},
"add"
> & {
readonly add: CustomQueueAddMethod
}
Full custom-queue instance contract for itemSchema F.
CustomQueueInstanceSpec<function (type parameter) F in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>F>> | import StoreStore.type Store.Storage = /*unresolved*/ anyStorage,
never,
function (type parameter) R in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>R | function (type parameter) RR in <Self, F extends CustomQueueItemFields = CustomQueueItemFields, E = never, R = never, RR = never>(tag: HyperlinkTag<Self, CustomQueueInstanceSpec<F>>, config: CustomQueueLayerConfig<Schema.Struct<F>["Type"], E, R, RR>): Layer.Layer<Self | Local<Self> | HandlerContextOf<CustomQueueInstanceSpec<F>> | Store.Storage, never, R | RR>RR
> =>
const withDefaultMemory: <unknown, never, R | RR>(layer: Layer.Layer<unknown, never, any>) => Layer.Layer<any, never, R | RR>Soft-default
Store.Storage
(
Store.withDefaultStorage
) — R fulfilled; override by
providing an app store into this layer.
withDefaultMemory(
import LayerLayer.const unwrap: <
unknown,
never,
any,
never,
any
>(
self: Effect.Effect<
Layer.Layer<unknown, never, any>,
never,
any
>
) => Layer.Layer<unknown, never, any>
Unwraps a Layer from an Effect, flattening the nested structure.
When to use
Use when you have an Effect that produces a Layer and you want to
use that layer directly.
Details
The resulting Layer will have the combined error and dependency types from
both the outer Effect and the inner Layer.
Example (Unwrapping an effectful layer)
import { Context, Effect, Layer } from "effect"
class Database extends Context.Service<Database, {
readonly query: (sql: string) => Effect.Effect<string>
}>()("Database") {}
const layerEffect = Effect.succeed(
Layer.succeed(Database, { query: Effect.fn("Database.query")((sql: string) => Effect.succeed("result")) })
)
const unwrappedLayer = Layer.unwrap(layerEffect)
unwrap(
import EffectEffect.const map: <Hyperlink.BuiltHyperlink<CustomQueueInstanceSpec<F>, R | RR>, never, any, any>(self: Effect.Effect<Hyperlink.BuiltHyperlink<CustomQueueInstanceSpec<F>, R | RR>, never, any>, f: (a: Hyperlink.BuiltHyperlink<CustomQueueInstanceSpec<F>, R | RR>) => any) => Effect.Effect<any, never, any> (+1 overload)Transforms the value inside an effect by applying a function to it.
When to use
Use to transform an effect's success value with a function that returns a
plain value, producing a new effect without changing the original effect's
typed error or context requirements.
Details
map takes a function and applies it to the value contained within an
effect, creating a new effect with the transformed value.
It's important to note that effects are immutable, meaning that the original
effect is not modified. Instead, a new effect is returned with the updated
value.
Example (Choosing map syntax variants)
import { Effect, pipe } from "effect"
const myEffect = Effect.succeed(1)
const transformation = (n: number) => n + 1
const mappedWithPipe = pipe(myEffect, Effect.map(transformation))
const mappedWithDataFirst = Effect.map(myEffect, transformation)
const mappedWithMethod = myEffect.pipe(Effect.map(transformation))
Example (Adding a service charge)
import { Effect, pipe } from "effect"
const addServiceCharge = (amount: number) => amount + 1
const fetchTransactionAmount = Effect.promise(() => Promise.resolve(100))
const finalAmount = pipe(
fetchTransactionAmount,
Effect.map(addServiceCharge)
)
Effect.runPromise(finalAmount).then(console.log)
// Output: 101
map(const buildCustomQueueImpl: <
Self,
F extends CustomQueueItemFields,
E,
R,
RR = never
>(
tag: HyperlinkTag<
Self,
CustomQueueInstanceSpec<F>
>,
config: CustomQueueLayerConfig<
Schema.Struct<F>["Type"],
E,
R,
RR
>
) => Effect.Effect<
Hyperlink.BuiltHyperlink<
CustomQueueInstanceSpec<F>,
R | RR
>,
never,
R | RR | Scope.Scope | Store.Storage
>
tag: HyperlinkTag<
Self,
CustomQueueInstanceSpec<F>
>
config: CustomQueueLayerConfig<
Schema.Struct<F>["Type"],
E,
R,
RR
>
built: Hyperlink.BuiltHyperlink<
CustomQueueInstanceSpec<F>,
R | RR
>
import HyperlinkHyperlink.serve(tag: HyperlinkTag<
Self,
CustomQueueInstanceSpec<F>
>
built: Hyperlink.BuiltHyperlink<
CustomQueueInstanceSpec<F>,
R | RR
>