@elcapitansponge/tysql v1.1.0

About The Project

This was born out of the desire to have robust module for managing and working with mysql databases across a range of various applications without having to rewrite the code or perform some copy pasta.

Getting Started

Installation

To install the package run the following command.

npm install @elcapitansponge/tysql

Upon installation, TySQL leverages .env to handle the connection configuration and details.

Configuration File

The configurations all have a db__ prefix.

The names of the configurations are familiar if you have used mysql connections before. This is reflected in the example of the .env file is bellow (Sample template can be located at Sample .env):

db__host: 'localhost'
db__user: 'usr'
db__password: 'pass'
db__port: 3306
db__schema: 'schema'

Example code

An example of useable typescript code can be found here

Roadmap

See the open issues for a full list of proposed features (and known issues).

Code of Conduct

See CODE_OF_CONDUCT for more information.

Contributing

See CONTRIBUTING for more information.

License

Distributed under the MIT License. See LICENSE for more information.