Skip to content

Commit

Permalink
fix: fixing options table on session's api page
Browse files Browse the repository at this point in the history
  • Loading branch information
elylucas committed Jan 26, 2023
1 parent 348898f commit f822d18
Showing 1 changed file with 4 additions and 13 deletions.
17 changes: 4 additions & 13 deletions docs/api/commands/session.mdx
Original file line number Diff line number Diff line change
@@ -111,19 +111,10 @@ before `setup` runs, regardless of the `testIsolation` configuration.

**<Icon name="angle-right" /> options** **_(Object)_**

| Option | Default | Description g | | ------------------ | ----------- | | |
`validate` | `undefined` | Validates the newly-created or restored
session.<br/><br/>Function to run immediately after the session is created and
`setup` function runs or after a session is restored and the page is cleared. If
it throws an exception, contains any failing Cypress command, returns a Promise
which rejects or resolves to `false`, or the last Cypress command yielded
`false`, the session is considered invalid.<br/><br/>- If validation fails
immediately after `setup`, the test will fail.<br/>- If validation fails after
restoring a session, `setup` will re-run. | | `cacheAcrossSpecs` | `false` |
When enabled, the newly created session is considered "global" and can be
restored in any spec during the test execution in the same Cypress run on the
same machine. Use this option for a session that will be used multiple times,
across many specs. |
| Option | Default | Description |
| ------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `validate` | `undefined` | Validates the newly-created or restored session. Function to run immediately after the session is created and `setup` function runs or after a session is restored and the page is cleared. If it throws an exception, contains any failing Cypress command, returns a Promise which rejects or resolves to `false`, or the last Cypress command yielded `false`, the session is considered invalid.<br/><br/>- If validation fails immediately after `setup`, the test will fail.<br/>- If validation fails after restoring a session, `setup` will re-run. |
| `cacheAcrossSpecs` | `false` | When enabled, the newly created session is considered "global" and can be restored in any spec during the test execution in the same Cypress run on the same machine. Use this option for a session that will be used multiple times, across many specs. |

### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management)

0 comments on commit f822d18

Please sign in to comment.