blob: 6b5075db792d0eba6750ab3091aec68a5ecff900 [file] [log] [blame]
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { MessageDataTypeMap } from './message-data-type-map.interface';
type KeysOfUnion<T> = T extends T ? keyof T : never;
export interface WebSocketMessage<
T extends Partial<Record<keyof MessageDataTypeMap, unknown>>,
Op extends KeysOfUnion<T> = KeysOfUnion<T>
> {
op: Op;
data?: T[Op];
ticket?: string; // default 'anonymous'
principal?: string; // default 'anonymous'
roles?: string; // default '[]'
msgId?: string;
}