Options for httpServer.
export interface HttpServerOptions {
readonly HttpServerOptions.path?: HttpRouter.PathInput | undefinedpath?: import HttpRouterHttpRouter.type PathInput = `/${string}` | "*"Path pattern accepted by the router. Routes must use an absolute path
beginning with / or the wildcard *.
PathInput;
readonly HttpServerOptions.serialization?: Layer.Layer<RpcSerialization.RpcSerialization, never, never> | undefinedserialization?: 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 RpcSerializationRpcSerialization.class RpcSerializationclass RpcSerialization {
key: Identifier;
Service: {
makeUnsafe: () => RpcSerialization.Parser;
contentType: string;
includesFraming: boolean;
};
}
Service that describes how RPC protocol messages are encoded and decoded,
including the content type and whether the serialization format provides
message framing.
When to use
Use to provide the serialization boundary shared by RPC clients and servers
for a chosen wire format.
RpcSerialization>;
readonly HttpServerOptions.health?: {
readonly path?: HttpRouter.PathInput;
} | undefined
path?: HttpRouter.PathInput | undefinedpath?: import HttpRouterHttpRouter.type PathInput = `/${string}` | "*"Path pattern accepted by the router. Routes must use an absolute path
beginning with / or the wildcard *.
PathInput };
/**
* Node log key for auto-mounted {@link NodeStatus} durable `logs.query`
* (`Hyperlink.store(Node)` / `Node.logs`). When omitted, inferred from served tags'
* bound {@link Node} when all share one key.
*/
readonly HttpServerOptions.node?: string | {
readonly key: string;
} | undefined
Node log key for auto-mounted
NodeStatus
durable logs.query
(Hyperlink.store(Node) / Node.logs). When omitted, inferred from served tags'
bound
Node
when all share one key.
node?: string | { readonly key: stringkey: string };
/**
* Soft Lookup directory advertise after serve registration (`Node.http` / `Node.ws` / protocol listen).
*
* @internal
*/
readonly HttpServerOptions.advertiseNode?: anySoft Lookup directory advertise after serve registration (Node.http / Node.ws / protocol listen).
advertiseNode?: import AnyNodeAnyNode & { readonly key: stringkey: string };
/**
* Call-site advertise conflict policy (forwarded to {@link Lookup.directoryAdvertiseLayer}).
*
* @internal
*/
readonly HttpServerOptions.onConflict?: anyCall-site advertise conflict policy (forwarded to
Lookup.directoryAdvertiseLayer
).
onConflict?: import OnConflictOnConflict;
}