types.js

/**
 * @typedef {object} Block
 * @property {string} content
 * @property {boolean} isTarget
 */

/**
 * Creates a Block object.
 * @param {string} content
 * @param {boolean} isTarget
 * @returns {Block}
 */
function createBlock(content, isTarget) {
	return { content, isTarget };
}

/**
 * @typedef {object} Submatch
 * @property {number} start - The starting byte offset of the match.
 * @property {number} end - The ending byte offset of the match.
 */

/**
 * @typedef {object} ResultLine
 * @property {Block[]} line
 * @property {number} line_number
 * @property {Submatch[]} submatches
 */

/**
 * Creates a ResultLine object.
 * @param {Block[]} [line=[]]
 * @param {number} [line_number=0]
 * @param {Submatch[]} [submatches=[]]
 * @returns {ResultLine}
 */
function createResultLine(line = [], line_number = 0, submatches = []) {
	return { line, line_number, submatches };
}

/**
 * @typedef {object} FileResult
 * @property {string} path
 * @property {string} filename
 * @property {ResultLine[]} results
 */

/**
 * Creates a FileResult object.
 * @param {string} path
 * @param {string} filename
 * @param {ResultLine[]} [results=[]]
 * @returns {FileResult}
 */
function createFileResult(path, filename, results = []) {
	return { path, filename, results };
}

module.exports = {
	createBlock,
	createResultLine,
	createFileResult
};