Theia API Documentation v1.65.0
    Preparing search index...

    Interface Options<T, TChangeSummary>

    interface Options<T, TChangeSummary> {
        createChangeSummary?: () => TChangeSummary;
        isEqual?: (a: T, b: T) => boolean;
        willHandleChange?: <U, UChange>(
            context: ChangeContext<U, UChange>,
            changeSummary: undefined | TChangeSummary,
        ) => boolean;
    }

    Type Parameters

    • T
    • TChangeSummary
    Index

    Properties

    createChangeSummary? isEqual? willHandleChange?

    Properties

    createChangeSummary?: () => TChangeSummary

    Creates a change summary that can collect the changes reported by the observed dependencies to willHandleChange.

    isEqual?: (a: T, b: T) => boolean
    willHandleChange?: <U, UChange>(
        context: ChangeContext<U, UChange>,
        changeSummary: undefined | TChangeSummary,
    ) => boolean

    Handles a change reported by an observed dependency, e.g. by adding it to the changeSummary. Returns true if the reported change should be reacted to, and false if it should be ignored.

    Settings

    Member Visibility

    On This Page

    Properties