Function mainUsageBlock

scripts/docs.js:242–337

(primaryExample, allData)

}

async function mainUsageBlock(primaryExample, allData) {
  const { data, pkg } = primaryExample
  const platforms = getPlatforms(allData)
  const main = data.jsdoc.find((doc) => Boolean(doc.examples))

  const exampleFunctionName = main.name
  const exampleCode = main.examples[0]
  const code = `
import Analytics from 'analytics'
import ${exampleFunctionName} from '${pkg.name}'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    ${exampleCode}
  ]
})

${renderRelevantMethods(data)}
`

  const providerName = cleanName(pkg.projectMeta.provider.name)
  const ABOUT_METHODS = aboutMethods(providerName)

  const API_METHODS = ['page', 'track', 'identify', 'reset']

  const infos = await Promise.all(allData.map((d) => {
    return getUsageExamples(d, data)
  }))

  // console.log('infos', infos)
  /* Get additional Usage examples */
  const additionalExamples = infos.flat()
    .sort(sortUsageExamples)
    .map((ex) => ex.text)
    .join('\n')

  let exposedFuncs
  const apiDocs = allData.map((y) => {
    const name = getPlatformName(y)
    exposedFuncs = getExposedFunctions(y.data)
    const exp = exposedFuncs
    const niceName = (name === 'node.js') ? `server-side` : name
    const jsDoc = renderJsDocs(y.data, y, niceName)
    const niceText = (name === 'node.js') ? `${niceName} ${name}` : `client side ${niceName}`
    const capsName = capitalizeFirstLetter(niceName)
    const apiMethodsExposed = exp
      .filter((x) => API_METHODS.includes(x))
      .map((x) => {
        const link = SRC_LINKS[x]
        const linkText = (link) ? `[analytics.${x}](${link})` : x
        return `- **${linkText}** - ${ABOUT_METHODS[x]}`
      }).join('\n')
    // console.log('apiMethodsExposed', apiMethodsExposed)
    let renderMethods = 'See below from browser API'
    if (apiMethodsExposed) {
      renderMethods = `The ${providerName} ${niceText} plugin works with these analytic api methods: