All files / src/api CompletionNotify.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
 
1x
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1x
6x
 
 
 
import { OnCompletion } from "@jonloucks/concurrency-ts/api/OnCompletion";
import { AutoClose } from "@jonloucks/contracts-ts/api/AutoClose";
import { guardFunctions, RequiredType } from "@jonloucks/concurrency-ts/api/Types";
 
/**
 * Responsibility: Dispatch Completion status to subscribers
 */
export interface CompletionNotify<T> {
 
  /**
   * Open a notification subscription for receive completions
   *
   * @param onCompletion the completion
   * @return the
   */
  notify(onCompletion: OnCompletion<T>): AutoClose;
}
 
/**
 * Determine if an instance implements CompletionNotify
 * 
 * @param instance the instance to check
 * @returns true if the instance implements CompletionNotify
 */
export function guard<T>(instance: unknown): instance is RequiredType<CompletionNotify<T>> {
  return guardFunctions(instance,
    'notify'
  );
}