Class Profile

Represents a user profile that exists on the system.

Hierarchy

  • Profile

Constructors

constructor

Properties

image nickname uid

Methods

[iterator]

Constructors

constructor

  • Creates a new Profile instance from the given profile UID.

    Parameters

    Returns Profile

    Example

    const profile = new Switch.Profile([
      0x10005d4864d166b7n,
      0x965b8cb028cd8a81n,
    ]);
    console.log(profile.nickname);

Properties

Readonly image

image: ArrayBuffer

The raw JPEG data for the profile image. Can be decoded with the Image class.

Readonly nickname

nickname: string

The human readable nickname of the profile.

Readonly uid

uid: ProfileUid

The unique ID of the profile, represented as an array of two bigint values.

Methods

Static [iterator]

  • [iterator](): Generator<Profile, void, unknown>

  • Can be used as an iterator to retrieve the list of user profiles.

    Returns Generator<Profile, void, unknown>

    Example

    for (const profile of Switch.Profile) {
      console.log(profile.nickname);
    }

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc