Socket
Socket
Sign inDemoInstall

recoil-nexus

Package Overview
Dependencies
Maintainers
1
Versions
42
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

recoil-nexus

A small Typescript package to access your Recoil atoms outside of React components.


Version published
Weekly downloads
27K
decreased by-38.82%
Maintainers
1
Weekly downloads
 
Created
Source

R E C O I L - N E X U S

by Luis Antonio Canettoli Ordoñez

If you have been using recoil for a while, you might have faced that outside React Components it's not possible to get or update values from atoms.

This Typescript implementation will workaround the issue and let you do so.

Live Example

Install

npm

npm i recoil-nexus

yarn

yarn add recoil-nexus

Usage

1. Add RecoilNexus in your RecoilRoot

import React from "react";
import { RecoilRoot } from "recoil";
import RecoilNexus from "recoil-nexus";

export default function App() {
  return (
    <RecoilRoot>
      <RecoilNexus />

      {/* ... */}
    </RecoilRoot>
  );
}

export default App;

2. Use the following methods to get/set values passing your atom as a parameter.

MethodReturns
getRecoilgetter function
getRecoilPromisegetter function, returns a promise. To be used with asynchronous selectors.
setRecoilsetter function, pass value to be set or updater function as second parameter
resetRecoilpass atom as parameter to reset to default value

Read current state:

const loading = getRecoil(loadingState);

Setting the new state like this is not inherently wrong:

setRecoil(loadingState, !loading);

However, if the new state depends on the previous one (like in this case), preferably use an updater function to correctly batch React state updates, as reading and updating the state at the same time could lead to unexpected results.

import { setRecoil } from "recoil-nexus"

export function toggleLoader() {
  setRecoil(loadingState, loading => !loading)
}

Test Setup

Jest

When testing in Jest, we need to set "transformIgnorePatterns": [] in our jest config, otherwise a SyntaxError: Cannot use import statement outside a module will cause the tests to fail. This can be acheived one of the following ways, depending on how you are defining your jest config:

export default config
  • in jest.config.js
"transformIgnorePatterns": []
  • in the top level of the package.json
"jest": {
  "transformIgnorePatterns": []
},

Credits

Kudos to VeepCream's 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.

Keywords

FAQs

Package last updated on 19 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc