npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rock-paper-scissors-lib

v1.0.0

Published

A library for Rock-Paper-Scissors game logic, providing a way to simulate and control the outcomes of the game with customizable probabilities for draw, win, and loss.

Downloads

22

Readme

Rock-Paper-Scissors Library

A library for Rock-Paper-Scissors game logic, providing a way to simulate and control the outcomes of the game with customizable probabilities for draw, win, and loss.

Installation

Install the library using npm:

npm install rock-paper-scissors-lib

Usage

Importing the Library You can import the library into your project as follows:

const { RockPaperScissors, Choice, GameOptions } = require('rock-paper-scissors-lib');

// or if you are using ES6 modules
import { RockPaperScissors, Choice, GameOptions } from 'rock-paper-scissors-lib';

Creating a Game

Create a new game instance by providing the probabilities for draw, win, and lose:

const options: GameOptions = {
  drawProbability: 0.33,
  winProbability: 0.33,
  loseProbability: 0.34,
};

const game = new RockPaperScissors(options);

Playing a Round

You can play a round by providing the player's choice:

const result = game.playRound(Choice.Rock);

console.log(result);
// Output example:
// {
//   playerChoice: 'rock',
//   machineChoice: 'scissors',
//   winner: 'player',
//   stats: { player: { rock: 1, paper: 0, scissors: 0 }, machine: { rock: 0, paper: 0, scissors: 1 }, totalGames: 1 }
// }

API

Classes

RockPaperScissors

The main class to create and play a game.

constructor(options: GameOptions) options: An object containing the probabilities for draw, win, and lose. playRound(playerChoice: Choice): Result playerChoice: The choice made by the player (Choice.Rock, Choice.Paper, or Choice.Scissors). Returns an object with the following properties: playerChoice: The player's choice. machineChoice: The machine's choice. winner: The winner of the round ('player', 'machine', or 'draw'). stats: An object containing the statistics of the game.

Enums

Choice

The choices available in the game.

Choice.Rock: Represents the choice "rock". Choice.Paper: Represents the choice "paper". Choice.Scissors: Represents the choice "scissors".

Interfaces

GameOptions

The options for creating a game.

drawProbability: The probability of a draw (a number between 0 and 1). winProbability: The probability of the player winning (a number between 0 and 1). loseProbability: The probability of the machine winning (a number between 0 and 1).

Stats

The statistics of the game.

player: An object containing the number of times the player chose each option. machine: An object containing the number of times the machine chose each option. totalGames: The total number of games played.