Add named export lazyWithPreload

Author: ianschmitz

README.md

@@ -19,14 +19,14 @@ const OtherComponent = lazy(() => import("./OtherComponent"));
 
 ```js
 import { Suspense } from "react";
-import lazy from "react-lazy-with-preload";
-const OtherComponent = lazy(() => import("./OtherComponent"));
+import { lazyWithPreload } from "react-lazy-with-preload";
+const OtherComponent = lazyWithPreload(() => import("./OtherComponent"));
 
 // ...
 OtherComponent.preload();
 ```
 
-To preload a component before it is rendered for the first time, the component that is returned from `lazy()` has a `preload` function attached that you can invoke. `preload()` returns a `Promise` that you can wait on if needed. The promise is idempotent, meaning that `preload()` will return the same `Promise` instance if called multiple times.
+To preload a component before it is rendered for the first time, the component that is returned from `lazyWithPreload()` has a `preload` function attached that you can invoke. `preload()` returns a `Promise` that you can wait on if needed. The promise is idempotent, meaning that `preload()` will return the same `Promise` instance if called multiple times.
 
 For more information about React code-splitting, `React.lazy` and `React.Suspense`, see https://reactjs.org/docs/code-splitting.html.
 

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "react-lazy-with-preload",
-    "version": "2.1.0",
+    "version": "2.2.0",
     "description": "Wraps the React.lazy API with preload functionality",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",

package.json

@@ -1,6 +1,6 @@
 import React from "react";
 import { act, render, screen, waitFor } from "@testing-library/react";
-import lazy from "../index";
+import lazy, { lazyWithPreload as namedExport } from "../index";
 
 function getTestComponentModule() {
     const TestComponent = React.forwardRef<
@@ -154,4 +154,8 @@ describe("lazy", () => {
 
         expect(preloadedComponent).toBe(OriginalComponent);
     });
+
+    it("exports named export as well", () => {
+        expect(lazy).toBe(namedExport);
+    });
 });

src/__tests__/index.test.tsx

@@ -4,7 +4,7 @@ export type PreloadableComponent<T extends ComponentType<any>> = T & {
     preload: () => Promise<T>;
 };
 
-export default function lazyWithPreload<T extends ComponentType<any>>(
+export function lazyWithPreload<T extends ComponentType<any>>(
     factory: () => Promise<{ default: T }>
 ): PreloadableComponent<T> {
     const LazyComponent = lazy(factory);
@@ -31,3 +31,5 @@ export default function lazyWithPreload<T extends ComponentType<any>>(
 
     return Component;
 }
+
+export default lazyWithPreload;