All files / src/api AutoOpen.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
 
28x
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
28x
563x
 
 
 
 
import { AutoClose } from "@jonloucks/contracts-ts/api/AutoClose";
import { guardFunctions, RequiredType } from "@jonloucks/contracts-ts/api/Types";
 
/**
 * Opt-in interface to be called once after creation, although implementations should
 * handle this gracefully. For example, this is when threads or hooks could be added.
 * will automatically call this method once if the deliverable implements this method.
 */
export interface AutoOpen { // Intentionally does not extend the Open interface
 
    /**
     * AutoOpen this instance
     * @return the mechanism to shut down
     */
    autoOpen(): AutoClose;
}
 
/**
 * Duck-typing check for AutoOpen interface.
 * 
 * @param instance the instance to check
 * @returns true if the instance implements AutoOpen, false otherwise
 */
export function guard(instance: unknown): instance is RequiredType<AutoOpen> {
    return guardFunctions(instance, 'autoOpen');
}