Interface CreateFilterParams

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

Properties

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

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

expiresIn?: null | number

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

irreversible?: null | boolean

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

phrase: string

Text to be filtered

wholeWord?: null | boolean

Consider word boundaries?