From 4c2faa7c97df55bcd2c90627c6853a6f77d73486 Mon Sep 17 00:00:00 2001 From: Olivier 'reivilibre Date: Sat, 3 Feb 2024 12:52:34 +0000 Subject: [PATCH] (add docstring to invitePersonToRoom) --- src/invites.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/invites.ts b/src/invites.ts index 7a5ea17..f5960f1 100644 --- a/src/invites.ts +++ b/src/invites.ts @@ -79,6 +79,11 @@ export async function resolveIdentifiers(client: ConferenceMatrixClient, people: return resolved; } +/** + * Invites a person to a room idempotently. + * + * Raises an exception when we don't have information to invite the user, or there is some Matrix or network error preventing us from doing so. + */ export async function invitePersonToRoom(client: ConferenceMatrixClient, resolvedPerson: ResolvedPersonIdentifier, roomId: string, config: IConfig): Promise { if (resolvedPerson.mxid) { if (config.dry_run_enabled) {