From 25e1de281c13302395625323a758cafd065e2164 Mon Sep 17 00:00:00 2001
From: Glenn Vorhes <gavorhes@wisc.edu>
Date: Wed, 15 Mar 2017 02:45:14 -0500
Subject: [PATCH] add example usage
---
src/util/objectHelpers.ts | 14 ++++++--------
1 file changed, 6 insertions(+), 8 deletions(-)
diff --git a/src/util/objectHelpers.ts b/src/util/objectHelpers.ts
index 8272b8b..163ae30 100644
--- a/src/util/objectHelpers.ts
+++ b/src/util/objectHelpers.ts
@@ -5,11 +5,6 @@
import provide from './provide';
let nm = provide('util');
-/**
- * @typedef {object} keyValuePair
- * @property {string} key
- * @property {object} value
- */
export interface keyVals {
key: string;
@@ -17,13 +12,16 @@ export interface keyVals {
}
+
+
/**
* iterate over the key value pairs of an object
+ * @example for (let x:KeyValuePair of keyValPairs(object)){..}
* @param {object} obj - the input object
- * @returns {Array<keyValuePair>} - array of key value pairs
+ * @returns {Array<keyVals>} - array of key value pairs
*/
-export function keyValPairs(obj): keyVals[] {
- let outArray = [];
+export function keyValPairs(obj): Array<keyVals> {
+ let outArray: Array<keyVals> = [];
for (let key of Object.keys(obj)) {
outArray.push({'key': key, 'value': obj[key]});
--
GitLab