@effection/core - npm Package Compare versions

Comparing version 2.0.0-beta.12 to 2.0.0-beta.13

CHANGELOG.md

 # @effection/core
 
+## \[2.0.0-beta.13]
+
+- Add shortcuts to create resolved/rejected/halted futures via Future.resolve(123), etc...
+  - [9599dde](https://github.com/thefrontside/effection/commit/9599dde14e9bc3ba4ac7ea473e8624164727be0c) Add shortcuts for resolves/rejected/halted future on 2021-09-08
+
 ## \[2.0.0-beta.12]
@@ -4,0 +9,0 @@

dist-cjs/future.d.ts

@@ -24,7 +24,13 @@ import { RunLoop } from './run-loop';
     produce(value: Value<T>): void;
-    /** @deprecated Use produce(value) instead */
-    resolve(value: Value<T>): void;
+    resolve(value: T): void;
+    reject(error: Error): void;
+    halt(): void;
 }
 export declare function createFuture<T>(): NewFuture<T>;
 export declare function createFutureOnRunLoop<T>(runLoop: RunLoop): NewFuture<T>;
+export declare const Future: {
+    resolve<T>(value: T): Future<T>;
+    reject<T_1 = unknown>(error: Error): Future<T_1>;
+    halt<T_2 = unknown>(): Future<T_2>;
+};
 //# sourceMappingURL=future.d.ts.map

dist-cjs/future.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createFutureOnRunLoop = exports.createFuture = void 0;
+exports.Future = exports.createFutureOnRunLoop = exports.createFuture = void 0;
 const halt_error_1 = require("./halt-error");
@@ -36,6 +36,2 @@ const run_loop_1 = require("./run-loop");
     }
-    function resolve(value) {
-        console.warn(`DEPRECATED: resolve() is deprecated and will be changed or removed prior to the release of effection 2.0\nuse produce() instead`);
-        produce(value);
-    }
     let promise;
@@ -67,6 +63,25 @@ function getPromise() {
         },
-        resolve
+        resolve: (value) => produce({ state: 'completed', value }),
+        reject: (error) => produce({ state: 'errored', error }),
+        halt: () => produce({ state: 'halted' }),
     };
 }
 exports.createFutureOnRunLoop = createFutureOnRunLoop;
+exports.Future = {
+    resolve(value) {
+        let { future, resolve } = createFuture();
+        resolve(value);
+        return future;
+    },
+    reject(error) {
+        let { future, reject } = createFuture();
+        reject(error);
+        return future;
+    },
+    halt() {
+        let { future, halt } = createFuture();
+        halt();
+        return future;
+    },
+};
 //# sourceMappingURL=future.js.map

dist-cjs/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = exports.label = exports.all = exports.race = exports.spawn = exports.withTimeout = exports.timeout = exports.ensure = exports.sleep = exports.createFuture = exports.withLabels = exports.deprecated = exports.Effection = exports.createTask = void 0;
+exports.run = exports.label = exports.all = exports.race = exports.spawn = exports.withTimeout = exports.timeout = exports.ensure = exports.sleep = exports.Future = exports.createFuture = exports.withLabels = exports.deprecated = exports.Effection = exports.createTask = void 0;
 const effection_1 = require("./effection");
@@ -15,2 +15,3 @@ var task_1 = require("./task");
 Object.defineProperty(exports, "createFuture", { enumerable: true, get: function () { return future_1.createFuture; } });
+Object.defineProperty(exports, "Future", { enumerable: true, get: function () { return future_1.Future; } });
 var sleep_1 = require("./operations/sleep");
@@ -17,0 +18,0 @@ Object.defineProperty(exports, "sleep", { enumerable: true, get: function () { return sleep_1.sleep; } });

dist-cjs/operations/ensure.js

@@ -22,5 +22,3 @@ "use strict";
         });
-        let { future, produce } = future_1.createFuture();
-        produce({ state: 'completed', value: undefined });
-        return future;
+        return future_1.Future.resolve(undefined);
     };
@@ -27,0 +25,0 @@ }

dist-cjs/operations/label.js

@@ -13,5 +13,3 @@ "use strict";
         scope.setLabels(labels);
-        let { future, produce } = future_1.createFuture();
-        produce({ state: 'completed', value: undefined });
-        return future;
+        return future_1.Future.resolve(undefined);
     }, { name: 'label' });
@@ -18,0 +16,0 @@ }

dist-cjs/operations/spawn.js

@@ -12,5 +12,3 @@ "use strict";
         let result = scope.run(operation, options);
-        let { future, produce } = future_1.createFuture();
-        produce({ state: 'completed', value: result });
-        return future;
+        return future_1.Future.resolve(result);
     }
@@ -17,0 +15,0 @@ function within(scope) {

dist-esm/future.d.ts

@@ -24,7 +24,13 @@ import { RunLoop } from './run-loop';
     produce(value: Value<T>): void;
-    /** @deprecated Use produce(value) instead */
-    resolve(value: Value<T>): void;
+    resolve(value: T): void;
+    reject(error: Error): void;
+    halt(): void;
 }
 export declare function createFuture<T>(): NewFuture<T>;
 export declare function createFutureOnRunLoop<T>(runLoop: RunLoop): NewFuture<T>;
+export declare const Future: {
+    resolve<T>(value: T): Future<T>;
+    reject<T_1 = unknown>(error: Error): Future<T_1>;
+    halt<T_2 = unknown>(): Future<T_2>;
+};
 //# sourceMappingURL=future.d.ts.map

dist-esm/future.js

@@ -32,6 +32,2 @@ import { HaltError } from './halt-error';
     }
