README
pe-paladins.js
A strongly typed fork of paladins.js, used by Paladins Edge
- Well maintained and up-to-date library
- All of the methods have the exact response type
- Updated champion enums to include
Azaan
as perAbsolution
patch - Does not rely on any Node specific libraries like
fs
orpath
Changelog
v3.2.5
- Added Siege: Beyond queue in
Enums
,Strings
andData
v3.2.4
- Updated
Data
,Enums
,Strings
for championVII
- Updated enums for
getMatchDetails
,getPlayerMatchHistory
- Added
TaskForce
toEnums
- Fixed
champion_id
type inChampionCard
v3.2.1
- BREAKING CHANGE: renamed
GetMatchIDSByQueue
ApiResponse interface toGetMatchIdsByQueue
- BREAKING CHANGE: renamed
Data
objects from capital to pascal case and changed keys from strings to enums - Refactored
ApiResponse
,Data
,Enums
,Strings
into their own folders - Updated documentation for a few API methods
- Updated
getPlayerQueueStats
andgetMatchIdsByQueue
queueId params to be Enums.Queue instead of number - Updated for
ApiResponse
property
Reason: these changes are a part of the library refactoring and removing clutter, and making things consistent. These will be the last set of breaking changes.
Install
$ npm install pe-paladins.js
Usage
TypeScript
import { API, ApiResponse } from "pe-paladins.js";
const api = new API({
devId: "your dev id",
authKey: "your authKey",
languageId: 1, // optional
}); // API loaded and ready to go.
const foo = async () => {
let response: ApiResponse.GetDataUsage
try {
response = await api.getDataUsage()
// Do something with response
} catch(error) {
// Handle the error
}
}
JavaScript
const { API } = require("pe-paladins.js");
const api = new API({
devId: "your dev id",
authKey: "your authKey",
languageId: 1, // optional
}); // API loaded and ready to go.
const foo = async () => {
let response;
try {
response = await api.getDataUsage()
// Do something with response
} catch(error) {
// Handle the error
}
}
Documentation / Methods
You can view all the available methods and documentation on pe-paladins.paladinsedge.ml. Some of the methods are removed/changed in pe-paladins.js compared to paladins.js