@blizzard-api/wow
Version:
A series of helpers to interact with the World of Warcraft Blizzard API
44 lines (43 loc) • 1.29 kB
JavaScript
import { wowBasePath } from "@blizzard-api/core";
//#region src/connected-realm/index.ts
/**
* Get a connected realm by ID.
* @param connectedRealmId The connected realm ID.
* @returns The connected realm. See {@link ConnectedRealmResponse}.
*/
function connectedRealm(connectedRealmId) {
return {
namespace: "dynamic",
path: `${wowBasePath}/connected-realm/${connectedRealmId}`
};
}
/**
* Get a connected realm index.
* @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
*/
function connectedRealmIndex() {
return {
namespace: "dynamic",
path: `${wowBasePath}/connected-realm/index`
};
}
/**
* Search for connected realms.
* @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
* @returns The search results. See {@link ConnectedRealmSearchResponse}.
*/
function connectedRealmSearch(options) {
return {
namespace: "dynamic",
parameters: {
_page: options._page,
orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
"realms.timezone": options["realms.timezone"],
"status.type": options["status.type"]
},
path: `${wowBasePath}/search/connected-realm`
};
}
//#endregion
export { connectedRealm, connectedRealmIndex, connectedRealmSearch };
//# sourceMappingURL=index.js.map