backend-test-utils: API report warnings cleanup
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
@@ -5,13 +5,9 @@
|
||||
```ts
|
||||
import { Knex } from 'knex';
|
||||
|
||||
// Warning: (ae-missing-release-tag) "isDockerDisabledForTests" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export function isDockerDisabledForTests(): boolean;
|
||||
|
||||
// Warning: (ae-missing-release-tag) "TestDatabaseId" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public
|
||||
export type TestDatabaseId =
|
||||
| 'POSTGRES_13'
|
||||
@@ -19,8 +15,6 @@ export type TestDatabaseId =
|
||||
| 'MYSQL_8'
|
||||
| 'SQLITE_3';
|
||||
|
||||
// Warning: (ae-missing-release-tag) "TestDatabases" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public
|
||||
export class TestDatabases {
|
||||
static create(options?: {
|
||||
@@ -29,7 +23,6 @@ export class TestDatabases {
|
||||
}): TestDatabases;
|
||||
// (undocumented)
|
||||
eachSupportedId(): [TestDatabaseId][];
|
||||
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
|
||||
init(id: TestDatabaseId): Promise<Knex>;
|
||||
// (undocumented)
|
||||
supports(id: TestDatabaseId): boolean;
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user