<
Self,
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top = Schema.Never,
R = never
>(
tag: HyperlinkTag<Self, InstanceSpec<I, A, E>>,
config: LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
): Layer.Layer<Self | Local<Self> | Store.Storage, never, R>Alias of layer.
layers & servinglayer
Source src/Gate.ts:94511 lines
export const const layerMemory: <
Self,
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top = Schema.Never,
R = never
>(
tag: HyperlinkTag<Self, InstanceSpec<I, A, E>>,
config: LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
) => Layer.Layer<
Self | Local<Self> | Store.Storage,
never,
R
>
Alias of
layer
.
layerMemory = <
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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | 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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | 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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | 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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | 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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | Store.Storage, never, R>R = never,
>(
tag: HyperlinkTag<
Self,
InstanceSpec<I, A, E>
>
(parameter) tag: {
key: Identifier;
Service: {
status: Hyperlink.Subscribable<Schema.Struct.ReadonlySide<{ readonly resourceId: Schema.String; readonly observedAt: Schema.Number; readonly configVersion: Schema.Number; readonly concurrency: Schema.Number; readonly waiting: Schema.Number; readon…;
waiting: Hyperlink.Subscribable<number>;
inFlight: Hyperlink.Subscribable<number>;
completed: Hyperlink.Subscribable<number>;
failed: Hyperlink.Subscribable<number>;
interrupted: Hyperlink.Subscribable<number>;
metrics: { readonly remaining: Hyperlink.Subscribable<number>; readonly resetAfter: Hyperlink.Subscribable<number>; readonly exceeded: Hyperlink.Subscribable<number> };
run: GateWireMember<I, A, E> extends Hyperlink.FromLocalMethod<infer M> ? Hyperlink.InjectLocal<M, Self> : GateWireMember<I, A, E> extends Hyperlink.LocalMethod<infer T> ? Hyperlink.LocalEffect<T, never, Self> : GateWireMember<I, A, E> extends …;
};
description: string | undefined;
of: (this: void, self: { readonly status: Hyperlink.Subscribable<Schema.Struct.ReadonlySide<{ readonly resourceId: Schema.String; readonly observedAt: Schema.Number; readonly configVersion: Schema.Number; readonly concurrency: Schema.Number; r…;
context: (self: { readonly status: Hyperlink.Subscribable<Schema.Struct.ReadonlySide<{ readonly resourceId: Schema.String; readonly observedAt: Schema.Number; readonly configVersion: Schema.Number; readonly concurrency: Schema.Number; readonly wait…;
use: (f: (service: { readonly status: Hyperlink.Subscribable<Schema.Struct.ReadonlySide<{ readonly resourceId: Schema.String; readonly observedAt: Schema.Number; readonly configVersion: Schema.Number; readonly concurrency: Schema.Number; readon…;
useSync: (f: (service: { readonly status: Hyperlink.Subscribable<Schema.Struct.ReadonlySide<{ readonly resourceId: Schema.String; readonly observedAt: Schema.Number; readonly configVersion: Schema.Number; readonly concurrency: Schema.Number; readon…;
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;
}
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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | 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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | 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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | 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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | Store.Storage, never, R>E>>,
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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | 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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | 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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | 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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | 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<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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | Store.Storage, never, R>Self | interface Local<in out Self>Granted only by a HyperService's local layer (
Hyperlink.layer
/
serve
) — never by
Hyperlink.client
. Local to this runtime's materialized impl for the tag (not a remote
client, not a peer). A
LocalMethod
carries it in its requirement channel, so calling a
non-serializable method against a client is a compile error (unsatisfied requirement); the
same call resolves when the local layer is provided. Branded by Self so one HyperService's local
layer can't unlock another's.
Local<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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | Store.Storage, never, R>Self> | 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>>, config: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | Store.Storage, never, R>R> =>
const layer: <
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<
Self | Local<Self> | Store.Storage,
never,
R
>
Build a Layer from a tag and config — yields an observable toolkit service.
Soft-defaults
Store.Storage
(R fulfilled). Override with your app store:
Gate.layer(Tag, config).pipe(Layer.provideMerge(AppStore.layer({ filename })))
layerMemory
is an alias for the same soft-default.
layer(tag: HyperlinkTag<
Self,
InstanceSpec<I, A, E>
>
(parameter) tag: {
key: Identifier;
Service: {
status: Hyperlink.Subscribable<Schema.Struct.ReadonlySide<{ readonly resourceId: Schema.String; readonly observedAt: Schema.Number; readonly configVersion: Schema.Number; readonly concurrency: Schema.Number; readonly waiting: Schema.Number; readon…;
waiting: Hyperlink.Subscribable<number>;
inFlight: Hyperlink.Subscribable<number>;
completed: Hyperlink.Subscribable<number>;
failed: Hyperlink.Subscribable<number>;
interrupted: Hyperlink.Subscribable<number>;
metrics: { readonly remaining: Hyperlink.Subscribable<number>; readonly resetAfter: Hyperlink.Subscribable<number>; readonly exceeded: Hyperlink.Subscribable<number> };
run: GateWireMember<I, A, E> extends Hyperlink.FromLocalMethod<infer M> ? Hyperlink.InjectLocal<M, Self> : GateWireMember<I, A, E> extends Hyperlink.LocalMethod<infer T> ? Hyperlink.LocalEffect<T, never, Self> : GateWireMember<I, A, E> extends …;
};
description: string | undefined;
of: (this: void, self: { readonly status: Hyperlink.Subscribable<Schema.Struct.ReadonlySide<{ readonly resourceId: Schema.String; readonly observedAt: Schema.Number; readonly configVersion: Schema.Number; readonly concurrency: Schema.Number; r…;
context: (self: { readonly status: Hyperlink.Subscribable<Schema.Struct.ReadonlySide<{ readonly resourceId: Schema.String; readonly observedAt: Schema.Number; readonly configVersion: Schema.Number; readonly concurrency: Schema.Number; readonly wait…;
use: (f: (service: { readonly status: Hyperlink.Subscribable<Schema.Struct.ReadonlySide<{ readonly resourceId: Schema.String; readonly observedAt: Schema.Number; readonly configVersion: Schema.Number; readonly concurrency: Schema.Number; readon…;
useSync: (f: (service: { readonly status: Hyperlink.Subscribable<Schema.Struct.ReadonlySide<{ readonly resourceId: Schema.String; readonly observedAt: Schema.Number; readonly configVersion: Schema.Number; readonly concurrency: Schema.Number; readon…;
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;
}
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;
}