masto
Version:
Mastodon API client for JavaScript, TypeScript, Node.js, browsers
27 lines (26 loc) • 886 B
TypeScript
export interface FilterContextRegistry {
home: never;
notifications: never;
public: never;
thread: never;
account: never;
}
export type FilterContext = keyof FilterContextRegistry;
/**
* Represents a user-defined filter for determining which statuses should not be shown to the user.
* @see https://docs.joinmastodon.org/entities/filter/
*/
export interface Filter {
/** The ID of the filter in the database. */
id: string;
/** The text to be filtered. */
phrase: string;
/** The contexts in which the filter should be applied. */
context: FilterContext[];
/** When the filter should no longer be applied */
expiresAt?: string | null;
/** Should matching entities in home and notifications be dropped by the server? */
irreversible: boolean;
/** Should the filter consider word boundaries? */
wholeWord: boolean;
}