recoil-nexus - npm Package Compare versions

Comparing version 0.2.51 to 0.3.0

build/RecoilNexus.d.ts

 import { RecoilState } from 'recoil';
 export default function RecoilNexus(): null;
-export declare function getRecoil<T>(atom: RecoilState<T>): Promise<T>;
+export declare function getRecoil<T>(atom: RecoilState<T>): T;
+export declare function getRecoilPromise<T>(atom: RecoilState<T>): Promise<T>;
 export declare function setRecoil<T>(atom: RecoilState<T>, value: T): void;

build/RecoilNexus.js

@@ -6,13 +6,15 @@ import { useRecoilCallback } from 'recoil';
         var snapshot = _a.snapshot;
-        return function (_a) {
-            var atom = _a.atom, resolve = _a.resolve;
-            resolve(snapshot.getPromise(atom));
+        return function (atom) {
+            return snapshot.getLoadable(atom).contents;
         };
     }, []);
+    nexus.getPromise = useRecoilCallback(function (_a) {
+        var snapshot = _a.snapshot;
+        return function (atom) {
+            return snapshot.getPromise(atom);
+        };
+    }, []);
     nexus.set = useRecoilCallback(function (_a) {
         var set = _a.set;
-        return function (_a) {
-            var atom = _a.atom, value = _a.value;
-            set(atom, value);
-        };
+        return set;
     }, []);
@@ -22,9 +24,10 @@ return null;
 export function getRecoil(atom) {
-    return new Promise(function (resolve) {
-        nexus.get({ atom: atom, resolve: resolve });
-    });
+    return nexus.get(atom);
 }
+export function getRecoilPromise(atom) {
+    return nexus.getPromise(atom);
+}
 export function setRecoil(atom, value) {
-    nexus.set({ atom: atom, value: value });
+    nexus.set(atom, value);
 }
 //# sourceMappingURL=RecoilNexus.js.map

package.json

 {
   "name": "recoil-nexus",
-  "version": "0.2.51",
+  "version": "0.3.0",
   "description": "A small Typescript package to access your Recoil atoms outside of React components.",
@@ -5,0 +5,0 @@ "main": "build/RecoilNexus.js",

README.md

@@ -49,3 +49,4 @@ # R E C O I L - N E X U S
 | :---------- | :-------------------------------------------------------- |
-| `getRecoil` | getter function, returns a promise                        |
+| `getRecoil` | getter function |
+| `getRecoilPromise` | getter function, returns a promise. To be used with asynchronous selectors. |
 | `setRecoil` | setter function, pass value to be set as second parameter |
@@ -58,4 +59,4 @@
 
-export default async function toggleLoading() {
-  const loading = await getRecoil(loadingState);
+export default function toggleLoading() {
+  const loading = getRecoil(loadingState);
   setRecoil(loadingState, !loading);
@@ -90,3 +91,3 @@ }
 
-Original credits to [VeepCream](https://github.com/VeepCream)'s [recoil-outside](https://www.npmjs.com/package/recoil-outside) Javascript implementation.
-In this Typescript package, I decided to remove RxJS and rely on promises only.
+Kudos to [VeepCream](https://github.com/VeepCream)'s [recoil-outside](https://www.npmjs.com/package/recoil-outside) original idea and Javascript implementation.  
+In this Typescript port/enhancement, I decided to remove RxJS and rely on native Recoil promises and loadables only.

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

6832

increased by2.92%

Number of lines in readme file

91

increased by1.11%

Worsened metrics

Lines of code

85

decreased by-4.49%

No dependency changes