@vuedoc/parser/esm/entity/MethodEntry.js

Generate a JSON documentation for a Vue file

import { AbstractCategorizeEntry } from './AbstractCategorizeEntry.js';
import { Type } from '../lib/Enum.js';
import { Value } from './Value.js';
const ARRAY_BRAKET = '[]';
export class MethodEntry extends AbstractCategorizeEntry {
    constructor(name, params) {
        super('method');
        this.name = name;
        this.params = params;
        this.syntax = [];
        this.returns = new MethodReturns();
    }
}
export class MethodParam {
    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() {
    while (true) {
        yield new MethodParam();
    }
}
export class MethodReturns {
    constructor(type = Type.void) {
        this.type = type instanceof Array ? type.map(Value.parseNativeType) : Value.parseNativeType(type);
        this.description = undefined;
    }
}
export const MethodParamGenerator = methodParamGenerator();
//# sourceMappingURL=MethodEntry.js.map