@kkdev92/vscode-ext-kit - v4.1.1
    Preparing search index...

    Interface FakeSettings

    In-memory settings capability for tests.

    interface FakeSettings {
        _fireChange(sections: readonly string[]): void;
        _reset(): void;
        _set(
            section: string,
            key: string,
            tier: FakeSettingsTier,
            value: unknown,
            placement?: FakeSettingsPlacement,
        ): void;
        inspect<T>(
            section: string,
            key: string,
            scope?: SettingsScope,
        ): SettingsInspection<T> | undefined;
        onDidChange(
            listener: (event: SettingsChangeSource) => void,
        ): PlatformRegistration;
        read<T>(section: string, key: string, scope?: SettingsScope): T | undefined;
        update(
            section: string,
            key: string,
            value: unknown,
            target: SettingsTarget,
            scope?: SettingsScope,
            overrideInLanguage?: boolean,
        ): Promise<void>;
    }

    Hierarchy

    • SettingsCapability
      • FakeSettings
    Index
    _fireChange _reset _set inspect onDidChange read update

    _fireChange

    • _fireChange(sections: readonly string[]): void

      Notifies listeners that the given keys changed, the way VS Code reports a configuration change: fully qualified leaf keys, not section names.

      The resulting affects(section) says yes when a changed key is that section or sits under it — so _fireChange(['sample.projects.enabled']) affects sample.projects, while a change to sample.pro does not.

      Parameters

      • sections: readonly string[]

      Returns void

    _reset

    _set

    • Reads the effective value, with VS Code's own tier resolution applied.

      Type Parameters

      • T

      Parameters

      Returns T | undefined

    • Writes a value to the requested tier. Passing undefined removes that tier's value. Rejections from the platform propagate to the caller.

      Parameters

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods