backend-test-utils: API report warnings cleanup

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2021-09-05 19:35:14 +02:00
parent 88f1597175
commit 4a8502d414
4 changed files with 6 additions and 8 deletions
@@ -31,6 +31,8 @@ import {
/**
* Encapsulates the creation of ephemeral test database instances for use
* inside unit or integration tests.
*
* @public
*/
export class TestDatabases {
private readonly instanceById: Map<string, Instance>;
@@ -113,7 +115,7 @@ export class TestDatabases {
* Returns a fresh, unique, empty logical database on an instance of the
* given database ID platform.
*
* @param id The ID of the database platform to use, e.g. 'POSTGRES_13'
* @param id - The ID of the database platform to use, e.g. 'POSTGRES_13'
* @returns A `Knex` connection object
*/
async init(id: TestDatabaseId): Promise<Knex> {
@@ -19,6 +19,8 @@ import { Knex } from 'knex';
/**
* The possible databases to test against.
*
* @public
*/
export type TestDatabaseId =
| 'POSTGRES_13'
@@ -14,6 +14,7 @@
* limitations under the License.
*/
/** @public */
export function isDockerDisabledForTests() {
// If we are not running in continuous integration, the default is to skip
// the (relatively heavy, long running) docker based tests. If you want to