quidphp-javascript

QuidPHP/JavaScript

About

QuidPHP/JavaScript is a JavaScript module useful for both the front-end & back-end. The scripts are compatible within the browser or Node.

License

QuidPHP/JavaScript is available as an open-source package under the MIT license.

Documentation

QuidPHP/Javascript documentation is available at QuidPHP/Docs.

Installation

QuidPHP/Javascript can be easily installed with NPM.

$ npm install quidphp-javascript

Once installed, the package will be available within your node_modules folder.

Dependency

QuidPHP/JavaScript has the following dependencies:

• laravel-mix/laravel-mix - The power of webpack, distilled for the rest of us
• scottcharlesworth/laravel-mix-polyfill - Quid\Main - A Laravel Mix extension to include polyfills by using Babel, core-js, and regenerator-runtime

All dependencies will be resolved by using the NPM installation process.

Requirement

QuidPHP/Javascript requires Node 15+ or any modern browser (not Internet Explorer).

Comment

QuidPHP/JavaScript code is commented and all methods are explained (in French).

Overview

QuidPHP/JavaScript contains one entry file.

• index - Entry file for the module

Source

QuidPHP/JavaScript contains 21 JavaScript files. Here is an overview:

• arr - Script with some objects related to array manipulation
• arrLike - Script with some functions related to array like management
• bool - Methods for bool primitive type
• datetime - Script with functions related to date and time
• debug - Script with functions related to debugging
• env - Methods related to javascript environment
• factory - Script with a method to create the objects with prototype
• func - Script with methods related to functions
• html - Script containing event listeners functions for target elements
• integer - Methods related to integer numbers
• json - Script with methods related to json format
• nav - Script with helper functions related to navigation and pagination
• num - Script with functions related to numbers
• obj - Script with a set of helper functions related to objects
• pojo - Script with a set of helper functions related to plain objects
• scalar - Script with functions related to scalar values
• str - Script with a set of helper functions related to strings
• testSuite - Script with a method to run a suite of tests
• type - Script with common methods for all variable types
• validate - Script with behaviours related to validation
• vari - Script with a set of general functions related to variables

Distributable

QuidPHP/JavaScript contains 2 scripts that can be used in the browser.

• javascript.js - Minified and transpiled script ready for production
• javascript-test.js - Same as javascript.js but also contains the module tests

Testing

QuidPHP/JavaScript contains 2 test scripts:

• javascript - Script to test the module in node or the browser
• run - File to run the testsuite in node

QuidPHP/JavaScript testsuite can be run in the browser by creating a new QuidPHP/Assert project. It can also be run in Node with the command:

$ npm run test