@axinom/mosaic-ui/src/helpers/utils.ts

UI components for building Axinom Mosaic applications

/**
 * A function doing nothing. Useful for example as fallback value for optional callbacks.
 *
 * using `parameter = () => {}` would drop your test coverage (unless you explicitly have a case testing calling the fallback value) - with `parameter = noop` it does not count as "untested function"
 */
// eslint-disable-next-line @typescript-eslint/no-empty-function
export function noop(): void {}

/**
 * Function that can be used for exhaustiveness checks on switch statements.
 */
export const assertNever = (_type: never): void => {
  // eslint-disable-next-line no-console
  console.error(`Switch was not exhaustive`);
};

/**
 * Declares a nullable T
 */
export type Maybe<T> = T | null;

/**
 * Make all properties in T nullable
 */
export type Nullable<T> = {
  [P in keyof T]: T[P] | null;
};

/**
 * Checks if the ref is available before executing the provided function.
 * @param ref Mutable Ref Object to check
 * @param fn Function to execute
 * @param args Arguments for the function
 */
export const executeIfRefAvailable = async <U, T = never>(
  ref: React.RefObject<U>,
  fn: (arg0: U, ...args: T[]) => void,
  ...args: T[]
): Promise<void> => {
  if (ref.current) {
    fn(ref.current, ...args);
  }
};