📜 Naming ​
Common ​
The common naming conventions in the Traced Fabric (TF) package reflect its fundamental purpose. For those interested in a deeper understanding of the project’s internals, exploring the core functionality and key naming conventions will provide valuable insights into how the system operates.
traceFabric
- function that will process data and make ittraceable
traced
- data whose changes are recordedtracedFabric
- data that istraced
bytraceFabric
tracedValue
- array or object inside oftracedFabric
. Can be inside of othertracedValues
mutation
- single change inside oftracedFabric
oftracedValue
trace
- array ofmutations
mutationCallback
- function that will be triggered whenmutation
happens
Core functionality ​
This section is intended for those who wish to understand how TF operates and explore its key concepts.
sender
-tracedFabric
that contains inside of anothertracedFabric
(receiver)receiver
/subscriber
-tracedFabric
that will receivemutations
from nestedsenders
metadata
- data that is used for indexingtracedValues
. Contains:tracedFabric
reference - reference to thetracedFabric
that contains value with currentmetadata
, no mater how deep it is nested- parent reference - reference to
tracedValue
that contains value with currentmetadata
. It can be empty if the value is contained insidetracedFabric
- key - indicates the key to access value with current
metadata
in parent reference or tracedFabric reference if previous does not exists