# Class: TestCompletion

## vertx-unit-js/test_completion~ TestCompletion

#### new TestCompletion()

This object provides callback-ability for the end of a test suite, the completion succeeds when all tests pass otherwise it fails.

Source:
  - vertx-unit-js/test_completion.js, line 32

### Methods

#### await(timeoutMillis)

Cause the current thread to wait until this completion completes with a configurable timeout.

If completion times out or the current thread is interrupted, an exception will be thrown.

##### Parameters:

Name | Type | Description
--- | --- | ---
`timeoutMillis` | number | the timeout in milliseconds

Source:
  - vertx-unit-js/test_completion.js, line 117

#### awaitSuccess(timeoutMillis)

Cause the current thread to wait until this completion completes and succeeds with a configurable timeout.

If completion times out or the current thread is interrupted or the suite fails, an exception will be thrown.

##### Parameters:

Name | Type | Description
--- | --- | ---
`timeoutMillis` | number | the timeout in milliseconds

Source:
  - vertx-unit-js/test_completion.js, line 134

#### handler(completionHandler)

Completion handler to receive a completion signal when this completions completes.

##### Parameters:

Name | Type | Description
--- | --- | ---
`completionHandler` | function | the completion handler

Source:
  - vertx-unit-js/test_completion.js, line 96

#### isCompleted() → {boolean}

Source:
  - vertx-unit-js/test_completion.js, line 57

##### Returns:

true if this completion is completed

Type
  boolean

#### isFailed() → {boolean}

Source:
  - vertx-unit-js/test_completion.js, line 83

##### Returns:

true if the this completion is completed and failed

Type
  boolean

#### isSucceeded() → {boolean}

Source:
  - vertx-unit-js/test_completion.js, line 70

##### Returns:

true if the this completion is completed succeeded

Type
  boolean

#### resolve(future)

Completes the future upon completion, otherwise fails it.

##### Parameters:

Name | Type | Description
--- | --- | ---
`future` | Future | the future to resolve

Source:
  - vertx-unit-js/test_completion.js, line 44