Skip to content

Commit 527b6a3

Browse files
committed
v2.13.9: Add Shard#lastKnownIslandNo. Collect discovery errors per each island and report them on discovery failure. Add PgClient#role to optionally turn off automatic replication lag tracking based on PG WAL. Improve typedoc.
1 parent e7a6f58 commit 527b6a3

File tree

191 files changed

+1755
-2014
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

191 files changed

+1755
-2014
lines changed

docs/classes/AllowIf.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
# Class: AllowIf\<TInput\>
88

9+
Defined in: [src/ent/rules/AllowIf.ts:12](https://github.com/clickup/ent-framework/blob/master/src/ent/rules/AllowIf.ts#L12)
10+
911
Returns ALLOW if the predicate succeeds, otherwise SKIP.
1012
- Used mostly for read permission checks.
1113
- This rule may still throw an exception if the exception is a wild one (not
@@ -27,6 +29,8 @@ Returns ALLOW if the predicate succeeds, otherwise SKIP.
2729

2830
> **new AllowIf**\<`TInput`\>(`predicate`): [`AllowIf`](AllowIf.md)\<`TInput`\>
2931
32+
Defined in: [src/ent/rules/Rule.ts:43](https://github.com/clickup/ent-framework/blob/master/src/ent/rules/Rule.ts#L43)
33+
3034
#### Parameters
3135

3236
| Parameter | Type |
@@ -41,24 +45,22 @@ Returns ALLOW if the predicate succeeds, otherwise SKIP.
4145

4246
[`Rule`](Rule.md).[`constructor`](Rule.md#constructors)
4347

44-
#### Defined in
45-
46-
[src/ent/rules/Rule.ts:43](https://github.com/clickup/ent-framework/blob/master/src/ent/rules/Rule.ts#L43)
47-
4848
## Properties
4949

5050
| Property | Type |
5151
| ------ | ------ |
52-
| `_TAG` | `"AllowIf"` |
53-
| `predicate` | [`Predicate`](../interfaces/Predicate.md)\<`TInput`\> |
54-
| `name` | `string` |
52+
| <a id="_tag"></a> `_TAG` | `"AllowIf"` |
53+
| <a id="predicate-1"></a> `predicate` | [`Predicate`](../interfaces/Predicate.md)\<`TInput`\> |
54+
| <a id="name"></a> `name` | `string` |
5555

5656
## Methods
5757

5858
### evaluate()
5959

6060
> **evaluate**(`vc`, `input`): `Promise`\<[`RuleResult`](../interfaces/RuleResult.md)\>
6161
62+
Defined in: [src/ent/rules/AllowIf.ts:15](https://github.com/clickup/ent-framework/blob/master/src/ent/rules/AllowIf.ts#L15)
63+
6264
#### Parameters
6365

6466
| Parameter | Type |
@@ -73,7 +75,3 @@ Returns ALLOW if the predicate succeeds, otherwise SKIP.
7375
#### Overrides
7476

7577
[`Rule`](Rule.md).[`evaluate`](Rule.md#evaluate)
76-
77-
#### Defined in
78-
79-
[src/ent/rules/AllowIf.ts:15](https://github.com/clickup/ent-framework/blob/master/src/ent/rules/AllowIf.ts#L15)

docs/classes/Batcher.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
# Class: Batcher\<TInput, TOutput\>
88

9+
Defined in: [src/abstract/Batcher.ts:19](https://github.com/clickup/ent-framework/blob/master/src/abstract/Batcher.ts#L19)
10+
911
Batcher is similar to DataLoader, but with a few important differences:
1012
1. It's strongly typed not only for the output, but for input too. And input
1113
can be arbitrary, not only strings (e.g. rows).
@@ -27,6 +29,8 @@ Batcher is similar to DataLoader, but with a few important differences:
2729

2830
> **new Batcher**\<`TInput`, `TOutput`\>(`runner`, `batchDelayMs`): [`Batcher`](Batcher.md)\<`TInput`, `TOutput`\>
2931
32+
Defined in: [src/abstract/Batcher.ts:90](https://github.com/clickup/ent-framework/blob/master/src/abstract/Batcher.ts#L90)
33+
3034
#### Parameters
3135

3236
| Parameter | Type |
@@ -38,30 +42,26 @@ Batcher is similar to DataLoader, but with a few important differences:
3842

3943
[`Batcher`](Batcher.md)\<`TInput`, `TOutput`\>
4044

41-
#### Defined in
42-
43-
[src/abstract/Batcher.ts:90](https://github.com/clickup/ent-framework/blob/master/src/abstract/Batcher.ts#L90)
44-
4545
## Methods
4646

4747
### flushQueue()
4848

4949
> `protected` **flushQueue**(): `Promise`\<`void`\>
5050
51+
Defined in: [src/abstract/Batcher.ts:32](https://github.com/clickup/ent-framework/blob/master/src/abstract/Batcher.ts#L32)
52+
5153
#### Returns
5254

5355
`Promise`\<`void`\>
5456

55-
#### Defined in
56-
57-
[src/abstract/Batcher.ts:32](https://github.com/clickup/ent-framework/blob/master/src/abstract/Batcher.ts#L32)
58-
5957
***
6058

6159
### run()
6260

6361
> **run**(`input`, `annotation`): `Promise`\<`TOutput`\>
6462
63+
Defined in: [src/abstract/Batcher.ts:95](https://github.com/clickup/ent-framework/blob/master/src/abstract/Batcher.ts#L95)
64+
6565
#### Parameters
6666

6767
| Parameter | Type |
@@ -72,7 +72,3 @@ Batcher is similar to DataLoader, but with a few important differences:
7272
#### Returns
7373

7474
`Promise`\<`TOutput`\>
75-
76-
#### Defined in
77-
78-
[src/abstract/Batcher.ts:95](https://github.com/clickup/ent-framework/blob/master/src/abstract/Batcher.ts#L95)

docs/classes/CanDeleteOutgoingEdge.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
# Class: CanDeleteOutgoingEdge\<TField\>
88

9+
Defined in: [src/ent/predicates/CanDeleteOutgoingEdge.ts:10](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanDeleteOutgoingEdge.ts#L10)
10+
911
Checks that an Ent available via a field can be deleted, or Ent doesn't exist
1012
(e.g. Ent is orphaned). See CanReadOutgoingEdge comments for more details.
1113

@@ -25,6 +27,8 @@ Checks that an Ent available via a field can be deleted, or Ent doesn't exist
2527

2628
> **new CanDeleteOutgoingEdge**\<`TField`\>(`field`, `toEntClass`): [`CanDeleteOutgoingEdge`](CanDeleteOutgoingEdge.md)\<`TField`\>
2729
30+
Defined in: [src/ent/predicates/CanDeleteOutgoingEdge.ts:15](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanDeleteOutgoingEdge.ts#L15)
31+
2832
#### Parameters
2933

3034
| Parameter | Type |
@@ -36,24 +40,22 @@ Checks that an Ent available via a field can be deleted, or Ent doesn't exist
3640

3741
[`CanDeleteOutgoingEdge`](CanDeleteOutgoingEdge.md)\<`TField`\>
3842

39-
#### Defined in
40-
41-
[src/ent/predicates/CanDeleteOutgoingEdge.ts:15](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanDeleteOutgoingEdge.ts#L15)
42-
4343
## Properties
4444

4545
| Property | Type |
4646
| ------ | ------ |
47-
| `name` | `string` |
48-
| `field` | `TField` |
49-
| `toEntClass` | [`EntClass`](../interfaces/EntClass.md) |
47+
| <a id="name"></a> `name` | `string` |
48+
| <a id="field-1"></a> `field` | `TField` |
49+
| <a id="toentclass-1"></a> `toEntClass` | [`EntClass`](../interfaces/EntClass.md) |
5050

5151
## Methods
5252

5353
### check()
5454

5555
> **check**(`vc`, `row`): `Promise`\<`boolean`\>
5656
57+
Defined in: [src/ent/predicates/CanDeleteOutgoingEdge.ts:22](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanDeleteOutgoingEdge.ts#L22)
58+
5759
#### Parameters
5860

5961
| Parameter | Type |
@@ -68,7 +70,3 @@ Checks that an Ent available via a field can be deleted, or Ent doesn't exist
6870
#### Implementation of
6971

7072
[`Predicate`](../interfaces/Predicate.md).[`check`](../interfaces/Predicate.md#check)
71-
72-
#### Defined in
73-
74-
[src/ent/predicates/CanDeleteOutgoingEdge.ts:22](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanDeleteOutgoingEdge.ts#L22)

docs/classes/CanReadOutgoingEdge.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
# Class: CanReadOutgoingEdge\<TField\>
88

9+
Defined in: [src/ent/predicates/CanReadOutgoingEdge.ts:18](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanReadOutgoingEdge.ts#L18)
10+
911
Checks that an ent which a field is pointing to is readable:
1012

1113
EntOur[company_id] ---> EntCompany[id]
@@ -32,6 +34,8 @@ to another ent with ID equals to the value of our ent's field.
3234

3335
> **new CanReadOutgoingEdge**\<`TField`\>(`field`, `toEntClass`): [`CanReadOutgoingEdge`](CanReadOutgoingEdge.md)\<`TField`\>
3436
37+
Defined in: [src/ent/predicates/CanReadOutgoingEdge.ts:23](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanReadOutgoingEdge.ts#L23)
38+
3539
#### Parameters
3640

3741
| Parameter | Type |
@@ -43,24 +47,22 @@ to another ent with ID equals to the value of our ent's field.
4347

4448
[`CanReadOutgoingEdge`](CanReadOutgoingEdge.md)\<`TField`\>
4549

46-
#### Defined in
47-
48-
[src/ent/predicates/CanReadOutgoingEdge.ts:23](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanReadOutgoingEdge.ts#L23)
49-
5050
## Properties
5151

5252
| Property | Type |
5353
| ------ | ------ |
54-
| `name` | `string` |
55-
| `field` | `TField` |
56-
| `toEntClass` | [`EntClass`](../interfaces/EntClass.md) |
54+
| <a id="name"></a> `name` | `string` |
55+
| <a id="field-1"></a> `field` | `TField` |
56+
| <a id="toentclass-1"></a> `toEntClass` | [`EntClass`](../interfaces/EntClass.md) |
5757

5858
## Methods
5959

6060
### check()
6161

6262
> **check**(`vc`, `row`): `Promise`\<`boolean`\>
6363
64+
Defined in: [src/ent/predicates/CanReadOutgoingEdge.ts:30](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanReadOutgoingEdge.ts#L30)
65+
6466
#### Parameters
6567

6668
| Parameter | Type |
@@ -75,7 +77,3 @@ to another ent with ID equals to the value of our ent's field.
7577
#### Implementation of
7678

7779
[`Predicate`](../interfaces/Predicate.md).[`check`](../interfaces/Predicate.md#check)
78-
79-
#### Defined in
80-
81-
[src/ent/predicates/CanReadOutgoingEdge.ts:30](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanReadOutgoingEdge.ts#L30)

docs/classes/CanUpdateOutgoingEdge.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
# Class: CanUpdateOutgoingEdge\<TField\>
88

9+
Defined in: [src/ent/predicates/CanUpdateOutgoingEdge.ts:10](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanUpdateOutgoingEdge.ts#L10)
10+
911
Checks that an Ent available via a field is updatable. See
1012
CanReadOutgoingEdge comments for more details.
1113

@@ -25,6 +27,8 @@ CanReadOutgoingEdge comments for more details.
2527

2628
> **new CanUpdateOutgoingEdge**\<`TField`\>(`field`, `toEntClass`): [`CanUpdateOutgoingEdge`](CanUpdateOutgoingEdge.md)\<`TField`\>
2729
30+
Defined in: [src/ent/predicates/CanUpdateOutgoingEdge.ts:15](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanUpdateOutgoingEdge.ts#L15)
31+
2832
#### Parameters
2933

3034
| Parameter | Type |
@@ -36,24 +40,22 @@ CanReadOutgoingEdge comments for more details.
3640

3741
[`CanUpdateOutgoingEdge`](CanUpdateOutgoingEdge.md)\<`TField`\>
3842

39-
#### Defined in
40-
41-
[src/ent/predicates/CanUpdateOutgoingEdge.ts:15](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanUpdateOutgoingEdge.ts#L15)
42-
4343
## Properties
4444

4545
| Property | Type |
4646
| ------ | ------ |
47-
| `name` | `string` |
48-
| `field` | `TField` |
49-
| `toEntClass` | [`EntClass`](../interfaces/EntClass.md) |
47+
| <a id="name"></a> `name` | `string` |
48+
| <a id="field-1"></a> `field` | `TField` |
49+
| <a id="toentclass-1"></a> `toEntClass` | [`EntClass`](../interfaces/EntClass.md) |
5050

5151
## Methods
5252

5353
### check()
5454

5555
> **check**(`vc`, `row`): `Promise`\<`boolean`\>
5656
57+
Defined in: [src/ent/predicates/CanUpdateOutgoingEdge.ts:22](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanUpdateOutgoingEdge.ts#L22)
58+
5759
#### Parameters
5860

5961
| Parameter | Type |
@@ -68,7 +70,3 @@ CanReadOutgoingEdge comments for more details.
6870
#### Implementation of
6971

7072
[`Predicate`](../interfaces/Predicate.md).[`check`](../interfaces/Predicate.md#check)
71-
72-
#### Defined in
73-
74-
[src/ent/predicates/CanUpdateOutgoingEdge.ts:22](https://github.com/clickup/ent-framework/blob/master/src/ent/predicates/CanUpdateOutgoingEdge.ts#L22)

0 commit comments

Comments
 (0)