rugby-roles v1.0.0

Rugby Roles

Rugby Roles is a JavaScript package available on npm that provides two main features to help you understand rugby player positions based on their jersey number, and vice versa.

Features

1. Jersey Number → Player Role

   • Provides the role associated with a specific jersey number.
   • For example:
     • Number 1 returns Loosehead Prop
     • Number 15 returns Fullback

2. Player Role → Jersey Number

   • Provides the jersey number associated with a specific role.
   • For example:
     • Role Scrum Half returns 9
     • Role Lock returns 4 or 5

Installation

You can install the package directly from npm:

npm install rugby-roles

Usage

1. Import the package into your project:

   const rugbyRoles = require('rugby-roles');

2. Use the available functions:

   • Get role by jersey number:

     const role = rugbyRoles.getRugbyPositionByNumber(7);
     console.log(role); // Flanker

   • Get jersey number by role:

     const number = rugbyRoles.getRugbyPositionByRole('Fly Half');
     console.log(number); // 10

API

getRugbyPositionByNumber(jerseyNumber)

• Description: Returns the player's role based on their jersey number.
• Parameters:
  • number (Number): The player's jersey number.
• Returns: (String): The player's role.

getRugbyPositionByRole(role)

• Description: Returns the jersey number associated with a specific role.
• Parameters:
  • role (String): The player's role.
• Returns: (Number|Array): The jersey number (or an array of numbers if more than one is possible).

Complete Example

const rugbyRoles = require('rugby-roles');

// Find the role associated with a jersey number
const role = rugbyRoles.getRugbyPositionByNumber(1);
console.log(`The role for jersey number 1 is: ${role}`); // Loosehead Prop

// Find the jersey number associated with a role
const number = rugbyRoles.getRugbyPositionByRole('Fullback');
console.log(`The jersey number for Fullback is: ${number}`); // 15

Contributions

Contributions to the project are welcome! Feel free to:

• Create issues to report problems or suggest improvements.
• Propose changes through pull requests.

License

This project is distributed under the MIT license. See the LICENSE file for more details.

We hope Rugby Roles helps you better understand the wonderful world of rugby!