Function buildParamDocs

utils/convert.mjs:169–215

(docs)

}

function buildParamDocs(docs) {
  let newClassItems = {};
  // the fields we need—note that `name` and `class` are needed at this step because it's used to group classitems together. They will be removed later in cleanUpClassItems.
  let allowed = new Set(['name', 'class', 'params', 'overloads', 'beta']);

  for (let classitem of docs.classitems) {
    // If `classitem` doesn't have overloads, then it's not a function—skip processing in this case
    if (classitem.name && classitem.class && classitem.hasOwnProperty('overloads')) {
      // Skip if the item already exists in newClassItems
      if (
        newClassItems[classitem.class] &&
        newClassItems[classitem.class][classitem.name]
      ) {
        continue;
      }

      // Clean up fields that will not be used in each classitem's overloads
      classitem.overloads?.forEach(overload => {
        delete overload.line;
        delete overload.return;
        overload.params.forEach(param => {
          delete param.description;
          delete param.name;
        });
      });

      Object.keys(classitem).forEach(key => {
        if (!allowed.has(key)) delete classitem[key];
      });

      newClassItems[classitem.class] = newClassItems[classitem.class] || {};
      newClassItems[classitem.class][classitem.name] = classitem;
    }
  }

  const cleanedClassItems = cleanUpClassItems(newClassItems);

  let out = fs.createWriteStream(
    path.join(__dirname, '../docs/parameterData.json'),
    {
      flags: 'w',
      mode: '0644'
    }
  );
  out.write(JSON.stringify(cleanedClassItems, null, 2));
  out.end();
}

fs.mkdirSync(path.join(__dirname, '../docs/reference'), { recursive: true });
fs.writeFileSync(path.join(__dirname, '../docs/reference/data.json'), JSON.stringify(converted, null, 2));