json-docs-generator/src/utils/buildTable.js

Util for describe REST APIs via docs.

const buildType = require('./buildType');

module.exports = (params) => {
  const rows = Object.entries(params).map(([parameter, meta]) => {
    const type = typeof meta === 'function' || Array.isArray(meta)
      ? buildType(meta)
      : buildType(meta.type);
    const required = meta && meta.required !== undefined
      ? meta.required
      : true;
    const description = meta && meta.description !== undefined
      ? meta.description
      : '-';

    return `| ${parameter} | ${type} | ${required ? 'yes' : 'no'} | ${description} |`;
  });

  return [
    '| Parameter | Type | Required | Description',
    '|:---------:|:----:|:--------:|:----------:|',
    ...rows,
  ].join('\n');
};