Skip to main content

UserServiceUtils

Types​

UserInfo​

</>
interface UserInfo {
Id: number--

The Id associated with the UserInfoResponse object

Username: string--

The username associated with the UserInfoResponse object

DisplayName: string--

The display name associated with the UserInfoResponse object

}

Functions​

promiseUserInfosByUserIds​

</>
UserServiceUtils.promiseUserInfosByUserIds(userIds: {number}) → Promise<{UserInfo}>

Wraps UserService:GetUserInfosByUserIdsAsync(userIds)

promiseUserInfo​

</>
UserServiceUtils.promiseUserInfo(userId: number) → Promise<UserInfo>

Wraps UserService:GetUserInfosByUserIdsAsync({ userId })[1]

promiseDisplayName​

</>
UserServiceUtils.promiseDisplayName(userId: number) → Promise<string>

Wraps UserService:GetUserInfosByUserIdsAsync({ userId })[1].DisplayName

promiseUserName​

</>
UserServiceUtils.promiseUserName(userId: number) → Promise<string>

Wraps UserService:GetUserInfosByUserIdsAsync({ userId })[1].Username

Show raw api
{
    "functions": [
        {
            "name": "promiseUserInfosByUserIds",
            "desc": "Wraps UserService:GetUserInfosByUserIdsAsync(userIds)",
            "params": [
                {
                    "name": "userIds",
                    "desc": "",
                    "lua_type": "{ number }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<{ UserInfo }>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 26,
                "path": "src/userserviceutils/src/Shared/UserServiceUtils.lua"
            }
        },
        {
            "name": "promiseUserInfo",
            "desc": "Wraps UserService:GetUserInfosByUserIdsAsync({ userId })[1]",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<UserInfo>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 52,
                "path": "src/userserviceutils/src/Shared/UserServiceUtils.lua"
            }
        },
        {
            "name": "promiseDisplayName",
            "desc": "Wraps UserService:GetUserInfosByUserIdsAsync({ userId })[1].DisplayName",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 73,
                "path": "src/userserviceutils/src/Shared/UserServiceUtils.lua"
            }
        },
        {
            "name": "promiseUserName",
            "desc": "Wraps UserService:GetUserInfosByUserIdsAsync({ userId })[1].Username",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 88,
                "path": "src/userserviceutils/src/Shared/UserServiceUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "UserInfo",
            "desc": "",
            "fields": [
                {
                    "name": "Id",
                    "lua_type": "number",
                    "desc": "The Id associated with the UserInfoResponse object"
                },
                {
                    "name": "Username",
                    "lua_type": "string",
                    "desc": "The username associated with the UserInfoResponse object"
                },
                {
                    "name": "DisplayName",
                    "lua_type": "string",
                    "desc": "The display name associated with the UserInfoResponse object"
                }
            ],
            "source": {
                "line": 20,
                "path": "src/userserviceutils/src/Shared/UserServiceUtils.lua"
            }
        }
    ],
    "name": "UserServiceUtils",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/userserviceutils/src/Shared/UserServiceUtils.lua"
    }
}