fix: expose short typescript helpers for useImported

src/entrypoints/index.ts

@@ -7,6 +7,7 @@ import { getMarkedChunks, getMarkedFileNames } from '../loadable/markerMapper';
 import { drainHydrateMarks, printDrainHydrateMarks, rehydrateMarks, waitForMarks } from '../loadable/marks';
 import { done as whenComponentsReady } from '../loadable/pending';
 import { addPreloader } from '../loadable/preloaders';
+import { DefaultImport } from '../types';
 import { ImportedComponent } from '../ui/Component';
 import { ImportedComponent as ComponentLoader } from '../ui/Component';
 import { ImportedStream } from '../ui/context';
@@ -45,5 +46,6 @@ export {
   clearImportedCache,
   ImportedConfiguration,
   configure,
+  DefaultImport,
 };
 export default imported;

src/types.ts

@@ -22,6 +22,10 @@ export type DefaultComponent<P> = ComponentType<P> | DefaultImportedComponent<P>
 export type DefaultComponentImport<T> = () => Promise<DefaultComponent<T>>;
 
 export type Defaultable<P> = P | Default<P>;
+/**
+ * standard "importer" accepted by the package.
+ * Could be {default:T} or T
+ */
 export type DefaultImport<T> = () => Promise<Defaultable<T>>;
 
 export interface MarkMeta {

src/ui/useImported.ts

@@ -103,6 +103,27 @@ export function useLoadable<T>(loadable: Loadable<T>, options: HookOptions = {})
   );
 }
 
+/**
+ * short version of {@link useImported}
+ * @param {Function} importer - an function with `import` inside it
+ *
+ * @return {Object}
+ *  - imported: if non empty - the data is loaded
+ *  - error: if non empty - there is an error
+ *  - loading: if true - then it's still loading
+ *  - loadable: the under laying reference
+ *  - retry: retry if case of failure
+ *
+ *  @example
+ *  const { imported: Imported, loadable } = useImported(importer);
+ *  if (Imported) {
+ *    // yep, it's imported
+ *    return <Imported {...children} />;
+ *  }
+ *  // else throw resolution
+ *  throw loadable.resolution;
+ */
+export function useImported<T>(importer: DefaultImport<T> | Loadable<T>): ImportedShape<T>;
 /**
  * The code splitting hook
  * @param {Function} importer - an function with `import` inside it
@@ -118,7 +139,7 @@ export function useLoadable<T>(loadable: Loadable<T>, options: HookOptions = {})
  *  - loadable: the under laying reference
  *  - retry: retry if case of failure
  *
- *  @see if you dont need precise control consider {@link useLazy}
+ *  @see if you dont need precise control consider(and loading Components) {@link useLazy}
  *
  *  @example
  *  const { imported: Imported, loadable } = useImported(importer);