<Self, S extends Hyperlink.Spec, HSelf, R = never>(
tag: Hyperlink.NodeBoundTag<Self, S, HSelf>,
impl:
| Hyperlink.ImplOf<S>
| Hyperlink.BuiltHyperlink<S, R>
| Effect.Effect<
Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>,
never,
R
>,
options?: NamelessListenOptions
): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>
<Serve extends Layer.Layer<never, never, never>>(
serve: Serve,
options?: NamelessListenOptions
): Layer.Layer<
Layer.Success<Serve> | ListenNode,
never,
Layer.Services<Serve>
>
<Serves extends ServeLayerList>(
serves: Serves,
options?: NamelessListenOptions
): Layer.Layer<
Layer.Success<Serves[number]> | ListenNode,
never,
Layer.Services<Serves[number]>
>
<
Node extends AnyNode & { readonly [catalogSym]?: unknown },
Serves extends ServeLayerList
>(
node: Node,
serves: Serves & ServesForCatalog<CatalogROut<Node>, Serves>,
options?: NamelessListenOptions
): Layer.Layer<
Layer.Success<Serves[number]> | ListenNode,
never,
Layer.Services<Serves[number]>
>Local WebSocket listen — localhost bind. Compose Lookup via
Layer.provide(Lookup.layer) / Lookup.layerOptions when claim / advertise needs it.
Protocol listen sibling of unix / http / nPipe / Prototype.listen
— keep in sync (handoff § Protocol listen siblings). Prefer this for same-machine WebSocket.
export function function ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R> (+3 overloads)Local WebSocket listen — localhost bind. Compose Lookup via
Layer.provide(Lookup.layer) / Lookup.layerOptions when claim / advertise needs it.
Protocol listen sibling of
unix
/
http
/
nPipe
/
Prototype.listen
— keep in sync (handoff § Protocol listen siblings). Prefer this for same-machine WebSocket.
ws<
function (type parameter) Self in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>Self,
function (type parameter) S in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>S extends import HyperlinkHyperlink.type Hyperlink.Spec = /*unresolved*/ anySpec,
function (type parameter) HSelf in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>HSelf,
function (type parameter) R in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>R = never,
>(
tag: Hyperlink.NodeBoundTag<Self, S, HSelf>tag: import HyperlinkHyperlink.type Hyperlink.NodeBoundTag = /*unresolved*/ anyNodeBoundTag<function (type parameter) Self in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>Self, function (type parameter) S in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>S, function (type parameter) HSelf in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>HSelf>,
impl: anyimpl:
| import HyperlinkHyperlink.type Hyperlink.ImplOf = /*unresolved*/ anyImplOf<function (type parameter) S in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>S>
| import HyperlinkHyperlink.type Hyperlink.BuiltHyperlink = /*unresolved*/ anyBuiltHyperlink<function (type parameter) S in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>S, function (type parameter) R in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>R>
| import EffectEffect.interface Effect<out A, out E = never, out R = never>The Effect interface defines a value that lazily describes a workflow or
job. The workflow requires some context R, and may fail with an error of
type E, or succeed with a value of type A.
When to use
Use when you need to represent a lazy, composable workflow that can require
services, fail with a typed error, or succeed with a typed value.
Details
Effect values model resourceful interaction with the outside world,
including synchronous, asynchronous, concurrent, and parallel interaction.
They use a fiber-based concurrency model, with built-in support for
scheduling, fine-grained interruption, structured concurrency, and high
scalability.
To run an Effect value, you need a Runtime, which is a type that is
capable of executing Effect values.
Effect<
import HyperlinkHyperlink.type Hyperlink.ImplOf = /*unresolved*/ anyImplOf<function (type parameter) S in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>S> | import HyperlinkHyperlink.type Hyperlink.BuiltHyperlink = /*unresolved*/ anyBuiltHyperlink<function (type parameter) S in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>S, function (type parameter) R in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>R>,
never,
function (type parameter) R in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>R
>,
options: anyoptions?: import NamelessListenOptionsNamelessListenOptions,
): 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 ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>Self | import HyperlinkHyperlink.type Hyperlink.Local = /*unresolved*/ anyLocal<function (type parameter) Self in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>Self> | import ListenNodeListenNode, never, function (type parameter) R in ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R>R>;
export function function ws<Serve extends Layer.Layer<never, never, never>>(serve: Serve, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serve> | ListenNode, never, Layer.Services<Serve>> (+3 overloads)Local WebSocket listen — localhost bind. Compose Lookup via
Layer.provide(Lookup.layer) / Lookup.layerOptions when claim / advertise needs it.
Protocol listen sibling of
unix
/
http
/
nPipe
/
Prototype.listen
— keep in sync (handoff § Protocol listen siblings). Prefer this for same-machine WebSocket.
ws<function (type parameter) Serve in ws<Serve extends Layer.Layer<never, never, never>>(serve: Serve, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serve> | ListenNode, never, Layer.Services<Serve>>Serve extends 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, never, never>>(
serve: Serve extends Layer.Layer<never, never, never>serve: function (type parameter) Serve in ws<Serve extends Layer.Layer<never, never, never>>(serve: Serve, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serve> | ListenNode, never, Layer.Services<Serve>>Serve,
options: anyoptions?: import NamelessListenOptionsNamelessListenOptions,
): 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<
import LayerLayer.type Success<T extends Layer.Any> =
T extends Layer.Layer<
infer _ROut,
infer _E,
infer _RIn
>
? _ROut
: never
Extracts the service output type (ROut) from a Layer type.
When to use
Use to derive the services provided by an existing or generic Layer without
restating its ROut type parameter.
Success<function (type parameter) Serve in ws<Serve extends Layer.Layer<never, never, never>>(serve: Serve, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serve> | ListenNode, never, Layer.Services<Serve>>Serve> | import ListenNodeListenNode,
never,
import LayerLayer.type Services<T extends Layer.Any> =
T extends infer L
? L extends Layer.Layer<
infer _ROut,
infer _E,
infer _RIn
>
? _RIn
: never
: never
Extracts the service requirements (RIn) from a Layer type.
When to use
Use to derive the dependency requirements of a generic or inferred Layer
without restating its RIn type parameter.
Services<function (type parameter) Serve in ws<Serve extends Layer.Layer<never, never, never>>(serve: Serve, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serve> | ListenNode, never, Layer.Services<Serve>>Serve>
>;
export function function ws<Serves extends ServeLayerList>(serves: Serves, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>> (+3 overloads)Local WebSocket listen — localhost bind. Compose Lookup via
Layer.provide(Lookup.layer) / Lookup.layerOptions when claim / advertise needs it.
Protocol listen sibling of
unix
/
http
/
nPipe
/
Prototype.listen
— keep in sync (handoff § Protocol listen siblings). Prefer this for same-machine WebSocket.
ws<function (type parameter) Serves in ws<Serves extends ServeLayerList>(serves: Serves, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>>Serves extends import ServeLayerListServeLayerList>(
serves: Serves extends ServeLayerListserves: function (type parameter) Serves in ws<Serves extends ServeLayerList>(serves: Serves, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>>Serves,
options: anyoptions?: import NamelessListenOptionsNamelessListenOptions,
): 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<
import LayerLayer.type Success<T extends Layer.Any> =
T extends Layer.Layer<
infer _ROut,
infer _E,
infer _RIn
>
? _ROut
: never
Extracts the service output type (ROut) from a Layer type.
When to use
Use to derive the services provided by an existing or generic Layer without
restating its ROut type parameter.
Success<function (type parameter) Serves in ws<Serves extends ServeLayerList>(serves: Serves, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>>Serves[number]> | import ListenNodeListenNode,
never,
import LayerLayer.type Services<T extends Layer.Any> =
T extends infer L
? L extends Layer.Layer<
infer _ROut,
infer _E,
infer _RIn
>
? _RIn
: never
: never
Extracts the service requirements (RIn) from a Layer type.
When to use
Use to derive the dependency requirements of a generic or inferred Layer
without restating its RIn type parameter.
Services<function (type parameter) Serves in ws<Serves extends ServeLayerList>(serves: Serves, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>>Serves[number]>
>;
export function function ws<Node extends AnyNode & {}, Serves extends ServeLayerList>(node: Node, serves: Serves & ServesForCatalog<CatalogROut<Node>, Serves>, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>> (+3 overloads)Local WebSocket listen — localhost bind. Compose Lookup via
Layer.provide(Lookup.layer) / Lookup.layerOptions when claim / advertise needs it.
Protocol listen sibling of
unix
/
http
/
nPipe
/
Prototype.listen
— keep in sync (handoff § Protocol listen siblings). Prefer this for same-machine WebSocket.
ws<
function (type parameter) Node in ws<Node extends AnyNode & {}, Serves extends ServeLayerList>(node: Node, serves: Serves & ServesForCatalog<CatalogROut<Node>, Serves>, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>>Node extends import AnyNodeAnyNode & { readonly [import catalogSymcatalogSym]?: unknown },
function (type parameter) Serves in ws<Node extends AnyNode & {}, Serves extends ServeLayerList>(node: Node, serves: Serves & ServesForCatalog<CatalogROut<Node>, Serves>, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>>Serves extends import ServeLayerListServeLayerList,
>(
node: Node extends AnyNode & {}node: function (type parameter) Node in ws<Node extends AnyNode & {}, Serves extends ServeLayerList>(node: Node, serves: Serves & ServesForCatalog<CatalogROut<Node>, Serves>, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>>Node,
serves: anyserves: function (type parameter) Serves in ws<Node extends AnyNode & {}, Serves extends ServeLayerList>(node: Node, serves: Serves & ServesForCatalog<CatalogROut<Node>, Serves>, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>>Serves & import ServesForCatalogServesForCatalog<import CatalogROutCatalogROut<function (type parameter) Node in ws<Node extends AnyNode & {}, Serves extends ServeLayerList>(node: Node, serves: Serves & ServesForCatalog<CatalogROut<Node>, Serves>, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>>Node>, function (type parameter) Serves in ws<Node extends AnyNode & {}, Serves extends ServeLayerList>(node: Node, serves: Serves & ServesForCatalog<CatalogROut<Node>, Serves>, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>>Serves>,
options: anyoptions?: import NamelessListenOptionsNamelessListenOptions,
): 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<
import LayerLayer.type Success<T extends Layer.Any> =
T extends Layer.Layer<
infer _ROut,
infer _E,
infer _RIn
>
? _ROut
: never
Extracts the service output type (ROut) from a Layer type.
When to use
Use to derive the services provided by an existing or generic Layer without
restating its ROut type parameter.
Success<function (type parameter) Serves in ws<Node extends AnyNode & {}, Serves extends ServeLayerList>(node: Node, serves: Serves & ServesForCatalog<CatalogROut<Node>, Serves>, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>>Serves[number]> | import ListenNodeListenNode,
never,
import LayerLayer.type Services<T extends Layer.Any> =
T extends infer L
? L extends Layer.Layer<
infer _ROut,
infer _E,
infer _RIn
>
? _RIn
: never
: never
Extracts the service requirements (RIn) from a Layer type.
When to use
Use to derive the dependency requirements of a generic or inferred Layer
without restating its RIn type parameter.
Services<function (type parameter) Serves in ws<Node extends AnyNode & {}, Serves extends ServeLayerList>(node: Node, serves: Serves & ServesForCatalog<CatalogROut<Node>, Serves>, options?: NamelessListenOptions): Layer.Layer<Layer.Success<Serves[number]> | ListenNode, never, Layer.Services<Serves[number]>>Serves[number]>
>;
export function function ws<Self, S extends Hyperlink.Spec, HSelf, R = never>(tag: Hyperlink.NodeBoundTag<Self, S, HSelf>, impl: Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R> | Effect.Effect<Hyperlink.ImplOf<S> | Hyperlink.BuiltHyperlink<S, R>, never, R>, options?: NamelessListenOptions): Layer.Layer<Self | Hyperlink.Local<Self> | ListenNode, never, R> (+3 overloads)Local WebSocket listen — localhost bind. Compose Lookup via
Layer.provide(Lookup.layer) / Lookup.layerOptions when claim / advertise needs it.
Protocol listen sibling of
unix
/
http
/
nPipe
/
Prototype.listen
— keep in sync (handoff § Protocol listen siblings). Prefer this for same-machine WebSocket.
ws(
nodeOrServesOrTag: anynodeOrServesOrTag:
| import AnyNodeAnyNode
| 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, never, never>
| import ServeLayerListServeLayerList
| import HyperlinkHyperlink.type Hyperlink.PipeableTag = /*unresolved*/ anyPipeableTag,
servesOrOptionsOrImpl: anyservesOrOptionsOrImpl?:
| 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, never, never>
| import ServeLayerListServeLayerList
| import NamelessListenOptionsNamelessListenOptions
| object,
options: anyoptions?: import NamelessListenOptionsNamelessListenOptions,
): 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,
| import UnaddressedNodeUnaddressedNode
| import AddressLessClaimLostAddressLessClaimLost
| import ListenTagNodeRequiredListenTagNodeRequired
| import WsListenRequiresWsWsListenRequiresWs, any> {
const const listenOptions: anylistenOptions = (
import isServeArgisServeArg(nodeOrServesOrTag: anynodeOrServesOrTag) ? servesOrOptionsOrImpl: anyservesOrOptionsOrImpl : options: anyoptions
) as import NamelessListenOptionsNamelessListenOptions | undefined;
// Lookup is not baked in — pipe `Layer.provide(Lookup.layer)` (default) or
// `Lookup.layerOptions({ path })` / `Lookup.client` when claim / advertise needs it.
if (import isServeArgisServeArg(nodeOrServesOrTag: anynodeOrServesOrTag)) {
const const list: ServeLayerListlist = (
var Array: ArrayConstructorArray.ArrayConstructor.isArray(arg: any): arg is any[]isArray(nodeOrServesOrTag: anynodeOrServesOrTag)
? nodeOrServesOrTag: any[]nodeOrServesOrTag
: [nodeOrServesOrTag: anynodeOrServesOrTag]
) as import ServeLayerListServeLayerList;
return const wsNameless: (
list: ServeLayerList,
options: ListenOptions | undefined
) => Layer.Layer<
never,
UnaddressedNode | AddressLessClaimLost,
never
>
Nameless anonymous WebSocket Node + bind (pipe Lookup when needed).
wsNameless(const list: ServeLayerListlist, const listenOptions: anylistenOptions) as 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,
| import UnaddressedNodeUnaddressedNode
| import AddressLessClaimLostAddressLessClaimLost
| import ListenTagNodeRequiredListenTagNodeRequired
| import WsListenRequiresWsWsListenRequiresWs, never>;
}
if (import isHyperlinkTagArgisHyperlinkTagArg(nodeOrServesOrTag: anynodeOrServesOrTag)) {
const const tag: anytag = nodeOrServesOrTag: anynodeOrServesOrTag;
const const tagKey: stringtagKey = (() => {
const const key: unknownkey = (const tag: anytag as unknown as { readonly key?: unknownkey?: unknown }).key?: unknownkey;
return typeof const key: unknownkey === "string" ? const key: stringkey : "unknown";
})();
const const bound: anybound = import HyperlinkHyperlink.nodeOf(const tag: anytag);
const const fleet: anyfleet = import HyperlinkHyperlink.nodesOf(
const tag: anytag as unknown as import HyperlinkHyperlink.type Hyperlink.HyperlinkTag = /*unresolved*/ anyHyperlinkTag<unknown, import HyperlinkHyperlink.type Hyperlink.Spec = /*unresolved*/ anySpec>,
);
if (const bound: anybound === var undefinedundefined) {
return import failListenTagNodefailListenTagNode({
tag: stringtag: const tagKey: stringtagKey,
reason: stringreason: const fleet: anyfleet.length > 1 ? "ambiguous" : "missing",
count: anycount: const fleet: anyfleet.length,
}) as 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,
| import UnaddressedNodeUnaddressedNode
| import AddressLessClaimLostAddressLessClaimLost
| import ListenTagNodeRequiredListenTagNodeRequired
| import WsListenRequiresWsWsListenRequiresWs, never>;
}
if (import isNonWsNodeisNonWsNode(const bound: anybound as import AnyNodeAnyNode)) {
const const n: AnyNoden = const bound: anybound as import AnyNodeAnyNode;
return import wsRequiresWsLayerwsRequiresWsLayer(
const n: AnyNoden.key,
const n: AnyNoden.kind ??
(typeof const n: AnyNoden.path === "string"
? "IpcSocket"
: typeof const n: AnyNoden.url === "string"
? "url"
: "unknown"),
) as 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,
| import UnaddressedNodeUnaddressedNode
| import AddressLessClaimLostAddressLessClaimLost
| import ListenTagNodeRequiredListenTagNodeRequired
| import WsListenRequiresWsWsListenRequiresWs, never>;
}
const const serveErased: (
tag: Hyperlink.PipeableTag,
impl: unknown
) => Layer.Layer<never, never, never>
serveErased = import HyperlinkHyperlink.serve as unknown as (
tag: Hyperlink.PipeableTagtag: import HyperlinkHyperlink.type Hyperlink.PipeableTag = /*unresolved*/ anyPipeableTag,
impl: unknownimpl: unknown,
) => 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, never, never>;
return const wsListenOn: (
node: AnyNode,
list: ServeLayerList,
options: ListenOptions | undefined
) => Layer.Layer<
never,
| UnaddressedNode
| AddressLessClaimLost
| WsListenRequiresWs,
never
>
Bind WebSocket for a Node — mint/claim when address-less or dynamic; else
wsServer
on a loopback port.
wsListenOn(
const bound: anybound as import AnyNodeAnyNode,
[const serveErased: (
tag: Hyperlink.PipeableTag,
impl: unknown
) => Layer.Layer<never, never, never>
serveErased(const tag: anytag, servesOrOptionsOrImpl: anyservesOrOptionsOrImpl)] as import ServeLayerListServeLayerList,
const listenOptions: anylistenOptions,
) as 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,
| import UnaddressedNodeUnaddressedNode
| import AddressLessClaimLostAddressLessClaimLost
| import ListenTagNodeRequiredListenTagNodeRequired
| import WsListenRequiresWsWsListenRequiresWs, never>;
}
const const node: AnyNodenode = nodeOrServesOrTag: anynodeOrServesOrTag as import AnyNodeAnyNode;
if (import isNonWsNodeisNonWsNode(const node: AnyNodenode)) {
return import wsRequiresWsLayerwsRequiresWsLayer(
const node: AnyNodenode.key,
const node: AnyNodenode.kind ??
(typeof const node: AnyNodenode.path === "string"
? "IpcSocket"
: typeof const node: AnyNodenode.url === "string"
? "url"
: "unknown"),
) as 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,
| import UnaddressedNodeUnaddressedNode
| import AddressLessClaimLostAddressLessClaimLost
| import ListenTagNodeRequiredListenTagNodeRequired
| import WsListenRequiresWsWsListenRequiresWs, never>;
}
const const serves: anyserves = servesOrOptionsOrImpl: anyservesOrOptionsOrImpl as
| 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, never, never>
| import ServeLayerListServeLayerList;
const const list: ServeLayerListlist = (var Array: ArrayConstructorArray.ArrayConstructor.isArray(arg: any): arg is any[]isArray(const serves: anyserves) ? const serves: any[]serves : [const serves: anyserves]) as import ServeLayerListServeLayerList;
return const wsListenOn: (
node: AnyNode,
list: ServeLayerList,
options: ListenOptions | undefined
) => Layer.Layer<
never,
| UnaddressedNode
| AddressLessClaimLost
| WsListenRequiresWs,
never
>
Bind WebSocket for a Node — mint/claim when address-less or dynamic; else
wsServer
on a loopback port.
wsListenOn(const node: AnyNodenode, const list: ServeLayerListlist, const listenOptions: anylistenOptions) as 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,
| import UnaddressedNodeUnaddressedNode
| import AddressLessClaimLostAddressLessClaimLost
| import ListenTagNodeRequiredListenTagNodeRequired
| import WsListenRequiresWsWsListenRequiresWs, never>;
}