Interface CreateFilterParams

interface CreateFilterParams {
    context: readonly (keyof mastodon.v1.FilterContextRegistry)[] | null;
    expiresIn?: number | null;
    irreversible?: boolean | null;
    phrase: string;
    wholeWord?: boolean | null;
}

Properties

context: readonly (keyof mastodon.v1.FilterContextRegistry)[] | null

Array of enumerable strings home, notifications, public, thread. At least one context must be specified.

expiresIn?: number | null

ISO 8601 Date-time for when the filter expires. Otherwise, null for a filter that doesn't expire.

irreversible?: boolean | null

Should the server irreversibly drop matching entities from home and notifications?

phrase: string

Text to be filtered

wholeWord?: boolean | null

Consider word boundaries?