2019-01-06 13:14:45 -06:00

44 lines
2.0 KiB
TypeScript

/**
* Copyright 2017 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Check to make sure the appropriate number of arguments are provided for a public function.
* Throws an error if it fails.
*
* @param {!string} fnName The function name
* @param {!number} minCount The minimum number of arguments to allow for the function call
* @param {!number} maxCount The maximum number of argument to allow for the function call
* @param {!number} argCount The actual number of arguments provided.
*/
export declare const validateArgCount: (fnName: any, minCount: any, maxCount: any, argCount: any) => void;
/**
* Generates a string to prefix an error message about failed argument validation
*
* @param {!string} fnName The function name
* @param {!number} argumentNumber The index of the argument
* @param {boolean} optional Whether or not the argument is optional
* @return {!string} The prefix to add to the error thrown for validation.
*/
export declare function errorPrefix(fnName: any, argumentNumber: any, optional: any): string;
/**
* @param {!string} fnName
* @param {!number} argumentNumber
* @param {!string} namespace
* @param {boolean} optional
*/
export declare function validateNamespace(fnName: any, argumentNumber: any, namespace: any, optional: any): void;
export declare function validateCallback(fnName: any, argumentNumber: any, callback: any, optional: any): void;
export declare function validateContextObject(fnName: any, argumentNumber: any, context: any, optional: any): void;