Merge pull request #4 from retejs/add-docs

docs: throws Cancelled

src/dataflow-engine.ts

@@ -107,7 +107,7 @@ export class DataflowEngine<Schemes extends DataflowEngineScheme> extends Scope<
   /**
    * Fetches input data for the node by fetching data for all its predecessors recursively.
    * @param nodeId Node id to fetch input data for
-   * @throws {Cancelled} when `reset` is called while fetching data
+   * @throws `Cancelled when `reset` is called while fetching data
    */
   public async fetchInputs(nodeId: NodeId) {
     return this.getDataflow().fetchInputs(nodeId)
@@ -116,7 +116,7 @@ export class DataflowEngine<Schemes extends DataflowEngineScheme> extends Scope<
   /**
    * Fetches output data of the node
    * @param nodeId Node id to fetch data from
-   * @throws {Cancelled} when `reset` is called while fetching data
+   * @throws `Cancelled` when `reset` is called while fetching data
    */
   public async fetch(nodeId: NodeId) {
     return this.getDataflow().fetch(nodeId)

src/index.ts

@@ -3,3 +3,4 @@ export * from './control-flow-engine'
 export * from './dataflow'
 export * from './dataflow-engine'
 export * from './utils/cancellable'
+export { Cancelled } from './utils/cancellable'

src/utils/cancellable.ts

@@ -1,4 +1,6 @@
-
+/**
+ * Cancelled exception. Thrown when `reset` is called while fetching data.
+ */
 export class Cancelled extends Error {
   constructor() {
     super('cancelled')