tablature/compile/index.js

Display Tabular Data.

const __tablature = require('./tablature')

/**
 * Display values in a table.
 * @param {!_tablature.Config} conf Options for the program.
 * @param {!Array<string>} conf.keys Keys to print as columns.
 * @param {!Array<!Object<string, string>>} conf.data The array of data items to prints as rows.
 * @param {!Object<string, string>} [conf.headings] The display names for each column.
 * @param {!Object<string, _tablature.Replacement>} [conf.replacements] The map of replacement functions which will run against data items.
 * @param {!Array<string>} [conf.centerValues] Centre values of these column (use original keys, not headings).
 * @param {!Array<string>} [conf.centerHeadings] Center headings of these column (use original keys, not headings).
 */
function tablature(conf) {
  return __tablature(conf)
}
module.exports = tablature


/* typal types/index.xml closure noSuppress */
/**
 * @typedef {_tablature.Replacement} Replacement The function to use to replace values for display.
 */
/**
 * @typedef {function(string): { value: string, length: number }} _tablature.Replacement The function to use to replace values for display.
 */
/**
 * @typedef {_tablature.Config} Config `＠record` Options for the program.
 */
/**
 * @typedef {Object} _tablature.Config `＠record` Options for the program.
 * @prop {!Array<string>} keys Keys to print as columns.
 * @prop {!Array<!Object<string, string>>} data The array of data items to prints as rows.
 * @prop {!Object<string, string>} [headings] The display names for each column.
 * @prop {!Object<string, _tablature.Replacement>} [replacements] The map of replacement functions which will run against data items.
 * @prop {!Array<string>} [centerValues] Centre values of these column (use original keys, not headings).
 * @prop {!Array<string>} [centerHeadings] Center headings of these column (use original keys, not headings).
 */