@trrack/core / Trrack
Interface: Trrack<State, Event>
Type parameters
| Name | Type |
|---|---|
State | State |
Event | extends string |
Table of contents
Properties
Methods
- apply
- currentChange
- done
- export
- exportObject
- getState
- import
- importObject
- on
- record
- redo
- to
- tree
- undo
Properties
annotations
• annotations: Object
Type declaration
| Name | Type |
|---|---|
add | (annotation: string, node?: NodeId) => void |
all | (node?: NodeId) => undefined | string[] |
latest | (node?: NodeId) => undefined | string |
Defined in
packages/core/src/provenance/types.ts:57 (opens in a new tab)
artifact
• artifact: Object
Type declaration
| Name | Type |
|---|---|
add | <A>(artifact: A, node?: NodeId) => void |
all | (node?: NodeId) => undefined | Artifact[] |
latest | (node?: NodeId) => undefined | Artifact |
Defined in
packages/core/src/provenance/types.ts:52 (opens in a new tab)
bookmarks
• bookmarks: Object
Type declaration
| Name | Type |
|---|---|
add | (node?: NodeId) => void |
is | (node?: NodeId) => boolean |
remove | (node?: NodeId) => void |
toggle | (node?: NodeId) => void |
Defined in
packages/core/src/provenance/types.ts:62 (opens in a new tab)
current
• current: ProvenanceNode<State, Event>
Defined in
packages/core/src/provenance/types.ts:30 (opens in a new tab)
graph
• graph: Object
Type declaration
| Name | Type |
|---|---|
backend | ProvenanceGraph<any, any> |
current | ProvenanceNode<any, any> |
initialState | ProvenanceGraph<any, any> |
root | RootNode<any> |
update | (action: Action<"listenerMiddleware/add">) => UnsubscribeListener & ThunkDispatch<ProvenanceGraph<any, any>, undefined, AnyAction> & Dispatch<AnyAction> |
addArtifact | (payload: AddArtifactPayload) => { payload: AddArtifactPayload ; type: "provenance-graph/addArtifact" } |
addMetadata | (payload: AddMetadataPayload) => { payload: AddMetadataPayload ; type: "provenance-graph/addMetadata" } |
addNode | (payload: StateNode<any, any>) => { payload: StateNode<any, any> ; type: "provenance-graph/addNode" } |
changeCurrent | (payload: NodeId) => { payload: NodeId ; type: "provenance-graph/changeCurrent" } |
currentChange | (func: CurrentChangeHandler, config: CurrentChangeHandlerConfig) => UnsubscribeCurrentChangeListener |
load | (payload: ProvenanceGraph<any, any>) => { payload: ProvenanceGraph<any, any> ; type: "provenance-graph/load" } |
Defined in
packages/core/src/provenance/types.ts:29 (opens in a new tab)
isTraversing
• isTraversing: boolean
Defined in
packages/core/src/provenance/types.ts:27 (opens in a new tab)
metadata
• metadata: Object
Type declaration
| Name | Type |
|---|---|
add | (metadata: Record<string, unknown>, node?: NodeId) => void |
all | (node?: NodeId) => undefined | Record<string, Metadata<unknown>[]> |
allOfType | <T>(type: string, node?: NodeId) => undefined | Metadata<T>[] |
latest | (node?: NodeId) => undefined | Record<string, Metadata<unknown>> |
latestOfType | <T>(type: string, node?: NodeId) => undefined | Metadata<T> |
types | (node?: NodeId) => string[] |
Defined in
packages/core/src/provenance/types.ts:38 (opens in a new tab)
registry
• registry: Registry<Event>
Defined in
packages/core/src/provenance/types.ts:26 (opens in a new tab)
root
• root: RootNode<State>
Defined in
packages/core/src/provenance/types.ts:31 (opens in a new tab)
Methods
apply
â–¸ apply<T, Payload>(label, act): any
Type parameters
| Name | Type |
|---|---|
T | extends string |
Payload | any |
Parameters
| Name | Type |
|---|---|
label | string |
act | Object |
act.payload | Payload |
act.type | T |
Returns
any
Defined in
packages/core/src/provenance/types.ts:33 (opens in a new tab)
currentChange
â–¸ currentChange(listener, skipOnNew?): UnsubscribeCurrentChangeListener
Parameters
| Name | Type |
|---|---|
listener | CurrentChangeHandler |
skipOnNew? | boolean |
Returns
UnsubscribeCurrentChangeListener
Defined in
packages/core/src/provenance/types.ts:70 (opens in a new tab)
done
â–¸ done(): void
Returns
void
Defined in
packages/core/src/provenance/types.ts:74 (opens in a new tab)
export
â–¸ export(): string
Returns
string
Defined in
packages/core/src/provenance/types.ts:77 (opens in a new tab)
exportObject
â–¸ exportObject(): ProvenanceGraph<State, Event>
Returns
ProvenanceGraph<State, Event>
Defined in
packages/core/src/provenance/types.ts:78 (opens in a new tab)
getState
â–¸ getState(node?): State
Parameters
| Name | Type |
|---|---|
node? | ProvenanceNode<State, Event> |
Returns
State
Defined in
packages/core/src/provenance/types.ts:28 (opens in a new tab)
import
â–¸ import(graphString): void
Parameters
| Name | Type |
|---|---|
graphString | string |
Returns
void
Defined in
packages/core/src/provenance/types.ts:79 (opens in a new tab)
importObject
â–¸ importObject(graph): void
Parameters
| Name | Type |
|---|---|
graph | ProvenanceGraph<State, Event> |
Returns
void
Defined in
packages/core/src/provenance/types.ts:80 (opens in a new tab)
on
â–¸ on(event, listener): void
Parameters
| Name | Type |
|---|---|
event | TrrackEvents |
listener | (args?: any) => void |
Returns
void
Defined in
packages/core/src/provenance/types.ts:76 (opens in a new tab)
record
â–¸ record(args): void
Parameters
| Name | Type |
|---|---|
args | RecordActionArgs<State, Event> |
Returns
void
Defined in
packages/core/src/provenance/types.ts:32 (opens in a new tab)
redo
â–¸ redo(to?): Promise<void>
Parameters
| Name | Type |
|---|---|
to? | "latest" | "oldest" |
Returns
Promise<void>
Defined in
packages/core/src/provenance/types.ts:69 (opens in a new tab)
to
â–¸ to(node): Promise<void>
Parameters
| Name | Type |
|---|---|
node | NodeId |
Returns
Promise<void>
Defined in
packages/core/src/provenance/types.ts:37 (opens in a new tab)
tree
â–¸ tree(): any
Returns
any
Defined in
packages/core/src/provenance/types.ts:75 (opens in a new tab)
undo
â–¸ undo(): Promise<void>
Returns
Promise<void>
Defined in
packages/core/src/provenance/types.ts:68 (opens in a new tab)