A modern SDK for interacting with the BoardGameGeek (BGG) XMLAPI2, written in TypeScript and inspired by BGG.
npm install bgg-sdk
import { bgg } from "bgg-sdk";
// import bgg from "bgg-sdk";
const results = await bgg.search({ query: "scythe" });
// results
{
"attributes": {
"termsofuse": "https://boardgamegeek.com/xmlapi/termsofuse"
},
"items": [
{
"id": "398158",
"type": "boardgame",
"name": "Grind House: Scythes Out",
"yearPublished": "2023"
},
{
"id": "226320",
"type": "boardgame",
"name": "My Little Scythe",
"yearPublished": "2017"
},
...
]
}
Hey there! 👋
I hope you've found my sdk useful for your project, but if you found any bugs please open an issue and I'll address it as soon as I can.
Of course always feel free to take a crack at fixing it yourself and opening a PR!
npm install
.npm test
and fix / add any necessary tests to maintain 100% code coverage. Your PR cannot be merged until all tests pass.