createIpcNotifyAdapter

FunctionExperimental

Signature

function createIpcNotifyAdapter(__namedParameters): NotifyAdapter<"sync">;

ipc/src/notify-adapter/notify-adapter.ipc.ts:61

Parameters

  • __namedParameters
    object
  • __namedParameters.directory
    string
    Directory for the registry files. Every process that passes the same directory receives every other one's notifications. Created on first use if it does not exist. The sockets themselves live in the operating system's temporary directory (os.tmpdir()), so the processes must also share that: not with systemd's PrivateTmp, and in containers that share only this directory, mount a shared temporary directory as well. On Windows they use named pipes instead.
  • __namedParameters.onError?
    (error) => void
    Called when the server started by a listen* call cannot listen or its registry file cannot be written. Runs synchronously; a throw is ignored.

Returns

NotifyAdapter<"sync">

Used in guides

esc

Search guides, integrations and every exported symbol.

↑ ↓ to navigate↵ to open