A fresh ServedHyperlinks registry. httpServer / ipcServer /
wsServer each provide Layer.fresh of this so two servers in one
process (e.g. Lookup + a Worker) do not share registrations via Layer memoization.
Provide this standalone only to collect serve registrations without a server.
export const const servedHyperlinksLayer: Layer.Layer<ServedHyperlinks>const servedHyperlinksLayer: {
build: (memoMap: Layer.MemoMap, scope: Scope.Scope) => Effect.Effect<Context.Context<ServedHyperlinks>, never, 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; <…;
}
A fresh
ServedHyperlinks
registry.
httpServer
/
ipcServer
/
wsServer
each provide
Layer.fresh
of this so two servers in one
process (e.g. Lookup + a Worker) do not share registrations via Layer memoization.
Provide this standalone only to collect serve registrations without a server.
servedHyperlinksLayer: 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<class ServedHyperlinksclass ServedHyperlinks {
key: Identifier;
Service: {
register: (entry: ServedHyperlink) => Effect.Effect<void>;
all: Effect.Effect<ReadonlyArray<ServedHyperlink>>;
};
}
The served-resources registry — an accumulator
serve
appends to and
httpServer
reads.
A plain Ref-backed list (not type-level state), so many serve layers compose under Layer.mergeAll
and the server sees every one. Provided by
httpServer
(or
servedHyperlinksLayer
); serve
registers only if it's present (so serve also works standalone).
ServedHyperlinks> = import LayerLayer.const effect: <ServedHyperlinks, {
readonly register: (entry: ServedHyperlink) => Effect.Effect<void>;
readonly all: Effect.Effect<ReadonlyArray<ServedHyperlink>>;
}, never, never>(service: Context.Key<ServedHyperlinks, {
readonly register: (entry: ServedHyperlink) => Effect.Effect<void>;
readonly all: Effect.Effect<ReadonlyArray<ServedHyperlink>>;
}>, effect: Effect.Effect<{
readonly register: (entry: ServedHyperlink) => Effect.Effect<void>;
readonly all: Effect.Effect<ReadonlyArray<ServedHyperlink>>;
}, never, never>) => Layer.Layer<...> (+1 overload)
Constructs a layer from an effect that produces a single service.
When to use
Use when you need to construct a Layer-provided service with an Effect,
dependencies, or scoped resource acquisition.
Details
This allows you to create a Layer from an Effect that produces a service.
The Effect is executed in the scope of the layer, allowing for proper
resource management.
Example (Creating a layer from an effect)
import { Context, Effect, Layer } from "effect"
class Database extends Context.Service<Database, {
readonly query: (sql: string) => Effect.Effect<string>
}>()("Database") {}
const layer = Layer.effect(Database,
Effect.sync(() => ({
query: (sql: string) => Effect.succeed(`Query: ${sql}`)
}))
)
effect(
class ServedHyperlinksclass ServedHyperlinks {
key: Identifier;
Service: {
register: (entry: ServedHyperlink) => Effect.Effect<void>;
all: Effect.Effect<ReadonlyArray<ServedHyperlink>>;
};
of: (this: void, self: { readonly register: (entry: ServedHyperlink) => Effect.Effect<void>; readonly all: Effect.Effect<ReadonlyArray<ServedHyperlink>> }) => { readonly register: (entry: ServedHyperlink) => Effect.Effect<void>; readonly all: …;
context: (self: { readonly register: (entry: ServedHyperlink) => Effect.Effect<void>; readonly all: Effect.Effect<ReadonlyArray<ServedHyperlink>> }) => Context.Context<ServedHyperlinks>;
use: (f: (service: { readonly register: (entry: ServedHyperlink) => Effect.Effect<void>; readonly all: Effect.Effect<ReadonlyArray<ServedHyperlink>> }) => Effect.Effect<A, E, R>) => Effect.Effect<A, E, ServedHyperlinks | R>;
useSync: (f: (service: { readonly register: (entry: ServedHyperlink) => Effect.Effect<void>; readonly all: Effect.Effect<ReadonlyArray<ServedHyperlink>> }) => A) => Effect.Effect<A, never, ServedHyperlinks>;
Identifier: Identifier;
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;
}
The served-resources registry — an accumulator
serve
appends to and
httpServer
reads.
A plain Ref-backed list (not type-level state), so many serve layers compose under Layer.mergeAll
and the server sees every one. Provided by
httpServer
(or
servedHyperlinksLayer
); serve
registers only if it's present (so serve also works standalone).
ServedHyperlinks,
import EffectEffect.const gen: <Effect.Effect<Ref.Ref<readonly ServedHyperlink[]>, never, never>, {
register: (entry: ServedHyperlink) => Effect.Effect<void, never, never>;
all: Effect.Effect<readonly ServedHyperlink[], never, never>;
}>(f: () => Generator<Effect.Effect<Ref.Ref<readonly ServedHyperlink[]>, never, never>, {
register: (entry: ServedHyperlink) => Effect.Effect<void, never, never>;
all: Effect.Effect<readonly ServedHyperlink[], never, never>;
}, never>) => Effect.Effect<...> (+1 overload)
Provides a way to write effectful code using generator functions, simplifying
control flow and error handling.
When to use
Use when you want to write effectful code that looks and behaves like
synchronous code, while still handling asynchronous tasks, errors, and complex
control flow such as loops and conditions.
Generator functions work similarly to async/await but keep errors,
requirements, and interruption in the Effect type. You can yield* values
from effects and return the final result at the end.
Example (Sequencing effects with generators)
import { Data, Effect } from "effect"
class DiscountRateError extends Data.TaggedError("DiscountRateError")<{}> {}
const addServiceCharge = (amount: number) => amount + 1
const applyDiscount = (
total: number,
discountRate: number
): Effect.Effect<number, DiscountRateError> =>
discountRate === 0
? Effect.fail(new DiscountRateError())
: Effect.succeed(total - (total * discountRate) / 100)
const fetchTransactionAmount = Effect.promise(() => Promise.resolve(100))
const fetchDiscountRate = Effect.promise(() => Promise.resolve(5))
export const program = Effect.gen(function*() {
const transactionAmount = yield* fetchTransactionAmount
const discountRate = yield* fetchDiscountRate
const discountedAmount = yield* applyDiscount(
transactionAmount,
discountRate
)
const finalAmount = addServiceCharge(discountedAmount)
return `Final amount to charge: ${finalAmount}`
})
gen(function* () {
const const ref: Ref.Ref<
ReadonlyArray<ServedHyperlink>
>
const ref: {
ref: MutableRef.MutableRef<A>;
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 RefRef.const make: <readonly ServedHyperlink[]>(value: readonly ServedHyperlink[]) => Effect.Effect<Ref.Ref<readonly ServedHyperlink[]>, never, never>Creates a new Ref with the specified initial value.
When to use
Use to create a Ref for shared mutable state inside an Effect program.
Example (Creating a ref)
import { Effect, Ref } from "effect"
const program = Effect.gen(function*() {
const ref = yield* Ref.make(42)
const value = yield* Ref.get(ref)
console.log(value) // 42
})
make<interface ReadonlyArray<T>ReadonlyArray<ServedHyperlink>>([]);
return {
register: (
entry: ServedHyperlink
) => Effect.Effect<void, never, never>
entry: ServedHyperlink(parameter) entry: {
groupId: string;
group: RpcGroup.RpcGroup<any>;
kind: string;
readiness: Effect.Effect<Readiness>;
contractHash: string;
nodeLogKey: string;
nodeKinds: ReadonlyArray<ProtocolKind>;
}
import RefRef.const update: <readonly ServedHyperlink[]>(self: Ref.Ref<readonly ServedHyperlink[]>, f: (a: readonly ServedHyperlink[]) => readonly ServedHyperlink[]) => Effect.Effect<void> (+1 overload)update(const ref: Ref.Ref<
ReadonlyArray<ServedHyperlink>
>
const ref: {
ref: MutableRef.MutableRef<A>;
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; <…;
}
all: ReadonlyArray<ServedHyperlink>all) => [...all: ReadonlyArray<ServedHyperlink>all, entry: ServedHyperlink(parameter) entry: {
groupId: string;
group: RpcGroup.RpcGroup<any>;
kind: string;
readiness: Effect.Effect<Readiness>;
contractHash: string;
nodeLogKey: string;
nodeKinds: ReadonlyArray<ProtocolKind>;
}
all: Effect.Effect<
ReadonlyArray<ServedHyperlink>,
never,
never
>
(property) all: {
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 RefRef.const get: <readonly ServedHyperlink[]>(self: Ref.Ref<readonly ServedHyperlink[]>) => Effect.Effect<readonly ServedHyperlink[], never, never>Gets the current value of the Ref.
When to use
Use to read the current Ref value without changing it.
Example (Getting the current value)
import { Effect, Ref } from "effect"
const program = Effect.gen(function*() {
const ref = yield* Ref.make(42)
const value = yield* Ref.get(ref)
console.log(value) // 42
})
get(const ref: Ref.Ref<
ReadonlyArray<ServedHyperlink>
>
const ref: {
ref: MutableRef.MutableRef<A>;
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; <…;
}