validation.d.ts 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. /**
  2. * @license
  3. * Copyright 2017 Google LLC
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. /**
  18. * Check to make sure the appropriate number of arguments are provided for a public function.
  19. * Throws an error if it fails.
  20. *
  21. * @param fnName The function name
  22. * @param minCount The minimum number of arguments to allow for the function call
  23. * @param maxCount The maximum number of argument to allow for the function call
  24. * @param argCount The actual number of arguments provided.
  25. */
  26. export declare const validateArgCount: (fnName: string, minCount: number, maxCount: number, argCount: number) => void;
  27. /**
  28. * Generates a string to prefix an error message about failed argument validation
  29. *
  30. * @param fnName The function name
  31. * @param argName The name of the argument
  32. * @return The prefix to add to the error thrown for validation.
  33. */
  34. export declare function errorPrefix(fnName: string, argName: string): string;
  35. /**
  36. * @param fnName
  37. * @param argumentNumber
  38. * @param namespace
  39. * @param optional
  40. */
  41. export declare function validateNamespace(fnName: string, namespace: string, optional: boolean): void;
  42. export declare function validateCallback(fnName: string, argumentName: string, callback: Function, optional: boolean): void;
  43. export declare function validateContextObject(fnName: string, argumentName: string, context: unknown, optional: boolean): void;