Module: router/Utils

Source: router/Utils.js, line 1

Methods#

(static) getResourceId(uri, path) → {String|undefined}#

Return URI fragment, if Route is a resource.

Parameters:

Name	Type	Description
`uri`	String	Request URI.
`path`	String	Route path value.

Source: router/Utils.js, line 143

Returns:

Type:: String | undefined

Example

CODE

 const result = getResourceId('/api/test/abc123', '/api/test');
// abc123

(static) isAsyncFunc(func) → {Boolean}#

Check if value is an async function.

Parameters:

Name	Type	Description
`func`	AsyncFunction	Async function.

Source: router/Utils.js, line 29

Returns:

Type:: Boolean

Example

CODE

 const result = isAsyncFunc(async function() {}));
// true

(static) isObject(Object) → {Boolean}#

Check if value is an Object instance.

Parameters:

Name	Type	Description
`Object`	Object	to check.

Source: router/Utils.js, line 45

Returns:

Type:: Boolean

Example

CODE

 const result = Utils.isObject({foo: 'bar'});
// true

(static) isPromise(obj) → {Boolean}#

Check if object is (or returns) Promise.

Parameters:

Name	Type	Description
`obj`	Object	Promise object.

Source: router/Utils.js, line 66

Returns:

Type:: Boolean

Example

CODE

 const result = isPromise(new Promise(() => {}));
// true
 
const result = function() {
  return Promise.resolve();
};
// true

(static) isValidFunc(value) → {Boolean}#

Check if valid Route/Middleware function.

Parameters:

Name	Type	Description
`value`	function	Route function.

Source: router/Utils.js, line 98

Returns:

Type:: Boolean

Example

CODE

 const result = isValidFunc((req, res, next) => {});
// true

(static) isValidPath(value) → {Boolean}#

Check if valid URI path.

Parameters:

Name	Type	Description
`value`	String	URI path value.

Source: router/Utils.js, line 82

Returns:

Type:: Boolean

Example

CODE

 const result = isValidPath('/api/test');
// true

(static) isValidRoute(uri, path, func) → {Boolean}#

Check if valid Request/Route.

Parameters:

Name	Type	Description
`uri`	String	Request URI.
`path`	String	Route path value.
`func`	function	Route function.

Source: router/Utils.js, line 120

Returns:

Type:: Boolean

Example

CODE

 const result = isValidRoute('/api/test/123456', '/api/test', (req, res) => {}));
// true

(static) moduleParent() → {String}#

Get executed module parent directory.

Source: router/Utils.js, line 178

Returns:

Type:: String

Example

CODE

 const dir = moduleParent();
// path/to/app/parent/directory

(static) promiseEvents(promises) → {Promise}#

Execute events; propagate variable state.

Parameters:

Name	Type	Description
`promises`	Array	Array of promised events.

Source: router/Utils.js, line 210

Returns:

Type:: Promise

Example

CODE

 const state = {};
 
  const promises = [
    ()  => Promise.resolve(a),
    (b) => Promise.resolve(b),
    (c) => Promise.resolve(c),
 
    ..
  ];
 
  promiseEvents(promises)
    .then(obj => obj)
    .catch(function(err) {
 
    });

(static) setFuncName(func, value)#

Set name for a given function (inline).

Parameters:

Name	Type	Description
`func`	function	Route function.
`value`	function	Function name.

Source: router/Utils.js, line 165

Example

CODE

 const func = function() {};
setFuncName(func, 'test');
func.name
// test

	const result = getResourceId('/api/test/abc123', '/api/test');
	// abc123

	const result = isPromise(new Promise(() => {}));
	// true

	const result = function() {
	return Promise.resolve();
	};
	// true

	const result = isValidRoute('/api/test/123456', '/api/test', (req, res) => {}));
	// true

	const state = {};

	const promises = [
	() => Promise.resolve(a),
	(b) => Promise.resolve(b),
	(c) => Promise.resolve(c),

	..
	];

	promiseEvents(promises)
	.then(obj => obj)
	.catch(function(err) {

	});

	const func = function() {};
	setFuncName(func, 'test');
	func.name
	// test