/nodejs-addons

💪 This repository contains C++ Addons Examples for NodeJS. The main idea is to document with examples and tips on how to create plugins with C ++ for NodeJS

Primary LanguagePythonMIT LicenseMIT



Node.js C++ Addons

💪 This repository contains C++ Addons Examples for NodeJS.



🔖 Description

The main idea is to document with examples and tips on how to create plugins with C ++ for Node.js. C and C ++ were my first programming languages, I learned the basics with them and I am very fond of them (although I am rusty 😆).

🌍 Websites of Interest

📌 Methodologies and Guidelines

Quality Assurance Code (QAC)

✅ Prerequisites

In order to work with this project, your local environment must have at least the following versions:

  • NodeJS Version: 14.xx
  • NPM Version: 6.14.7

📐 How to work with this project

Install Dependencies

$npm i

Running the App

$node ./src/'folder'/'file.js'

📦 How to prepare and build a C++ Addons

Install Dependencies

$npm i -g node-gyp

Generate the appropriate project build files.

$node-gyp configure

Build the addon project.

$node-gyp build

📂 Code scaffolding

/
├── assets 🌈                     # Images Sources.
├── env 🔌                        # Configure enviroments deploy.
├── src 💯
|   ├── hello-world
|   |   ├── example01             # Show Hello word message.
|   |   └── example02             # Add colors and reset default color.
|   |
|   ├── data-types
|   |   ├── example01             # Working with int, float and double.
|   |   ├── example02             # Working with char and char array.
|   |   ├── example03             # Working with string.
|   |   └── example04             # Working with bool.
|   |
|   ├── arrays
|   |   ├── example01             # Create array with int values and show by index.
|   |   ├── example02             # Read the number of bytes that an array with int occupies.
|   |   ├── example03             # Create array with strings values and show by index.
|   |   ├── example04             # Read the number of bytes that an array with strings occupies.
|   |   ├── example05             # Execute other function and return array strings.
|   |   ├── example06             # Execute other function with internal bucle for and return array strings.
|   |   └── example07             # Execute other function with internal bucle for and show the array size.
|   |
|   ├── operators
|   |   ├── example01             # Sum, sub, multi and div with two int.
|   |   ├── example02             # Increment and decrement with two int.
|   |   └── example03             # Working with div and precision with decimals.
|   |
|   ├── conditionals
|   |   ├── example01             # Use if and else conditionals.
|   |   └── example02             # Working with switch conditionals.
|   |
|   ├── bucles
|   |   ├── example01             # Working with bucle while.
|   |   ├── example02             # Working with bucle for.
|   |   ├── example03             # Working with bucle do while.
|   |   └── example04             # Working with nested loops.
|   |
|   ├── methods
|   |   ├── example01             # Define two public method into the addons.
|   |   └── example02             # Define two public method and one internal.
|   |
|   ├── params
|   |   └── example01             # Get if param is number, string and the length.
|   |
|   ├── returns
|   |   ├── example01             # Return from addon to js the number of params.
|   |   └── example02             # Return from addon to js the value of the param.
|   └── ...
└── ...

⛽️ Review and Update Dependences

For review and update all npm dependences of this project you need install in global npm package "npm-check-updates" npm module.

# Install and Run
$npm i -g npm-check-updates
$ncu

Happy Code

Created with JavaScript, lot of ❤️ and a few ☕️

This README.md file has been written keeping in mind