@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
54 lines (38 loc) • 1.61 kB
Markdown
---
lang: en
title: 'API docs: testlab.skipif'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/testlab
permalink: /doc/en/lb4/apidocs.testlab.skipif.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/testlab](./testlab.md) > [skipIf](./testlab.skipif.md)
## skipIf() function
Helper function for skipping tests when a certain condition is met.
<b>Signature:</b>
```typescript
export declare function skipIf<ARGS extends unknown[], RETVAL>(skip: boolean, verb: TestDefinition<ARGS, RETVAL> & {
skip: TestDefinition<ARGS, RETVAL>;
}, name: string, ...args: ARGS): RETVAL;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| skip | boolean | Should the test case/suite be skipped? |
| verb | [TestDefinition](./testlab.testdefinition.md)<!-- --><ARGS, RETVAL> & { skip: [TestDefinition](./testlab.testdefinition.md)<!-- --><ARGS, RETVAL>; } | The function to invoke to define the test case or the test suite, e.g. <code>it</code> or <code>describe</code>. |
| name | string | The test name (the first argument of <code>verb</code> function). |
| args | ARGS | Additional arguments (framework specific), typically a function implementing the test. |
<b>Returns:</b>
RETVAL
## Example
```ts
skipIf(
!features.freeFormProperties,
describe,
'free-form properties (strict: false)',
() => {
// the tests
}
);
```