<Self>(
tag: HyperlinkTag<Self, ScheduleHyperlinkSpec>,
options?: { readonly initial?: ReadonlyArray<ScheduleWindow> }
): Layer.Layer<Self | Local<Self>>The local layer for a standalone Schedule resource — an in-memory window manager
(optionally seeded with initial windows) that any number of processes can be gated by.
export const const scheduleLayer: <Self>(
tag: HyperlinkTag<Self, ScheduleHyperlinkSpec>,
options?: {
readonly initial?: ReadonlyArray<ScheduleWindow>
}
) => Layer.Layer<Self | Local<Self>>
The local layer for a standalone
Schedule
resource — an in-memory window manager
(optionally seeded with initial windows) that any number of processes can be gated by.
scheduleLayer = <function (type parameter) Self in <Self>(tag: HyperlinkTag<Self, ScheduleHyperlinkSpec>, options?: {
readonly initial?: ReadonlyArray<ScheduleWindow>;
}): Layer.Layer<Self | Local<Self>>
Self>(
tag: HyperlinkTag<
Self,
ScheduleHyperlinkSpec
>
tag: import HyperlinkTagHyperlinkTag<function (type parameter) Self in <Self>(tag: HyperlinkTag<Self, ScheduleHyperlinkSpec>, options?: {
readonly initial?: ReadonlyArray<ScheduleWindow>;
}): Layer.Layer<Self | Local<Self>>
Self, type ScheduleHyperlinkSpec = {
entries: any
get: any
has: any
set: any
add: any
upsert: any
remove: any
removeMany: any
clear: any
}
The standalone
Schedule
resource's spec.
ScheduleHyperlinkSpec>,
options: {
readonly initial?: ReadonlyArray<ScheduleWindow>
}
options?: { readonly initial?: ReadonlyArray<ScheduleWindow>initial?: interface ReadonlyArray<T>ReadonlyArray<ScheduleWindow> },
): 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>(tag: HyperlinkTag<Self, ScheduleHyperlinkSpec>, options?: {
readonly initial?: ReadonlyArray<ScheduleWindow>;
}): Layer.Layer<Self | Local<Self>>
Self | import LocalLocal<function (type parameter) Self in <Self>(tag: HyperlinkTag<Self, ScheduleHyperlinkSpec>, options?: {
readonly initial?: ReadonlyArray<ScheduleWindow>;
}): Layer.Layer<Self | Local<Self>>
Self>> =>
import LayerLayer.const unwrap: <any, never, never, never, Scope.Scope>(self: Effect.Effect<Layer.Layer<any, never, never>, never, Scope.Scope>) => Layer.Layer<any, never, never>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: <ImplOf<{
entries: any;
get: any;
has: any;
set: any;
add: any;
upsert: any;
remove: any;
removeMany: any;
clear: any;
}>, never, Scope.Scope, any>(self: Effect.Effect<ImplOf<{
entries: any;
get: any;
has: any;
set: any;
add: any;
upsert: any;
remove: any;
removeMany: any;
clear: any;
}>, never, Scope.Scope>, f: (a: ImplOf<{
entries: any;
get: any;
has: any;
set: any;
add: any;
upsert: any;
remove: any;
removeMany: any;
clear: any;
}>) => any) => Effect.Effect<any, never, Scope.Scope> (+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 buildScheduleImpl: (options?: {
readonly initial?: ReadonlyArray<ScheduleWindow>
}) => Effect.Effect<
ImplOf<ScheduleHyperlinkSpec>,
never,
Scope.Scope
>
buildScheduleImpl(options: {
readonly initial?: ReadonlyArray<ScheduleWindow>
}
options), (impl: ImplOf<{
entries: any
get: any
has: any
set: any
add: any
upsert: any
remove: any
removeMany: any
clear: any
}>
impl) => import HyperlinkHyperlink.layer(tag: HyperlinkTag<
Self,
ScheduleHyperlinkSpec
>
tag, impl: ImplOf<{
entries: any
get: any
has: any
set: any
add: any
upsert: any
remove: any
removeMany: any
clear: any
}>
impl)),
);