@clickup/ent-framework
Version:
A PostgreSQL graph-database-alike library with microsharding and row-level security
73 lines (43 loc) • 1.98 kB
Markdown
[**/ent-framework**](../README.md)
***
[/ent-framework](../globals.md) / CanDeleteOutgoingEdge
# Class: CanDeleteOutgoingEdge\<TField\>
Defined in: [src/ent/predicates/CanDeleteOutgoingEdge.ts:10](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanDeleteOutgoingEdge.ts#L10)
Checks that an Ent available via a field can be deleted, or Ent doesn't exist
(e.g. Ent is orphaned). See CanReadOutgoingEdge comments for more details.
## Type Parameters
| Type Parameter |
| ------ |
| `TField` *extends* `string` |
## Implements
- [`Predicate`](../interfaces/Predicate.md)\<`Record`\<`TField`, `string` \| `null`\>\>
## Constructors
### new CanDeleteOutgoingEdge()
> **new CanDeleteOutgoingEdge**\<`TField`\>(`field`, `toEntClass`): [`CanDeleteOutgoingEdge`](CanDeleteOutgoingEdge.md)\<`TField`\>
Defined in: [src/ent/predicates/CanDeleteOutgoingEdge.ts:15](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanDeleteOutgoingEdge.ts#L15)
#### Parameters
| Parameter | Type |
| ------ | ------ |
| `field` | `TField` |
| `toEntClass` | [`EntClass`](../interfaces/EntClass.md) |
#### Returns
[`CanDeleteOutgoingEdge`](CanDeleteOutgoingEdge.md)\<`TField`\>
## Properties
| Property | Type |
| ------ | ------ |
| <a id="name"></a> `name` | `string` |
| <a id="field-1"></a> `field` | `TField` |
| <a id="toentclass-1"></a> `toEntClass` | [`EntClass`](../interfaces/EntClass.md) |
## Methods
### check()
> **check**(`vc`, `row`): `Promise`\<`boolean`\>
Defined in: [src/ent/predicates/CanDeleteOutgoingEdge.ts:22](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanDeleteOutgoingEdge.ts#L22)
#### Parameters
| Parameter | Type |
| ------ | ------ |
| `vc` | [`VC`](VC.md) |
| `row` | `Record`\<`TField`, `null` \| `string`\> |
#### Returns
`Promise`\<`boolean`\>
#### Implementation of
[`Predicate`](../interfaces/Predicate.md).[`check`](../interfaces/Predicate.md#check)