Skip to main content

clearDeprecationWarnings

Test-only helper that resets the process-wide set of already-warned deprecated tokens tracked by warnIfDeprecated. Production callers do not need to invoke this — the dedup set is process-lifetime by design (one warning per deprecated token, no spam).

Why a warnings reset hook​

warnIfDeprecated warns once per deprecated token for the whole process lifetime. Across Jest cases that exercise the deprecation path repeatedly, the dedup set silences subsequent warnings — making "this should warn" assertions silently pass after the first case. clearDeprecationWarnings() lets each beforeEach start with an empty dedup set.

Signature​

import { clearDeprecationWarnings } from '@conduction/nextcloud-vue'

clearDeprecationWarnings()
ArgumentTypeDescription
——No arguments.

Return value​

Returns undefined.

Usage​

import {
    warnIfDeprecated,
    clearDeprecationWarnings,
} from '@conduction/nextcloud-vue'

describe('deprecated tokens', () => {
    beforeEach(() => {
        clearDeprecationWarnings()
    })

    it('warns once for a deprecated token', () => {
        const warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {})
        warnIfDeprecated('@config.legacyKey', warnSpy)
        warnIfDeprecated('@config.legacyKey', warnSpy)
        expect(warnSpy).toHaveBeenCalledTimes(1)
        warnSpy.mockRestore()
    })
})

See also​