@theia/core/lib/common/contribution-filter/contribution-filter.d.ts

Theia is a cloud & desktop IDE framework implemented in TypeScript.

import { interfaces } from 'inversify';
import { Filter } from './filter';
export type ContributionType = interfaces.ServiceIdentifier<any>;
export declare const ContributionFilterRegistry: unique symbol;
export interface ContributionFilterRegistry {
    /**
     * Add filters to be applied for every type of contribution.
     */
    addFilters(types: '*', filters: Filter<Object>[]): void;
    /**
     * Given a list of contribution types, register filters to apply.
     * @param types types for which to register the filters.
     */
    addFilters(types: ContributionType[], filters: Filter<Object>[]): void;
    /**
     * Applies the filters for the given contribution type. Generic filters will be applied on any given type.
     * @param toFilter the elements to filter
     * @param type the contribution type for which potentially filters were registered
     * @returns the filtered elements
     */
    applyFilters<T extends Object>(toFilter: T[], type: ContributionType): T[];
}
export declare const FilterContribution: unique symbol;
/**
 * Register filters to remove contributions.
 */
export interface FilterContribution {
    /**
     * Use the registry to register your contribution filters.
     * * Note that filtering contributions based on their class (constructor) name is discouraged.
     * Class names are minified in production builds and therefore not reliable.
     * Use instance of checks or direct constructor comparison instead:
     *
     * ```ts
     * registry.addFilters('*', [
     *     contrib => !(contrib instanceof SampleFilteredCommandContribution)
     * ]);
     * ```
     */
    registerContributionFilters(registry: ContributionFilterRegistry): void;
}
//# sourceMappingURL=contribution-filter.d.ts.map