UNPKG

@clickup/ent-framework

Version:

A PostgreSQL graph-database-alike library with microsharding and row-level security

80 lines (48 loc) 1.97 kB
[**@clickup/ent-framework**](../README.md) *** [@clickup/ent-framework](../globals.md) / DenyIf # Class: DenyIf\<TInput\> Defined in: [src/ent/rules/DenyIf.ts:14](https://github.com/clickup/ent-framework/blob/master/src/ent/rules/DenyIf.ts#L14) Returns DENY if the predicate succeeds, otherwise SKIP. - Used mostly to early block some read/write access. - EntAccessError exception will be treated as a DENY signal (so it will abort processing immediately). - This rule may still throw an exception if the exception is a wild one (not derived from EntAccessError). ## Extends - [`Rule`](Rule.md)\<`TInput`\> ## Type Parameters | Type Parameter | | ------ | | `TInput` *extends* `object` | ## Constructors ### new DenyIf() > **new DenyIf**\<`TInput`\>(`predicate`): [`DenyIf`](DenyIf.md)\<`TInput`\> Defined in: [src/ent/rules/Rule.ts:43](https://github.com/clickup/ent-framework/blob/master/src/ent/rules/Rule.ts#L43) #### Parameters | Parameter | Type | | ------ | ------ | | `predicate` | [`Predicate`](../interfaces/Predicate.md)\<`TInput`\> \| (`vc`, `input`) => `boolean` \| `Promise`\<`boolean`\> | #### Returns [`DenyIf`](DenyIf.md)\<`TInput`\> #### Inherited from [`Rule`](Rule.md).[`constructor`](Rule.md#constructors) ## Properties | Property | Type | | ------ | ------ | | <a id="_tag"></a> `_TAG` | `"DenyIf"` | | <a id="predicate-1"></a> `predicate` | [`Predicate`](../interfaces/Predicate.md)\<`TInput`\> | | <a id="name"></a> `name` | `string` | ## Methods ### evaluate() > **evaluate**(`vc`, `input`): `Promise`\<[`RuleResult`](../interfaces/RuleResult.md)\> Defined in: [src/ent/rules/DenyIf.ts:17](https://github.com/clickup/ent-framework/blob/master/src/ent/rules/DenyIf.ts#L17) #### Parameters | Parameter | Type | | ------ | ------ | | `vc` | [`VC`](VC.md) | | `input` | `TInput` | #### Returns `Promise`\<[`RuleResult`](../interfaces/RuleResult.md)\> #### Overrides [`Rule`](Rule.md).[`evaluate`](Rule.md#evaluate)