Added API docs for Suite#id and Spec#id

These properties are the only way to obtain runnable IDs, without which
you can't call the form of Env#execute that takes an array of IDs.
This commit is contained in:
Steve Gravrock
2021-07-29 19:32:15 -07:00
parent 286524959b
commit 43073b3bc5
3 changed files with 24 additions and 0 deletions

View File

@@ -712,6 +712,12 @@ getJasmineRequireObj().Spec = function(j$) {
this.expectationFactory = attrs.expectationFactory;
this.asyncExpectationFactory = attrs.asyncExpectationFactory;
this.resultCallback = attrs.resultCallback || function() {};
/**
* The unique ID of this spec.
* @name Spec#id
* @readonly
* @type {string}
*/
this.id = attrs.id;
/**
* The description passed to the {@link it} that created this spec.
@@ -9242,6 +9248,12 @@ getJasmineRequireObj().Suite = function(j$) {
*/
function Suite(attrs) {
this.env = attrs.env;
/**
* The unique ID of this suite.
* @name Suite#id
* @readonly
* @type {string}
*/
this.id = attrs.id;
/**
* The parent of this suite, or null if this is the top suite.

View File

@@ -7,6 +7,12 @@ getJasmineRequireObj().Spec = function(j$) {
this.expectationFactory = attrs.expectationFactory;
this.asyncExpectationFactory = attrs.asyncExpectationFactory;
this.resultCallback = attrs.resultCallback || function() {};
/**
* The unique ID of this spec.
* @name Spec#id
* @readonly
* @type {string}
*/
this.id = attrs.id;
/**
* The description passed to the {@link it} that created this spec.

View File

@@ -5,6 +5,12 @@ getJasmineRequireObj().Suite = function(j$) {
*/
function Suite(attrs) {
this.env = attrs.env;
/**
* The unique ID of this suite.
* @name Suite#id
* @readonly
* @type {string}
*/
this.id = attrs.id;
/**
* The parent of this suite, or null if this is the top suite.