docschema/dist/types/lib/constants.d.ts

Schema declaration and validation library using JsDoc comments

/**
 * List of From => To values
 *
 * IMPORTANT: For the keys, put keys like
 */
export type TAG_REPLACEMENTS = string;
/**
 * List of From => To values
 *
 * IMPORTANT: For the keys, put keys like @constructor
 * before @const, so the tag replacements works properly
 * after that.
 *
 * @see https://jsdoc.app/
 * @readonly
 * @enum {string}
 */
export const TAG_REPLACEMENTS: Readonly<{
    '@virtual': "@abstract";
    '@extends': "@augments";
    '@constructor': "@class";
    '@const': "@constant";
    '@defaultvalue': "@default";
    '@desc': "@description";
    '@host': "@external";
    '@fileoverview': "@file";
    '@overview': "@file";
    '@emits': "@fires";
    '@func': "@function";
    '@method': "@function";
    '@var': "@member";
    '@arg': "@param";
    '@argument': "@param";
    '@prop': "@property";
    '@return': "@returns";
    '@exception': "@throws";
    '@yield': "@yields";
    '@linkcode': "@link";
    '@linkplain': "@link";
}>;