Runners.ts overview
Since v1.0.0
Exports Grouped by Category
Client
RpcClientProtocol (class)
Signature
declare class RpcClientProtocol
Since v1.0.0
Constructors
make
Signature
declare const make: (
options: Omit<Runners["Type"], "sendLocal" | "notifyLocal">
) => Effect.Effect<Runners["Type"], never, MessageStorage.MessageStorage | Snowflake.Generator | ShardingConfig | Scope>
Since v1.0.0
Layers
layerNoop
Signature
declare const layerNoop: Layer.Layer<Runners, never, MessageStorage.MessageStorage | ShardingConfig>
Since v1.0.0
layerRpc
Signature
declare const layerRpc: Layer.Layer<Runners, never, MessageStorage.MessageStorage | ShardingConfig | RpcClientProtocol>
Since v1.0.0
No-op
makeNoop
Signature
declare const makeNoop: Effect.Effect<
{
readonly ping: (address: RunnerAddress) => Effect.Effect<void, RunnerUnavailable>
readonly sendLocal: <R extends Rpc.Any>(options: {
readonly message: Message.Outgoing<R>
readonly send: <Rpc extends Rpc.Any>(
message: Message.IncomingLocal<Rpc>
) => Effect.Effect<void, EntityNotManagedByRunner | MailboxFull | AlreadyProcessingMessage>
readonly simulateRemoteSerialization: boolean
}) => Effect.Effect<void, EntityNotManagedByRunner | MailboxFull | AlreadyProcessingMessage>
readonly send: <R extends Rpc.Any>(options: {
readonly address: RunnerAddress
readonly message: Message.Outgoing<R>
}) => Effect.Effect<
void,
EntityNotManagedByRunner | RunnerUnavailable | MailboxFull | AlreadyProcessingMessage | PersistenceError
>
readonly notify: <R extends Rpc.Any>(options: {
readonly address: Option.Option<RunnerAddress>
readonly message: Message.Outgoing<R>
readonly discard: boolean
}) => Effect.Effect<void>
readonly notifyLocal: <R extends Rpc.Any>(options: {
readonly message: Message.Outgoing<R>
readonly notify: (options: Message.IncomingLocal<any>) => Effect.Effect<void, EntityNotManagedByRunner>
readonly discard: boolean
}) => Effect.Effect<void>
},
never,
Scope | MessageStorage.MessageStorage | ShardingConfig | Snowflake.Generator
>
Since v1.0.0
Rpcs
RpcClient (interface)
Signature
export interface RpcClient extends RpcClient_.FromGroup<typeof Rpcs> {}
Since v1.0.0
Rpcs (class)
Signature
declare class Rpcs
Since v1.0.0
makeRpcClient
Signature
declare const makeRpcClient: Effect.Effect<RpcClient, never, Scope | RpcClient_.Protocol>
Since v1.0.0
constructors
makeRpc
Signature
declare const makeRpc: Effect.Effect<
{
readonly ping: (address: RunnerAddress) => Effect.Effect<void, RunnerUnavailable>
readonly sendLocal: <R extends Rpc.Any>(options: {
readonly message: Message.Outgoing<R>
readonly send: <Rpc extends Rpc.Any>(
message: Message.IncomingLocal<Rpc>
) => Effect.Effect<void, EntityNotManagedByRunner | MailboxFull | AlreadyProcessingMessage>
readonly simulateRemoteSerialization: boolean
}) => Effect.Effect<void, EntityNotManagedByRunner | MailboxFull | AlreadyProcessingMessage>
readonly send: <R extends Rpc.Any>(options: {
readonly address: RunnerAddress
readonly message: Message.Outgoing<R>
}) => Effect.Effect<
void,
EntityNotManagedByRunner | RunnerUnavailable | MailboxFull | AlreadyProcessingMessage | PersistenceError
>
readonly notify: <R extends Rpc.Any>(options: {
readonly address: Option.Option<RunnerAddress>
readonly message: Message.Outgoing<R>
readonly discard: boolean
}) => Effect.Effect<void>
readonly notifyLocal: <R extends Rpc.Any>(options: {
readonly message: Message.Outgoing<R>
readonly notify: (options: Message.IncomingLocal<any>) => Effect.Effect<void, EntityNotManagedByRunner>
readonly discard: boolean
}) => Effect.Effect<void>
},
never,
Scope | MessageStorage.MessageStorage | ShardingConfig | Snowflake.Generator | RpcClientProtocol
>
Since v1.0.0
context
Runners (class)
Signature
declare class Runners
Since v1.0.0