<commit_before>'use strict';
/**
 * SockEvents for SockBot2.0
 * @module events
 * @author Accalia
 * @license MIT
 */

/**
 * SockEvents object
 *
 * All methods from core EventEmitter are preserved, refer to the [core api](https://nodejs.org/api/events.html)
 * for details.
 *
 * @typedef {object}
 * @name SockEvents
 * @augments {EventEmitter}
 */
exports.SockEvents = {
    /**
     * Parsed Command Data
     *
     * @name command
     * @typedef {object}
     * @param {string} input Raw Command Input
     * @param {string} command Command name
     * @param {string[]} args Command arguments
     * @param {string} mention Mention text that was included in command
     * @param {external.posts.CleanedPost} post Post that triggered the command
     */

    /**
     * Discourse message-bus channel message handler
     *
     * @callback
     * @name messageHandler
     * @param {externals.messageBus.message} message Message to handle
     */

    /**
     * Discourse message-bus topic message handler
     *
     * @callback
     * @name topicMessageHandler
     * @param {externals.messageBus.postMessage} message Payload of message
     * @param {externals.topics.Topic} topic Topic containing post
     * @param {externals.posts.CleanedPost} post Post that triggered the message
     */

    /**
     * Notification Handler
     *
     * @callback
     * @name notificationHandler
     * @param {external.notifications.notification} notification Received notification
     * @param {external.topics.Topic} [topic] Topic data for received notification
     * @param {external.posts.CleanedPost} [post] Post data for recieved notification
     */

    /**
     * Command handler
     *
     * @callback
     * @name commandHandler
     * @param {command} command Triggering Command
     */

    /**
     * Register a message-bus channel listener
     *
     * @function
     * @name onChannel
     * @param {string} channel Message-bus channel to subscribe to
     * @param {messageHandler} handler Event Handler
     */

    /**
     * Register a message-bus topic listener
     *
     * @function
     * @name onTopic
     * @param {Number} topicId Numerical ID of topic to subscribe to
     * @param {topicMessageHandler} handler Event Handler
     */

    /**
     * Unregister a message-bus channel listener
     *
     * @function
     * @name removeChannel
     * @param {string} channel Message-bus channel to subscribe to
     * @param {messageHandler} handler Event Handler
     * @returns {SockEvents} SockEvents for chaining calls
     */

    /**
     * Unregister a message-bus topic listener
     *
     * @function
     * @name removeFunction
     * @param {Number} topicId Numerical ID of topic to subscribe to
     * @param {topicMessageHandler} handler Event Handler
     * @returns {SockEvents} SockEvents for chaining calls
     */

    /**
     * Add a notification listener
     *
     * @function
     * @name onNotification
     * @param {string} type Notification type
     * @param {notificationHandler} handler Notification handler
     * @returns {SockEvents} SockEvents for chaining calls
     */

    /**
     * Remove a notification listener
     *
     * @function
     * @name removeNotification
     * @param {string} type Notification type
     * @param {notificationHandler} handler Notification handler
     * @returns {SockEvents} SockEvents for chaining calls
     */

    /**
     * Add a notification listener
     *
     * @function
     * @name onCommand
     * @param {string} type Command name
     * @param {string} helpstring Short help text for command
     * @param {commandHandler} handler Command handler
     * @returns {SockEvents} SockEvents for chaining calls
     */

    /**
     * Remove a command listener
     *
     * @function
     * @name removeCommand
     * @param {string} command Command type
     * @param {commandHandler} handler Command handler
     * @returns {SockEvents} SockEvents for chaining calls
     */
};<commit_msg>update docs to remove lint warning<commit_after>'use strict';
/**
 * SockEvents object
 *
 * All methods from core EventEmitter are preserved, refer to the [core api](https://nodejs.org/api/events.html)
 * for details.
 *
 * @module SockEvents
 * @name SockEvents
 * @author Accalia
 * @license MIT
 * @augments {EventEmitter}
 */

/**
 * Parsed Command Data
 *
 * @name command
 * @typedef {object}
 * @param {string} input Raw Command Input
 * @param {string} command Command name
 * @param {string[]} args Command arguments
 * @param {string} mention Mention text that was included in command
 * @param {external.posts.CleanedPost} post Post that triggered the command
 */

/**
 * Discourse message-bus channel message handler
 *
 * @callback
 * @name messageHandler
 * @param {externals.messageBus.message} message Message to handle
 */

/**
 * Discourse message-bus topic message handler
 *
 * @callback
 * @name topicMessageHandler
 * @param {externals.messageBus.postMessage} message Payload of message
 * @param {externals.topics.Topic} topic Topic containing post
 * @param {externals.posts.CleanedPost} post Post that triggered the message
 */

/**
 * Notification Handler
 *
 * @callback
 * @name notificationHandler
 * @param {external.notifications.notification} notification Received notification
 * @param {external.topics.Topic} [topic] Topic data for received notification
 * @param {external.posts.CleanedPost} [post] Post data for recieved notification
 */

/**
 * Command handler
 *
 * @callback
 * @name commandHandler
 * @param {command} command Triggering Command
 */

/**
 * Register a message-bus channel listener
 *
 * @function
 * @name onChannel
 * @param {string} channel Message-bus channel to subscribe to
 * @param {messageHandler} handler Event Handler
 * @returns {SockEvents} SockEvents for chaining calls
 */

/**
 * Register a message-bus topic listener
 *
 * @function
 * @onTopic
 * @param {Number} topicId Numerical ID of topic to subscribe to
 * @param {topicMessageHandler} handler Event Handler
 * @returns {SockEvents} SockEvents for chaining calls
 */

/**
 * Unregister a message-bus channel listener
 *
 * @function
 * @name removeChannel
 * @param {string} channel Message-bus channel to subscribe to
 * @param {messageHandler} handler Event Handler
 * @returns {SockEvents} SockEvents for chaining calls
 */

/**
 * Unregister a message-bus topic listener
 *
 * @function
 * @name removeTopic
 * @param {Number} topicId Numerical ID of topic to subscribe to
 * @param {topicMessageHandler} handler Event Handler
 * @returns {SockEvents} SockEvents for chaining calls
 */

/**
 * Add a notification listener
 *
 * @function
 * @name onNotification
 * @param {string} type Notification type
 * @param {notificationHandler} handler Notification handler
 * @returns {SockEvents} SockEvents for chaining calls
 */

/**
 * Remove a notification listener
 *
 * @function
 * @name removeNotification
 * @param {string} type Notification type
 * @param {notificationHandler} handler Notification handler
 * @returns {SockEvents} SockEvents for chaining calls
 */

/**
 * Add a notification listener
 *
 * @function
 * @name onCommand
 * @param {string} type Command name
 * @param {string} helpstring Short help text for command
 * @param {commandHandler} handler Command handler
 * @returns {SockEvents} SockEvents for chaining calls
 */

/**
 * Remove a command listener
 *
 * @function
 * @name removeCommand
 * @param {string} command Command type
 * @param {commandHandler} handler Command handler
 * @returns {SockEvents} SockEvents for chaining calls
 */
{'fraction_non_alphanumeric': 0.09770190413657255, 'fraction_numerical': 0.000262639527248851, 'mean_word_length': 3.2100608070757324, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1258683', 'n_tokens_mistral': 2094, 'n_tokens_neox': 2023, 'n_words': 716}