-    function resolve(value) {
-        console.warn(`DEPRECATED: resolve() is deprecated and will be changed or removed prior to the release of effection 2.0\nuse produce() instead`);
-        produce(value);
-    }
     let promise;
@@ -63,5 +59,24 @@ function getPromise() {
         },
-        resolve
+        resolve: (value) => produce({ state: 'completed', value }),
+        reject: (error) => produce({ state: 'errored', error }),
+        halt: () => produce({ state: 'halted' }),
     };
 }
+export const Future = {
+    resolve(value) {
+        let { future, resolve } = createFuture();
+        resolve(value);
+        return future;
+    },
+    reject(error) {
+        let { future, reject } = createFuture();
+        reject(error);
+        return future;
+    },
+    halt() {
+        let { future, halt } = createFuture();
+        halt();
+        return future;
+    },
+};
 //# sourceMappingURL=future.js.map

dist-esm/index.js

@@ -6,3 +6,3 @@ import { Effection } from './effection';
 export { withLabels } from './labels';
-export { createFuture } from './future';
+export { createFuture, Future } from './future';
 export { sleep } from './operations/sleep';
@@ -9,0 +9,0 @@ export { ensure } from './operations/ensure';

dist-esm/operations/ensure.js

@@ -1,2 +0,2 @@
-import { createFuture } from '../future';
+import { Future } from '../future';
 export function ensure(fn) {
@@ -19,7 +19,5 @@ return function ensure(task) {
         });
-        let { future, produce } = createFuture();
-        produce({ state: 'completed', value: undefined });
-        return future;
+        return Future.resolve(undefined);
     };
 }
 //# sourceMappingURL=ensure.js.map

dist-esm/operations/label.js

@@ -1,2 +0,2 @@
-import { createFuture } from '../future';
+import { Future } from '../future';
 import { withLabels } from '../labels';
@@ -10,7 +10,5 @@ export function label(labels) {
         scope.setLabels(labels);
-        let { future, produce } = createFuture();
-        produce({ state: 'completed', value: undefined });
-        return future;
+        return Future.resolve(undefined);
     }, { name: 'label' });
 }
 //# sourceMappingURL=label.js.map

dist-esm/operations/spawn.js

@@ -1,2 +0,2 @@
-import { createFuture } from '../future';
+import { Future } from '../future';
 export function spawn(operation, options) {
@@ -9,5 +9,3 @@ function spawn(task) {
         let result = scope.run(operation, options);
-        let { future, produce } = createFuture();
-        produce({ state: 'completed', value: result });
-        return future;
+        return Future.resolve(result);
     }
@@ -14,0 +12,0 @@ function within(scope) {

package.json

 {
   "name": "@effection/core",
-  "version": "2.0.0-beta.12",
+  "version": "2.0.0-beta.13",
   "main": "dist-cjs/index.js",
@@ -5,0 +5,0 @@ "module": "dist-esm/index.js",

src/future.ts

@@ -26,4 +26,5 @@ import { HaltError } from './halt-error';
   produce(value: Value<T>): void;
-  /** @deprecated Use produce(value) instead */
-  resolve(value: Value<T>): void;
+  resolve(value: T): void;
+  reject(error: Error): void;
+  halt(): void;
 }
@@ -65,8 +66,2 @@
 
-  function resolve(value: Value<T>) {
-    console.warn(`DEPRECATED: resolve() is deprecated and will be changed or removed prior to the release of effection 2.0\nuse produce() instead`);
-    produce(value);
-  }
-
-
   let promise: Promise<T>;
@@ -98,4 +93,26 @@
     },
-    resolve
+    resolve: (value: T) => produce({ state: 'completed', value }),
+    reject: (error: Error) => produce({ state: 'errored', error }),
+    halt: () => produce({ state: 'halted' }),
   };
 }
+
+export const Future = {
+  resolve<T>(value: T): Future<T> {
+    let { future, resolve } = createFuture<T>();
+    resolve(value);
+    return future;
+  },
+
+  reject<T = unknown>(error: Error): Future<T> {
+    let { future, reject } = createFuture<T>();
+    reject(error);
+    return future;
+  },
+
+  halt<T = unknown>(): Future<T> {
+    let { future, halt } = createFuture<T>();
+    halt();
+    return future;
+  },
+};

src/operations/ensure.ts

 import { Operation } from '../operation';
-import { createFuture } from '../future';
+import { Future } from '../future';
 
@@ -21,6 +21,4 @@ export function ensure<T>(fn: () => Operation<T> | void): Operation<undefined> {
 
-    let { future, produce } = createFuture<undefined>();
-    produce({ state: 'completed', value: undefined });
-    return future;
+    return Future.resolve(undefined);
   };
 }

src/operations/label.ts

 import { Operation } from '../operation';
 import { Labels } from '../labels';
-import { createFuture } from '../future';
+import { Future } from '../future';
 import { withLabels } from '../labels';
@@ -13,6 +13,4 @@
     scope.setLabels(labels);
-    let { future, produce } = createFuture<undefined>();
-    produce({ state: 'completed', value: undefined });
-    return future;
+    return Future.resolve(undefined);
   }, { name: 'label' });
 }

src/operations/spawn.ts

 import { Operation, OperationFunction } from '../operation';
-import { createFuture } from '../future';
+import { Future } from '../future';
 import type { Task, TaskOptions } from '../task';
@@ -16,5 +16,3 @@
     let result = scope.run(operation, options);
-    let { future, produce } = createFuture<Task<T>>();
-    produce({ state: 'completed', value: result });
-    return future;
+    return Future.resolve(result);
   }
@@ -21,0 +19,0 @@

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

217362

increased by0.76%

Lines of code

3289

increased by1.26%

No dependency changes