One served resource's registry entry — its group (folded into the shared server), wire id, kind, and
readiness derivation. serve appends it; httpServer reads them for the merged server +
/health + node-status.
export interface ServedHyperlink {
readonly ServedHyperlink.groupId: stringgroupId: string;
readonly ServedHyperlink.group: RpcGroup.RpcGroup<any>(property) ServedHyperlink.group: {
requests: ReadonlyMap<string, R>;
annotations: Context.Context<never>;
add: (...rpcs: Rpcs2) => RpcGroup.RpcGroup<any>;
merge: (...groups: Groups) => RpcGroup.RpcGroup<any>;
omit: (...tags: Tags) => RpcGroup.RpcGroup<any>;
middleware: (middleware: M) => RpcGroup.RpcGroup<Rpc.Rpc<string, Schema.Top, Schema.Top, Schema.Top, AnyService | M, ApplyServices<M['Identifier'], unknown>>>;
prefix: (prefix: Prefix) => RpcGroup.RpcGroup<Rpc.Rpc<`${Prefix}${string}`, Schema.Top, Schema.Top, Schema.Top, AnyService, unknown>>;
toHandlers: (build: Handlers | Effect.Effect<Handlers, EX, RX>) => Effect.Effect<Context.Context<Rpc.Handler<string>>, EX, RX | RpcGroup.HandlersServices<any, Handlers>>;
toLayer: (build: Handlers | Effect.Effect<Handlers, EX, RX>) => Layer.Layer<Rpc.Handler<string>, EX, Exclude<RX, Scope.Scope> | RpcGroup.HandlersServices<any, Handlers>>;
of: (handlers: Handlers) => Handlers;
toLayerHandler: (tag: Tag, build: Handler | Effect.Effect<Handler, EX, RX>) => Layer.Layer<Rpc.Handler<Tag>, EX, Exclude<RX, Scope.Scope> | (Handler extends (...args: any) => Stream.Stream<infer _A, infer _E, infer _R> | Rpc.Wrapper<Stream.Stream<infer _A…;
accessHandler: (tag: Tag) => Effect.Effect<(payload: unknown, options: { readonly client: Rpc.ServerClient; readonly requestId: RequestId; readonly headers: Headers.Headers }) => Effect.Effect<unknown, unknown, never>, never, Rpc.Handler<Tag>>;
annotate: (service: Context.Key<I, S>, value: S) => RpcGroup.RpcGroup<any>;
annotateRpcs: (service: Context.Key<I, S>, value: S) => RpcGroup.RpcGroup<any>;
annotateMerge: (annotations: Context.Context<S>) => RpcGroup.RpcGroup<any>;
annotateRpcsMerge: (annotations: Context.Context<S>) => RpcGroup.RpcGroup<any>;
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 RpcGroupRpcGroup.interface RpcGroup<in out R extends Rpc.Any>A collection of RPC definitions that can be composed, annotated, and
converted into server handlers or layers.
RpcGroup<any>;
readonly ServedHyperlink.kind: stringkind: string;
readonly ServedHyperlink.readiness: Effect.Effect<Readiness>(property) ServedHyperlink.readiness: {
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;
}
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<Readiness>;
/** F4 wire-contract fingerprint — stamped at serve from the tag Spec. */
readonly ServedHyperlink.contractHash: stringF4 wire-contract fingerprint — stamped at serve from the tag Spec.
contractHash: string;
/** Node log key when the served tag is bound to a {@link Node} (`options.node`). */
readonly ServedHyperlink.nodeLogKey?: string | undefinedNode log key when the served tag is bound to a
Node
(options.node).
nodeLogKey?: string;
/** Declared transport set of the tag's {@link Node}, when node-bound — the server asserts its own
* transport is a **member**, else {@link ProtocolKindMismatch}. A multi-protocol node lists all its
* transports, so serving it over any one passes. */
readonly ServedHyperlink.nodeKinds?: readonly ProtocolKind[] | undefinedDeclared transport set of the tag's
Node
, when node-bound — the server asserts its own
transport is a member, else
ProtocolKindMismatch
. A multi-protocol node lists all its
transports, so serving it over any one passes.
nodeKinds?: interface ReadonlyArray<T>ReadonlyArray<import ProtocolKindProtocolKind>;
}