galactic-bot/@types/Utils.d.ts

// Galactic - Discord moderation bot
// Copyright (C) 2024  Navy.gif

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

export type FilterType = 'explicit' | 'regex' | 'fuzzy'

export type FilterResult = {
    filter?: string,
    match?: string,
    matcher?: string,
    matched?: boolean,
    _matcher?: string,
    type?: FilterType
    word?: string,
    raw?: string,
    sim?: number,
    threshold?: number,
    sanctioned?: boolean
}

export type Nullable<T> = {
    [K in keyof T]: T[K] | null
}