curse-filter/lib/middlewares/middlewaresConfig.d.ts

JavaScript/Typescript multi-language curse word filter

import { DetectOptions } from '../utils.js';
/**
 * @class MiddlewaresConfig
 * @description
 * This class is used to configure the middlewares for express.js.
 */
export declare class MiddlewaresConfig {
    /**
     * @property `onError`
     * @description
     * Function to be called when a not allowed content is detected, before sending the response.
     * @default null
     */
    static onError: () => void | null;
    /**
     * @property `detectOptions`
     * @description
     * Options to be passed to the `detect` function of middlewares.
     * @default {} // (no specific options are passed)
     */
    static detectOptions: DetectOptions;
    /**
     * @property `errorMessage`
     * @description
     * Error message to be sent in response when a not allowed content is detected.
     * @default 'Not allowed content detected.'
     */
    static errorMessage: string;
    /**
     * @property `errorCode`
     * @description
     * Error code to be sent in response when a not allowed content is detected.
     * @default 422
     * @see [status codes](https://developer.mozilla.org/en-US/docs/web/http/status)
     * @see [code 422](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422)
     */
    static errorCode: number;
}