@trrack/core / Trrack
Interface: Trrack<State, Event>
Defined in: provenance/types.ts:25
Type Parameters
State
State
Event
Event extends string
Properties
annotations
annotations:
object
Defined in: provenance/types.ts:57
add()
add(
annotation,node?):void
Parameters
annotation
string
node?
Returns
void
all()
all(
node?):string[] |undefined
Parameters
node?
Returns
string[] | undefined
latest()
latest(
node?):string|undefined
Parameters
node?
Returns
string | undefined
artifact
artifact:
object
Defined in: provenance/types.ts:52
add()
add<
A>(artifact,node?):void
Type Parameters
A
A
Parameters
artifact
A
node?
Returns
void
all()
all(
node?):Artifact[] |undefined
Parameters
node?
Returns
Artifact[] | undefined
latest()
latest(
node?):Artifact|undefined
Parameters
node?
Returns
Artifact | undefined
bookmarks
bookmarks:
object
Defined in: provenance/types.ts:62
add()
add(
node?):void
Parameters
node?
Returns
void
is()
is(
node?):boolean
Parameters
node?
Returns
boolean
remove()
remove(
node?):void
Parameters
node?
Returns
void
toggle()
toggle(
node?):void
Parameters
node?
Returns
void
current
current:
ProvenanceNode<State,Event>
Defined in: provenance/types.ts:30
graph
graph:
ProvenanceGraphStore<State,Event>
Defined in: provenance/types.ts:29
isTraversing
isTraversing:
boolean
Defined in: provenance/types.ts:27
metadata
metadata:
object
Defined in: provenance/types.ts:38
add()
add(
metadata,node?):void
Parameters
metadata
Record<string, unknown>
node?
Returns
void
all()
all(
node?):Record<string,Metadata[]> |undefined
Parameters
node?
Returns
Record<string, Metadata[]> | undefined
allOfType()
allOfType<
T>(type,node?):Metadata<T>[] |undefined
Type Parameters
T
T = unknown
Parameters
type
string
node?
Returns
Metadata<T>[] | undefined
latest()
latest(
node?):Record<string,Metadata> |undefined
Parameters
node?
Returns
Record<string, Metadata> | undefined
latestOfType()
latestOfType<
T>(type,node?):Metadata<T> |undefined
Type Parameters
T
T = unknown
Parameters
type
string
node?
Returns
Metadata<T> | undefined
types()
types(
node?):string[]
Parameters
node?
Returns
string[]
registry
registry:
Registry<Event>
Defined in: provenance/types.ts:26
root
root:
RootNode<State>
Defined in: provenance/types.ts:31
Methods
apply()
apply<
T,Payload>(label,act):Promise<void>
Defined in: provenance/types.ts:33
Type Parameters
T
T extends string
Payload
Payload = unknown
Parameters
label
string
act
payload
Payload
type
T
Returns
Promise<void>
currentChange()
currentChange(
listener,skipOnNew?):UnsubscribeCurrentChangeListener
Defined in: provenance/types.ts:70
Parameters
listener
skipOnNew?
boolean
Returns
UnsubscribeCurrentChangeListener
done()
done():
void
Defined in: provenance/types.ts:74
Returns
void
export()
export():
string
Defined in: provenance/types.ts:77
Returns
string
exportObject()
exportObject():
ProvenanceGraph<State,Event>
Defined in: provenance/types.ts:78
Returns
ProvenanceGraph<State, Event>
getState()
getState(
node?):State
Defined in: provenance/types.ts:28
Parameters
node?
ProvenanceNode<State, Event>
Returns
State
import()
import(
graphString):void
Defined in: provenance/types.ts:79
Parameters
graphString
string
Returns
void
importObject()
importObject(
graph):void
Defined in: provenance/types.ts:80
Parameters
graph
ProvenanceGraph<State, Event>
Returns
void
on()
on(
event,listener):void
Defined in: provenance/types.ts:76
Parameters
event
listener
(args?) => void
Returns
void
record()
record(
args):void
Defined in: provenance/types.ts:32
Parameters
args
RecordActionArgs<State, Event>
Returns
void
redo()
redo(
to?):Promise<void>
Defined in: provenance/types.ts:69
Parameters
to?
"latest" | "oldest"
Returns
Promise<void>
to()
to(
node):Promise<void>
Defined in: provenance/types.ts:37
Parameters
node
Returns
Promise<void>
tree()
tree():
unknown
Defined in: provenance/types.ts:75
Returns
unknown
undo()
undo():
Promise<void>
Defined in: provenance/types.ts:68
Returns
Promise<void>