<
Self,
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top = Schema.Never,
R = never
>(
tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>,
config: LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
): Layer.Layer<
HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage,
never,
R
>Serve this gate remotely (served-only) — RPC handlers without granting the local instance.
Soft-defaults Store.Storage. Override with Layer.provide / provideMerge(AppStore).
layers & servingStore.Storage
Source src/Gate.ts:96517 lines
export const const serveRemote: <
Self,
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top = Schema.Never,
R = never
>(
tag: HyperlinkTag<
Self,
InstanceSpec<I, A, E>,
any
>,
config: LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
) => Layer.Layer<
| HandlerContextOf<InstanceSpec<I, A, E>>
| Store.Storage,
never,
R
>
Serve this gate remotely (served-only) — RPC handlers without granting the local instance.
Soft-defaults
Store.Storage
. Override with Layer.provide / provideMerge(AppStore).
serveRemote = <
function (type parameter) Self in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>Self,
function (type parameter) I in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>I extends import SchemaSchema.Top,
function (type parameter) A in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>A extends import SchemaSchema.Top,
function (type parameter) E in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>E 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,
function (type parameter) R in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>R = never,
>(
tag: HyperlinkTag<
Self,
InstanceSpec<I, A, E>,
any
>
(parameter) tag: {
description: string | undefined;
key: Identifier;
of: (this: void, self: any) => any;
context: (self: any) => Context.Context<Self>;
use: (f: (service: any) => Effect.Effect<A, E, R>) => Effect.Effect<A, E, Self | R>;
useSync: (f: (service: any) => A) => Effect.Effect<A, never, Self>;
Identifier: Identifier;
Service: Shape;
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;
}
interface HyperlinkTag<Self, S extends Spec, 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; }>>The type of a HyperService tag carrying spec S — what
Hyperlink.Tag
produces
(and what you extend). Lets a consumer write
<S extends Spec>(tag: HyperlinkTag<Self, S>) and read the spec through named types
(
specOf
/
groupOf
) instead of a Parameters<typeof specOf> workaround.
HyperlinkTag<function (type parameter) Self in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>Self, type InstanceSpec<
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top = Schema.Never
> = {
readonly status: GateStatusRef
readonly waiting: GateCountRef
readonly inFlight: GateCountRef
readonly completed: GateCountRef
readonly failed: GateCountRef
readonly interrupted: GateCountRef
readonly metrics: typeof gateMetricsNestSpec
readonly run: GateWireMember<I, A, E>
}
Instance spec for a gate typed by its wire schemas — namespaced short form of
internal GateInstanceSpec (import * as Gate → Gate.InstanceSpec).
InstanceSpec<function (type parameter) I in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>I, function (type parameter) A in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>A, function (type parameter) E in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>E>, any>,
config: LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
(parameter) config: {
name: string;
effect: LayerEffect<I, A, E, R>;
concurrency: number;
rateLimit: RateLimitOptions;
}
interface LayerConfig<I, A, E, R>Layer / serve config — the tag carries wire schemas; this supplies the gated effect.
LayerConfig<import SchemaSchema.Schema.type Schema<out T>.Type<S> = S extends {
readonly Type: infer T;
} ? T : never
Extracts the decoded Type from a schema.
Example (Extracting the decoded type)
import { Schema } from "effect"
const Person = Schema.Struct({ name: Schema.String, age: Schema.Number })
type Person = Schema.Schema.Type<typeof Person>
// { readonly name: string; readonly age: number }
Type<function (type parameter) I in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>I>, import SchemaSchema.Schema.type Schema<out T>.Type<S> = S extends {
readonly Type: infer T;
} ? T : never
Extracts the decoded Type from a schema.
Example (Extracting the decoded type)
import { Schema } from "effect"
const Person = Schema.Struct({ name: Schema.String, age: Schema.Number })
type Person = Schema.Schema.Type<typeof Person>
// { readonly name: string; readonly age: number }
Type<function (type parameter) A in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>A>, import SchemaSchema.Schema.type Schema<out T>.Type<S> = S extends {
readonly Type: infer T;
} ? T : never
Extracts the decoded Type from a schema.
Example (Extracting the decoded type)
import { Schema } from "effect"
const Person = Schema.Struct({ name: Schema.String, age: Schema.Number })
type Person = Schema.Schema.Type<typeof Person>
// { readonly name: string; readonly age: number }
Type<function (type parameter) E in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>E>, function (type parameter) R in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>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<type HandlerContextOf<S extends Spec> = RpcUnionOf<S, ""> extends Rpc<infer _Tag extends string, infer _Payload extends Schema.Top, infer _Success extends Schema.Top, infer _Error extends Schema.Top, infer _Middleware extends AnyService, infer _Requires> ? Handler<_Tag> : neverThe context a server layer for a
Spec
provides: the handler for every method.
Used to pin the server layers' output type so their requirement channel stays
never — RpcGroup's own ToHandlerFn defaults that channel to any, so without
this the inferred server layer would re-leak any into anything that consumes it.
HandlerContextOf<type InstanceSpec<
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top = Schema.Never
> = {
readonly status: GateStatusRef
readonly waiting: GateCountRef
readonly inFlight: GateCountRef
readonly completed: GateCountRef
readonly failed: GateCountRef
readonly interrupted: GateCountRef
readonly metrics: typeof gateMetricsNestSpec
readonly run: GateWireMember<I, A, E>
}
Instance spec for a gate typed by its wire schemas — namespaced short form of
internal GateInstanceSpec (import * as Gate → Gate.InstanceSpec).
InstanceSpec<function (type parameter) I in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>I, function (type parameter) A in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>A, function (type parameter) E in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>E>> | import StoreStore.class Storageclass Storage {
key: Identifier;
Service: {
at: <Input extends StoreSpec | StoreContractValue>(scopeKey: string, input: Input) => Effect.Effect<StoreHandleOf<Input>, StoreScopeNotRegistered>;
changes: (scopeKey: string) => Effect.Effect<Stream.Stream<StoreChangeEvent, StoreJournalDecodeError>, StoreScopeNotRegistered, Scope>;
};
}
Scope bridge every store handle resolves through — provided by an app
Service
layer or
the soft-default
layerDefaultMemory
(via
withDefaultStorage
). Engines resolve
handles via
withDefault
/
withStorage
(preferred) or bridge.at.
Storage, never, function (type parameter) R in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<HandlerContextOf<InstanceSpec<I, A, E>> | Store.Storage, never, R>R> =>
const withDefaultStoreBridge: <A, E, R>(
layer: Layer.Layer<A, E, R | Store.Storage>
) => Layer.Layer<A | Store.Storage, E, R>
Soft-default
Store.Storage
(
Store.withDefaultStorage
) — R fulfilled; override by
providing an app store into this layer.
withDefaultStoreBridge(
import LayerLayer.const unwrap: <A, E1, R1, E, R>(
self: Effect<Layer<A, E1, R1>, E, R>
) => Layer<
A,
E | E1,
R1 | Exclude<R, Scope.Scope>
>
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: {
<A, B>(f: (a: A) => B): <E, R>(
self: Effect<A, E, R>
) => Effect<B, E, R>
<A, E, R, B>(
self: Effect<A, E, R>,
f: (a: A) => B
): Effect<B, E, R>
}
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 buildRunImpl: <
Self,
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top,
R
>(
tag: HyperlinkTag<
Self,
InstanceSpec<I, A, E>,
any
>,
config: LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
) => Effect.Effect<
Driver<InstanceSpec<I, A, E>, R>,
never,
R | Scope.Scope | Store.Storage
>
Build the live gate behind tag and map it onto the toolkit service impl — shared by
layer
/
serve
/
serveRemote
.
buildRunImpl(tag: HyperlinkTag<
Self,
InstanceSpec<I, A, E>,
any
>
(parameter) tag: {
description: string | undefined;
key: Identifier;
of: (this: void, self: any) => any;
context: (self: any) => Context.Context<Self>;
use: (f: (service: any) => Effect.Effect<A, E, R>) => Effect.Effect<A, E, Self | R>;
useSync: (f: (service: any) => A) => Effect.Effect<A, never, Self>;
Identifier: Identifier;
Service: Shape;
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;
}
config: LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
(parameter) config: {
name: string;
effect: LayerEffect<I, A, E, R>;
concurrency: number;
rateLimit: RateLimitOptions;
}
built: Hyperlink.Driver<
InstanceSpec<I, A, E>,
R
>
(parameter) built: {
impl: WithRequirement<ImplOf<S>, R>;
workerContext: Context.Context<R>;
}
import HyperlinkHyperlink.const serveRemoteDriver: <
S extends Hyperlink.Spec,
R
>(
tag: {
readonly [wireKeySym]: string
readonly [specSym]: Hyperlink.FlatSpec
readonly [specTypeSym]?: S
readonly [groupSym]: {
readonly toLayer: (
handlers: never
) => Layer.Any
}
},
driver: Driver<S, R>
) => Layer.Layer<HandlerContextOf<S>, never, R>
Served-only mount for a
Driver
— preserves the driver's requirement R on the Layer.
Separate from
serveRemote
so plain-impl ServeRequirements inference stays sharp and
open-S Driver overloads don't hit TS2589. Used by Gate / Daemon / WorkPool /
serve
.
Success channel is
HandlerContextOf
<S> when S is concrete on the tag; callers that
already name handler slots on their public return can treat this as the R-preserving mount.
serveRemoteDriver(tag: HyperlinkTag<
Self,
InstanceSpec<I, A, E>,
any
>
(parameter) tag: {
description: string | undefined;
key: Identifier;
of: (this: void, self: any) => any;
context: (self: any) => Context.Context<Self>;
use: (f: (service: any) => Effect.Effect<A, E, R>) => Effect.Effect<A, E, Self | R>;
useSync: (f: (service: any) => A) => Effect.Effect<A, never, Self>;
Identifier: Identifier;
Service: Shape;
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;
}
built: Hyperlink.Driver<
InstanceSpec<I, A, E>,
R
>
(parameter) built: {
impl: WithRequirement<ImplOf<S>, R>;
workerContext: Context.Context<R>;
}
Referenced by 1 symbols