Skip to content

Add documentation for DSL methods #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 5, 2018
Merged

Add documentation for DSL methods #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/signalGraphDefinitionTransform.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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]> => <
Expand All @@ -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,
Expand Down