docs-v2/content/flux/v0/stdlib/internal/testutil/fail.md

43 lines
1.2 KiB
Markdown

---
title: testutil.fail() function
description: >
`testutil.fail()` causes the current script to fail.
menu:
flux_v0_ref:
name: testutil.fail
parent: internal/testutil
identifier: internal/testutil/fail
weight: 201
---
<!------------------------------------------------------------------------------
IMPORTANT: This page was generated from comments in the Flux source code. Any
edits made directly to this page will be overwritten the next time the
documentation is generated.
To make updates to this documentation, update the function comments above the
function definition in the Flux source code:
https://github.com/influxdata/flux/blob/master/stdlib/internal/testutil/testutil.flux#L9-L9
Contributing to Flux: https://github.com/influxdata/flux#contributing
Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md
------------------------------------------------------------------------------->
`testutil.fail()` causes the current script to fail.
##### Function type signature
```js
() => bool
```
{{% caption %}}
For more information, see [Function type signatures](/flux/v0/function-type-signatures/).
{{% /caption %}}