-
Notifications
You must be signed in to change notification settings - Fork 4
Add tags docs #107
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add tags docs #107
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import Version from "../../_partials/specs/version.mdx"; | ||
|
|
||
| # addTag | ||
|
|
||
| <Version version="8.37.0" /> | ||
|
|
||
| ## Overview {#overview} | ||
|
|
||
| Use the `addTag` command to add a tag (or multiple tags) to a test during execution. | ||
|
|
||
| ## Usage {#usage} | ||
|
|
||
| ```typescript | ||
| await browser.addTag("one"); | ||
| await browser.addTag(["first", "second"]); | ||
| ``` | ||
|
|
||
| Also, the test object now has methods to add a tag, get a list of tags, and check if a tag exists. | ||
| You can use it in your plugin where you have access to test objects. | ||
|
|
||
| ```typescript | ||
| type TestTag = { | ||
| title: string; | ||
| dynamic?: boolean; | ||
| }; | ||
|
|
||
| function addTag(tag: string | string[]): void; | ||
| function hasTag(tag: string): boolean; | ||
| function getTag(): TestTag[]; | ||
| ``` | ||
|
|
||
| `getTag` returns an array of the tag objects mentioned above. | ||
| Each object has a `title` and a `dynamic` field, which indicates that the tag was added during the test. | ||
|
|
||
| ## Command Parameters {#parameters} | ||
|
|
||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <td>**Name**</td> | ||
| <td>**Type**</td> | ||
| <td>**Description**</td> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>tag</td> | ||
| <td>`string | string[]`</td> | ||
| <td>Required parameter. Name of tag or tags.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
52 changes: 52 additions & 0 deletions
52
i18n/ru/docusaurus-plugin-content-docs/current/commands/browser/addTag.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import Version from "../../_partials/specs/version.mdx"; | ||
|
|
||
| # addTag | ||
|
|
||
| <Version version="8.37.0" /> | ||
|
|
||
| ## Обзор {#overview} | ||
|
|
||
| Используйте команду `addTag`, чтобы добавить один или несколько тегов к тесту во время его выполнения. | ||
|
|
||
| ## Использование {#usage} | ||
|
|
||
| ```typescript | ||
| await browser.addTag("one"); | ||
| await browser.addTag(["first", "second"]); | ||
| ``` | ||
|
|
||
| Также, объект теста теперь имеет методы для добавления тега, получения списка тегов и проверки существования тега. | ||
| Вы можете использовать это в своём плагине где у вас есть доступ к объектам тестов. | ||
|
|
||
| ```typescript | ||
| type TestTag = { | ||
| title: string; | ||
| dynamic?: boolean; | ||
| }; | ||
|
|
||
| function addTag(tag: string | string[]): void; | ||
| function hasTag(tag: string): boolean; | ||
| function getTag(): TestTag[]; | ||
| ``` | ||
|
|
||
| Метод `getTag` возвращает массив объектов тегов, которые были упомянуты выше. | ||
| Каждый объект имеет поле `title` и поле `dynamic`, которое указывает на то, что тег был добавлен в процессе теста. | ||
|
|
||
| ## Параметры команды {#parameters} | ||
|
|
||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <td>**Имя**</td> | ||
| <td>**Тип**</td> | ||
| <td>**Описание**</td> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>tag</td> | ||
| <td>`string | string[]`</td> | ||
| <td>Обязательный параметр. Название тега или тегов.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing example of setting multiple tags in one suite/test
There should be example where
tagis array