Глобальные
Методы
afterAll(functionopt, timeoutopt)
Выполнить общую завершающую операцию после выполнения всех спецификаций в describe.
Примечание: Будьте осторожны, так как совместное использование завершающей операции в afterAll может привести к случайной утечке состояния между вашими спецификациями, из-за чего они могут ошибочно пройти или не пройти.
Параметры:
| Имя | Тип | Атрибуты | Значение по умолчанию | Описание |
|---|---|---|---|---|
function | implementationCallback | <необязательный> | Функция, содержащая код для завершения выполнения спецификаций. | |
timeout | Int | <необязательный> | jasmine.DEFAULT_TIMEOUT_INTERVAL | Настройка таймаута для асинхронного afterAll. |
- С:
- 2.1.0
- См.:
afterEach(functionopt, timeoutopt)
Выполнить общую завершающую операцию после каждой спецификации в describe, в котором она вызывается.
Параметры:
| Имя | Тип | Атрибуты | Значение по умолчанию | Описание |
|---|---|---|---|---|
function | implementationCallback | <необязательный> | Функция, содержащая код для завершения выполнения спецификаций. | |
timeout | Int | <необязательный> | jasmine.DEFAULT_TIMEOUT_INTERVAL | Настройка таймаута для асинхронного afterEach. |
- С:
- 1.3.0
- См.:
beforeAll(functionopt, timeoutopt)
Выполнить общую подготовительную операцию перед выполнением всех спецификаций в describe.
Примечание: Будьте осторожны, так как совместное использование подготовительной операции в beforeAll может привести к случайной утечке состояния между вашими спецификациями, из-за чего они могут ошибочно пройти или не пройти.
Параметры:
| Имя | Тип | Атрибуты | Значение по умолчанию | Описание |
|---|---|---|---|---|
function | implementationCallback | <необязательный> | Функция, содержащая код для подготовки выполнения спецификаций. | |
timeout | Int | <необязательный> | jasmine.DEFAULT_TIMEOUT_INTERVAL | Настройка таймаута для асинхронного beforeAll. |
- С:
- 2.1.0
- См.:
beforeEach(functionopt, timeoutopt)
Выполнить общую подготовительную операцию перед каждой спецификацией в describe, в котором она вызывается.
Параметры:
| Имя | Тип | Атрибуты | Значение по умолчанию | Описание |
|---|---|---|---|---|
function | implementationCallback | <необязательный> | Функция, содержащая код для подготовки выполнения спецификаций. | |
timeout | Int | <необязательный> | jasmine.DEFAULT_TIMEOUT_INTERVAL | Настройка таймаута для асинхронного beforeEach. |
- С:
- 1.3.0
- См.:
describe(description, specDefinitions)
Создайте группу спецификаций (часто называемую набором).
Вызовы describe могут быть вложены в другие вызовы для создания набора в виде дерева.
Параметры:
| Имя | Тип | Описание |
|---|---|---|
description | Строка | Текстовое описание группы |
specDefinitions | функция | Функция, которую Jasmine вызовет для определения внутренних наборов и спецификаций |
- С:
- 1.3.0
expect(actual) → {matchers}
Создайте ожидание для спецификации.
Параметры:
| Имя | Тип | Описание |
|---|---|---|
actual | Объект | Фактическое вычисленное значение для проверки ожиданий. |
- С:
- 1.3.0
Возвращает:
- Тип
- matchers
expectAsync(actual) → {async-matchers}
Создайте асинхронное ожидание для спецификации. Обратите внимание, что все мачеры, предоставленные асинхронным ожиданием, возвращают промисы, которые должны быть возвращены из спецификации или ожидания с помощью await для того, чтобы Jasmine связал их с соответствующей спецификацией.
Параметры:
| Имя | Тип | Описание |
|---|---|---|
actual | Объект | Фактическое вычисленное значение для проверки ожиданий. |
- С:
- 3.3.0
Возвращает:
- Тип
- async-matchers
Примеры
await expectAsync(somePromise).toBeResolved();
return expectAsync(somePromise).toBeResolved();
fail(erroropt)
Явно пометить спецификацию как не пройденную.
Параметры:
| Имя | Тип | Атрибуты | Описание |
|---|---|---|---|
error | Строка | Ошибка | <необязательный> | Причина сбоя. |
- С:
- 2.1.0
fdescribe(description, specDefinitions)
Фокусированный describe
Если наборы или спецификации сфокусированы, будут выполнены только те, которые сфокусированы
Параметры:
| Имя | Тип | Описание |
|---|---|---|
description | Строка | Текстовое описание группы |
specDefinitions | функция | Функция, которую Jasmine вызовет для определения внутренних наборов и спецификаций |
- С:
- 2.1.0
- См.:
fit(description, testFunction, timeoutopt)
Фокусированный it
Если наборы или спецификации сфокусированы, будут выполнены только те, которые сфокусированы.
Параметры:
| Имя | Тип | Атрибуты | Значение по умолчанию | Описание |
|---|---|---|---|---|
description | String | Текстовое описание того, что проверяет этот спецификатор. | ||
testFunction | implementationCallback | Функция, содержащая код вашего теста. | ||
timeout | Int | <optional> | jasmine.DEFAULT_TIMEOUT_INTERVAL | Настройка таймаута для асинхронного спецификатора. |
- С момента:
- 2.1.0
- См.:
it(описание, функция_тестаopt, таймаутopt)
Определение одного спецификатора. Спецификатор должен содержать одну или несколько инструкций expectations, которые проверяют состояние кода.
Спецификатор, все ожидания которого выполнены успешно, будет пройден, а спецификатор с любыми ошибками будет не пройден. Имя it — это местоимение для целевого теста, а не сокращение. Оно делает спецификатор более удобочитаемым, связывая имя функции it и аргумент description в полное предложение.
Параметры:
| Имя | Тип | Атрибуты | Значение по умолчанию | Описание |
|---|---|---|---|---|
description | String | Текстовое описание того, что проверяет этот спецификатор | ||
testFunction | implementationCallback | <optional> | Функция, содержащая код вашего теста. Если не указана, тест будет | |
timeout | Int | <optional> | jasmine.DEFAULT_TIMEOUT_INTERVAL | Настройка таймаута для асинхронного спецификатора. |
- С момента:
- 1.3.0
- См.:
pending(сообщениеopt)
Отметить спецификатор как приостановленный, результаты ожиданий будут проигнорированы.
Параметры:
| Имя | Тип | Атрибуты | Описание |
|---|---|---|---|
message | String | <optional> | Причина приостановки спецификатора. |
- С момента:
- 2.0.0
setSpecProperty(ключ, значение)
Устанавливает пользовательское свойство, которое будет предоставлено репортерам как часть поля свойств SpecResult
Параметры:
| Имя | Тип | Описание |
|---|---|---|
key | String | Название свойства |
value | * | Значение свойства |
- С момента:
- 3.6.0
setSuiteProperty(ключ, значение)
Устанавливает пользовательское свойство, которое будет предоставлено репортерам как часть поля свойств SuiteResult
Параметры:
| Имя | Тип | Описание |
|---|---|---|
key | String | Название свойства |
value | * | Значение свойства |
- С момента:
- 3.6.0
spyOn(объект, имя_метода) → {Spy}
Установить шпион на существующий объект.
Параметры:
| Имя | Тип | Описание |
|---|---|---|
obj | Object | Объект, на котором нужно установить |
methodName | String | Название метода, который нужно заменить на |
- С момента:
- 1.3.0
Возвращаемое значение:
- Тип
- Spy
spyOnAllFunctions(объект, включатьНеПеречисляемые) → {Object}
Установка шпионов на все изменяемые и настраиваемые свойства объекта.
Параметры:
| Имя | Тип | Описание |
|---|---|---|
obj | Object | Объект, на котором нужно установить |
includeNonEnumerable | boolean | Включать ли шпионы для неперечисляемых свойств |
- С момента:
- 3.2.1
Возвращаемое значение:
объект со шпионом
- Тип
- Object
spyOnProperty(объект, имя_свойства, тип_доступаopt) → {Spy}
Установка шпиона на свойство, установленное с Object.defineProperty на существующий объект.
Параметры:
| Имя | Тип | Атрибуты | Значение по умолчанию | Описание |
|---|---|---|---|---|
obj | Object | Объект, на котором нужно установить | ||
propertyName | String | Название свойства, которое нужно заменить на | ||
accessType | String | <optional> | get | Тип доступа (get|set) свойства, на котором нужно установить |
- С момента:
- 2.6.0
Возвращаемое значение:
- Тип
- Spy
xdescribe(описание, спецификации)
Временно отключенное описание describe
Спецификаторы внутри xdescribe будут помечены как приостановленные и не будут выполнены
Параметры:
| Имя | Тип | Описание |
|---|---|---|
description | String | Текстовое описание группы |
specDefinitions | function | Функция, которую Jasmine вызовет, которая определит внутренние наборы и спецификаторы |
- С момента:
- 1.3.0
xit(описание, функция_тестаopt)
Временно отключенный it
Спецификатор будет отображен как pending и не будет выполнен.
Параметры:
| Имя | Тип | Атрибуты | Описание |
|---|---|---|---|
description | Строка | Текстовое описание того, что проверяет данный тест. | |
testFunction | implementationCallback | <необязательно> | Функция, содержащая код вашего теста. Не будет выполняться. |
- С:
- 1.3.0
Определения типов
DebugLogEntry
Свойства:
| Имя | Тип | Описание |
|---|---|---|
message | Строка | Сообщение, переданное в |
timestamp | число | Время добавления записи в миллисекундах с начала выполнения теста. |
Expectation
Свойства:
| Имя | Тип | Описание |
|---|---|---|
matcherName | Строка | Имя матчера, выполняемого для данного ожидания. |
message | Строка | Сообщение об ошибке ожидания. |
stack | Строка | Стек вызовов ошибки, если доступен. |
passed | Булево | Прошло ли ожидание или нет. |
expected | Объект | Если ожидание не выполнено, ожидаемое значение. |
actual | Объект | Если ожидание не выполнено, фактическое значение. |
globalErrorType | Строка | undefined | Тип ошибки, сообщаемой о глобальной группе тестов. Допустимые значения: undefined, "afterAll", "load", "lateExpectation", и "lateError". |
implementationCallback(doneнеобязательно)
Обратный вызов, передаваемый в части базового интерфейса Jasmine.
По умолчанию Jasmine предполагает, что эта функция выполняется синхронно. Если вам нужно протестировать код асинхронно, вы можете указать, что получаете done обратный вызов, вернуть Promise или использовать ключевое слово async, если оно поддерживается вашей средой.
Параметры:
| Имя | Тип | Атрибуты | Описание |
|---|---|---|---|
done | функция | <необязательно> | Указывает Jasmine, что этот обратный вызов является асинхронным, и Jasmine должен подождать его вызова, прежде чем продолжать. |
Возвращаемое значение:
Вместо использования done, вы можете вернуть Promise, чтобы Jasmine дождался завершения.
JasmineDoneInfo
Информация, передаваемая событию Reporter#jasmineDone.
Свойства:
| Имя | Тип | Описание |
|---|---|---|
overallStatus | OverallStatus | Общий результат группы тестов: 'passed', 'failed', или 'incomplete'. |
totalTime | Целое число | Общее время (в мс) выполнения группы тестов. |
incompleteReason | IncompleteReason | Объяснение, почему группа тестов была неполной. |
order | Порядок | Информация о порядке (случайном или нет) выполнения группы тестов. |
failedExpectations | Массив.<Expectation> | Список ожиданий, которые не прошли в |
deprecationWarnings | Массив.<Expectation> | Список предупреждений о устаревании, возникших на глобальном уровне. |
- С:
- 2.4.0
JasmineStartedInfo
Информация, передаваемая событию Reporter#jasmineStarted.
Свойства:
| Имя | Тип | Описание |
|---|---|---|
totalSpecsDefined | Целое число | Общее количество тестов, определенных в этой группе. |
order | Порядок | Информация о порядке (случайном или нет) выполнения группы тестов. |
- С:
- 2.0.0
SpecFilter(spec)
Функция, которая принимает тест и возвращает true, если он должен быть выполнен, или false, если он должен быть пропущен.
Параметры:
| Имя | Тип | Описание |
|---|---|---|
spec | Spec | Тест, к которому применяется фильтр. |
Возвращаемое значение:
boolean
SpecResult
Свойства:
| Имя | Тип | Описание |
|---|---|---|
id | Целое число | Уникальный идентификатор этого теста. |
description | Строка | Описание, переданное в |
fullName | Строка | Полное описание, включая всех предков этого теста. |
failedExpectations | Массив.<Expectation> | Список ожиданий, которые не прошли во время выполнения этого теста. |
passedExpectations | Массив.<Expectation> | Список ожиданий, которые прошли во время выполнения этого теста. |
deprecationWarnings | Массив.<Expectation> | Список предупреждений о устаревании, возникших во время выполнения этого теста. |
pendingReason | Строка | Если тест |
status | Строка | После завершения теста, эта строка представляет статус прохождения/непрохождения этого теста. |
duration | число | Время в мс, используемое для выполнения теста, включая любые before/afterEach. |
properties | Объект | Пользовательские свойства, если таковые имеются, установленные с помощью |
debugLogs | Массив.<DebugLogEntry> | null | Сообщения, если таковые имеются, которые были записаны с помощью |
- С:
- 2.0.0
SuiteResult
Свойства:
| Имя | Тип | Описание |
|---|---|---|
id | Int | Уникальный идентификатор этого набора. |
description | String | Текст описания, переданный в |
fullName | String | Полное описание, включая всех предков этого набора. |
failedExpectations | Array.<Expectation> | Список ожиданий, которые не выполнились в |
deprecationWarnings | Array.<Expectation> | Список предупреждений об устаревших функциях, которые произошли в этом наборе. |
status | String | После завершения набора эта строка представляет собой статус прохождения/непрохождения этого набора. |
duration | number | Время выполнения набора в мс, включая любые before/afterAll, before/afterEach. |
properties | Object | Свойства, заданные пользователем, если таковые имеются, с помощью |
- Since:
- 2.0.0
© 2008–2019 Pivotal Labs
Licensed under the MIT License.
https://jasmine.github.io/api/4.0/global.html
