rx-bgg-api

RxJS based BoardGameGeek API Package, fully written in Typescript.

Usage no npm install needed!

<script type="module">
  import rxBggApi from 'https://cdn.skypack.dev/rx-bgg-api';
</script>

README

RX BGG API

RxJS based BoardGameGeek API Package, fully written in Typescript.

Installation

npm install --save @wanieldeiss/rx-bgg-api

Usage

import * as BggApi from '@wanieldeiss/rx-bgg-api';
import { SearchParameters } from '@wanieldeiss/rx-bgg-api/interfaces';

const searchParameters: SearchParameters = {
  query: '7 Wonders',
  type: 'boardgame', // optionally
  exact: 5 // optionally
};

BggApi.search(searchParameters).subscribe(
  (res) => {
    console.log('Response:', res);
  },
  (err) => {
    console.error(err);
  }
);

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT