NPM module - izara-shared: Difference between revisions

From Izara Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 32: Line 32:
  */
  */
</syntaxhighlight>
</syntaxhighlight>
= projectGraphSharedLib =
Helper functions for Project Graph.
== projectGraphSharedLib.createVertexId ==
<syntaxhighlight lang="JavaScript">
/**
* Creates vertexId from vertexTag and unique id
* @param {string} vertexTag
* @param {string} uniqueId
*
* @returns {string} vertexId
*/
</syntaxhighlight>
=== logic ===
# return conatenate vertexTag + "_" + uniqueId

Revision as of 14:45, 16 February 2021

Overview

Shared libraries

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
 */

projectGraphSharedLib

Helper functions for Project Graph.

projectGraphSharedLib.createVertexId

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

logic

  1. return conatenate vertexTag + "_" + uniqueId