alt="The Chess Centre"
src="https://github.com/Chess-Centre/welcome/blob/master/img/bcc-dark-logo.png?raw=true"
width="100"
/>

CircleCI

Chess Players

Utility for accessing chess player data

GitHub tag (latest by date)

Intro

This NodeJS package is provided to help developers build applications or components which want to use the published chess player rating list data.

An example of this would be a React Component which renders a players profile i.e., name, country, rating - where the component prop accepts the FIDE id from a REST endpoint you expose on your server.

_This information is found here at the FIDE website._

Getting started



npm install chess-players

or



yarn add chess-players







Examples (typescript)

$3

typescript

import Fide, { Player } from './fide';



(async () => {

  const fide = new Fide();

  const players: Array = await fide.getPlayers();



  console.log(

Players: ${players.length}

);

})();







          alt="player count"

      src="https://github.com/chess-centre/chess-players/blob/master/src/img/player-count.png?raw=true"

    />





$3

typescript

import Fide, { Player } from './fide';



(async () => {

  const fide = new Fide();

  const players: Array = await fide.getPlayers();



  const topTen = players

    .sort((a: Player, b: Player) => b.rating - a.rating)

    .slice(0, 10)

    .reduce(

      (players: any, player: any) => 

      [...players, { name: player.name, rating: player.rating, nationality: player.country }],

      [],

    );



  console.log(topTen);

})();







          alt="player top ten"

      src="https://github.com/chess-centre/chess-players/blob/master/src/img/player-top-ten.png?raw=true"

    />





$3

typescript

import Fide, { Player } from './fide';



(async () => {

  const fide = new Fide();

  const players: Array = await fide.getPlayers();



  const player = players.find(player => player.fideid === 418250)



  console.log(player);

})();







          alt="player top ten"

      src="https://github.com/chess-centre/chess-players/blob/master/src/img/player.png?raw=true"

    />





$3

typescript

import Fide, { Player, Options } from './fide';



(async () => {

  const fide = new Fide();

  const config: Options = {

    ratingType: "rapid",

    month: "jan",

    year: 2019

  }

  const players: Array = await fide.getPreviousPlayersList(config);

})();

$3

typescript

import Fide from './fide';



(async () => {

  const fide = new Fide();

  console.time('players');

  await fide.getPlayers();

  console.timeEnd('players');



  console.time('players-memoized');

  await fide.getPlayers();

  console.timeEnd('players-memoized');

})();

alt="player memoized"
src="https://github.com/chess-centre/chess-players/blob/master/src/img/player-memoized.png?raw=true"
/>

$3

MIT