client/src/hooks/createOptionalContext.ts

/*
 * Copyright (C) 2022 Savoir-faire Linux Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation; either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this program.  If not, see
 * <https://www.gnu.org/licenses/>.
 */
import { createContext, useContext } from 'react';

export const createOptionalContext = <T>(displayName: string) => {
  const Context = createContext<T | undefined>(undefined);
  Context.displayName = displayName;

  function useOptionalContext(noThrow: true): T | undefined;
  function useOptionalContext(noThrow?: false): T;
  function useOptionalContext(noThrow?: boolean) {
    const value = useContext(Context);
    if (value === undefined && !noThrow) {
      throw new Error(`The context ${Context.displayName} is not provided`);
    }
    return value;
  }

  return {
    Context,
    useOptionalContext,
  };
};