Interface ChannelInfo

A single analyzed channel of an IPC module.

interface ChannelInfo {
    argsType: string | null;
    isHandler: boolean;
    isStream?: boolean;
    key: string;
    returnType: string;
}

Properties

argsType: string | null

Serialized argument tuple type, or null when there are no args.

isHandler: boolean

true for handle/handleOnce, false for listen/listenOnce/stream.

isStream?: boolean

true for stream, which generates an IpcStream method.

key: string

Channel key (before prefixing), e.g. "get-all".

returnType: string

Serialized (awaited) return type; the yielded chunk type for streams; "any" for listeners.