All files / src/api RepositoryFactory.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
30
31
32
33
 
26x
 
26x
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
26x
26x
 
 
 
 
 
26x
 
 
 
import { Contract } from "@jonloucks/contracts-ts/api/Contract";
import { create as createContract } from "@jonloucks/contracts-ts/api/RatifiedContract";
import { Repository, Config } from "@jonloucks/contracts-ts/api/Repository";
import { RequiredType, guardFunctions } from "@jonloucks/contracts-ts/api/Types";
 
/**
 * Factory interface for creating Repository instances.
 */
export interface RepositoryFactory {
 
  /**
   * Create a new Repository instance.    
   */
  createRepository(config?: Config): RequiredType<Repository>;
}
 
/**
 * Type guard for RepositoryFactory
 * 
 * @param value the value to check
 * @return true if value is RepositoryFactory, false otherwise
 */
export function guard(value: unknown): value is RequiredType<RepositoryFactory> {
  return guardFunctions(value, "createRepository");
}
 
/**
 * The factory Contract for creating new Repository instances.
 */
export const CONTRACT: Contract<RequiredType<RepositoryFactory>> = createContract({
  test: guard,
  name: "RepositoryFactory"
});