ServiceDefinition<Self, Name, I, A, E, R>Service factory result — tag surface plus baked-in layer and configure helpers.
models
Source src/Gate.ts:25236 lines
export interface interface ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>Service factory result — tag surface plus baked-in layer and configure helpers.
ServiceDefinition<
function (type parameter) Self in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>Self,
function (type parameter) Name in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>Name extends string,
function (type parameter) I in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>I extends import SchemaSchema.Top,
function (type parameter) A in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>A extends import SchemaSchema.Top,
function (type parameter) E in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>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 ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>R = never,
> extends type TagDefinition<
Self,
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top = Schema.Never
> = Hyperlink.HyperlinkTag<
Self,
InstanceSpec<I, A, E>,
Gate<
PrettifyPayload<I["Type"]>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
never
>
> & {
readonly run: StaticRun<I, A, E, Self>
}
Tag factory result — Hyperlink tag + wire schemas + static
StaticRun
.
TagDefinition<function (type parameter) Self in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>Self, function (type parameter) I in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>I, function (type parameter) A in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>A, function (type parameter) E in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>E> {
readonly ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Never, R = never>.defaultSpec: ServiceConfig<I, A, E, R> & { readonly name: Name }defaultSpec: interface ServiceConfig<I extends Schema.Top = Schema.Void, A extends Schema.Top = Schema.Void, E extends Schema.Top = Schema.Never, R = never>Full
Service
config — wire schemas and the gated effect in one object.
ServiceConfig<function (type parameter) I in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>I, function (type parameter) A in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>A, function (type parameter) E in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>E, function (type parameter) R in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>R> & { readonly name: Name extends stringname: function (type parameter) Name in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>Name };
readonly ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Never, R = never>.layer: Layer.Layer<Self | Store.Storage, never, R>(property) ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Never, R = never>.layer: {
build: (memoMap: MemoMap, scope: Scope.Scope) => Effect<Context.Context<Self | Storage>, 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 ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>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 ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>R>;
readonly ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Never, R = never>.configure: (patch: ConfigPatch<LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>>) => Layer.Layer<never>configure: (
patch: ConfigPatch<
LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
>
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<
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 ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>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 ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>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 ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>E>,
function (type parameter) R in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.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>;
readonly ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Never, R = never>.wrapGate: (fn: (previous: LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>["effect"]) => LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>["effect"]) => Layer.Layer<never>wrapGate: (
fn: (
previous: LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>["effect"]
) => LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>["effect"]
previous: LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>["effect"]
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 ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>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 ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>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 ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>E>,
function (type parameter) R in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>R
>["effect"],
) => 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 ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>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 ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>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 ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>E>,
function (type parameter) R in ServiceDefinition<Self, Name extends string, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.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>;
}