From 73ce362a8f7ecccf35e22387a4008df18d21e4c8 Mon Sep 17 00:00:00 2001
From: Daniel Ramos <danielramosacosta@hotmail.com>
Date: Wed, 3 Oct 2018 22:23:28 +0100
Subject: [PATCH] docs(signalGraphDefinitionTransform): Add docs for
 addDependency, addPrimary and addDerived

re #6
---
 src/signalGraphDefinitionTransform.ts | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

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<SignalsType, Dependencies, P, D>
 ) => SignalGraphDefinition<SignalsType, Dependencies, P | EP[0], D | EP[1]>
 
+/**
+ * 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 = <SignalsType, Dependencies, K extends keyof SignalsType>(
   key: K
 ): SignalGraphDefinitionTransform<SignalsType, Dependencies, [K, never]> => <
@@ -45,6 +56,15 @@ export const addPrimary = <SignalsType, Dependencies, K extends keyof SignalsTyp
   primaryKeys: (signalGraphDefinition.primaryKeys as (P | K)[]).concat(key)
 })
 
+/**
+ * Adds a new derived signal into the Signal Graph. It uses other signals passed
+ * by arguments to create a new derived signal.
+ * @param key The key for the derivation
+ * @param derivationFn The function that will create a derived stream from its
+ * arguments
+ * @param args The list of keys of other primary signals or derived streams
+ * required for the derivation function
+ */
 export const addDerived = <
   SignalsType,
   Dependencies,