tic-tac-typescript v0.0.5

Tic Tac Typescript

A Typescript SDK for handling tic-tac-toe in your application.

Install

• npm install typescript
• npm install tic-tac-typescript

How it Works

Here's a verbose example:

import { Player, Game, GameBoardSpace } from 'tic-tac-typescript';

/**
 * Create a Player with the required `onMoveRequested` hook
 */
const player1 = new Player({

    /**
     * When the game has started, and it's this players turn, the game will
     * call this player's `onMoveRequested` hook.
     * 
     * The game argument exposes properties and methods about the state of the game
     * which you can incorportate into the logic for selecting a space.
     */
    onMoveRequested: function (game: Game) {

        /**
         * In this case we'll just choose the first available space.
         * Once we're ready to take a space, we call `this.makeMove()`.
         */
        this.makeMove(game, game.availableSpaces[0]);
    },
});

/**
 * Create an opponent
 */
const player2 = new Player({
    onMoveRequested: function (game: Game) {

        /**
         * This player will always attempt to take space 'A1'.
         * This will always fail since player1 went first and took 'A1'.
         * 
         * Once that attempt fails, it will take the next available space.
         */
        try {
            this.makeMove(game, GameBoardSpace.A1);
        } catch (e) {

            /**
             * The game will throw a InvalidMoveError whenever a player makes an invalid move.
             * 
             * In this case:
             * e = { errors: { spaceIsTaken: { message: (human readable string), space: 'A1' } }
             */
            this.makeMove(game, game.availableSpaces[0]);
        }
    },

    /**
     * Use the optional `onGameEnded` hook to print the winner and their winning line.
     */
    onGameEnded: function (game: Game) {
        console.info(

            /**
             * If winner is null, the game ended in a tie.
             */
            game.winner === null ? `It's a Tie` : `Winner is ${game.winner.id}`
        );

        if (game.winner) {
            console.info('Winning Line', game.winningVector); // ['A3', 'B2', 'C1']
        }
    },
});

const game = new Game(player1, player2);

/**
 * The Game instance will take care of all the logic needed to orchestrate the game
 * (queuing players, validating moves, checking for winners, etc.).
 */
game.start();

More Examples

See more implementation examples in the Examples Directory.

Play The Undefeated Computer!

Example 04 features a computer that cannot lose a game of Tic-Tac-Toe. You can play the computer in the CLI by cloning this repo and executing the script in the example.

• Make sure your machine has node installed (version >=7) node -v. See nvm if needed.
• Clone the repo: git clone https://github.com/kevinmirc/tic-tac-typescript.git
• Change dir to repo: cd tic-tac-typescript/
• Install dependencies npm i
• Install typescript npm i typescript
• Run the npm script npm run game. This will start a match between you and the undefeated computer.
• optional You can execute other example implementations by executing the file with ts-node node_modules/.bin/ts-node examples/03-cli-vs-computer.ts. This will start a CLI Match with you vs a (defeatable) computer.