detritus-client/lib/utils/markup.d.ts

A Typescript NodeJS library to interact with Discord's API, both Rest and Gateway.

import { MarkupTimestampStyles } from '../constants';
export declare const Strings: Readonly<{
    BOLD: string;
    CODEBLOCK: string;
    CODESTRING: string;
    CODESTRING_DOUBLE: string;
    ESCAPE: string;
    ITALICS: string;
    SPOILER: string;
    STRIKE: string;
    UNDERLINE: string;
}>;
export declare const Regexes: Readonly<{
    [x: string]: RegExp;
    EVERYONE: RegExp;
    LINK: RegExp;
    MENTION: RegExp;
    MENTION_HARDCORE: RegExp;
    URL: RegExp;
}>;
export declare const Replacements: Readonly<{
    [x: string]: string;
    MENTION: string;
}>;
export interface MarkupFilter {
    limit: number;
    links: boolean;
    mentions: boolean;
    mentionEscapeCharacter: string;
    replacement: string;
}
export interface MarkupFilterOptions {
    limit?: number;
    links?: boolean;
    mentions?: boolean;
    mentionEscapeCharacter?: string;
    replacement?: string;
}
export declare function bold(text: string, options?: MarkupFilterOptions): string;
export interface CodeblockFilter extends MarkupFilter {
    language: string;
}
export interface CodeblockFilterOptions extends MarkupFilterOptions {
    language?: string;
}
export declare function codeblock(text: string, options?: CodeblockFilterOptions): string;
export declare function codestring(text: string, options?: MarkupFilterOptions): string;
export declare function italics(text: string, options?: MarkupFilterOptions): string;
export declare function spoiler(text: string, options?: MarkupFilterOptions): string;
export declare function strike(text: string, options?: MarkupFilterOptions): string;
export declare function underline(text: string, options?: MarkupFilterOptions): string;
export declare function url(text: string, url: string, comment?: string): string;
export declare function timestamp(timestamp: Date | number | string | null, format?: MarkupTimestampStyles): string;
export declare function trueSlice(text: string, limit?: number): string;
export declare const escape: Readonly<{
    all: (text: string, options?: MarkupFilterOptions) => string;
    bold: (text: string, options?: MarkupFilterOptions) => string;
    codeblock: (text: string, options?: CodeblockFilterOptions) => string;
    codestring: (text: string, options?: MarkupFilterOptions) => string;
    italics: (text: string, options?: MarkupFilterOptions) => string;
    links: (text: string, replacement?: string) => string;
    mentions: (text: string, replacement?: string) => string;
    spoiler: (text: string, options?: MarkupFilterOptions) => string;
    strike: (text: string, options?: MarkupFilterOptions) => string;
    underline: (text: string, options?: MarkupFilterOptions) => string;
    url: (text: string, options?: MarkupFilterOptions) => string;
}>;