Rulvar API reference / @rulvar/effects / EffectAdapter
Interface: EffectAdapter
Defined in: packages/effects/src/adapter.ts:89
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
descriptor | readonly | EffectProviderDescriptor | packages/effects/src/adapter.ts:90 |
Methods
closeAcceptance()?
ts
optional closeAcceptance(request): Promise<EffectLookupAnswer>;Defined in: packages/effects/src/adapter.ts:104
The acceptance-closing primitive (query then cancel): after this resolves with found: false, late bytes for this effect are unacceptable at the provider, which is the ONLY thing that makes a negative answer final (RFC section 4.4).
Parameters
| Parameter | Type |
|---|---|
request | EffectLookupRequest |
Returns
Promise<EffectLookupAnswer>
dispatch()
ts
dispatch(request): Promise<EffectDispatchResult>;Defined in: packages/effects/src/adapter.ts:95
Sends one attempt. Called ONLY by the dispatcher, ONLY with the seq of an attempt record it just appended.
Parameters
| Parameter | Type |
|---|---|
request | EffectDispatchRequest |
Returns
Promise<EffectDispatchResult>
lookup()?
ts
optional lookup(request): Promise<EffectLookupAnswer>;Defined in: packages/effects/src/adapter.ts:97
Queries the provider for the effect's truth, when the row offers it.
Parameters
| Parameter | Type |
|---|---|
request | EffectLookupRequest |
Returns
Promise<EffectLookupAnswer>