gateway-addon/src/utils.ts

Bindings for WebThings Gateway add-ons

/**
 *
 * utils - Some utility export functions
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.*
 */

export function repeatChar(char: string, len: number): string {
  if (len <= 0) {
    return '';
  }
  return new Array(len + 1).join(char);
}

export function padLeft(str: string, len: number): string {
  return (repeatChar(' ', len) + str).slice(-len);
}

export function padRight(str: string, len: number): string {
  return (str + repeatChar(' ', len)).slice(0, len);
}

export function hexStr(num: number, len: number): string {
  return (repeatChar('0', len) + num.toString(16)).slice(-len);
}

export function alignCenter(str: string, len: number): string {
  if (str.length >= len) {
    return str.slice(0, len);
  }
  const leftSpace = (len - str.length) / 2;
  return padRight(padLeft(str, str.length + leftSpace), len);
}

/**
 * Prints formatted columns of lines. Lines is an array of lines.
 * Each line can be a single character, in which case a separator line
 * using that character is printed. Otherwise a line is expected to be an
 * array of fields.
 * The alignment argument is expected to be a string, one character per
 * column. '<' = left, '>' = right, '=' = center). If no alignment
 * character is found, then left alignment is assumed.
 */
export function printTable(alignment: string, lines: string[][]): void {
  const width: number[] = [];
  let colWidth;
  let idx;

  // Take a pass through the data and figure out the width for each column.
  for (const line of lines) {
    if (typeof line !== 'string') {
      for (idx in line) {
        colWidth = line[idx].length;
        if (typeof width[idx] === 'undefined' || colWidth > width[idx]) {
          width[idx] = colWidth;
        }
      }
    }
  }

  // Now that we know how wide each column is, go and print them.
  for (const line of lines) {
    let lineStr = '';
    for (const idx in width) {
      if (parseInt(idx) > 0) {
        lineStr += ' ';
      }
      colWidth = width[idx];
      if (typeof line === 'string') {
        lineStr += repeatChar(line[0], colWidth);
      } else {
        const align = alignment[idx];
        let field = line[idx];
        if (typeof field === 'undefined') {
          field = '';
        }
        if (align === '>') {
          lineStr += padLeft(field, colWidth);
        } else if (align === '=') {
          lineStr += alignCenter(field, colWidth);
        } else {
          lineStr += padRight(field, colWidth);
        }
      }
    }
    console.log(lineStr);
  }
}

/**
 * Get the current time.
 *
 * @returns {String} The current time in the form YYYY-mm-ddTHH:MM:SS+00:00
 */
export function timestamp(): string {
  const date = new Date().toISOString();
  return date.replace(/\.\d{3}Z/, '+00:00');
}