document OptionListUtils helper function and rename

Expensify · May 3, 2023 · 8042ffb · 8042ffb
1 parent dd89377
commit 8042ffb
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/src/libs/OptionsListUtils.js b/src/libs/OptionsListUtils.js
@@ -141,7 +141,14 @@ function addSMSDomainIfPhoneNumber(login) {
     return login;
 }
 
-function getAvatarsForParticipants(logins, personalDetails) {
+/**
+ * Collect avatar data for a list of user logins
+ *
+ * @param {Array<String>} logins 
+ * @param {Object} personalDetails 
+ * @returns {Object}
+ */
+function getAvatarsForLogins(logins, personalDetails) {
     return _.map(logins, (login) => {
         const userPersonalDetail = lodashGet(personalDetails, login, {login: login, avatar: ''});
         return {
@@ -901,7 +908,7 @@ function getHeaderMessage(hasSelectableOptions, hasUserToInvite, searchValue, ma
 
 export {
     addSMSDomainIfPhoneNumber,
-    getAvatarsForParticipants,
+    getAvatarsForLogins,
     isCurrentUser,
     getSearchOptions,
     getNewChatOptions,

diff --git a/src/pages/workspace/WorkspaceInviteMessagePage.js b/src/pages/workspace/WorkspaceInviteMessagePage.js
@@ -166,7 +166,7 @@ class WorkspaceInviteMessagePage extends React.Component {
                         <View style={[styles.mv4, styles.justifyContentCenter, styles.alignItemsCenter]}>
                             <MultipleAvatars
                                 size={CONST.AVATAR_SIZE.LARGE}
-                                icons={OptionsListUtils.getAvatarsForParticipants(this.props.invitedMembersDraft)}
+                                icons={OptionsListUtils.getAvatarsForLogins(this.props.invitedMembersDraft)}
                                 shouldStackHorizontally
                                 secondAvatarStyle={[
                                     styles.secondAvatarInline,