|
| 1 | +/* eslint-disable @typescript-eslint/ban-ts-comment */ |
1 | 2 | // Copyright (c) Jupyter Development Team.
|
2 | 3 | // Distributed under the terms of the Modified BSD License.
|
3 | 4 |
|
@@ -82,9 +83,11 @@ export type GalataOptions = {
|
82 | 83 | * Mock JupyterLab settings in-memory or not.
|
83 | 84 | *
|
84 | 85 | * Possible values are:
|
85 |
| - * - true (default): JupyterLab settings will be mocked on a per test basis |
| 86 | + * - true: JupyterLab settings will be mocked on a per test basis |
86 | 87 | * - false: JupyterLab settings won't be mocked (Be careful it will read & write settings local files)
|
87 |
| - * - Record<string, unknown>: Mapping {pluginId: settings} that will override default settings |
| 88 | + * - Record<string, unknown>: Mapping {pluginId: settings} that will be default user settings |
| 89 | + * |
| 90 | + * The default value is `galata.DEFAULT_SETTINGS` |
88 | 91 | *
|
89 | 92 | * By default the settings are stored in-memory. However the
|
90 | 93 | * they are still initialized with the hard drive values.
|
@@ -165,14 +168,16 @@ export const test: TestType<
|
165 | 168 | * Mock JupyterLab settings in-memory or not.
|
166 | 169 | *
|
167 | 170 | * Possible values are:
|
168 |
| - * - true (default): JupyterLab settings will be mocked on a per test basis |
| 171 | + * - true: JupyterLab settings will be mocked on a per test basis |
169 | 172 | * - false: JupyterLab settings won't be mocked (Be careful it may write settings local files)
|
170 |
| - * - Record<string, unknown>: Mapping {pluginId: settings} that will override default settings |
| 173 | + * - Record<string, unknown>: Mapping {pluginId: settings} that will be default user settings |
| 174 | + * |
| 175 | + * The default value is `galata.DEFAULT_SETTINGS` |
171 | 176 | *
|
172 | 177 | * By default the settings are stored in-memory. However the
|
173 | 178 | * they are still initialized with the hard drive values.
|
174 | 179 | */
|
175 |
| - mockSettings: true, |
| 180 | + mockSettings: galata.DEFAULT_SETTINGS, |
176 | 181 | /**
|
177 | 182 | * Galata can keep the uploaded and created files in ``tmpPath`` on
|
178 | 183 | * the server root for debugging purpose. By default the files are kept
|
@@ -254,7 +259,7 @@ export const test: TestType<
|
254 | 259 | * JupyterLab test page.
|
255 | 260 | *
|
256 | 261 | * It brings the following feature on top of Playwright Page object:
|
257 |
| - * - Goto to JupyterLab URL and wait for the application to be ready |
| 262 | + * - Goto to JupyterLab URL and wait for the application to be ready (autoGoto == true) |
258 | 263 | * - Helpers for JupyterLab
|
259 | 264 | * - Settings mock-up
|
260 | 265 | * - State mock-up
|
|
0 commit comments