Type Alias RouterClient<Router>

Client type that provides type-safe request methods based on router inference

type RouterClient<
    Router extends
        InferProtocol<
            Record<string, RouteOutput<Capability<StandardSchemaV1>, unknown>>,
        >,
> = {
    request<Cmd extends string>(
        cmd: Cmd,
        args: Extract<Router, { cmd: Cmd }>["in"],
    ): Promise<Extract<Router, { cmd: Cmd }>["out"]>;
}

Type Parameters

Router extends InferProtocol<
Record<string, RouteOutput<Capability<StandardSchemaV1>, unknown>>,
>

Index

Methods

request

Methods

request

request<Cmd extends string>(
cmd: Cmd,
args: Extract<Router, { cmd: Cmd }>["in"],
): Promise<Extract<Router, { cmd: Cmd }>["out"]>
Type Parameters
- Cmd extends string
Parameters
- cmd: Cmd
- args: Extract<Router, { cmd: Cmd }>["in"]
Returns Promise<Extract<Router, { cmd: Cmd }>["out"]>
- Defined in iso-ucan/src/types.ts:258

Type Alias RouterClient<Router>

Type Parameters

Index

Methods

Methods

request

Type Parameters

Parameters

Returns Promise<Extract<Router, { cmd: Cmd }>["out"]>

Settings

On This Page