Skip to content
Snippets Groups Projects
Commit 25e1de28 authored by Glenn Vorhes's avatar Glenn Vorhes
Browse files

add example usage

parent d483f8b8
No related branches found
No related tags found
No related merge requests found
......@@ -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]});
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment