scrivito/src/scrivito_sdk/common/throw_invalid_arguments_error.ts

Scrivito is a professional, yet easy to use SaaS Enterprise Content Management Service, built for digital agencies and medium to large businesses. It is completely maintenance-free, cost-effective, and has unprecedented performance and security.

import { docUrl } from 'scrivito_sdk/common';
import { logError } from 'scrivito_sdk/common/error_logging';
import { ArgumentError } from 'scrivito_sdk/common/errors';

export type TypeCheck = (...givenArguments: unknown[]) => void;

export function throwInvalidArgumentsError(
  functionName: string,
  errorMessage: string,
  { docPermalink, severity }: { docPermalink: string; severity?: 'warning' }
) {
  const fullErrorMessage = `Invalid arguments for '${functionName}': ${errorMessage} Visit ${docUrl(
    docPermalink
  )} for more information.`;

  if (severity === 'warning') {
    logError(fullErrorMessage);
  } else {
    throw new ArgumentError(fullErrorMessage);
  }
}