Aller au contenu principal
Version : Suivant

L'objet Jest

L'objet jest est automatiquement dans la portée dans chaque fichier de test. Les méthodes de l'objet jest aident à créer des simulations et vous permettent de contrôler le comportement global de Jest. Il peut également être importé explicitement par import {jest} from '@jest/globals'.

Méthodes


Modules simulés

jest.disableAutomock()

Désactive la simulation automatique dans le chargeur de module.

Consultez la section automock de configuration pour plus d'informations

Une fois cette méthode appelée, tous les require()s retourneront les versions réelles de chaque module (plutôt qu'une version simulée).

Configuration de Jest :

{
"automock": true
}

Exemple :

utils.js
export default {
authorize: () => {
return 'token';
},
};
__tests__/disableAutomocking.js
import utils from '../utils';

jest.disableAutomock();

test('original implementation', () => {
// maintenant nous avons l'implémentation originale,
// même si nous définissons l'auto-simulation dans une configuration de jest
expect(utils.authorize()).toBe('token');
});

Cela est généralement utile lorsque le nombre de dépendances que vous souhaitez simuler est bien inférieur au nombre de dépendances que vous ne souhaitez pas. Par exemple, si vous écrivez un test pour un module qui utilise un grand nombre de dépendances qui peuvent être raisonnablement classées comme des « détails d'implémentation » du module, alors vous ne voulez probablement pas les simuler.

Les exemples de dépendances qui peuvent être considérées comme des « détails d'implémentation » sont des choses allant des modules intégrés au langage (par exemple, les méthodes Array.prototype) aux méthodes utilitaires très courantes (par exemple, underscore/lo-dash, utilitaires de tableau, etc.) et aux bibliothèques entières comme React.js.

Renvoie l'objet jest pour le chaînage.

Remarque : cette méthode était auparavant appelée autoMockOff. Lorsque vous utilisez babel-jest, les appels à disableAutomock seront automatiquement remontés en haut du bloc de code. Utilisez autoMockOff si vous voulez éviter explicitement ce comportement.

jest.enableAutomock()

Active la simulation automatique dans le chargeur de module.

Renvoie l'objet jest pour le chaînage.

Consultez la section automock de configuration pour plus d'informations

Exemple :

utils.js
export default {
authorize: () => {
return 'token';
},
isAuthorized: secret => secret === 'wizard',
};
__tests__/enableAutomocking.js
jest.enableAutomock();

import utils from '../utils';

test('original implementation', () => {
// maintenant nous avons l'implémentation simulée,
expect(utils.authorize._isMockFunction).toBeTruthy();
expect(utils.isAuthorized._isMockFunction).toBeTruthy();
});

Remarque : cette méthode était auparavant appelée autoMockOn. Lorsque vous utilisez babel-jest, les appels à enableAutomock seront automatiquement remontés en haut du bloc de code. Utilisez autoMockOn si vous voulez éviter explicitement ce comportement.

jest.createMockFromModule(moduleName)

renommé dans Jest 26.0.0+

Aussi sous l'alias : .genMockFromModule(moduleName)

Avec le nom d'un module, utilisez le système de simulation automatique pour générer pour vous une version simulée du module.

Ceci est utile lorsque vous voulez créer un simulation manuelle qui étend le comportement de la simulation automatique.

Exemple :

utils.js
export default {
authorize: () => {
return 'token';
},
isAuthorized: secret => secret === 'wizard',
};
__tests__/createMockFromModule.test.js
const utils = jest.createMockFromModule('../utils').default;
utils.isAuthorized = jest.fn(secret => secret === 'not wizard');

test('implémentation créée par jest.createMockFromModule', () => {
expect(utils.authorize.mock).toBeTruthy();
expect(utils.isAuthorized('not wizard')).toEqual(true);
});

Voici comment createMockFromModule simulera les types de données suivants :

Fonction

Crée une nouvelle fonction simulée. La nouvelle fonction n'a pas de paramètres formels et lorsqu'elle est appelée, retournera undefined. Cette fonctionnalité s'applique également aux fonctions async.

Classe

Crée une nouvelle classe. L'interface de la classe originale est maintenue, toutes les fonctions et propriétés des membres de la classe seront simulées.

Objet

Crée un nouvel objet profondément cloné. Les clés de l'objet sont maintenues et leurs valeurs sont simulées.

Tableau

Crée un nouveau tableau vide, ignorant l'original.

Primitives

Crée une nouvelle propriété avec la même valeur primitive que la propriété originale.

Exemple :

example.js
module.exports = {
function: function square(a, b) {
return a * b;
},
asyncFunction: async function asyncSquare(a, b) {
const result = (await a) * b;
return result;
},
class: new (class Bar {
constructor() {
this.array = [1, 2, 3];
}
foo() {}
})(),
object: {
baz: 'foo',
bar: {
fiz: 1,
buzz: [1, 2, 3],
},
},
array: [1, 2, 3],
number: 123,
string: 'baz',
boolean: true,
symbol: Symbol.for('a.b.c'),
};
__tests__/example.test.js
const example = jest.createMockFromModule('./example');

test('devrait exécuter le code exemple', () => {
// crée une nouvelle fonction simulée sans argument formel.
expect(example.function.name).toEqual('square');
expect(example.function.length).toEqual(0);

// les fonctions asynchrones reçoivent le même traitement que les fonctions synchrones standard.
expect(example.asyncFunction.name).toEqual('asyncSquare');
expect(example.asyncFunction.length).toEqual(0);

// crée une nouvelle classe avec la même interface, les fonctions membres et les propriétés sont simulées.
expect(example.class.constructor.name).toEqual('Bar');
expect(example.class.foo.name).toEqual('foo');
expect(example.class.array.length).toEqual(0);

// crée une version profondément clonée de l'objet original.
expect(example.object).toEqual({
baz: 'foo',
bar: {
fiz: 1,
buzz: [],
},
});

// crée un nouveau tableau vide, ignorant le tableau original.
expect(example.array.length).toEqual(0);

// crée une nouvelle propriété avec la même valeur primitive que la propriété originale.
expect(example.number).toEqual(123);
expect(example.string).toEqual('baz');
expect(example.boolean).toEqual(true);
expect(example.symbol).toEqual(Symbol.for('a.b.c'));
});

jest.mock(moduleName, factory, options)

Simule un module avec une version simulée automatiquement lorsqu'il est exigé. factory et options sont facultatifs. Par exemple :

banana.js
module.exports = () => 'banana';
__tests__/test.js
jest.mock('../banana');

const banana = require('../banana'); // banana sera explicitement simulée.

banana(); // retournera 'undefined' parce que la fonction est auto-simulée.

Le second argument peut être utilisé pour spécifier une factory de modules explicite qui est exécutée au lieu d'utiliser la fonctionnalité de simulation automatique de Jest :

jest.mock('../moduleName', () => {
return jest.fn(() => 42);
});

// Exécute la fonction spécifiée comme second argument de `jest.mock`.
const moduleName = require('../moduleName');
moduleName(); // retournera '42';

Lors de l'utilisation du paramètre factory pour un module ES6 avec une exportation par défaut, la propriété __esModule : true doit être spécifiée. Cette propriété est normalement générée par Babel / TypeScript, mais ici elle doit être définie manuellement. Lors de l'importation d'une exportation par défaut, c'est une instruction pour importer la propriété nommée default de l'objet d'exportation :

import moduleName, {foo} from '../moduleName';

jest.mock('../moduleName', () => {
return {
__esModule: true,
default: jest.fn(() => 42),
foo: jest.fn(() => 43),
};
});

moduleName(); // Retournera 42
foo(); // Retournera 43

Le troisième argument peut être utilisé pour créer des simulations virtuels - des simulations de modules qui n'existent nulle part dans le système :

jest.mock(
'../moduleName',
() => {
/*
* Implémentation personnalisée d'un module qui n'existe pas en JS,
* comme un module généré ou un module natif dans react-native.
*/
},
{virtual: true},
);

Avertissement : L'importation d'un module dans un fichier de configuration (comme spécifié par setupFilesAfterEnv) empêchera la simulation du module en question, ainsi que de tous les modules qu'il importe.

Les modules qui sont simulés avec jest.mock ne sont simulés que pour le fichier qui appelle jest.mock. Un autre fichier qui importe le module obtiendra l'implémentation originale même s'il est exécuté après le fichier de test qui simule le module.

Renvoie l'objet jest pour le chaînage.

jest.unmock(moduleName)

Indique que le système de modules ne doit jamais retourner une version simulée du module spécifié à partir de require() (par exemple, qu'il doit toujours retourner le module réel).

L'utilisation la plus fréquente de cette API est de spécifier le module qu'un test donné a l'intention de tester (et donc ne veut pas être automatiquement simulé).

Renvoie l'objet jest pour le chaînage.

jest.doMock(moduleName, factory, options)

Lorsque vous utilisez babel-jest, les appels à mock seront automatiquement remontés en haut du bloc de code. Utilisez cette méthode si vous voulez éviter explicitement ce comportement.

Un exemple où cela est utile est lorsque vous voulez simuler un module différemment dans le même fichier :

beforeEach(() => {
jest.resetModules();
});

test('moduleName 1', () => {
jest.doMock('../moduleName', () => {
return jest.fn(() => 1);
});
const moduleName = require('../moduleName');
expect(moduleName()).toEqual(1);
});

test('moduleName 2', () => {
jest.doMock('../moduleName', () => {
return jest.fn(() => 2);
});
const moduleName = require('../moduleName');
expect(moduleName()).toEqual(2);
});

L'utilisation de jest.doMock() avec les importations ES6 nécessite des étapes supplémentaires. Suivez-les si vous ne voulez pas utiliser require dans vos tests :

  • Nous devons spécifier la propriété __esModule : true (voir l'API de jest.mock() pour plus d'informations).
  • Les importations de modules statiques ES6 sont hissées en haut du fichier, donc à la place nous devons les importer dynamiquement en utilisant import().
  • Enfin, nous avons besoin d'un environnement qui soutienne l'importation dynamique. Veuillez consulter Utilisation de Babel pour la configuration initiale. Ensuite, ajoutez le plugin babel-plugin-dynamic-import-node, ou un équivalent, à votre configuration Babel pour activer l'importation dynamique dans Node.
beforeEach(() => {
jest.resetModules();
});

test('moduleName 1', () => {
jest.doMock('../moduleName', () => {
return {
__esModule: true,
default: 'default1',
foo: 'foo1',
};
});
return import('../moduleName').then(moduleName => {
expect(moduleName.default).toEqual('default1');
expect(moduleName.foo).toEqual('foo1');
});
});

test('moduleName 2', () => {
jest.doMock('../moduleName', () => {
return {
__esModule: true,
default: 'default2',
foo: 'foo2',
};
});
return import('../moduleName').then(moduleName => {
expect(moduleName.default).toEqual('default2');
expect(moduleName.foo).toEqual('foo2');
});
});

Renvoie l'objet jest pour le chaînage.

jest.dontMock(moduleName)

Lorsque vous utilisez babel-jest, les appels à unmock seront automatiquement remontés en haut du bloc de code. Utilisez cette méthode si vous voulez éviter explicitement ce comportement.

Renvoie l'objet jest pour le chaînage.

jest.setMock(moduleName, moduleExports)

Fournit explicitement l'objet simulé que le système de module doit retourner pour le module spécifié.

Il arrive parfois que la simulation générée automatiquement par le système de modules ne soit pas suffisante pour vos besoins de test. Normalement, dans ces circonstances, vous devriez écrire une simulation manuelle qui est plus adéquate pour le module en question. Cependant, en de très rares occasions, même une simulation manuelle n'est pas adaptée à vos besoins et vous devez construire la simulation vous-même dans votre test.

Dans ces rares cas, vous pouvez utiliser cette API pour remplir manuellement l'emplacement dans le registre des modules fictifs du système de modules.

Renvoie l'objet jest pour le chaînage.

Remarque Il est recommandé d'utiliser à la place jest.mock(). Le deuxième argument de l'API jest.mock est une factory de module plutôt que l'objet module exporté attendu.

jest.requireActual(moduleName)

Renvoie le module réel au lieu d'une simulation, en contournant toutes les vérifications pour savoir si le module doit recevoir une implémentation simulée ou non.

Exemple :

jest.mock('../myModule', () => {
// Nécessite que le module original ne soit pas simulé...
const originalModule = jest.requireActual('../myModule');

return {
__esModule: true, // Utilisez-le lorsque vous travaillez avec esModules
...originalModule,
getRandom: jest.fn().mockReturnValue(10),
};
});

const getRandom = require('../myModule').getRandom;

getRandom(); // Retourne toujours 10

jest.requireMock(moduleName)

Renvoie un module simulé au lieu du module réel, en contournant toutes les vérifications pour savoir si le module doit être requis normalement ou non.

jest.resetModules()

Réinitialise le registre des modules - le cache de tous les modules requis. Ceci est utile pour isoler les modules où l'état local peut entrer en conflit entre les tests.

Exemple :

const sum1 = require('../sum');
jest.resetModules();
const sum2 = require('../sum');
sum1 === sum2;
// > false (Les deux modules sum sont des « instances » distinctes du module sum.)

Exemple dans un test :

beforeEach(() => {
jest.resetModules();
});

test('fonctionne', () => {
const sum = require('../sum');
});

test('fonctionne aussi', () => {
const sum = require('../sum');
// sum est une copie différente du module sum du test précédent.
});

Renvoie l'objet jest pour le chaînage.

jest.isolateModules(fn)

jest.isolateModules(fn) va un peu plus loin que jest.resetModules() et crée un registre de type bac à sable pour les modules qui sont chargés à l'intérieur de la fonction callback. Ceci est utile pour isoler les modules spécifiques pour chaque test afin que l'état du module local n'entre pas en conflit entre les tests.

let myModule;
jest.isolateModules(() => {
myModule = require('myModule');
});

const otherCopyOfMyModule = require('myModule');

Fonctions simulées

jest.fn(implementation?)

Retourne une nouvelle fonction simulée non utilisée. En option, prend une implémentation simulée.

const mockFn = jest.fn();
mockFn();
expect(mockFn).toHaveBeenCalled();

// Avec une implémentation simulée :
const returnsTrue = jest.fn(() => true);
console.log(returnsTrue()); // true;
remarque

Consultez la page Fonctions fictives pour plus de détails sur l'utilisation de TypeScript.

jest.isMockFunction(fn)

Détermine si la fonction donnée est une fonction simulée.

jest.spyOn(object, methodName)

Crée une fonction simulée similaire à jest.fn mais qui surveille également les appels à objet[methodName]. Retourne une fonction simulée de Jest.

Remarque : Par défaut, jest.spyOn appelle également la méthode spied. Ceci est un comportement différent de la plupart des autres bibliothèques de test. Si vous voulez écraser la fonction originale, vous pouvez utiliser jest.spyOn(object, methodName).mockImplementation(() => customImplementation) ou object[methodName] = jest.fn(() => customImplementation);

Exemple :

const video = {
play() {
return true;
},
};

module.exports = video;

Exemple de test :

const video = require('./video');

test('lit la vidéo', () => {
const spy = jest.spyOn(video, 'play');
const isPlaying = video.play();

expect(spy).toHaveBeenCalled();
expect(isPlaying).toBe(true);

spy.mockRestore();
});

jest.spyOn(object, methodName, accessType?)

Depuis Jest 22.1.0+, la méthode jest.spyOn prend un troisième argument optionnel de type accessType qui peut être soit 'get' ou 'set', qui s'avère utile lorsque vous voulez espionner respectivement un getter ou un setter.

Exemple :

const video = {
// c'est un getter !
get play() {
return true;
},
};

module.exports = video;

const audio = {
_volume: false,
// c'est un setter !
set volume(value) {
this._volume = value;
},
get volume() {
return this._volume;
},
};

module.exports = audio;

Exemple de test :

const audio = require('./audio');
const video = require('./video');

test('lit la video', () => {
const spy = jest.spyOn(video, 'play', 'get'); // nous passons 'get'
const isPlaying = video.play;

expect(spy).toHaveBeenCalled();
expect(isPlaying).toBe(true);

spy.mockRestore();
});

test('lit l\'audio', () => {
const spy = jest.spyOn(audio, 'volume', 'set'); // nous passons 'set'
audio.volume = 100;

expect(spy).toHaveBeenCalled();
expect(audio.volume).toBe(100);

spy.mockRestore();
});

jest.clearAllMocks()

Efface les propriétés mock.calls, mock.instances, mock.contexts et mock.results de toutes les simulations. Equivalent aux appels de .mockClear() sur chaque fonction simulée.

Renvoie l'objet jest pour le chaînage.

jest.resetAllMocks()

Réinitialise l'état de toutes les simulations. Equivalent aux appels de .mockReset() sur chaque fonction simulée.

Renvoie l'objet jest pour le chaînage.

jest.restoreAllMocks()

Restaure tous les simulations à leur valeur originale. Equivalent aux appels de .mockRestore() sur chaque fonction simulée. Attention, jest.restoreAllMocks() ne fonctionne que lorsque la simulation a été créée avec jest.spyOn; pour les autres simulations, vous devrez les restaurer manuellement.

jest.mocked<T>(item: T, deep = false)

L'helper de test mocked fournit des écritures sur vos modules simulés et même sur leurs méthodes profondes, basées sur le typage de sa source. Il utilise la dernière fonctionnalité TypeScript, de sorte que vous avez même la complétion des types d'arguments dans l'IDE (par opposition à jest.MockInstance).

Remarque : bien qu'il convienne que ce soit une fonction pour que le type d'entrée soit modifié, le helper lui-même ne fait rien d'autre que de renvoyer la valeur d'entrée donnée.

Exemple :

// foo.ts
export const foo = {
a: {
b: {
c: {
hello: (name: string) => `Hello, ${name}`,
},
},
},
name: () => 'foo',
};
// foo.spec.ts
import {foo} from './foo';
jest.mock('./foo');

// Ici, toute la variable foo est profondément simulée
const mockedFoo = jest.mocked(foo, true);

test('deep', () => {
// il n'y aura pas d'erreur TS ici, et vous aurez la complétion dans les IDEs modernes
mockedFoo.a.b.c.hello('me');
// la même chose ici
expect(mockedFoo.a.b.c.hello.mock.calls).toHaveLength(1);
});

test('direct', () => {
foo.name();
// Ici, seul foo.name est simulé (ou ses méthodes si c'est un objet)
expect(jest.mocked(foo.name).mock.calls).toHaveLength(1);
});

Faux temporisateurs

jest.useFakeTimers(fakeTimersConfig?)

Indique à Jest d'utiliser des versions fictives des API globales de date, de performance, de temps et de temporisation. L'implémentation des faux temporisateurs est garantie par @sinonjs/fake-timers.

Les faux temporisateurs vont remplacer Date, performance.now(), queueMicrotask(), setImmediate(), clearImmediate(), setInterval(), clearInterval(), setTimeout(), clearTimeout() avec une implémentation qui obtient son heure à partir d'une horloge factice.

Dans l'environnement Node process.hrtime, process.nextTick() et dans l'environnement JSDOM requestAnimationFrame(), cancelAnimationFrame(), requestIdleCallback(), cancelIdleCallback() seront également remplacés.

Options de configuration :

type FakeableAPI =
| 'Date'
| 'hrtime'
| 'nextTick'
| 'performance'
| 'queueMicrotask'
| 'requestAnimationFrame'
| 'cancelAnimationFrame'
| 'requestIdleCallback'
| 'cancelIdleCallback'
| 'setImmediate'
| 'clearImmediate'
| 'setInterval'
| 'clearInterval'
| 'setTimeout'
| 'clearTimeout';

type FakeTimersConfig = {
/**
* Si défini à `true` tous les temporisateurs seront automatiquement avancés de 20 millisecondes
* toutes les 20 millisecondes. Un delta de temps personnalisé peut être fourni en passant un nombre.
* La valeur par défaut est `false`.
*/
advanceTimers?: boolean | number;
/**
* Liste des noms des APIs qui ne doivent pas être falsifiés. La valeur par défaut est `[]`, ce qui signifie que
* toutes les APIs sont falsifiées.
*/
doNotFake?: Array<FakeableAPI>;
/**
* Utilise l'ancienne implémentation des faux temporisateurs au lieu de celle supportée par `@sinonjs/fake-timers`.
* La valeur par défaut est `false`.
*/
legacyFakeTimers?: boolean;
/** Définit l'heure actuelle du système à utiliser par de faux temporisateurs. La valeur par défaut est `Date.now()`. */
now?: number | Date;
/**
* Le nombre maximum de temporisateurs récursifs qui seront exécutés lors de l'appel de `jest.runAllTimers()`.
* La valeur par défaut est `100_000` temporisateurs.
*/
timerLimit?: number;
};

L'appel de jest.useFakeTimers() utilisera des faux temporisateurs pour tous les tests du fichier, jusqu'à ce que les temporisateurs originaux soient restaurés avec jest.useRealTimers().

Vous pouvez appeler jest.useFakeTimers() ou jest.useRealTimers() de n'importe où : niveau supérieur, à l'intérieur d'un bloc test, etc. Gardez à l'esprit qu'il s'agit d'une opération globale et affectera les autres tests dans le même fichier. L'appel de jest.useFakeTimers() une fois de plus dans le même fichier de test réinitialiserait l'état interne (par exemple le nombre de temporisateurs) et réinstallerait les faux temporisateurs en utilisant les options fournies :

test('avance les minuteurs automatiquement', () => {
jest.useFakeTimers({advanceTimers: true});
// ...
});

test('n\'avance pas les temporisateurs et ne fausse pas `performance`', () => {
jest.useFakeTimers({doNotFake: ['performance']});
// ...
});

test('désinstalle les faux temporisateurs pour le reste des tests dans le fichier', () => {
jest.useRealTimers();
// ...
});
Les anciens faux temporisateurs

Pour certaines raisons, il se peut que vous deviez utiliser une ancienne implémentation de faux temporisateurs. Elle peut être activée comme ceci (les options supplémentaires ne sont pas supportées) :

jest.useFakeTimers({
legacyFakeTimers: true,
});

Les anciens faux temporisateurs vont remplacer setImmediate(), clearImmediate(), setInterval(), clearInterval(), setTimeout(), clearTimeout() avec les fonctions simulées de Jest. Dans l'environnement Node process.nextTick() et dans l'environnement JSDOM requestAnimationFrame(), cancelAnimationFrame() seront également remplacés.

Renvoie l'objet jest pour le chaînage.

jest.useRealTimers()

Indique à Jest de restaurer les implémentations originales de la date globale, de la performance, de l'heure et des API de temporisation. Par exemple, vous pouvez appeler jest.useRealTimers() à l'intérieur du hook afterEach pour restaurer les temporisateurs après chaque test :

afterEach(() => {
jest.useRealTimers();
});

test('faire quelque chose avec de faux temporisateurs', () => {
jest.useFakeTimers();
// ...
});

test('faire quelque chose avec des temporisateurs réels', () => {
// ...
});

Renvoie l'objet jest pour le chaînage.

jest.runAllTicks()

Libère la file d'attente des micro-tâches (généralement interfacée dans node via process.nextTick).

Lorsque cette API est appelée, toutes les micro-tâches en attente qui ont été mises en file d'attente via process.nextTick seront exécutées. En outre, si ces micro-tâches elles-mêmes planifient de nouvelles micro-tâches, elles seront continuellement libérées jusqu'à ce qu'il n'y ait plus de micro-tâches dans la file d'attente.

jest.runAllTimers()

Libère la file d'attente macro-tâche (par exemple toutes les tâches mises en file d'attente par setTimeout(), setInterval() et setImmediate()) et la file d'attente micro-tâche (généralement interfacée dans node via le processus process.nextTick).

Lorsque cette API est appelée, toutes les macro-tâches et les micro-tâches en attente seront exécutées. Si ces tâches elles-mêmes planifient de nouvelles tâches, elles seront continuellement libérées jusqu'à ce qu'il n'y ait plus de tâches dans la file d'attente.

Ceci est souvent utile pour exécuter les setTimeout de façon synchrone pendant un test afin d'affirmer de façon synchrone un comportement qui ne se produirait qu'après que les callbacks setTimeout() ou setInterval() soient exécutées. Consultez la doc des simulateurs de temporisation pour plus d'informations.

jest.runAllImmediates()

Libère toutes les tâches mises en file d'attente par setImmediate().

info

Cette fonction est disponible uniquement lors de l'utilisation de l'ancienne implémentation des faux temporisateurs.

jest.advanceTimersByTime(msToRun)

Exécute uniquement la file d'attente macro (c'est-à-dire toutes les tâches mises en file d'attente par setTimeout() ou setInterval() et setImmediate()).

Lorsque cette API est appelée, tous les temporisateurs sont avancés de msToRun millisecondes. Toutes les « macro-tâches » en attente qui ont été mises en file d'attente via setTimeout() ou setInterval(), et qui devraient être exécutées pendant ce laps de temps, seront exécutées. En plus, si ces macro-tâches planifient de nouvelles macro-tâches qui devraient être exécutées dans le même laps de temps, celles-ci seront exécutées jusqu'à ce qu'il ne reste plus de macro-tâches dans la file d'attente qui doivent être exécutées dans les msToRun millisecondes.

jest.runOnlyPendingTimers()

Exécute uniquement les macro-tâches qui sont actuellement en attente (par exemple seules les tâches qui ont été mises en file d'attente par setTimeout() ou setInterval() jusqu'à ce point). Si l'une des macro-tâches en cours planifie de nouvelles macro-tâches, ces nouvelles tâches ne seront pas exécutées par cet appel.

Ceci est utile pour des scénarios tels que celui où le module testé planifie un setTimeout() dont le callback planifie un autre setTimeout() récursivement (ce qui signifie que la planification ne s'arrête jamais). Dans ces scénarios, il est utile de pouvoir avancer dans le temps d'une seule étape à la fois.

jest.advanceTimersToNextTimer(steps)

Avance tous les temporisateurs en millisecondes nécessaires pour que seuls les prochains timeouts/intervals s'exécutent.

En option, vous pouvez fournir steps, afin qu'il exécute le nombre de steps des prochains timeouts/intervals.

jest.clearAllTimers()

Supprime tous les temporisateurs en attente du système de temporisation.

Cela signifie que si des temporisateurs ont été programmés (mais n'ont pas encore été exécutés), ils seront effacés et n'auront jamais la possibilité de s'exécuter à l'avenir.

jest.getTimerCount()

Retourne le nombre de temporisateurs fictifs qui restent à exécuter.

jest.setSystemTime(now?: number | Date)

Définit l'heure actuelle du système utilisée par les temporisateurs fictifs. Simule un utilisateur qui change l'horloge du système pendant que votre programme fonctionne. Cela affecte l'heure actuelle mais ne provoque pas en soi par exemple le déclenchement de temporisateurs; ils se déclencheront exactement comme ils l'auraient fait sans l'appel à jest.setSystemTime().

info

Cette fonction n'est pas disponible lors de l'utilisation de l'ancienne implémentation des faux temporisateurs.

jest.getRealSystemTime()

Lors de simulation de temps, Date.now() sera également simulée. Si vous avez besoin pour une raison quelconque d'avoir accès à l'heure réelle, vous pouvez appeler cette fonction.

info

Cette fonction n'est pas disponible lors de l'utilisation de l'ancienne implémentation des faux temporisateurs.

Divers

jest.setTimeout(timeout)

Définit l'intervalle de temps par défaut (en millisecondes) pour tous les tests et avant/après les hooks dans le fichier de test. Cela n'affecte que le fichier de test à partir duquel cette fonction est appelée.

Pour définir des intervalles de temps sur des tests différents dans le même fichier, utilisez l'option timeout sur chaque test individuel.

Remarque : Le timeout par défaut est de 5 secondes si cette méthode n'est pas appelée.

Remarque : Si vous voulez définir le timeout pour tous les fichiers de test, un bon endroit pour le faire est dans setupFilesAfterEnv.

Exemple :

jest.setTimeout(1000); // 1 seconde

jest.retryTimes(numRetries, options)

Exécute les tests échoués n-fois jusqu'à ce qu'ils passent ou jusqu'à ce que le nombre maximum de tentatives soit épuisé. Les options sont facultatives. Cela ne fonctionne qu'avec l'exécuteur par défaut jest-circus ! Il doit se trouver au niveau supérieur d'un fichier de test ou dans un bloc describe. Les nouvelles tentatives ne fonctionneront pas si jest.retryTimes() est appelé dans un bloc beforeEach ou test.

Exemple dans un test :

jest.retryTimes(3);
test('va échouer', () => {
expect(true).toBe(false);
});

Si logErrorsBeforeRetry est activé, Jest enregistrera la ou les erreurs qui ont causé l'échec du test dans la console, fournissant une visibilité sur la raison pour laquelle une nouvelle tentative s'est produite.

jest.retryTimes(3, {logErrorsBeforeRetry: true});
test('va échouer', () => {
expect(true).toBe(false);
});

Renvoie l'objet jest pour le chaînage.