Expanded jsdocs for jasmine.DEFAULT_TIMEOUT_INTERVAL

This commit is contained in:
Steve Gravrock
2021-09-25 13:29:44 -07:00
parent af1b43eeff
commit 7fc3408051
2 changed files with 34 additions and 14 deletions

View File

@@ -174,32 +174,42 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) {
/** /**
* Maximum object depth the pretty printer will print to. * Maximum object depth the pretty printer will print to.
* Set this to a lower value to speed up pretty printing if you have large objects. The default value is 8. * Set this to a lower value to speed up pretty printing if you have large objects.
* @name jasmine.MAX_PRETTY_PRINT_DEPTH * @name jasmine.MAX_PRETTY_PRINT_DEPTH
* @default 8
* @since 1.3.0 * @since 1.3.0
*/ */
j$.MAX_PRETTY_PRINT_DEPTH = 8; j$.MAX_PRETTY_PRINT_DEPTH = 8;
/** /**
* Maximum number of array elements to display when pretty printing objects. * Maximum number of array elements to display when pretty printing objects.
* This will also limit the number of keys and values displayed for an object. * This will also limit the number of keys and values displayed for an object.
* Elements past this number will be ellipised. The default value is 50. * Elements past this number will be ellipised.
* @name jasmine.MAX_PRETTY_PRINT_ARRAY_LENGTH * @name jasmine.MAX_PRETTY_PRINT_ARRAY_LENGTH
* @default 50
* @since 2.7.0 * @since 2.7.0
*/ */
j$.MAX_PRETTY_PRINT_ARRAY_LENGTH = 50; j$.MAX_PRETTY_PRINT_ARRAY_LENGTH = 50;
/** /**
* Maximum number of characters to display when pretty printing objects. * Maximum number of characters to display when pretty printing objects.
* Characters past this number will be ellipised. The default value is 1000. * Characters past this number will be ellipised.
* @name jasmine.MAX_PRETTY_PRINT_CHARS * @name jasmine.MAX_PRETTY_PRINT_CHARS
* @default 100
* @since 2.9.0 * @since 2.9.0
*/ */
j$.MAX_PRETTY_PRINT_CHARS = 1000; j$.MAX_PRETTY_PRINT_CHARS = 1000;
/** /**
* Default number of milliseconds Jasmine will wait for an asynchronous spec to complete. * Default number of milliseconds Jasmine will wait for an asynchronous spec,
* While debugging tests, you may want to set this to a large * before, or after function to complete. This can be overridden on a case by
* number no bigger than 2147483647 so that `before` or `after` hooks do not run in the middle of an * case basis by passing a time limit as the third argument to {@link it},
* async test that you are stepping through in a debugger. The default value is 5000. * {@link beforeEach}, {@link afterEach}, {@link beforeAll}, or
* {@link afterAll}. The value must be no greater than the largest number of
* milliseconds supported by setTimeout, which is usually 2147483647.
*
* While debugging tests, you may want to set this to a large number (or pass
* a large number to one of the functions mentioned above) so that Jasmine
* does not move on to after functions or the next spec while you're debugging.
* @name jasmine.DEFAULT_TIMEOUT_INTERVAL * @name jasmine.DEFAULT_TIMEOUT_INTERVAL
* @default 5000
* @since 1.3.0 * @since 1.3.0
*/ */
j$.DEFAULT_TIMEOUT_INTERVAL = 5000; j$.DEFAULT_TIMEOUT_INTERVAL = 5000;

View File

@@ -5,32 +5,42 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) {
/** /**
* Maximum object depth the pretty printer will print to. * Maximum object depth the pretty printer will print to.
* Set this to a lower value to speed up pretty printing if you have large objects. The default value is 8. * Set this to a lower value to speed up pretty printing if you have large objects.
* @name jasmine.MAX_PRETTY_PRINT_DEPTH * @name jasmine.MAX_PRETTY_PRINT_DEPTH
* @default 8
* @since 1.3.0 * @since 1.3.0
*/ */
j$.MAX_PRETTY_PRINT_DEPTH = 8; j$.MAX_PRETTY_PRINT_DEPTH = 8;
/** /**
* Maximum number of array elements to display when pretty printing objects. * Maximum number of array elements to display when pretty printing objects.
* This will also limit the number of keys and values displayed for an object. * This will also limit the number of keys and values displayed for an object.
* Elements past this number will be ellipised. The default value is 50. * Elements past this number will be ellipised.
* @name jasmine.MAX_PRETTY_PRINT_ARRAY_LENGTH * @name jasmine.MAX_PRETTY_PRINT_ARRAY_LENGTH
* @default 50
* @since 2.7.0 * @since 2.7.0
*/ */
j$.MAX_PRETTY_PRINT_ARRAY_LENGTH = 50; j$.MAX_PRETTY_PRINT_ARRAY_LENGTH = 50;
/** /**
* Maximum number of characters to display when pretty printing objects. * Maximum number of characters to display when pretty printing objects.
* Characters past this number will be ellipised. The default value is 1000. * Characters past this number will be ellipised.
* @name jasmine.MAX_PRETTY_PRINT_CHARS * @name jasmine.MAX_PRETTY_PRINT_CHARS
* @default 100
* @since 2.9.0 * @since 2.9.0
*/ */
j$.MAX_PRETTY_PRINT_CHARS = 1000; j$.MAX_PRETTY_PRINT_CHARS = 1000;
/** /**
* Default number of milliseconds Jasmine will wait for an asynchronous spec to complete. * Default number of milliseconds Jasmine will wait for an asynchronous spec,
* While debugging tests, you may want to set this to a large * before, or after function to complete. This can be overridden on a case by
* number no bigger than 2147483647 so that `before` or `after` hooks do not run in the middle of an * case basis by passing a time limit as the third argument to {@link it},
* async test that you are stepping through in a debugger. The default value is 5000. * {@link beforeEach}, {@link afterEach}, {@link beforeAll}, or
* {@link afterAll}. The value must be no greater than the largest number of
* milliseconds supported by setTimeout, which is usually 2147483647.
*
* While debugging tests, you may want to set this to a large number (or pass
* a large number to one of the functions mentioned above) so that Jasmine
* does not move on to after functions or the next spec while you're debugging.
* @name jasmine.DEFAULT_TIMEOUT_INTERVAL * @name jasmine.DEFAULT_TIMEOUT_INTERVAL
* @default 5000
* @since 1.3.0 * @since 1.3.0
*/ */
j$.DEFAULT_TIMEOUT_INTERVAL = 5000; j$.DEFAULT_TIMEOUT_INTERVAL = 5000;