solidoc2/builders/event-builder.js

Solidity Documentation Generator 2

const i18n = require('../i18n')

const build = (nodes) => {
  if (!nodes || !nodes.length) {
    return ''
  }

  const builder = []

  builder.push(`**${i18n.translate('Events')}**`)
  builder.push('\n')
  builder.push('\n')
  builder.push('```js')
  builder.push('\n')

  for (const i in nodes) {
    const node = nodes[i]
    const parameterList = []

    for (const i in node.parameters.parameters) {
      const parameter = node.parameters.parameters[i]
      const argumentName = parameter.name
      const dataType = parameter.typeDescriptions.typeString.replace('contract ', '')
      const indexed = parameter.indexed || false

      parameterList.push(`${dataType} ${indexed ? 'indexed' : ''} ${argumentName}`.trim())
    }

    builder.push(`event ${node.name}(${parameterList.join(', ')});`)
    builder.push('\n')
  }

  builder.push('```')
  builder.push('\n')
  builder.push('\n')

  return builder.join('')
}

module.exports = { build }