Type Alias WebSocketHostMessageType<ThisWebSocket>

WebSocketHostMessageType: ThisWebSocket["hostMessage"] extends undefined
? undefined
: NonNullable<ThisWebSocket["hostMessage"]>["runtimeType"]

Extracts a WebSocket's host message type.

Type Parameters

ThisWebSocket extends WebSocketDefinition

Example

import {defineWebSocket, type WebSocketHostMessageType} from '@rest-vir/api';
import {defineShape} from 'object-shape-tester';

const chatSocket = defineWebSocket({
    path: '/ws/chat',
    hostMessage: defineShape({event: '', payload: ''}),
});

type HostMessage = WebSocketHostMessageType<typeof chatSocket>;

Package

@rest-vir/api