https://github.com/hellooo-stack/halo-commons-nodejs
commons-nodejs is the common nodejs lib of Hellooo Stack.
https://github.com/hellooo-stack/halo-commons-nodejs
common es6 excel file javascript nodejs
Last synced: about 1 month ago
JSON representation
commons-nodejs is the common nodejs lib of Hellooo Stack.
- Host: GitHub
- URL: https://github.com/hellooo-stack/halo-commons-nodejs
- Owner: hellooo-stack
- License: apache-2.0
- Created: 2022-11-20T06:05:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-21T12:24:43.000Z (over 2 years ago)
- Last Synced: 2024-10-30T08:06:03.501Z (over 1 year ago)
- Topics: common, es6, excel, file, javascript, nodejs
- Language: JavaScript
- Homepage:
- Size: 1.67 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Halo-Commons-NodeJS
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:
```shell
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
```javascript
// 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.
```javascript
// 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.
```javascript
// 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.
```javascript
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.
```javascript
// 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](CONTRIBUTING.md) for more information.
# License
This library is licensed under the Apache Version 2.0 license.
Please see the [LICENSE](LICENSE) file for more information.