Rocket.Chat/apps/meteor/lib/getUserDisplayNames.ts

import type { IUser } from '@rocket.chat/core-typings';

import { normalizeUsername } from './utils/normalizeUsername';

/*
    In contrary to getUserDisplayName, this function returns an array of strings, containing name & username in the order they're supposed to be displayed.
*/
export const getUserDisplayNames = (
	name: IUser['name'],
	username: IUser['username'],
	useRealName: boolean,
): [nameOrUsername: string, username?: string] => {
	if (!username) {
		throw new Error('Username is required');
	}
	const shouldUseName = !!(useRealName && name);
	const normalizedUsername = normalizeUsername(username);

	return shouldUseName ? [name, normalizedUsername] : [normalizedUsername];
};