Difference between revisions of "My Node.js notes"

Latest revision as of 10:12, 16 December 2021

Node.js install

Go to https://nodejs.org and follow instructions for the Node.js version you want or install via Node Version Manager (NVM).

There are multiple ways to install NVM. I used NVM BASH script and instructions located here for Ubuntu 20.

Node Version Manager (NVM)

My Node Version Manager (NVM) notes

Node.js Package Manager (npm)

npm

Initialize an npm project. Within project directory use npm init command. The default command launches a questionnaire. To answer default on all questions use -y argument.

Uninstall global module

npm uninstall -g nodemon

Install local module

npm install nodemon

Install as dev dependency (not installed on production environment)

npm install nodemon --save-dev

Basic stuff

debugger statement and node inspect

Windows users may need to use node --inspect-brk

chrome:://inspect

Exit Chrome DevTool debugger.

Type restart at console after exiting Chrome DevTool to restart app with same arguments.

Press CTRL+C twice to exit debugger in console.

nodemon

If nodemon installed globally

nodemon <app.name> -e <comma separated list of extensions to monitor>

If nodemon installed locally a script can launch. See scripts key section for details.

package.json info

scripts key

create key value pair where key is name of script and value is script location

Example:

"scripts": {
    "dev": "nodemon src/app.js -e js,hbs"
  }

At node prompt type npm run dev to execute script nodemon src/app.js -e js,hbs

NPM modules

CORS is a node.js package for providing a Connect/Express middleware that can be used to enable CORS with various options.

The official MongoDB driver for Node.js. Provides a high-level API on top of mongodb-core that is meant for end users.

Mongoose provides a straight-forward, schema-based solution to model your application data. It includes built-in type casting, validation, query building, business logic hooks and more, out of the box.

validator is a library of string validators and sanitizers.

bcryptjs is optimized bcrypt in JavaScript with zero dependencies. Compatible to the C++ bcrypt binding on node.js and also works in browser.

jsonwebtokens is an implementation of JSON Web Tokens.

Multer is a node.js middleware for handling multipart/form-data, which is primarily used for uploading files. It is written on top of busboy for maximum efficiency.

busboy is a node.js module for parsing incoming HTML form data.

sharp is a high speed node.js module that convert large images in common formats to smaller, web-friendly JPEG, PNG and WebP images of varying dimensions.

env-cmd is a simple node program for executing commands using an environment from an env file.

jest is a delightful JavaScript testing library

mocha is a simple, flexible, fun JavaScript test framework for Node.js & the browser

HTTP assertions made easy via superagent. The motivation with supertest is to provide a high-level abstraction for testing HTTP, while still allowing you to drop down to the lower-level API provided by superagent.

Socket.IO enables real-time bidirectional event-based communication. Socket.IO home

bad-words is a javascript filter for badwords.

moment is a lightweight JavaScript date library for parsing, validating, manipulating, and formatting dates.

Resources

Node.js home

regex 101

To software notes

@@ Line 1: / Line 1: @@
+== Node.js install ==
+Go to [https://nodejs.org https://nodejs.org] and follow instructions for the Node.js version you want or install via Node Version Manager (NVM).
+There are multiple ways to install NVM. I used NVM BASH script and instructions located
+[https://github.com/nvm-sh/nvm#installing-and-updating here] for Ubuntu 20.
+== Node Version Manager (NVM) ==
+[[My Node Version Manager (NVM) notes]]
 == Node.js Package Manager (npm)==
@@ Line 5: / Line 16: @@
 Initialize an npm project. Within project directory use <code>npm init</code> command. The default command launches a questionnaire. To answer default on all questions use -y argument.
+Uninstall global module
+<pre>npm uninstall -g nodemon</pre>
+Install local module
+<pre>npm install nodemon</pre>
+Install as dev dependency (not installed on production environment)
+<pre>npm install nodemon --save-dev</pre>
 == Basic stuff ==
 debugger statement and <code>node inspect</code>
+Windows users may need to use <code>node --inspect-brk</code>
 <pre>chrome:://inspect</pre>
@@ Line 20: / Line 44: @@
 == [https://www.npmjs.com/package/nodemon nodemon] ==
-nodemon <app.name> -e <comma separated list of extensions to monitor>
+If nodemon installed globally
+<pre>nodemon <app.name> -e <comma separated list of extensions to monitor></pre>
+If nodemon installed locally a script can launch. See [[#scripts key|scripts key]] section for details.
+== package.json info ==
+=== scripts key ===
+create key value pair where key is name of script and value is script location
+Example:
+<pre>"scripts": {
+    "dev": "nodemon src/app.js -e js,hbs"
+  }</pre>
-<code>nodemon src/app.js -e js,hbs
+At node prompt type <code>npm run dev</code> to execute script <code>nodemon src/app.js -e js,hbs</code>
 == NPM modules ==
+[https://www.npmjs.com/package/cors CORS] is a node.js package for providing a Connect/Express middleware that can be used to enable [https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS CORS] with various options.
-[https://www.npmjs.com/package/cors CORS] is a node.js package for providing a Connect/Express middleware that can be used to enable [https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS CORS] with various options.
+The official [https://www.npmjs.com/package/mongodb MongoDB driver for Node.js]. Provides a high-level API on top of mongodb-core that is meant for end users.
+[https://mongoosejs.com/ Mongoose] provides a straight-forward, schema-based solution to model your application data. It includes built-in type casting, validation, query building, business logic hooks and more, out of the box.
+[https://www.npmjs.com/package/validator validator] is a library of string validators and sanitizers.
+[https://www.npmjs.com/package/bcryptjs bcryptjs] is optimized bcrypt in JavaScript with zero dependencies. Compatible to the C++ bcrypt binding on node.js and also works in browser.
+[https://www.npmjs.com/package/jsonwebtoken jsonwebtokens] is an implementation of [https://tools.ietf.org/html/rfc7519 JSON Web Tokens].
+[https://www.npmjs.com/package/multer Multer] is a node.js middleware for handling multipart/form-data, which is primarily used for uploading files. It is written on top of busboy for maximum efficiency.
+[https://www.npmjs.com/package/busboy busboy] is a node.js module for parsing incoming HTML form data.
+[https://www.npmjs.com/package/sharp sharp] is a high speed node.js module that convert large images in common formats to smaller, web-friendly JPEG, PNG and WebP images of varying dimensions.
+[https://www.npmjs.com/package/env-cmd env-cmd] is a simple node program for executing commands using an environment from an env file.
+[https://www.npmjs.com/package/jest jest] is a delightful JavaScript testing library
+[https://www.npmjs.com/package/mocha mocha] is a simple, flexible, fun JavaScript test framework for Node.js & the browser
+HTTP assertions made easy via superagent. The motivation with [https://www.npmjs.com/package/supertest supertest] is to provide a high-level abstraction for testing HTTP, while still allowing you to drop down to the lower-level API provided by superagent.
+[https://www.npmjs.com/package/socket.io Socket.IO] enables real-time bidirectional event-based communication. [https://socket.io/ Socket.IO] home
+[https://www.npmjs.com/package/bad-words bad-words] is a javascript filter for badwords.
+[https://www.npmjs.com/package/moment moment] is a lightweight JavaScript date library for parsing, validating, manipulating, and formatting dates.
 == Resources ==
 [https://nodejs.org/en/ Node.js] home
+[https://regex101.com/ regex 101]
 <center>[[Software|To software notes]]</center>