Function defineChannel

defineChannel<
    T extends ChannelType,
    TArgs extends any[] = any[],
    TResult = any,
    TEmit extends IpcEventMap = Record<string, any[]>,
>(
    type: T,
    fn: T extends "stream"
        ? IpcStreamHandler<TArgs, TResult, TEmit>
        : T extends "handle"
        | "handleOnce"
            ? IpcHandler<TArgs, TResult, TEmit>
            : IpcListener<TArgs, TResult, TEmit>,
): T extends "handle"
| "handleOnce"
    ? HandlerDef<TArgs, TResult, TEmit>
    : T extends "stream"
        ? StreamDef<TArgs, TResult, TEmit>
        : ListenerDef<TArgs, TResult, TEmit>
Wrap a handler/listener/stream function into a channel definition tagged with its kind (handler, listener, or stream) and whether it should only fire once.

Prefer the createIpcHelpers helpers (handle, listen, …) over calling this directly — they preset the type argument for you.
Type Parameters
- T extends ChannelType
- TArgs extends any[] = any[]
- TResult = any
- TEmit extends IpcEventMap = Record<string, any[]>
Parameters
- type: T
  One of handle, handleOnce, listen, listenOnce, stream.
- fn: T extends "stream"
      ? IpcStreamHandler<TArgs, TResult, TEmit>
      : T extends "handle"
      | "handleOnce"
          ? IpcHandler<TArgs, TResult, TEmit>
          : IpcListener<TArgs, TResult, TEmit>
  The handler (for handle*), listener (for listen*), or iterable-returning callback (for stream).
Returns T extends "handle"
| "handleOnce"
    ? HandlerDef<TArgs, TResult, TEmit>
    : T extends "stream"
        ? StreamDef<TArgs, TResult, TEmit>
        : ListenerDef<TArgs, TResult, TEmit>
- Defined in src/runtime/ipc-module.ts:57

Function defineChannel

Type Parameters

Parameters

Returns T extends "handle"| "handleOnce" ? HandlerDef<TArgs, TResult, TEmit> : T extends "stream" ? StreamDef<TArgs, TResult, TEmit> : ListenerDef<TArgs, TResult, TEmit>

Settings

Returns T extends "handle"
| "handleOnce"
? HandlerDef<TArgs, TResult, TEmit>
: T extends "stream"
? StreamDef<TArgs, TResult, TEmit>
: ListenerDef<TArgs, TResult, TEmit>