Skip to content

docs: improve the example code for autoLogin #4019

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.

Sign up for GitHub

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 1 commit into from
Nov 22, 2023
Merged

docs: improve the example code for autoLogin #4019

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,14 @@ If a session expires automatically logs in again.
```js
// inside a test file
// use login to inject auto-login function
Feature('Login');

Before(({ login }) => {
login('user'); // login using user session
});

// Alternatively log in for one scenario
Scenario('log me in', ( {I, login} ) => {
// Alternatively log in for one scenario.
Scenario('log me in', ( { I, login } ) => {
login('admin');
I.see('I am logged in');
});
Expand Down
6 changes: 4 additions & 2 deletions lib/plugin/autoLogin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,14 @@ const defaultConfig = {
* ```js
* // inside a test file
* // use login to inject auto-login function
* Feature('Login');
*
* Before(({ login }) => {
* login('user'); // login using user session
* });
*
* // Alternatively log in for one scenario
* Scenario('log me in', ( {I, login} ) => {
* // Alternatively log in for one scenario.
* Scenario('log me in', ( { I, login } ) => {
* login('admin');
* I.see('I am logged in');
* });
Expand Down