Skip to content

README.md

Latest commit

 

History

History
36 lines (20 loc) · 1.29 KB

README.md

File metadata and controls

36 lines (20 loc) · 1.29 KB

MySQL Wrapper

Typescript NPM Software License

An ESM/CommonJS library following Oriented-Object Programming pattern to manager a MySQL connection.

Usage

This package is only a wrapper. Applying the @piggly/ddd-toolkit behavior to mysql2 library. May not be for every project or everyone. See unit testing for examples.

Changelog

See the CHANGELOG file for information about all code changes.

Testing the code

This library uses the Jest. Tests are made of integrations test. We carry out tests of all the main features of this application.

⚠️ You must install (https://github.com/datacharmer/test_db)[https://github.com/datacharmer/test_db] database on your MySQL instance.

cross-env JEST_MYSQL_USER=root JEST_MYSQL_PASSWORD=pass npm run test:once

Contributions

See the CONTRIBUTING file for information before submitting your contribution.

Credits

License

MIT License (MIT). See LICENSE.