Anchorage API reference
Documentation
GitHub
Preparing search index...
@proofoftech/flowsafe
schedules
FencedScheduleMutationCapability
Interface FencedScheduleMutationCapability
Epoch activation can race a waiting request, so this contract applies before activation.
interface
FencedScheduleMutationCapability
{
database
:
SignalDatabase
&
Required
<
Pick
<
SignalDatabase
,
"batch"
>
>
;
createOwnedSchedule
(
schedule
:
AuthorizedSchedule
,
owner
:
ResourceOwner
,
maxSchedules
:
number
,
context
:
MutationEpochContext
,
)
:
Promise
<
Schedule
|
null
>
;
deleteOwnedSchedule
(
id
:
string
,
context
:
MutationEpochContext
,
)
:
Promise
<
"pending"
|
"deleted"
>
;
observeScheduleMutation
(
id
:
string
,
operation
:
"resume"
|
"pause"
,
context
:
MutationEpochContext
,
)
:
Promise
<
Schedule
|
null
>
;
pauseSchedule
(
id
:
string
,
context
:
MutationEpochContext
)
:
Promise
<
Schedule
>
;
resumeSchedule
(
id
:
string
,
mutation
:
ScheduleResumeMutation
,
context
:
MutationEpochContext
,
)
:
Promise
<
Schedule
>
;
updateSchedule
(
id
:
string
,
patch
:
ScheduleUpdate
,
context
:
MutationEpochContext
,
)
:
Promise
<
Schedule
>
;
}
Index
Properties
database
Methods
create
Owned
Schedule
delete
Owned
Schedule
observe
Schedule
Mutation
pause
Schedule
resume
Schedule
update
Schedule
Properties
Readonly
database
database
:
SignalDatabase
&
Required
<
Pick
<
SignalDatabase
,
"batch"
>
>
Methods
create
Owned
Schedule
createOwnedSchedule
(
schedule
:
AuthorizedSchedule
,
owner
:
ResourceOwner
,
maxSchedules
:
number
,
context
:
MutationEpochContext
,
)
:
Promise
<
Schedule
|
null
>
Parameters
schedule
:
AuthorizedSchedule
owner
:
ResourceOwner
maxSchedules
:
number
context
:
MutationEpochContext
Returns
Promise
<
Schedule
|
null
>
delete
Owned
Schedule
deleteOwnedSchedule
(
id
:
string
,
context
:
MutationEpochContext
,
)
:
Promise
<
"pending"
|
"deleted"
>
Parameters
id
:
string
context
:
MutationEpochContext
Returns
Promise
<
"pending"
|
"deleted"
>
observe
Schedule
Mutation
observeScheduleMutation
(
id
:
string
,
operation
:
"resume"
|
"pause"
,
context
:
MutationEpochContext
,
)
:
Promise
<
Schedule
|
null
>
Parameters
id
:
string
operation
:
"resume"
|
"pause"
context
:
MutationEpochContext
Returns
Promise
<
Schedule
|
null
>
pause
Schedule
pauseSchedule
(
id
:
string
,
context
:
MutationEpochContext
)
:
Promise
<
Schedule
>
Parameters
id
:
string
context
:
MutationEpochContext
Returns
Promise
<
Schedule
>
resume
Schedule
resumeSchedule
(
id
:
string
,
mutation
:
ScheduleResumeMutation
,
context
:
MutationEpochContext
,
)
:
Promise
<
Schedule
>
Parameters
id
:
string
mutation
:
ScheduleResumeMutation
context
:
MutationEpochContext
Returns
Promise
<
Schedule
>
update
Schedule
updateSchedule
(
id
:
string
,
patch
:
ScheduleUpdate
,
context
:
MutationEpochContext
,
)
:
Promise
<
Schedule
>
Parameters
id
:
string
patch
:
ScheduleUpdate
context
:
MutationEpochContext
Returns
Promise
<
Schedule
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
database
Methods
create
Owned
Schedule
delete
Owned
Schedule
observe
Schedule
Mutation
pause
Schedule
resume
Schedule
update
Schedule
Documentation
GitHub
Anchorage API reference
Loading...
Epoch activation can race a waiting request, so this contract applies before activation.