https://github.com/code-crash/ccax

This project is to utilize when we want to assert params in JS/TS projects
https://github.com/code-crash/ccax

Last synced: 10 months ago
JSON representation

This project is to utilize when we want to assert params in JS/TS projects

• Host: GitHub
• URL: https://github.com/code-crash/ccax
• Owner: Code-Crash
• License: mit
• Created: 2022-11-03T11:24:28.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-14T17:50:13.000Z (over 2 years ago)
• Last Synced: 2025-08-19T19:33:08.113Z (10 months ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/ccax
• Size: 308 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: .github/README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CCAX

## Overview

This project is to utilize when we want to assert some params, it can be string, number or any instance of any class.

The motivation behind this is to avoid if-else chains just to validate the parameters. see https://stackoverflow.com/q/73795540/2961427 for more details.

[![GitHub license](https://img.shields.io/npm/l/ccax?color=blue)](https://github.com/Code-Crash/ccax/blob/main/LICENSE)

[![npm version](https://img.shields.io/npm/v/ccax)](https://www.npmjs.com/package/ccax)

[![PRs Welcome](https://img.shields.io/badge/contribution-Welcome-brightgreen)](https://github.com/Code-Crash/ccax#how-to-contribute)

![Download](https://img.shields.io/npm/dw/ccax)

## How to Use

TODO: Update this [In Progress]

## How to Contribute

1. Clone the repository

2. Create a branch (`[your-github-username]/[bug-or-task-name]`)

3. Check out your branch and do the changes, and add the test case.

4. Run `npm run lint`, `npm run` format` to clean the code

5. Run `npm run test`, make sure existing and new tests should pass or else the pull request will be rejected.

6. Commit the changes to your branch.

7. Create a pull request for `develop` branch and tag reviewers.

TODOs:

1. Add more assertor for classes and instances

2. Create test cases for all the assertors

3. Update the README.md