@loopback/docs/site/apidocs/testlab.skipif.md

Documentation files rendered at [https://loopback.io](https://loopback.io)

---
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) &gt; [@loopback/testlab](./testlab.md) &gt; [skipIf](./testlab.skipif.md)

## skipIf() function

Helper function for skipping tests when a certain condition is met.

**Signature:**

```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

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

skip


</td><td markdown="1">

boolean


</td><td markdown="1">

Should the test case/suite be skipped?


</td></tr>
<tr><td markdown="1">

verb


</td><td markdown="1">

[TestDefinition](./testlab.testdefinition.md)<!-- -->&lt;ARGS, RETVAL&gt; &amp; { skip: [TestDefinition](./testlab.testdefinition.md)<!-- -->&lt;ARGS, RETVAL&gt;; }


</td><td markdown="1">

The function to invoke to define the test case or the test suite, e.g. `it` or `describe`<!-- -->.


</td></tr>
<tr><td markdown="1">

name


</td><td markdown="1">

string


</td><td markdown="1">

The test name (the first argument of `verb` function).


</td></tr>
<tr><td markdown="1">

args


</td><td markdown="1">

ARGS


</td><td markdown="1">

Additional arguments (framework specific), typically a function implementing the test.


</td></tr>
</tbody></table>

**Returns:**

RETVAL

## Example


```ts
skipIf(
  !features.freeFormProperties,
  describe,
 'free-form properties (strict: false)',
  () => {
    // the tests
  }
);
```