API Documentation Github stalks.io

Class

Passport

Passport(passportDataopt)

Constructor

# new Passport(passportDataopt)

Represents a passport. (All options are optional.)
Parameters:
Name Type Attributes Description
passportData PassportData <optional>

View Source structures/accounts/passport/Passport.js, line 11

Members

boolean

# boughtLocal

Whether your island has ever had turnips bought from it.

View Source structures/accounts/passport/Passport.js, line 50

string

# friendCode

The friend code of a user. Format: SW-1234-5678-0910

View Source structures/accounts/passport/Passport.js, line 42

boolean

# nullable patronLowkey

Whether to hide you from the patrons page.

View Source structures/accounts/passport/Passport.js, line 58

string

# townName

The town/island name of a user.

View Source structures/accounts/passport/Passport.js, line 33

string

# username

The username of a user.

View Source structures/accounts/passport/Passport.js, line 17

string

# villagerName

The villager name of a user.

View Source structures/accounts/passport/Passport.js, line 25

Methods

# toJSON() → {PassportData}

Serializes the Week to a JSON.

View Source structures/accounts/passport/Passport.js, line 66

PassportData