Package Exports
- wynnsdk
- wynnsdk/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (wynnsdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
WynnSDK
Unofficial SDK for the Wynncraft API with built-in caching support (Fruma update supported)
Installation
npm install wynnsdkFeatures
- 🚀 Easy-to-use wrapper for the Wynncraft API
- 💾 Built-in caching system to respect API rate limits
- ⚡ Promise-based async/await support
Usage
import { WynnSDK } from 'wynnsdk';
// Initialize the SDK
const sdk = new WynnSDK();
// Get player information
const playerInfo = await sdk.getPlayer('PlayerName');
// Get guild information
const guildInfo = await sdk.getGuild('GuildName');
// Get item information
const itemInfo = await sdk.searchItem('Legendary Spear');
// Get live player and guild, party, friend locations
const playerLiveData = await sdk.getPlayerLocations();Caching System
WynnSDK implements an intelligent caching system to:
- Respect Wynncraft API rate limits
- Reduce API calls for frequently requested data
- Improve response times
Cache durations:
The cache duration is automaticly determinate with header of the request.
Documentation
Full documentation will be available soon.
Contributing
Contributions are welcome! Feel free to:
- Fork the project
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Author
- Sebastien Moraz
Links
Support
If you encounter any problems or have questions, please:
- Open an issue
- Contact the author through GitHub