@nichathan-gaming/assertions

Assertions

Defines functions for assertions in javascript.

Features

• assertArray: Asserts that the value is an array.
• assertArray: Asserts that the value is an array.
• assertArrayType: Asserts that all values of the givenArray have the type of validType.
• assertArrayTypes: Asserts that all values of the givenArray have a type in validTypes.
• assertClass: Asserts that the value is a class.
• assertImage: Asserts that the imageUrl has a valid extension supported by Chrome, Edge, Firefox, Safari, and Opera for the img tag
• assertInstanceOf: Asserts that the value is an instance of the classType.
• assertInstanceOneOf: Asserts that the value is an instance of one of the classTypes.
• assertSameType: Asserts that both of the values have the same type.
• assertTuple: Asserts that the compareValue has the same length and type as the tuple.
• assertType: Asserts that the typeof the value is the given type.
• assertTypeOfOne: Asserts that the value is one of the types.
• basicTypes: Defines an enum of basic javascript types

Contributing

Contributions are welcome! If you have ideas for improvements or new features, feel free to open an issue or submit a pull request. Please ensure that your contributions align with the project's goals and coding standards.

Steps to Contribute

1. Fork the Repository:

   • Click the "Fork" button at the top right of the repository page to create a copy of the repository under your GitHub account.

2. Clone Your Fork:

   • Clone your forked repository to your local machine using the following command:

     git clone https://github.com/J-M-Nichols/assertions.git

3. Create a Branch:

   • Create a new branch for your feature or bug fix:

     git checkout -b feature-or-bugfix-name

4. Make Your Changes:

   • Implement your changes or new features in your local repository.

5. Test Your Changes:

   • Ensure that your changes are thoroughly tested and do not break existing functionality.

6. Commit Your Changes:

   • Commit your changes with a descriptive commit message:

     git commit -m "Description of changes"

7. Push to Your Fork:

   • Push your changes to your forked repository:

     git push origin feature-or-bugfix-name

8. Open a Pull Request:

   • Navigate to the original repository and click the "New Pull Request" button.
   • Select your branch and submit the pull request for review.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgments

• Thanks to all contributors and users who have helped improve this project.
• Special thanks to the developers of the algorithms and techniques used in this project.