Interface BaseMessage

Defines the fundamental message structure used for all IPC communications. This interface serves as the base for more specific message types and contains all possible fields that might be used in any message.

interface BaseMessage {
    action?: Action;
    details?: string;
    disconnect?: boolean;
    error?: string;
    id?: string;
    msg?: string;
    pid?: number;
    socket?: string;
    version?: number;
}

Properties

action? details? disconnect? error? id? msg? pid? socket? version?

Properties

Optionalaction

action?: Action

Specifies the type of action being performed

Optionaldetails

details?: string

Additional error context or stack trace information

Optionaldisconnect

disconnect?: boolean

When true, signals that the connection should be terminated after message processing

Optionalerror

error?: string

Description of any error that occurred

Optionalid

id?: string

Unique identifier for the client connection

Optionalmsg

msg?: string

Payload data encoded as a base64 string

Optionalpid

pid?: number

Process ID of the connected client (platform-dependent availability)

Optionalsocket

socket?: string

Path to the IPC socket being used for communication

Optionalversion

version?: number

Protocol version identifier for compatibility checking

Settings

Member Visibility

On This Page

Properties