UserSummary

UserSummary

new UserSummary(userData) → {UserSummary.<String, (String|undefined), String, Object>}

UserSummary constructor

Source:

classes/structures/user/userSummary.js, line 10

Parameters:

Name Type Description

userData

Object

The user data

Name	Type	Description
`id`	`String`	The user id
`type`	`String` \| `undefined`	The user type
`name`	`String`	The username of the user

Returns:

Type:: UserSummary.<String, (String|undefined), String, Object>

The user id, the user type, the username of the user

Members

(readonly) id :String

The user id

Source:

classes/structures/user/userSummary.js, line 16

Type:

String

(readonly) name :String

The username of the user

Source:

classes/structures/user/userSummary.js, line 23

Type:

String

(readonly) raw :Object

The raw data

Source:

classes/structures/user/userSummary.js, line 36

Type:

Object

userType :String|null

The user type

Source:

classes/structures/user/userSummary.js, line 29

Type:

String | null