Anchorage API reference
Documentation
GitHub
Preparing search index...
@proofoftech/fleet-control
index
PlatformPlaneClient
Interface PlatformPlaneClient
interface
PlatformPlaneClient
{
assertUntrustedDispatchNamespace
()
:
Promise
<
void
>
;
disableControlWorkerPublicAccess
(
scriptName
:
string
)
:
Promise
<
void
>
;
ensureDispatchNamespace
()
:
Promise
<
void
>
;
ensureQueueConsumer
(
options
:
{
deadLetterQueue
?:
string
;
queueName
:
string
;
scriptName
:
string
;
}
,
)
:
Promise
<
void
>
;
inspectControlWorker
(
scriptName
:
string
,
)
:
Promise
<
PlatformWorkerInspection
|
undefined
>
;
platformPlaneScope
()
:
Readonly
<
{
accountId
:
string
;
dispatchNamespace
:
string
}
,
>
;
putControlSecrets
(
scriptName
:
string
,
secrets
:
Readonly
<
Record
<
string
,
string
>
>
,
)
:
Promise
<
void
>
;
uploadControlWorker
(
spec
:
{
bindings
:
readonly
Readonly
<
Record
<
string
,
unknown
>
>
[]
;
compatibilityDate
:
string
;
mainModule
:
string
;
modules
:
readonly
WorkerModule
[]
;
scriptName
:
string
;
}
,
)
:
Promise
<
string
>
;
withMutationFence
<
T
>
(
fence
:
ExternalMutationFence
,
operation
:
()
=>
Promise
<
T
>
,
)
:
Promise
<
T
>
;
}
Index
Methods
assert
Untrusted
Dispatch
Namespace
disable
Control
Worker
Public
Access
ensure
Dispatch
Namespace
ensure
Queue
Consumer
inspect
Control
Worker
platform
Plane
Scope
put
Control
Secrets
upload
Control
Worker
with
Mutation
Fence
Methods
assert
Untrusted
Dispatch
Namespace
assertUntrustedDispatchNamespace
()
:
Promise
<
void
>
Returns
Promise
<
void
>
disable
Control
Worker
Public
Access
disableControlWorkerPublicAccess
(
scriptName
:
string
)
:
Promise
<
void
>
Parameters
scriptName
:
string
Returns
Promise
<
void
>
ensure
Dispatch
Namespace
ensureDispatchNamespace
()
:
Promise
<
void
>
Returns
Promise
<
void
>
ensure
Queue
Consumer
ensureQueueConsumer
(
options
:
{
deadLetterQueue
?:
string
;
queueName
:
string
;
scriptName
:
string
;
}
,
)
:
Promise
<
void
>
Parameters
options
:
{
deadLetterQueue
?:
string
;
queueName
:
string
;
scriptName
:
string
}
Returns
Promise
<
void
>
inspect
Control
Worker
inspectControlWorker
(
scriptName
:
string
,
)
:
Promise
<
PlatformWorkerInspection
|
undefined
>
Parameters
scriptName
:
string
Returns
Promise
<
PlatformWorkerInspection
|
undefined
>
platform
Plane
Scope
platformPlaneScope
()
:
Readonly
<
{
accountId
:
string
;
dispatchNamespace
:
string
}
>
Returns
Readonly
<
{
accountId
:
string
;
dispatchNamespace
:
string
}
>
put
Control
Secrets
putControlSecrets
(
scriptName
:
string
,
secrets
:
Readonly
<
Record
<
string
,
string
>
>
,
)
:
Promise
<
void
>
Parameters
scriptName
:
string
secrets
:
Readonly
<
Record
<
string
,
string
>
>
Returns
Promise
<
void
>
upload
Control
Worker
uploadControlWorker
(
spec
:
{
bindings
:
readonly
Readonly
<
Record
<
string
,
unknown
>
>
[]
;
compatibilityDate
:
string
;
mainModule
:
string
;
modules
:
readonly
WorkerModule
[]
;
scriptName
:
string
;
}
,
)
:
Promise
<
string
>
Parameters
spec
:
{
bindings
:
readonly
Readonly
<
Record
<
string
,
unknown
>
>
[]
;
compatibilityDate
:
string
;
mainModule
:
string
;
modules
:
readonly
WorkerModule
[]
;
scriptName
:
string
;
}
Returns
Promise
<
string
>
with
Mutation
Fence
withMutationFence
<
T
>
(
fence
:
ExternalMutationFence
,
operation
:
()
=>
Promise
<
T
>
,
)
:
Promise
<
T
>
Type Parameters
T
Parameters
fence
:
ExternalMutationFence
operation
:
()
=>
Promise
<
T
>
Returns
Promise
<
T
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
assert
Untrusted
Dispatch
Namespace
disable
Control
Worker
Public
Access
ensure
Dispatch
Namespace
ensure
Queue
Consumer
inspect
Control
Worker
platform
Plane
Scope
put
Control
Secrets
upload
Control
Worker
with
Mutation
Fence
Documentation
GitHub
Anchorage API reference
Loading...