yoastseo-dep/src/languageProcessing/values/ProminentWord.js

Yoast clientside page analysis

/**
 * Represents a prominent word in the context of relevant words.
 *
 * @constructor
 *
 * @param {string} word             The word.
 * @param {string} [stem]           The stem / base form of the word, defaults to the word.
 * @param {number} [occurrences]    The number of occurrences, defaults to 0.
 */
function ProminentWord( word, stem, occurrences ) {
	this._word = word;
	this._stem = stem ? stem : word;
	this._occurrences = occurrences || 0;
}

/**
 * Sets the word.
 *
 * @param {string} word The word to set.
 *
 * @returns {void}.
 */
ProminentWord.prototype.setWord = function( word ) {
	this._word = word;
};

/**
 * Returns the word.
 *
 * @returns {string} The word.
 */
ProminentWord.prototype.getWord = function() {
	return this._word;
};

/**
 * Returns the stem of the word.
 *
 * @returns {string} The stem.
 */
ProminentWord.prototype.getStem = function() {
	return this._stem;
};

/**
 * Sets the number of occurrences to the word.
 *
 * @param {int} numberOfOccurrences The number of occurrences to set.
 *
 * @returns {void}.
 */
ProminentWord.prototype.setOccurrences = function( numberOfOccurrences ) {
	this._occurrences = numberOfOccurrences;
};

/**
 * Returns the amount of occurrences of this word.
 *
 * @returns {number} The number of occurrences.
 */
ProminentWord.prototype.getOccurrences = function() {
	return this._occurrences;
};

/**
 * Serializes the ProminentWord instance to an object.
 *
 * @returns {Object} The serialized ProminentWord.
 */
ProminentWord.prototype.serialize = function() {
	return {
		_parseClass: "ProminentWord",
		word: this._word,
		stem: this._stem,
		occurrences: this._occurrences,
	};
};

/**
 * Parses the object to a ProminentWord.
 *
 * @param {Object} serialized The serialized object.
 *
 * @returns {ProminentWord} The parsed ProminentWord.
 */
ProminentWord.parse = function( serialized ) {
	return new ProminentWord( serialized.word, serialized.stem, serialized.occurrences );
};

export default ProminentWord;