@readonly

Оглавление

• Обзор
• Примеры

Обзор

Тег @readonly указывает, что символ предназначен для чтения только. Обратите внимание, что это только для целей документации — JSDoc не будет проверять, действительно ли вы использовали символ как только для чтения в вашем коде.

Примеры

/**
 * A constant.
 * @readonly
 * @const {number}
 */
const FOO = 1;

/**
 * Options for ordering a delicious slice of pie.
 * @namespace
 */
var pieOptions = {
    /**
     * Plain.
     */
    plain: 'pie',
    /**
     * A la mode.
     * @readonly
     */
    get aLaMode() {
        return this.plain + ' with ice cream';
    }
};