Interfaces

@system-inc/base-foundation · 515c140 · 6 symbols

RpcArgumentOptions

interface

defaultValue?: Json
Optional default value for the argument.

This can be used to provide a default value when the argument is not present in the RPC call.
description?: string
Optional description for the argument. This can be used for documentation purposes to explain the purpose of the argument.
name?: string
The name of the argument. This is used for documentation purposes and can help with debugging.
optional?: boolean
Whether the argument is optional.

If true, the argument is not required for the RPC call. If false, the argument must be present in the RPC call and will throw an error if missing.

Defaults to false.

interface

environments: NamedConfiguration<RequireAny<{ binding?: string; endpoint?: string; host?: string; secure?: boolean }, "binding" | "host">>
name: string
A name used to designate this RPC with.

You can use this to inject an instance of an RPC client bound to a specific RPC service.

interface

visibility?: RpcVisibility
Optional visibility override for this procedure. Takes precedence over the service-level (@RpcService) and worker-level (rpc.service settings) visibility. 'internal' — callable only from bound workers; 'public' — callable from the public route. In local development mode everything is effectively 'public'.

interface

interface

Settings for the RPC service that will be served by this worker.

allowedWorkers?: string[]
A list of workers that are allowed to bind to this worker and call its RPCs.

This is only relevant if the visibility is set to 'internal'.
route?: string
Override the default endPoint that serves the RPC service here. See DefaultRemoteProcedureEndpoint.
visibility?: RpcVisibility
Whether the RPC service should be callable from a public route.

If set to 'public', the RPC service will be callable from a public route. If set to 'internal', the RPC service will only be callable from a bound worker.

The default value is 'internal' if unspecified.

interface

Settings for RPCs in the worker.

client?: RpcClientSettings[]
Settings for calling RPCs from this worker.
service?: RpcServiceSettings
Settings for the RPC service that will be served by this worker.