Class BaseAPIObject
Hierarchy
Index
Constructors
Properties
Constructors
constructor
- new
BaseAPIObject(requestedAt, respondedAt, receivedAt, timestamp, apiVersion, libVersion, source): BaseAPIObject Parameters
requestedAt: number
respondedAt: number
receivedAt: number
timestamp: number
apiVersion: `${number}.${number}.${number}`
libVersion: `${number}.${number}.${number}`
source: `https://api.wynncraft.com/${string}`
Returns BaseAPIObject
Properties
api
api
The version of the requested API route
lib
lib
The version of the representation of the data by the wrapper
received
received
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.
requested
requested
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.
responded
responded
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.
Represents the basis of all objects returned by API requests