26 lines
782 B
TypeScript
26 lines
782 B
TypeScript
import type { Context } from "react";
|
|
import { useContext } from "react";
|
|
import { isDefined } from "./isDefined";
|
|
|
|
/**
|
|
* Passes the call to `useContext` and throw an exception if the resolved value is either `null` or `undefined`.
|
|
* Can be used for contexts that are required and should always have a non nullable value.
|
|
*
|
|
* @param context The context to pass to `useContext`
|
|
* @returns
|
|
*/
|
|
export default function useRequiredContext<T>(
|
|
context: Context<T>
|
|
): NonNullable<T> {
|
|
const resolved = useContext(context);
|
|
|
|
if (isDefined(resolved)) {
|
|
return resolved;
|
|
}
|
|
|
|
throw new Error(
|
|
`No provider found for ${
|
|
context.displayName ? `the '${context.displayName}'` : "an unknown"
|
|
} context, make sure it is included in your component hierarchy.`
|
|
);
|
|
}
|