MCPcopy Create free account
hub / github.com/DavidWells/analytics / jsDocFormatArguments

Function jsDocFormatArguments

scripts/docs.js:422–441  ·  view source on GitHub ↗
(params, platform)

Source from the content-addressed store, hash-verified

420}
421
422function jsDocFormatArguments(params, platform) {
423 if (!params) return ''
424 const theArgs = params.filter((param) => {
425 return param.name !== 'pluginConfig'
426 }).map((param) => {
427 return jsDocRenderArg(param)
428 })
429 // console.log('theArgs', theArgs)
430 if (theArgs.length) {
431 return `
432
433### Configuration options for ${platform}
434
435| Option | description |
436|:---------------------------|:-----------|
437${theArgs.join('\n')}
438`
439 }
440 return ''
441}
442
443function jsDocRenderArg(param) {
444 const optionalText = (param.optional) ? '_optional_ - ' : '**required** - '

Callers 1

renderJsDocsFunction · 0.85

Calls 1

jsDocRenderArgFunction · 0.85

Tested by

no test coverage detected