Represents the party information for a specific player

Hierarchy

Constructors

Properties

apiVersion: `${number}.${number}.${number}`

The version of the requested API route

libVersion: `${number}.${number}.${number}`

The version of the representation of the data by the wrapper

The members of the player's party. This includes all guild members and friends currently logged into the same world, along with all party members of the player, regardless of whether they share a world.

The connected player themselves is not included in this list.
receivedAt: number

The unix timestamp indicating when this request was received

This is measured using the local clock.
If the response was returned from cache, then requestedAt, respondedAt and receivedAt may be in the past.
requestedAt: number

The unix timestamp indicating when this request was sent

This is measured using the local clock.
If the response was returned from cache, then requestedAt, respondedAt and receivedAt may be in the past.
respondedAt: number

The unix timestamp indicating when this request was responded to by the API

This is measured using the API server's clock.
If the response was returned from cache, then requestedAt, respondedAt and receivedAt may be in the past.

The player to whom this request is bound

source: `https://api.wynncraft.com/${string}`

The route used to request the data for this object

This is the value used to identify cache entries. API results with the same source can use the cache.
timestamp: number

The unix timestamp indicating when the data of this request was created

You can use this timestamp to determine how old a piece of data is.
world: null | string

The world the player is currently logged into

This can be null if the player just went offline

Generated using TypeDoc