@sinisterdev/rock-paper-scissor

About

Integrate the "Rock-Paper-Scissors" game into your project using this simple package

• Get the results easily in the form of an object
• No bugs discovered till date
• Beginner friendly and fast

Installation

npm install @sinisterdev/rock-paper-scissor

Usage

const game = require('@sinisterdev/rock-paper-scissor');

const result = game.play("rock"); /* Options: ["rock", "paper", "scissors"] */

console.log(result); // Returns an object containing result
console.log(result.success) // Returns aboolean whether the game functioned as expected
console.log(result.winner) // Returns a string containing the winner of round (player/computer/tie)
console.log(result.computer) // Retuns the computer's choice in form of string

Result Object

<Result> is the Result object:

<Result>.success - Whether the game functioned as expected - Type: boolean

<Result>.winner - Winner of the round in the form of a string. Round may have resulted in a tie if play() function's force parameter is set to false. Type: string

<Result>.computer - The computer's choice in form of a string. Type: string

<Result>.error - The error message, null when operation is successful

Issues

If you have any bugs, or if you want to request a feature, please open an issue