Skip to content

Commit 4a9adfe

Browse files
doc: add fullName property to SuiteContext
Add documentation for the missing fullName property in SuiteContext class. This property returns the name of the suite and each of its ancestors, separated by '>'. The property has been available since v22.3.0 but was missing from the documentation. Fixes: #60757
1 parent 17fba60 commit 4a9adfe

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

doc/api/test.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1045,7 +1045,7 @@ test('runs timers as setTime passes ticks', (context) => {
10451045
## Snapshot testing
10461046

10471047
<!-- YAML
1048-
added: v22.3.0
1048+
added: v20.16.0
10491049
changes:
10501050
- version: v23.4.0
10511051
pr-url: https://github.com/nodejs/node/pull/55897
@@ -1915,7 +1915,7 @@ assertion already exists with the same name, it is overwritten.
19151915
## `snapshot`
19161916

19171917
<!-- YAML
1918-
added: v22.3.0
1918+
added: v20.16.0
19191919
-->
19201920

19211921
An object whose methods are used to configure default snapshot settings in the
@@ -1926,7 +1926,7 @@ placing common configuration code in a module preloaded with `--require` or
19261926
### `snapshot.setDefaultSnapshotSerializers(serializers)`
19271927

19281928
<!-- YAML
1929-
added: v22.3.0
1929+
added: v20.16.0
19301930
-->
19311931

19321932
* `serializers` {Array} An array of synchronous functions used as the default
@@ -1941,7 +1941,7 @@ more robust serialization mechanism is required, this function should be used.
19411941
### `snapshot.setResolveSnapshotPath(fn)`
19421942

19431943
<!-- YAML
1944-
added: v22.3.0
1944+
added: v20.16.0
19451945
-->
19461946

19471947
* `fn` {Function} A function used to compute the location of the snapshot file.
@@ -3602,7 +3602,7 @@ highlighting.
36023602
#### `context.assert.snapshot(value[, options])`
36033603

36043604
<!-- YAML
3605-
added: v22.3.0
3605+
added: v20.16.0
36063606
-->
36073607

36083608
* `value` {any} A value to serialize to a string. If Node.js was started with
@@ -3667,7 +3667,7 @@ the path of the root test file.
36673667
### `context.fullName`
36683668

36693669
<!-- YAML
3670-
added: v22.3.0
3670+
added: v20.16.0
36713671
-->
36723672

36733673
The name of the test and each of its ancestors, separated by `>`.
@@ -3970,6 +3970,14 @@ The absolute path of the test file that created the current suite. If a test
39703970
file imports additional modules that generate suites, the imported suites will
39713971
return the path of the root test file.
39723972

3973+
### `context.fullName`
3974+
3975+
<!-- YAML
3976+
added: v20.16.0
3977+
-->
3978+
3979+
The name of the suite and each of its ancestors, separated by `>`.
3980+
39733981
### `context.name`
39743982

39753983
<!-- YAML

0 commit comments

Comments
 (0)