refactor(useRapier): throw when used outside Physics (#539)

* refactor(useRapier): throw when used outside Physics * chore: changesets --------- Co-authored-by: Hugo Wiledal <[email protected]>
pmndrs · Oct 17, 2023 · c9e897a · c9e897a
1 parent 144881d
commit c9e897a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/.changeset/silent-chefs-refuse.md b/.changeset/silent-chefs-refuse.md
@@ -0,0 +1,5 @@
+---
+"@react-three/rapier": patch
+---
+
+Throw useful error when `usePhysics` used outside `<Physics />` (@CodyJasonBennett)
diff --git a/packages/react-three-rapier/src/hooks/hooks.ts b/packages/react-three-rapier/src/hooks/hooks.ts
@@ -29,8 +29,10 @@ const useMutableCallback = <T>(fn: T) => {
  * Exposes the Rapier context, and world
  * @category Hooks
  */
-export const useRapier = () => {
-  return useContext(rapierContext) as RapierContext;
+export const useRapier = (): RapierContext => {
+  const rapier = useContext(rapierContext);
+  if (!rapier) throw new Error('react-three-rapier: useRapier must be used within <Physics />!')
+  return rapier;
 };
 
 /**