Syntax - Backend services - Revision history

Sven the Barbarian: /* Misc */

2026-07-22T06:16:05Z

Misc

@@ Line 171: / Line 171: @@
 });
 await Promise.all(promises);
 </syntaxhighlight>

Sven the Barbarian: /* Functions */

2026-07-22T06:11:01Z

Functions

← Older revision		Revision as of 06:11, 22 July 2026
Line 72:		Line 72:

	* In most cases use named functions		* In most cases use named functions
			* Locally scoped functions (not exported from a library file) start with underscore, eg: _thisIsALocalFunction()

	== Naming Conventions ==		== Naming Conventions ==

Sven the Barbarian: /* Constants */

2025-10-10T01:45:30Z

Constants

← Older revision		Revision as of 01:45, 10 October 2025
Line 93:		Line 93:
	* all UPPERCASE		* all UPPERCASE
	* use underscores to separate words		* use underscores to separate words
			* temporary CONST use lowerCaseCamel, eg in loops

	=== Common abbreviations ===		=== Common abbreviations ===

Sven the Barbarian at 22:24, 7 October 2025

2025-10-07T22:24:47Z

← Older revision		Revision as of 22:24, 7 October 2025
Line 116:		Line 116:

	* all code should add the <syntaxhighlight lang="JavaScript" inline>'use strict';</syntaxhighlight> expression at the top of code (under license but before requires)		* all code should add the <syntaxhighlight lang="JavaScript" inline>'use strict';</syntaxhighlight> expression at the top of code (under license but before requires)

			=== Conditionals ===

			* Do not use ternary conditional operator: <syntaxhighlight lang="JavaScript" inline>.. ? .. : .. ;</syntaxhighlight>
			* incorrect: <syntaxhighlight lang="JavaScript" inline>foo = bar > 0 ? true : false;</syntaxhighlight>
			* correct: <syntaxhighlight lang="JavaScript" inline>if(bar > 0){foo = true} else {foo = false}</syntaxhighlight>

			* Do not pass return value of conditional directly into variable
			* incorrect: <syntaxhighlight lang="JavaScript" inline>foo = bar > 0;</syntaxhighlight>
			* correct: <syntaxhighlight lang="JavaScript" inline>if(bar > 0){foo = true} else {foo = false}</syntaxhighlight>

	=== Iterating arrays and objects ===		=== Iterating arrays and objects ===

Sven the Barbarian: /* Project File System Syntax */

2022-11-08T14:46:15Z

Project File System Syntax

← Older revision		Revision as of 14:46, 8 November 2022
Line 221:		Line 221:
	== Directories ==		== Directories ==

	* lowercase for standard dirs (src, app, __test__/unit/src)		* lowercase for standard dirs (src, app, __test__/unit/src, src/libs)
	* UpperCamelCase for Service specific dirs		* UpperCamelCase for Service specific dirs
			* shared functions go into libs folder, each lib file us UpperCaseCamel and ends in ..Lib so clearly identified, when requiring the variable name matches the file name but lowerCaseCamel

	== Filenames ==		== Filenames ==

Sven the Barbarian at 01:34, 18 September 2021

2021-09-18T01:34:30Z

← Older revision		Revision as of 01:34, 18 September 2021
Line 236:		Line 236:
	* Our standard is to check for that error in middleware eg handleInvokeSync function:		* Our standard is to check for that error in middleware eg handleInvokeSync function:
	/mnt/WebsiteData/httpdocs/00_shop/IzaraCoreServices/izara-middleware/src/middleware_service_requests/lambda.js		/mnt/WebsiteData/httpdocs/00_shop/IzaraCoreServices/izara-middleware/src/middleware_service_requests/lambda.js

			= Neo4j graphs =

			== Node Labels ==

			* lowerCaseCamel

			== Relationship Types ==

			* lowerCaseCamel
			* if we are building a relationship type that connects with a node label, eg "has_product", use an underscore between the relationship prefix and the node label

			== Node and Relationship properties ==

			* lowerCaseCamel

