CyberChef/src/core/operations/Ngram.mjs

/**
 * @author benjcal [benj.calderon@gmail.com]
 * @copyright Crown Copyright 2024
 * @license Apache-2.0
 */

import Operation from "../Operation.mjs";

/**
 * ngram operation
 */
class Ngram extends Operation {

    /**
     * Ngram constructor
     */
    constructor() {
        super();

        this.name = "Ngram";
        this.module = "Default";
        this.description = "Extracts n-grams from the input text. N-grams are contiguous sequences of n characters from a given text sample.";
        this.infoURL = "https://wikipedia.org/wiki/N-gram";
        this.inputType = "string";
        this.outputType = "string";
        this.args = [
            {
                name: "N-gram size",
                type: "number",
                value: 3
            },
        ];
    }

    /**
     * @param {string} input
     * @param {Object[]} args
     * @returns {string}
     */
    run(input, args) {
        const n = args[0];
        const ngrams = [];
        for (let i = 0; i <= input.length - n; i++) {
            ngrams.push(input.slice(i, i + n));
        }

        return ngrams.join("\n");
    }

}

export default Ngram;