/** @class ENUM SourceForge github geointapps gitlab

ENUM

ENUM provides a shallow and deep copy enumerator:

Copy(src,tar)  		// shallow copy src to tar 
Copy(src,tar,key)  // deep copy src to tar 

where, in a deep copy, src keys index the target thusly (with key = "."):

{
	A: value,			// sets target[A] = value

	"A.B.C": value, 	// sets target[A][B][C] = value

	"A.B.C.": {			// appends X,Y to target[A][B][C]
		X:value, Y:value, ...
	},	

	OBJECT: [ 			// prototype OBJECT (Array,String,Date,Object) = method X,Y, ...
		function X() {}, 
		function Y() {}, 
	... ],

	Function: 			// append method X to ENUM callback stack
		function X() {}
}

ENUM also provides a means to extend constructors:

[ prototype, ...].Extend( Array || String || Date || Object )

as well as list and object serializers:

Each(opts,cb) 		// enumerate and/or serialize list/object opts with callback cb( n, opts[n], xcb )

where the cb may elect to serialize itself by testing and calling back xcb as follows:

	if (xcb) 
		xcb( rec )  // where rec = null to bypass rec stacking

	else 
		// key is resulting rec stack when indexing of A has finished

ENUM provides a list:

function fetcher( rec, info => { 
});

[ rec, ...].serialize( fetcher, (rec, fails) => {
	if ( rec ) 
		// rec = record being serialized
	else
		// done. fails = number of failed fetches
}

and a string serializer:

function fetcher( rec, ex => {
	// regexp arguments rec.arg0, rec.arg1, rec.arg2, ...
	// rec.ID = record number being processed
	return "replaced string";
});

"string to search".serialize( fetcher, regex, "placeholder key", str => { 
	// str = final string with all replacements made
});

Installation

Clone ENUM basic enumerators into your PROJECT/enum folder.

Manage

npm run [ edit || start ]			# Configure environment
npm test [ ? || E1 || ...]					# Unit test
npm run [ prmprep || prmload ]		# Revise PRM

Usage

From some assembly:

var ENUM = require("enum");
	
const { Copy, Each } = ENUM;  	// extract these from enum

License

MIT

*/