All files / src/api OnCompletion.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
 
1x
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1x
6x
 
import { Completion } from "@jonloucks/concurrency-ts/api/Completion";
import { RequiredType, guardFunctions } from "@jonloucks/concurrency-ts/api/Types";
 
/**
 * Responsibility: to receive the information when an action or activity has finished.
 * Use for both asynchronous and synchronous actions. The only difference is when and on what
 * thread the callback is executed on
 * @param <T> the type of completion value
 */
export interface OnCompletion<T> {
 
  /**
   * Callback which receives the
   * @param completion the completion information.
   */
  onCompletion(completion: RequiredType<Completion<T>>): void;
}
 
/**
 * Determine if the given instance is an OnCompletion
 *
 * @param instance the instance to check
 * @return true if instance is an OnCompletion, false otherwise
 */
export function guard<T>(instance: unknown): instance is RequiredType<OnCompletion<T>> {
  return guardFunctions(instance, 'onCompletion');
};