Skip to content

sundaycrafts/react-async-segregation

Repository files navigation

npm

Encourage side effects segregation to make testing easier for React components

Usage

withHookSegregation injects initial rendering data from asynchronous React hooks such as useContext, SWR.

You can keep the component pure with this HOC to make it easy to test.

import { withHookSegregation } from "react-async-segregation";

export function MyComponent(props: {
  name: string;
  country: string;
  age: number;
  useFetcher: () => { data: any; error: Error; }
}) {/* ...*/}

const staticProps = { country: "Neverland", useFetcher: () => {/*...*/} };
export default withHookSegregation(MyComponent, staticProps, () => {
  // ... call more asynchronous hooks here ...
  return {
    data: { name: "Alice", age: 18 },
    error: undefined // withHookSegregation simply throws this if it's given
  }
}, /* (option) LoadingComponent */);

Utilities

withEnv

It allows you to switch dependencies by environment variables. It is useful for building a testable component that is called by others.

It uses a development props by default in case NODE_ENV is not given or given an unexpected value for some reason. You can omit to give every environment field by adding a default field for default value.

Its precedence order of entries is corresponding env > development > default.

//...
import { withEnv } from 'react-async-segregation/util'

const Frame = (props: {
  children: string,
  remoteData: any,
  useFetchData: () => {data: any; error: Error }
}) => {/* ... */}

const ConfiguredFrame = ({children}: {children: string}) => withHookSegregation(
  Frame,
  {
    children,
    useFetchData: () => {/* ... */}
  },
  withEnv({
    test: () => ({data: { remoteData: "remote data" }}),
    default: asyncHook,
  }))

export default ConfiguredFrame

// Page.tsx
const Page = () => (<ConfiguredFrame>Hello World!</ConfiguredFrame>)

Or, if you want to just inject dependencies without fetching any data, you can do like this:

// ...
const ConfiguredFrame = ({children}: {children: string}) => Frame(withEnv({
  test: { children, useFetchData: () => {/* ... */} },
  default: { children, useFetchData: asyncHook },
}))
export default ConfiguredFrame

About

Encourage side effects segregation for React component

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published