Skip to content

Latest commit

 

History

History
90 lines (71 loc) · 3.16 KB

README.md

File metadata and controls

90 lines (71 loc) · 3.16 KB
Raw

Halo-Commons-NodeJS

Code Size NPM GitHub license

Halo-Commons-NodeJS is a common Node.js library used in the Hellooo Stack. It provides a range of useful functionalities for Excel, File, HTTP, MongoDB, MySQL, Redis and other common tasks. As a developer, this library is a great tool for quickly and efficiently building Node.js applications, allowing you to handle common tasks without having to reinvent the wheel.

QuickStart

Installation

You can easily install the client library using the following command:

npm i @hellooo-stack/halo-commons

Features

You can find full examples in the 'doc/examples' directory. And here are some of the key features and example code for using this library:

Excel

The Excel module offers convenient methods for reading from and writing to Excel files, allowing you to perform these tasks with just one line of code

// todo
// Please read the sources now for more information, It's very easy to use. Or you can refer to [here](https://github.com/Alpha2J/script-tools/tree/master/nodejs) to learn more.

File

The File module supports file detection and provides read/write functionalities, as well as the ability to handle large files.

// todo
// Please read the sources now for more information, It's very easy to use. Or you can refer to [here](https://github.com/Alpha2J/script-tools/tree/master/nodejs) to learn more.

HTTP

The HTTP module supports the use of ES6 syntax for calling the HTTP module.

// todo
// Please read the sources now for more information, It's very easy to use. Or you can refer to [here](https://github.com/Alpha2J/script-tools/tree/master/nodejs) to learn more.

MySQL

The MySQL module supports the use of ES6 syntax for calling the MySQL module.

const {mysqlAsync, utils: {datetimeUtil}} = require('@hellooo-stack/halo-commons');
const mysql = require('mysql');

const mysqlConfig = {
    host: 'localhost',
    user: 'root',
    password: 'nopwd',
    database: 'example',
    connectionLimit: 10
};
(async () => {
    const pool = mysqlAsync.createPool(mysqlConfig);
    const connection = await pool.getConnectionAsync();
    
    const insertSQL = `insert into .... values ...`;
    await connection.queryAsync(insertSQL);

    // release connection
    connection.release();

    // end pool
    await pool.endPoolAsync();
})();

Redis

The Redis module supports the use of ES6 syntax for calling the MySQL module.

// todo
// Please read the sources now for more information, It's very easy to use. Or you can refer to [here](https://github.com/Alpha2J/script-tools/tree/master/nodejs) to learn more.

Contributing

We welcome contributions to the Halo-Commons-NodeJS library. Please refer to the Contributing Guide for more information.

License

This library is licensed under the Apache Version 2.0 license. Please see the LICENSE file for more information.