@cbnsndwch/zero-sources

isDirectMessagesRoom() function

Home > @cbnsndwch/zrocket-contracts > isDirectMessagesRoom

isDirectMessagesRoom() function

Determines if a given room is a direct message room.

Signature:

declare function isDirectMessagesRoom(
    room: Partial<IRoomBase> | IDirectMessagesRoom
): room is IDirectMessagesRoom;

Parameters

Parameter

Type

Description

room

Partial<IRoomBase> | IDirectMessagesRoom

The room to check, which can be a partial IRoom or an IDirectMessageRoom.

Returns:

room is IDirectMessagesRoom

A boolean indicating whether the room is a direct message room.

How was this page?