diff --git a/src/signalGraphDefinitionTransform.ts b/src/signalGraphDefinitionTransform.ts index 29e9e5c..0787493 100644 --- a/src/signalGraphDefinitionTransform.ts +++ b/src/signalGraphDefinitionTransform.ts @@ -16,6 +16,12 @@ export type SignalGraphDefinitionTransform< signalGraphDefinition: SignalGraphDefinition ) => SignalGraphDefinition +/** + * Injects a dependency into the Signal Graph that can be used by derived + * signals + * @param key The key of the dependency + * @param dependency The dependency to be injected + */ export const addDependency = < SignalsType, Dependencies, @@ -33,6 +39,11 @@ export const addDependency = < depedencies: assoc(key, dependency, signalGraphDefinition.depedencies) }) +/** + * Adds a primary signal into the Signal Graph, wich are the source streams + * of the Signal Graph. + * @param key The key for the primary signal + */ export const addPrimary = ( key: K ): SignalGraphDefinitionTransform => < @@ -45,6 +56,15 @@ export const addPrimary =