Class BaseUser Abstract

Hierarchy

BaseUser
- User
- Account

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseUser(client: PteroApp | PteroClient, data: any): BaseUser

- Defined in src/structures/User.ts:32
Parameters
- client: PteroApp | PteroClient
- data: any
Returns BaseUser

Properties

client

client: PteroApp | PteroClient

email

email: string

The email of the user.

firstname

firstname: string

The firstname of the user.

Readonly id

id: number

The internal ID of the user.

language

language: string

The language set for the user.

lastname

lastname: string

The lastname of the user.

username

username: string

The username of the user.

Methods

_patch

_patch(data: any): void

- Defined in src/structures/User.ts:39
Parameters
- data: any
Returns void

toJSON

toJSON(): object

- Defined in src/structures/User.ts:52
Converts the user into a JSON object, relative to the API response object.

Returns object
The JSON object.

toString

toString(): string

- Defined in src/structures/User.ts:60
Returns string
The string representation of the user.

Generated using TypeDoc