NPM module - izara-shared: Difference between revisions

From Izara Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 34: Line 34:
  *
  *
  * @returns {Object} returns the configValue for a single config record, or null if none found
  * @returns {Object} returns the configValue for a single config record, or null if none found
*/
</syntaxhighlight>
= neptuneSharedLib =
Helper functions for interacting with Neptune graph databases.
== neptuneSharedLib.createVertexId ==
<syntaxhighlight lang="JavaScript">
/**
* Creates vertexId from vertexTag and unique id
* @param {string} vertexTag
* @param {string} uniqueId
*
* @returns {string} vertexId
  */
  */
</syntaxhighlight>
</syntaxhighlight>

Revision as of 02:45, 1 March 2021

Overview

Shared libraries

Repository

https://bitbucket.org/stb_working/izara-shared/src/master/

dynamodbSharedLib

Helper functions for interacting with DynamoDB resources.

dynamodbSharedLib.createStringSet

/**
 * Creates a string set element for use with documentClient
 * @param {string[]} stringSet
 *
 * @returns {string} String formatted as a string set for Dynamo
 */

configSharedLib

Helper functions for Config tables.

configSharedLib.getConfigValue

/**
 * @param {string} configTag
 * @param {string} configKey
 *
 * @returns {Object} returns the configValue for a single config record, or null if none found
 */

neptuneSharedLib

Helper functions for interacting with Neptune graph databases.

neptuneSharedLib.createVertexId

/**
 * Creates vertexId from vertexTag and unique id
 * @param {string} vertexTag
 * @param {string} uniqueId
 *
 * @returns {string} vertexId
 */