rc-js-util/docs/rc-js-util.promiserejectfalse.md

A collection of TS and C++ utilities to help writing performant and correct applications, achieved through strict typing and (removable) invariant checking.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [rc-js-util](./rc-js-util.md) &gt; [promiseRejectFalse](./rc-js-util.promiserejectfalse.md)

## promiseRejectFalse() function

Returns a Promise of rejection with the supplied error if the `value` is false.

**Signature:**

```typescript
export declare function promiseRejectFalse(value: Promise<boolean> | boolean, error: unknown): Promise<void>;
```

## Parameters

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

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

value


</td><td>

Promise&lt;boolean&gt; \| boolean


</td><td>


</td></tr>
<tr><td>

error


</td><td>

unknown


</td><td>


</td></tr>
</tbody></table>
**Returns:**

Promise&lt;void&gt;

## Remarks

See [promiseRejectFalse()](./rc-js-util.promiserejectfalse.md)<!-- -->.