Sven the Barbarian: /* Constants */

2021-08-20T02:27:06Z

Constants

← Older revision		Revision as of 02:27, 20 August 2021
Line 92:		Line 92:

	* all UPPERCASE		* all UPPERCASE
			* use underscores to separate words

	=== Common abbreviations ===		=== Common abbreviations ===

Sven the Barbarian: /* Misc */

2021-01-11T12:03:45Z

Misc

← Older revision		Revision as of 12:03, 11 January 2021
Line 115:		Line 115:

	* all code should add the <syntaxhighlight lang="JavaScript" inline>'use strict';</syntaxhighlight> expression at the top of code (under license but before requires)		* all code should add the <syntaxhighlight lang="JavaScript" inline>'use strict';</syntaxhighlight> expression at the top of code (under license but before requires)

			=== Iterating arrays and objects ===

			* Standard methods to iterate arrays and objects:

			==== Array, values only ====

			* use <syntaxhighlight lang="JavaScript" inline>for (const value of array) {</syntaxhighlight>
			* use ''const'' so inside the loop cannot change the value
			* use <syntaxhighlight lang="JavaScript" inline>Array.isArray(array)</syntaxhighlight> to check if a variable is an array
			* use ''map'' method when applicable, map returns an array of promises so works well with async-await (use await Promise.all if needed)
			* avoid array.forEach: async-await code does not work as expected: [[https://gist.github.com/joeytwiddle/37d2085425c049629b80956d3c618971]]
			* avoid array.forEach: cannot break/continue

			==== Object, values only ====

			* use <syntaxhighlight lang="JavaScript" inline>for .. in ..</syntaxhighlight> (will iterate inherited keys)
			* or use <syntaxhighlight lang="JavaScript" inline>for (const value of Object.values(obj)) { }</syntaxhighlight> (only iterates this objects keys)
			* for .. in iterates ''enumerable'' properties of an object.

			==== Array, keys and values ====

			* use <syntaxhighlight lang="JavaScript" inline>for(let key = 0; key < array.length; key++){ .. array[key] .. }</syntaxhighlight>

			==== Objects, keys and values ====

			* use <syntaxhighlight lang="JavaScript" inline>for (const [key, value] of Object.entries(obj)) { }</syntaxhighlight>
			* for map use (?maybe not async) <syntaxhighlight lang="JavaScript" inline>const array = Object.entries(object).map(([key, value]) => { .. });</syntaxhighlight>

			==== async: in serial ====

			<syntaxhighlight lang="JavaScript">
			for (const value of object) {
			await asyncFunction(value);
			}
			</syntaxhighlight>

			==== async: in parallel ====

			<syntaxhighlight lang="JavaScript">
			let promises = array.map(async (value) => {
			await asyncFunction(value);
			});
			await Promise.all(promises);
			</syntaxhighlight>

	== Documenting code ==		== Documenting code ==

Sven the Barbarian: /* Variables, properties, function names */

2021-01-06T13:31:47Z

Variables, properties, function names

← Older revision		Revision as of 13:31, 6 January 2021
Line 83:		Line 83:
	* if array add “s” on the end		* if array add “s” on the end
	* no underscore/dashes, only A-Z/a-z		* no underscore/dashes, only A-Z/a-z
			* library functions we will often group into modules resembling entities in our design and the module will be named accordingly, when requiring these modules name the variables libXxxxx so that we do not clash with instances of those entities

	=== Class and module names ===		=== Class and module names ===

Sven the Barbarian: /* Naming Conventions */

2020-11-10T02:43:41Z

Naming Conventions

← Older revision		Revision as of 02:43, 10 November 2020
Line 91:		Line 91:

	* all UPPERCASE		* all UPPERCASE

			=== Common abbreviations ===

			* ''Hdr'' = Handler
			* ''Msg'' = Message
			* ''Rcv'' = Receive
			* ''Snd'' = Send

	== Misc ==		== Misc ==