Class NameSearch

Represents the result of a name search on the Wynncraft API

Hierarchy

Constructors

constructor

Properties

apiVersion guildTags guilds items libVersion players query receivedAt requestedAt respondedAt source timestamp

Constructors

Private constructor

Properties

apiVersion

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

The version of the requested API route

guildTags

guildTags: GuildListItem[]

The guilds where the search pattern appeared in the tag

Ordered in ascending order of creation date.

guilds

guilds: string[]

The guild names including the search pattern in their name

Ordered in ascending order of creation date.

items

items: Item[]

The items whose names contain the query string

libVersion

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

The version of the representation of the data by the wrapper

players

players: PlayerIdentifier[]

The players whose name begins with the query

Ordered approximately lexicographically.

query

query: string

The query used for this search

receivedAt

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

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

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.

source

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

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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc