cronjo/src/cancel.js

[](README.md) [](README.tr-TR.md)

/**
 * 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.
 **/

/** Require Base */
const lt = require('long-timeout')
/** * */

/**
 * Returns true or error.
 * 
 * @param {Object} timer The timer object of lont-timeout package.
 * 
 * @returns {Boolean|Error} Returns true or error.
 * 
 * @summary Returns true or error.
 * 
 * @license Apache-2.0
 */
module.exports = function(timer) {
    if(!timer) throw new Error(`[${timer}]: Invalid timer parameter. Timer required.`)
    try {
        lt.clearTimeout(timer)
        return true
    } catch(error) { throw new Error(error) }
}