<
Self,
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top = Schema.Never,
R = never
>(
tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>,
config: RunHyperlinkLayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
): Layer.Layer<
| Self
| Local<Self>
| HandlerContextOf<RunInstanceSpec<I, A, E>>
| Store.Storage,
never,
R
>Serve this run gate and grant its local instance from one materialization.
Soft-defaults Store.Storage. Override with Layer.provide / provideMerge(AppStore).
layers & servingStore.Storage
Source src/RunHyperlink.ts:86628 lines
export function function serve<
Self,
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top = Schema.Never,
R = never
>(
tag: HyperlinkTag<
Self,
RunInstanceSpec<I, A, E>,
any
>,
config: RunHyperlinkLayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
): Layer.Layer<
| Self
| Local<Self>
| HandlerContextOf<RunInstanceSpec<I, A, E>>
| Store.Storage,
never,
R
>
Serve this run gate and grant its local instance from one materialization.
Soft-defaults
Store.Storage
. Override with Layer.provide / provideMerge(AppStore).
serve<
function (type parameter) Self in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>Self,
function (type parameter) I in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>I extends import SchemaSchema.Top,
function (type parameter) A in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>A extends import SchemaSchema.Top,
function (type parameter) E in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>E extends import SchemaSchema.Top = typeof import SchemaSchema.const Never: Schema.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?: Schema.MakeOptions) => never;
makeOption: (input: never, options?: Schema.MakeOptions) => Option<never>;
makeEffect: (input: never, options?: Schema.MakeOptions) => Effect.Effect<never, Schema.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 serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>R = never,
>(
tag: HyperlinkTag<
Self,
RunInstanceSpec<I, A, E>,
any
>
import HyperlinkTagHyperlinkTag<function (type parameter) Self in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>Self, import RunInstanceSpecRunInstanceSpec<function (type parameter) I in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>I, function (type parameter) A in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>A, function (type parameter) E in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>E>, any>,
config: RunHyperlinkLayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
(parameter) config: {
name: string;
effect: RunHyperlinkLayerEffect<I, A, E, R>;
concurrency: number;
}
interface RunHyperlinkLayerConfig<I, A, E, R>Layer / serve config — the tag carries wire schemas; this supplies the gated effect.
RunHyperlinkLayerConfig<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 serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<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 serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<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 serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>E>, function (type parameter) R in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<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<
function (type parameter) Self in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>Self | import LocalLocal<function (type parameter) Self in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>Self> | import HandlerContextOfHandlerContextOf<import RunInstanceSpecRunInstanceSpec<function (type parameter) I in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>I, function (type parameter) A in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>A, function (type parameter) E in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>E>> | import StoreStore.type Store.Storage = /*unresolved*/ anyStorage,
never,
function (type parameter) R in serve<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top = Schema.Never, R = never>(tag: HyperlinkTag<Self, RunInstanceSpec<I, A, E>, any>, config: RunHyperlinkLayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, R>): Layer.Layer<Self | Local<Self> | HandlerContextOf<RunInstanceSpec<I, A, E>> | Store.Storage, never, R>R
>;
export function function serve<
Self,
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top = Schema.Never,
R = never
>(
tag: HyperlinkTag<
Self,
RunInstanceSpec<I, A, E>,
any
>,
config: RunHyperlinkLayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
): Layer.Layer<
| Self
| Local<Self>
| HandlerContextOf<RunInstanceSpec<I, A, E>>
| Store.Storage,
never,
R
>
Serve this run gate and grant its local instance from one materialization.
Soft-defaults
Store.Storage
. Override with Layer.provide / provideMerge(AppStore).
serve(
tag: HyperlinkTag<any, any, any>tag: import HyperlinkTagHyperlinkTag<any, any, any>,
config: RunHyperlinkLayerConfig<
any,
any,
any,
any
>
(parameter) config: {
name: string;
effect: RunHyperlinkLayerEffect<I, A, E, R>;
concurrency: number;
}
interface RunHyperlinkLayerConfig<I, A, E, R>Layer / serve config — the tag carries wire schemas; this supplies the gated effect.
RunHyperlinkLayerConfig<any, any, any, any>,
): 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<any, any, any> {
const const baseTag: HyperlinkTag<
any,
RunInstanceSpec<any, any, any>
>
import HyperlinkTagHyperlinkTag<any, import RunInstanceSpecRunInstanceSpec<any, any, any>> = tag: HyperlinkTag<any, any, any>tag;
return const withDefaultStoreBridge: <
unknown,
unknown,
unknown
>(
layer: Layer.Layer<unknown, unknown, any>
) => Layer.Layer<any, unknown, unknown>
Soft-default
Store.Storage
(
Store.withDefaultStorage
) — R fulfilled; override by
providing an app store into this layer.
withDefaultStoreBridge(
import LayerLayer.const unwrap: <
unknown,
unknown,
unknown,
never,
any
>(
self: Effect.Effect<
Layer.Layer<unknown, unknown, unknown>,
never,
any
>
) => Layer.Layer<unknown, unknown, 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: <BuiltHyperlink<RunInstanceSpec<I, A, E>, R>, never, any, any>(self: Effect.Effect<BuiltHyperlink<RunInstanceSpec<I, A, E>, R>, never, any>, f: (a: BuiltHyperlink<RunInstanceSpec<I, A, E>, R>) => 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 buildRunImpl: <
Self,
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top,
R
>(
tag: HyperlinkTag<
Self,
RunInstanceSpec<I, A, E>,
any
>,
config: RunHyperlinkLayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
R
>
) => Effect.Effect<
BuiltHyperlink<RunInstanceSpec<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(const baseTag: HyperlinkTag<
any,
RunInstanceSpec<any, any, any>
>
config: RunHyperlinkLayerConfig<
any,
any,
any,
any
>
(parameter) config: {
name: string;
effect: RunHyperlinkLayerEffect<I, A, E, R>;
concurrency: number;
}
built: BuiltHyperlink<
RunInstanceSpec<I, A, E>,
R
>
import HyperlinkHyperlink.serve(const baseTag: HyperlinkTag<
any,
RunInstanceSpec<any, any, any>
>
built: BuiltHyperlink<
RunInstanceSpec<I, A, E>,
R
>
Referenced by 1 symbols