@code-to-json/utils - npm Package Compare versions

Comparing version 0.5.49 to 0.6.0

CHANGELOG.md

@@ -6,2 +6,14 @@ # Change Log
 
+# [0.6.0](https://github.com/mike-north/code-to-json/compare/@code-to-json/utils@0.5.49...@code-to-json/utils@0.6.0) (2019-01-04)
+
+
+### Features
+
+* move InvalidArgumentsError to utils ([d58dd3f](https://github.com/mike-north/code-to-json/commit/d58dd3f))
+* parameterize reference system over ref-registry ([7b6d54b](https://github.com/mike-north/code-to-json/commit/7b6d54b))
+
+
+
+
+
 ## [0.5.49](https://github.com/mike-north/code-to-json/compare/@code-to-json/utils@0.5.48...@code-to-json/utils@0.5.49) (2019-01-03)
@@ -8,0 +20,0 @@

lib/src/deferred-processing/queue.d.ts

 import { Ref, RefTypes } from './ref';
-export interface Queue<K extends string, T extends object> {
+export interface Queue<K, T extends object> {
     queue(item: T): Ref<K>;
@@ -12,3 +12,3 @@ numUnprocessed(): number;
 }
-export declare function createQueue<K extends RefTypes, T extends object>(k: K, idGenerator: (t: T) => string): Queue<K, T>;
+export declare function createQueue<RefRegistry, K extends RefTypes<RefRegistry>, T extends object>(k: K, idGenerator: (t: T) => string): Queue<K, T>;
 //# sourceMappingURL=queue.d.ts.map

lib/src/deferred-processing/queue.js

@@ -46,2 +46,2 @@ "use strict";
 exports.createQueue = createQueue;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVldWUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvZGVmZXJyZWQtcHJvY2Vzc2luZy9xdWV1ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLCtCQUFpRDtBQWNqRCxTQUFnQixXQUFXLENBQ3pCLENBQUksRUFDSixXQUE2QjtJQUU3QixNQUFNLFNBQVMsR0FBRyxJQUFJLEdBQUcsRUFBdUIsQ0FBQztJQUNqRCxPQUFPO1FBQ0wsS0FBSyxDQUFDLElBQU87WUFDWCxNQUFNLFlBQVksR0FBRyxTQUFTLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ3pDLElBQUksWUFBWSxFQUFFO2dCQUNoQixPQUFPLFlBQVksQ0FBQyxHQUFHLENBQUM7YUFDekI7WUFDRCxNQUFNLEVBQUUsR0FBRyxXQUFXLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDN0IsTUFBTSxHQUFHLEdBQVcsZUFBUyxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQztZQUNyQyxTQUFTLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxFQUFFLEdBQUcsRUFBRSxTQUFTLEVBQUUsS0FBSyxFQUFFLENBQUMsQ0FBQztZQUMvQyxPQUFPLEdBQUcsQ0FBQztRQUNiLENBQUM7UUFDRCxjQUFjO1lBQ1osT0FBTyxDQUFDLEdBQUcsU0FBUyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsRUFBRSxFQUFFLElBQUksRUFBRSxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLEVBQUUsR0FBRyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQztRQUN6RixDQUFDO1FBQ0QsS0FBSyxDQUFXLEVBQStCO1lBQzdDLElBQUksY0FBYyxHQUFHLENBQUMsQ0FBQztZQUN2QixTQUFTLENBQUMsT0FBTyxDQUFDLENBQUMsS0FBSyxFQUFFLEdBQUcsRUFBRSxFQUFFO2dCQUMvQixNQUFNLEVBQUUsR0FBRyxFQUFFLFNBQVMsRUFBRSxHQUFHLEtBQUssQ0FBQztnQkFDakMsSUFBSSxTQUFTLEVBQUU7b0JBQ2IsT0FBTztpQkFDUjtnQkFDRCxFQUFFLENBQUMsR0FBRyxFQUFFLEdBQUcsQ0FBQyxDQUFDO2dCQUNiLDZDQUE2QztnQkFDN0MsS0FBSyxDQUFDLFNBQVMsR0FBRyxJQUFJLENBQUM7Z0JBQ3ZCLGNBQWMsRUFBRSxDQUFDO1lBQ25CLENBQUMsQ0FBQyxDQUFDO1lBQ0gsT0FBTyxFQUFFLGNBQWMsRUFBRSxDQUFDO1FBQzVCLENBQUM7UUFDRCxlQUFlLENBQUMsRUFBa0M7WUFDaEQsSUFBSSxjQUFjLEdBQUcsQ0FBQyxDQUFDO1lBQ3ZCLElBQUksRUFBRSxjQUFjLEVBQUUsS0FBSyxFQUFFLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUMsQ0FBQztZQUMvQyxPQUFPLEtBQUssR0FBRyxDQUFDLEVBQUU7Z0JBQ2hCLEtBQUssR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQyxDQUFDLGNBQWMsQ0FBQztnQkFDdEMsY0FBYyxJQUFJLEtBQUssQ0FBQzthQUN6QjtZQUNELE9BQU8sRUFBRSxjQUFjLEVBQUUsQ0FBQztRQUM1QixDQUFDO0tBQ0YsQ0FBQztBQUNKLENBQUM7QUEzQ0Qsa0NBMkNDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVldWUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvZGVmZXJyZWQtcHJvY2Vzc2luZy9xdWV1ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLCtCQUFpRDtBQWNqRCxTQUFnQixXQUFXLENBQ3pCLENBQUksRUFDSixXQUE2QjtJQUU3QixNQUFNLFNBQVMsR0FBRyxJQUFJLEdBQUcsRUFBdUIsQ0FBQztJQUNqRCxPQUFPO1FBQ0wsS0FBSyxDQUFDLElBQU87WUFDWCxNQUFNLFlBQVksR0FBRyxTQUFTLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ3pDLElBQUksWUFBWSxFQUFFO2dCQUNoQixPQUFPLFlBQVksQ0FBQyxHQUFHLENBQUM7YUFDekI7WUFDRCxNQUFNLEVBQUUsR0FBRyxXQUFXLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDN0IsTUFBTSxHQUFHLEdBQVcsZUFBUyxDQUFpQixDQUFDLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDckQsU0FBUyxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsRUFBRSxHQUFHLEVBQUUsU0FBUyxFQUFFLEtBQUssRUFBRSxDQUFDLENBQUM7WUFDL0MsT0FBTyxHQUFHLENBQUM7UUFDYixDQUFDO1FBQ0QsY0FBYztZQUNaLE9BQU8sQ0FBQyxHQUFHLFNBQVMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxDQUFDLEVBQUUsRUFBRSxJQUFJLEVBQUUsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxFQUFFLEdBQUcsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUM7UUFDekYsQ0FBQztRQUNELEtBQUssQ0FBVyxFQUErQjtZQUM3QyxJQUFJLGNBQWMsR0FBRyxDQUFDLENBQUM7WUFDdkIsU0FBUyxDQUFDLE9BQU8sQ0FBQyxDQUFDLEtBQUssRUFBRSxHQUFHLEVBQUUsRUFBRTtnQkFDL0IsTUFBTSxFQUFFLEdBQUcsRUFBRSxTQUFTLEVBQUUsR0FBRyxLQUFLLENBQUM7Z0JBQ2pDLElBQUksU0FBUyxFQUFFO29CQUNiLE9BQU87aUJBQ1I7Z0JBQ0QsRUFBRSxDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsQ0FBQztnQkFDYiw2Q0FBNkM7Z0JBQzdDLEtBQUssQ0FBQyxTQUFTLEdBQUcsSUFBSSxDQUFDO2dCQUN2QixjQUFjLEVBQUUsQ0FBQztZQUNuQixDQUFDLENBQUMsQ0FBQztZQUNILE9BQU8sRUFBRSxjQUFjLEVBQUUsQ0FBQztRQUM1QixDQUFDO1FBQ0QsZUFBZSxDQUFDLEVBQWtDO1lBQ2hELElBQUksY0FBYyxHQUFHLENBQUMsQ0FBQztZQUN2QixJQUFJLEVBQUUsY0FBYyxFQUFFLEtBQUssRUFBRSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLENBQUM7WUFDL0MsT0FBTyxLQUFLLEdBQUcsQ0FBQyxFQUFFO2dCQUNoQixLQUFLLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUMsQ0FBQyxjQUFjLENBQUM7Z0JBQ3RDLGNBQWMsSUFBSSxLQUFLLENBQUM7YUFDekI7WUFDRCxPQUFPLEVBQUUsY0FBYyxFQUFFLENBQUM7UUFDNUIsQ0FBQztLQUNGLENBQUM7QUFDSixDQUFDO0FBM0NELGtDQTJDQyJ9

lib/src/deferred-processing/ref.d.ts

@@ -1,2 +0,1 @@
-import RefRegistry from './ref-registry';
 export interface RefId<S> {
@@ -11,9 +10,9 @@ __do_not_use_this_refid: S;
  */
-export declare type Ref<K extends string, S extends {} = string> = [RefType<K>, RefId<S>];
+export declare type Ref<K, S extends {} = string> = [RefType<K>, RefId<S>];
 /**
  * Get a reference type for a registry
  */
-export declare type RefFor<K extends keyof RefRegistry> = RefRegistry[K];
-export declare type RefTypes = keyof RefRegistry;
-export declare type AnyRef = RefRegistry[RefTypes];
+export declare type RefFor<RefRegistry, K extends keyof RefRegistry> = RefRegistry[K];
+export declare type RefTypes<RefRegistry> = keyof RefRegistry;
+export declare type AnyRef<RefRegistry> = RefRegistry[RefTypes<RefRegistry>];
 /**
@@ -30,3 +29,3 @@ * Check to see whether a value is a reference
  */
-export declare function createRef<K extends RefTypes>(type: K, id: string): Ref<K>;
+export declare function createRef<RefRegistry, K extends RefTypes<RefRegistry>>(type: K, id: string): Ref<K>;
 /**
@@ -33,0 +32,0 @@ * Get a reference's type name

lib/src/deferred-processing/ref.js

@@ -42,2 +42,2 @@ "use strict";
 exports.refId = refId;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVmLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2RlZmVycmVkLXByb2Nlc3NpbmcvcmVmLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsb0NBQW1DO0FBdUJuQzs7O0dBR0c7QUFDSCxTQUFnQixLQUFLLENBQXFCLEtBQVM7SUFDakQsT0FBTyxDQUNMLENBQUMsQ0FBQyxLQUFLO1FBQ1AsQ0FBQyxDQUFDLGVBQU8sQ0FBQyxLQUFLLENBQUM7UUFDaEIsS0FBSyxDQUFDLE1BQU0sS0FBSyxDQUFDO1FBQ2xCLE9BQU8sS0FBSyxDQUFDLENBQUMsQ0FBQyxLQUFLLFFBQVE7UUFDNUIsT0FBTyxLQUFLLENBQUMsQ0FBQyxDQUFDLEtBQUssUUFBUSxDQUM3QixDQUFDO0FBQ0osQ0FBQztBQVJELHNCQVFDO0FBRUQ7Ozs7O0dBS0c7QUFDSCxTQUFnQixTQUFTLENBQXFCLElBQU8sRUFBRSxFQUFVO0lBQy9ELE9BQU8sQ0FBRSxJQUEwQixFQUFFLEVBQVMsQ0FBQyxDQUFDO0FBQ2xELENBQUM7QUFGRCw4QkFFQztBQUVEOzs7R0FHRztBQUNILFNBQWdCLE9BQU8sQ0FBbUIsR0FBZ0I7SUFDeEQsT0FBTyxHQUFHLENBQUMsQ0FBQyxDQUFRLENBQUM7QUFDdkIsQ0FBQztBQUZELDBCQUVDO0FBRUQ7OztHQUdHO0FBQ0gsU0FBZ0IsS0FBSyxDQUFlLEdBQWdCO0lBQ2xELE9BQU8sR0FBRyxDQUFDLENBQUMsQ0FBUSxDQUFDO0FBQ3ZCLENBQUM7QUFGRCxzQkFFQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVmLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2RlZmVycmVkLXByb2Nlc3NpbmcvcmVmLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsb0NBQW1DO0FBc0JuQzs7O0dBR0c7QUFDSCxTQUFnQixLQUFLLENBQXFCLEtBQVM7SUFDakQsT0FBTyxDQUNMLENBQUMsQ0FBQyxLQUFLO1FBQ1AsQ0FBQyxDQUFDLGVBQU8sQ0FBQyxLQUFLLENBQUM7UUFDaEIsS0FBSyxDQUFDLE1BQU0sS0FBSyxDQUFDO1FBQ2xCLE9BQU8sS0FBSyxDQUFDLENBQUMsQ0FBQyxLQUFLLFFBQVE7UUFDNUIsT0FBTyxLQUFLLENBQUMsQ0FBQyxDQUFDLEtBQUssUUFBUSxDQUM3QixDQUFDO0FBQ0osQ0FBQztBQVJELHNCQVFDO0FBRUQ7Ozs7O0dBS0c7QUFDSCxTQUFnQixTQUFTLENBQ3ZCLElBQU8sRUFDUCxFQUFVO0lBRVYsT0FBTyxDQUFFLElBQTBCLEVBQUUsRUFBUyxDQUFDLENBQUM7QUFDbEQsQ0FBQztBQUxELDhCQUtDO0FBRUQ7OztHQUdHO0FBQ0gsU0FBZ0IsT0FBTyxDQUFtQixHQUFnQjtJQUN4RCxPQUFPLEdBQUcsQ0FBQyxDQUFDLENBQVEsQ0FBQztBQUN2QixDQUFDO0FBRkQsMEJBRUM7QUFFRDs7O0dBR0c7QUFDSCxTQUFnQixLQUFLLENBQWUsR0FBZ0I7SUFDbEQsT0FBTyxHQUFHLENBQUMsQ0FBQyxDQUFRLENBQUM7QUFDdkIsQ0FBQztBQUZELHNCQUVDIn0=

lib/src/index.d.ts

 export { default as UnreachableError } from './errors/unreachable';
+export { default as InvalidArgumentsError } from './errors/invalid-arguments';
 export { some, all, isArray } from './array';
-export { Result, ErrorResult, SuccessResult } from './types';
+export { Result, ErrorResult, SuccessResult, TextFileReader, FileExistenceChecker } from './types';
 export { isBlank, isPresent, isEmpty, isNone } from './checks';
@@ -5,0 +6,0 @@ export { createQueue, Queue } from './deferred-processing/queue';

lib/src/index.js

@@ -5,2 +5,4 @@ "use strict";
 exports.UnreachableError = unreachable_1.default;
+var invalid_arguments_1 = require("./errors/invalid-arguments");
+exports.InvalidArgumentsError = invalid_arguments_1.default;
 var array_1 = require("./array");
@@ -26,2 +28,2 @@ exports.some = array_1.some;
 exports.conditionallyMergeTransformed = object_1.conditionallyMergeTransformed;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxvREFBbUU7QUFBMUQseUNBQUEsT0FBTyxDQUFvQjtBQUNwQyxpQ0FBNkM7QUFBcEMsdUJBQUEsSUFBSSxDQUFBO0FBQUUsc0JBQUEsR0FBRyxDQUFBO0FBQUUsMEJBQUEsT0FBTyxDQUFBO0FBRTNCLG1DQUErRDtBQUF0RCwyQkFBQSxPQUFPLENBQUE7QUFBRSw2QkFBQSxTQUFTLENBQUE7QUFBRSwyQkFBQSxPQUFPLENBQUE7QUFBRSwwQkFBQSxNQUFNLENBQUE7QUFDNUMscURBQWlFO0FBQXhELDhCQUFBLFdBQVcsQ0FBQTtBQUNwQixpREFBa0c7QUFBcEUsd0JBQUEsT0FBTyxDQUFBO0FBQUUsc0JBQUEsS0FBSyxDQUFBO0FBQUUsc0JBQUEsS0FBSyxDQUFBO0FBQUUsMEJBQUEsU0FBUyxDQUFBO0FBQzlELHFDQUFvQztBQUEzQiw0QkFBQSxPQUFPLENBQUE7QUFDaEIsbUNBQXlEO0FBQWhELGlEQUFBLDZCQUE2QixDQUFBIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxvREFBbUU7QUFBMUQseUNBQUEsT0FBTyxDQUFvQjtBQUNwQyxnRUFBOEU7QUFBckUsb0RBQUEsT0FBTyxDQUF5QjtBQUN6QyxpQ0FBNkM7QUFBcEMsdUJBQUEsSUFBSSxDQUFBO0FBQUUsc0JBQUEsR0FBRyxDQUFBO0FBQUUsMEJBQUEsT0FBTyxDQUFBO0FBRTNCLG1DQUErRDtBQUF0RCwyQkFBQSxPQUFPLENBQUE7QUFBRSw2QkFBQSxTQUFTLENBQUE7QUFBRSwyQkFBQSxPQUFPLENBQUE7QUFBRSwwQkFBQSxNQUFNLENBQUE7QUFDNUMscURBQWlFO0FBQXhELDhCQUFBLFdBQVcsQ0FBQTtBQUNwQixpREFBa0c7QUFBcEUsd0JBQUEsT0FBTyxDQUFBO0FBQUUsc0JBQUEsS0FBSyxDQUFBO0FBQUUsc0JBQUEsS0FBSyxDQUFBO0FBQUUsMEJBQUEsU0FBUyxDQUFBO0FBQzlELHFDQUFvQztBQUEzQiw0QkFBQSxPQUFPLENBQUE7QUFDaEIsbUNBQXlEO0FBQWhELGlEQUFBLDZCQUE2QixDQUFBIn0=

lib/src/types.d.ts

 export declare type ErrorResult<E extends Error = Error> = ['error', E];
 export declare type SuccessResult<T> = ['ok', T];
 export declare type Result<T, E extends Error = Error> = SuccessResult<T> | ErrorResult<E>;
+export declare type TextFileReader = (name: string) => string;
+export declare type FileExistenceChecker = (name: string) => boolean;
 //# sourceMappingURL=types.d.ts.map

package.json

 {
   "name": "@code-to-json/utils",
-  "version": "0.5.49",
+  "version": "0.6.0",
   "description": "",
@@ -13,3 +13,3 @@ "main": "lib/src/index.js",
     "lint": "yarn lint:ts && yarn lint:js && yarn lint:md",
-    "lint:ts": "tslint --project .",
+    "lint:ts": "tslint --project . && tslint --project test",
     "lint:js": "eslint . --ext js,ts",
@@ -29,3 +29,3 @@ "lint:md": "remark .",
     "chai": "4.2.0",
-    "eslint": "5.11.1",
+    "eslint": "5.12.0",
     "eslint-config-airbnb-base": "13.1.0",
@@ -94,3 +94,3 @@ "eslint-config-prettier": "3.3.0",
   },
-  "gitHead": "3c98c210707964545dc2123c2a456bedc454b299"
+  "gitHead": "b74d81c5263a2922f12e4951e92fd39533934f37"
 }

src/deferred-processing/queue.ts

 import { createRef, Ref, RefTypes } from './ref';
 
-interface EntityInfo<K extends string, T extends object> {
+interface EntityInfo<K, T extends object> {
   ref: Ref<K>;
@@ -8,3 +8,3 @@ processed: boolean;
 
-export interface Queue<K extends string, T extends object> {
+export interface Queue<K, T extends object> {
   queue(item: T): Ref<K>;
@@ -16,3 +16,3 @@ numUnprocessed(): number;
 
-export function createQueue<K extends RefTypes, T extends object>(
+export function createQueue<RefRegistry, K extends RefTypes<RefRegistry>, T extends object>(
   k: K,
@@ -29,3 +29,3 @@ idGenerator: (t: T) => string,
       const id = idGenerator(item);
-      const ref: Ref<K> = createRef(k, id);
+      const ref: Ref<K> = createRef<RefRegistry, K>(k, id);
       itemToRef.set(item, { ref, processed: false });
@@ -32,0 +32,0 @@ return ref;

src/deferred-processing/ref.ts

 import { isArray } from '../array';
-import RefRegistry from './ref-registry';
 
@@ -14,3 +13,3 @@ export interface RefId<S> {
  */
-export type Ref<K extends string, S extends {} = string> = [RefType<K>, RefId<S>];
+export type Ref<K, S extends {} = string> = [RefType<K>, RefId<S>];
 
@@ -20,6 +19,6 @@ /**
  */
-export type RefFor<K extends keyof RefRegistry> = RefRegistry[K];
+export type RefFor<RefRegistry, K extends keyof RefRegistry> = RefRegistry[K];
 
-export type RefTypes = keyof RefRegistry;
-export type AnyRef = RefRegistry[RefTypes];
+export type RefTypes<RefRegistry> = keyof RefRegistry;
+export type AnyRef<RefRegistry> = RefRegistry[RefTypes<RefRegistry>];
 
@@ -46,3 +45,6 @@ /**
  */
-export function createRef<K extends RefTypes>(type: K, id: string): Ref<K> {
+export function createRef<RefRegistry, K extends RefTypes<RefRegistry>>(
+  type: K,
+  id: string,
+): Ref<K> {
   return [(type as any) as RefType<K>, id as any];
@@ -49,0 +51,0 @@ }

src/index.ts

 export { default as UnreachableError } from './errors/unreachable';
+export { default as InvalidArgumentsError } from './errors/invalid-arguments';
 export { some, all, isArray } from './array';
-export { Result, ErrorResult, SuccessResult } from './types';
+export { Result, ErrorResult, SuccessResult, TextFileReader, FileExistenceChecker } from './types';
 export { isBlank, isPresent, isEmpty, isNone } from './checks';
@@ -5,0 +6,0 @@ export { createQueue, Queue } from './deferred-processing/queue';

src/types.ts

 export type ErrorResult<E extends Error = Error> = ['error', E];
 export type SuccessResult<T> = ['ok', T];
 export type Result<T, E extends Error = Error> = SuccessResult<T> | ErrorResult<E>;
+export type TextFileReader = (name: string) => string;
+export type FileExistenceChecker = (name: string) => boolean;

test/deferred-processing.test.ts

 import { expect } from 'chai';
 import { suite, test } from 'mocha-typescript';
-import { createRef } from '../src/deferred-processing/ref';
-import { createQueue, isRef, Queue } from '../src/index';
+import { createQueue, Queue } from '../src/index';
 
-declare module '../src/deferred-processing/ref-registry' {
-  export default interface RefRegistry {
-    foo: ['foo', string];
-  }
-}
-
 @suite
@@ -17,3 +10,6 @@ class DeferredProcessingTests {
   public before() {
-    this.q = createQueue('foo', (val: { idd: string }) => `~~${val.idd}~~`);
+    this.q = createQueue<{ foo: any }, 'foo', { idd: string }>(
+      'foo',
+      (val: { idd: string }) => `~~${val.idd}~~`,
+    );
   }
@@ -20,0 +16,0 @@

test/error.test.ts

@@ -5,8 +5,2 @@ import { expect } from 'chai';
 
-declare module '../src/deferred-processing/ref-registry' {
-  export default interface RefRegistry {
-    foo: ['foo', string];
-  }
-}
-
 @suite
@@ -13,0 +7,0 @@ class ErrorTests {

test/ref.test.ts

@@ -6,8 +6,2 @@ import { expect } from 'chai';
 
-declare module '../src/deferred-processing/ref-registry' {
-  export default interface RefRegistry {
-    foo: ['foo', string];
-  }
-}
-
 @suite
@@ -19,3 +13,3 @@ class RefTests {
     expect(isRef()).to.eql(false);
-    const r = createRef('foo', '1231');
+    const r = createRef<{ foo: string }, 'foo'>('foo', '1231');
     expect(isRef(r)).to.eql(true);
@@ -22,0 +16,0 @@ expect(isRef(['foo' as any, 99 as any])).to.eql(false);

tsconfig.json

@@ -11,3 +11,3 @@ {
   "include": ["src"],
-  "exclude": ["node_modules/**/*", "lib/**/*"]
+  "exclude": ["lib"]
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

67508

increased by3.27%

Lines of code

1058

increased by2.82%

No dependency changes