Skip to content

PayloadKind

const PayloadKind: object;

Defined in: src/protocol/onAirPackets.ts:37

Named constants for the OnAirPayload kind discriminant, so consumers branch on readable names instead of bare strings: case PayloadKind.GRP_TXT (=== ‘grpTxt’). Values equal the kind literals, so the constant and the raw string are interchangeable and both narrow payload. Distinct from the numeric wire enum PAYLOAD_TYPE (keys header.payloadType).

readonly ACK: "ack" = 'ack';
readonly ADVERT: "advert" = 'advert';
readonly ANON_REQ: "anonReq" = 'anonReq';
readonly CONTROL_DISCOVER_REQ: "controlDiscoverReq" = 'controlDiscoverReq';
readonly CONTROL_DISCOVER_RESP: "controlDiscoverResp" = 'controlDiscoverResp';
readonly CONTROL_OTHER: "controlOther" = 'controlOther';
readonly GRP_TXT: "grpTxt" = 'grpTxt';
readonly PATH: "path" = 'path';
readonly RAW: "raw" = 'raw';
readonly REQ: "req" = 'req';
readonly RESPONSE: "response" = 'response';
readonly TRACE: "trace" = 'trace';
readonly TXT_MSG: "txtMsg" = 'txtMsg';