Interface: AmnesiaDevToolsProviderApi
Defined in: devtools.ts:31
Inspection api exposed by each registered provider.
Properties
clear
clear: (
scopeId?) =>void
Defined in: devtools.ts:54
Clear scopeId, or every scope when omitted.
Parameters
| Parameter | Type |
|---|---|
scopeId? | string |
Returns
void
dump
dump: () =>
Record<string,AmnesiaState>
Defined in: devtools.ts:48
Snapshot every registered scope keyed by id.
Returns
Record<string, AmnesiaState>
futureSnapshot
futureSnapshot: (
scopeId?) => readonlyHistoryEntry[]
Defined in: devtools.ts:46
Convenience: just the future entries for scopeId (active by default).
Parameters
| Parameter | Type |
|---|---|
scopeId? | string |
Returns
readonly HistoryEntry[]
getActiveScopeId
getActiveScopeId: () =>
string
Defined in: devtools.ts:35
The scope id currently receiving keyboard shortcuts.
Returns
string
getSnapshot
getSnapshot: (
scopeId?) =>AmnesiaState
Defined in: devtools.ts:42
Read a scope's snapshot. With no argument, returns the active scope's snapshot.
Parameters
| Parameter | Type |
|---|---|
scopeId? | string |
Returns
id
id:
string
Defined in: devtools.ts:33
Stable id under which the provider is registered.
pastSnapshot
pastSnapshot: (
scopeId?) => readonlyHistoryEntry[]
Defined in: devtools.ts:44
Convenience: just the past entries for scopeId (active by default).
Parameters
| Parameter | Type |
|---|---|
scopeId? | string |
Returns
readonly HistoryEntry[]
scopes
scopes: () => readonly
string[]
Defined in: devtools.ts:37
Snapshot of the registered scope ids.
Returns
readonly string[]
triggerRedo
triggerRedo: (
scopeId?) =>Promise<number|null>
Defined in: devtools.ts:52
Trigger redo() on scopeId (active by default).
Parameters
| Parameter | Type |
|---|---|
scopeId? | string |
Returns
Promise<number | null>
triggerUndo
triggerUndo: (
scopeId?) =>Promise<number|null>
Defined in: devtools.ts:50
Trigger undo() on scopeId (active by default). Returns the entry id, or null.
Parameters
| Parameter | Type |
|---|---|
scopeId? | string |
Returns
Promise<number | null>