Dice Roll is a project of rolling dice javascript based. Developed to support any application that needs data with random numbers.
With this project, you can create a single instance of dice roll or create an instance of many rolling dices that will work together.
This project is a prototype of study, implementation, configure of many tecnologies, how: ES6, Eslint, jest, standard, babel, webpack
I chose as many technologies as possible to implement within a small project. If you have any ideas for anything else I can do around here, I'll be happy to receive your feedback.
Run this command to install project dependencies
npm installTo see example of this project, run:
npm startTo generate a build, you have to execute:
npm run build # This command generate '/dist' filesDice class is a most single mode of dice roll. With that, you can make randomic value with range from 1 to 'amount of sides'.
Class structure
class Dice(sides: int) {
roll(): Dice
getSides(): int
getValue(): int
}This is an example to make Dice instances:
// Whithout parameter the dice instance receive 6 sides by default
const dice = new Dice() // dice has 6 sides (by default)
const dice2 = new Dice(10) // dice has 10 sides
// This line return the amount of sides
dice2.getSides() // result: 10
// Roll dice to make aleatory result
dice2.roll()
dice2.getValue() // result: An aleatory Number between 1 and 10
// You can make chain call
dice2.roll().getValue() // result: An aleatory Number between 1 and 10Dices class is a roller of dice series. With that, you can make roll of many dices at the sume time.
Class structure
class Dices(amount: int, sides: int) {
roll (options = { unique: boolean }): Dice
getAmount(): int
getValues(): Array(int)
getUniqueValues(): Array(int)
}This is an example to make Dices instances:
const dices = new Dices() // dice has 2 dices (by default) with 6 sides (by default)
const dices2 = new Dices(10) // dice2 has 10 dices with 6 sides (by default)
const dices3 = new Dices(10, 5) // dice3 has 10 dices with 6 sides
// Roll dices to make aleatory results
dices2.roll()
dices2.getValue() // result: array[10] Numbers between 1 and 10
// You can make chain call
dices2.roll().getValue() // result: array[10] Numbers between 1 and 10
// If you want all dices with different value, you can pass 'unique' parameter
dices2.roll({ unique: true })We use SemVer for versioning. For the versions available, see the tags on this repository.
See the CHANGELOG for all version update details
I hope you know about the basis of my project, but if you don't know much, here are some documents that can help you:
This project is licensed under the MIT License - see the LICENSE file for details