@vuedoc/parser/src/entity/MethodEntry.ts

Generate a JSON documentation for a Vue file

import { AbstractCategorizeEntry } from './AbstractCategorizeEntry.js';
import { Type } from '../lib/Enum.js';
import { Value } from './Value.js';
import { Entry } from '../../types/Entry.js';
import { Parser } from '../../types/Parser.js';

const ARRAY_BRAKET = '[]';

export class MethodEntry extends AbstractCategorizeEntry<'method'> implements Entry.MethodEntry {
  name: string;
  params: MethodParam[];
  syntax: string[];
  returns: MethodReturns;

  constructor(name: string, params: MethodParam[]) {
    super('method');

    this.name = name;
    this.params = params;
    this.syntax = [];
    this.returns = new MethodReturns();
  }
}

export class MethodParam implements Entry.Param {
  name: string;
  type: string | string[];
  description?: string;
  defaultValue?: string;
  rest: boolean;
  optional: boolean;

  constructor() {
    this.name = '';
    this.type = Type.unknown;
    this.rest = false;
  }

  static parse(param) {
    if (param.rest && !param.type.endsWith(ARRAY_BRAKET) && param.type[0] !== ARRAY_BRAKET[0]) {
      param.type += ARRAY_BRAKET;
    }
  }

  static toString(param) {
    let name = param.name;
    let type = param.type;

    if (param.optional) {
      name += '?';
    }

    if (param.type instanceof Array) {
      type = type.join(' | ');
    }

    if (param.rest) {
      return `...${param.name}: ${type}`;
    }

    return param.defaultValue
      ? `${name}: ${type} = ${param.defaultValue}`
      : `${name}: ${type}`;
  }
}

export function* methodParamGenerator(): Generator<MethodParam, MethodParam> {
  while (true) {
    yield new MethodParam();
  }
}

export class MethodReturns {
  type: string | string[];
  description: undefined;

  constructor(type: Parser.Type | Parser.Type[] = Type.void) {
    this.type = type instanceof Array ? type.map(Value.parseNativeType) : Value.parseNativeType(type);
    this.description = undefined;
  }
}

export const MethodParamGenerator = methodParamGenerator();