Function generateMethodDeclaration

utils/typescript.mjs:582–636

(method, options = {})

}

function generateMethodDeclaration(method, options = {}) {
  let output = '';
  const { globalFunction = false } = options;

  const indent = globalFunction ? '' : '  ';
  const commentIndent = globalFunction ? 0 : 2;

  if (method.description) {
    output += `${indent}/**\n`;
    output += formatJSDocComment(method.description, commentIndent) + '\n';

    // Add param docs from first overload
    if (method.overloads?.[0]?.params) {
      method.overloads[0].params.forEach(param => {
        if (param.description) {
          output += formatJSDocComment(`@param ${param.name} ${param.description}`, commentIndent) + '\n';
        }
      });
    }

    // Add return docs
    if (method.return?.description) {
      output += formatJSDocComment(`@returns ${method.return.description}`, commentIndent) + '\n';
    }

    output += `${indent} */\n`;
  }

  const staticPrefix = method.static ? 'static ' : '';
  const declarationPrefix = globalFunction ? 'function ' : `${indent}${staticPrefix}`;

  // Generate overload declarations
  if (method.overloads && method.overloads.length > 0) {
    method.overloads.forEach(overload => {
      const params = (overload.params || [])
        .map(param => generateParamDeclaration(param, options, overload.params))
        .join(', ');

      let returnType = 'void';
      if (overload.chainable && !globalFunction && options.currentClass !== 'p5') {
        returnType = options.currentClass || 'this';
        // TODO: Decide what should be chainable. Many of these are accidental / not thought through
      } else if (overload.return && overload.return.type) {
        returnType = convertTypeToTypeScript(overload.return.type, options);
      } else if (method.return && method.return.type) {
        returnType = convertTypeToTypeScript(method.return.type, options);
      }

      output += `${declarationPrefix}${method.name}(${params}): ${returnType};\n`;
    });
  }

  output += '\n';
  return output;
}

function generateClassDeclaration(classData) {
  let output = '';