UnlyEd/next-right-now

View on GitHub
src/modules/core/userConsent/contexts/userConsentContext.tsx

Summary

Maintainability
A
0 mins
Test Coverage
import React from 'react';
import { UserConsent } from '../types/UserConsent';

export type UserConsentContext = UserConsent

/**
 * Initial context, used by default until the Context Provider is initialised.
 *
 * @default Empty object, to allow for destructuring even when the context hasn't been initialised (on the server)
 */
const initialContext = {};

/**
 * Uses native React Context API
 *
 * @example Usage
 *  import userConsentContext from './src/stores/userConsentContext';
 *  const { getUserConsent }: UserConsentContext = React.useContext(userConsentContext);
 *
 * @see https://reactjs.org/docs/context.html
 * @see https://medium.com/better-programming/react-hooks-usecontext-30eb560999f for useContext hook example (open in anonymous browser #paywall)
 */
export const userConsentContext = React.createContext<UserConsentContext>(initialContext);

export default userConsentContext;