Skip to main content

interface Deno.TestDefinition

Properties #

#fn: (t: TestContext) => void | Promise<void>
#name: string

The name of the test.

#ignore: boolean
optional

If truthy the current test step will be ignored.

It is a quick way to skip over a step, but also can be used for conditional logic, like determining if an environment feature is present.

#only: boolean
optional

If at least one test has only set to true, only run tests that have only set to true and fail the test suite.

#sanitizeOps: boolean = false
optional

Check that the number of async completed operations after the test step is the same as number of dispatched operations. This ensures that the code tested does not start async operations which it then does not await. This helps in preventing logic errors and memory leaks in the application code.

Can also be enabled globally with the --sanitize-ops CLI flag, the DENO_TEST_SANITIZE_OPS=1 environment variable, or the test.sanitizeOps option in deno.json. Can be set per-module with Deno.test.sanitizer.

#sanitizeResources: boolean = false
optional

Ensure the test step does not "leak" resources - like open files or network connections - by ensuring the open resources at the start of the test match the open resources at the end of the test.

Can also be enabled globally with the --sanitize-resources CLI flag, the DENO_TEST_SANITIZE_RESOURCES=1 environment variable, or the test.sanitizeResources option in deno.json. Can be set per-module with Deno.test.sanitizer.

#sanitizeExit: boolean = true
optional

Ensure the test case does not prematurely cause the process to exit, for example via a call to Deno.exit.

#permissions: PermissionOptions = "inherit"
optional

Specifies the permissions that should be used to run the test.

Set this to "inherit" to keep the calling runtime permissions, set this to "none" to revoke all permissions, or set a more specific set of permissions using a PermissionOptionsObject.

#timeout: number
optional

Maximum duration in milliseconds that the test is allowed to run before being marked as a failed test. Both asynchronous hangs and synchronous hot loops are caught.

If unset or 0, the test runs without a deadline.

Did you find what you needed?

Privacy policy