All files / src/auxiliary AtomicBooleanFactory.ts

100% Statements 5/5
100% Branches 0/0
100% Functions 1/1
100% Lines 5/5

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 30 31 32 33 34 35 36  26x 26x                                         26x 25x           26x          
import { Contract } from "@jonloucks/contracts-ts/api/Contract";
import { create as createContract } from "@jonloucks/contracts-ts/api/RatifiedContract";
import { RequiredType, guardFunctions } from "@jonloucks/contracts-ts/api/Types";
import { AtomicBoolean } from "@jonloucks/contracts-ts/auxiliary/AtomicBoolean";
 
/**
 * Factory interface for creating AtomicBoolean instances.
 */
export interface AtomicBooleanFactory {
 
  /**
   * Create a new AtomicBoolean instance.    
   * @param initialValue the initial value of the AtomicBoolean
   */
  createAtomicBoolean(initialValue?: boolean): RequiredType<AtomicBoolean>;
}
 
/**
 * Type guard for AtomicBooleanFactory interface.
 * 
 * @param instance the instance to check
 * @returns true if the instance implements AtomicBooleanFactory
 */
export function guard(instance: unknown): instance is RequiredType<AtomicBooleanFactory> {
  return guardFunctions(instance, "createAtomicBoolean");
}
 
/**
 * The factory Contract for creating new AtomicBoolean instances.
 */
export const CONTRACT: Contract<AtomicBooleanFactory> = createContract({
  test: guard,
  name: "AtomicBooleanFactory"
});