notifier.js (1347B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2021 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 // FIXME: remove this stub and create a stdlib equivalent of update-notifier 20 21 'use strict'; 22 23 // MODULES // 24 25 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 26 var noop = require( '@stdlib/utils/noop' ); 27 28 29 // MAIN // 30 31 /** 32 * Notifier constructor. 33 * 34 * @private 35 * @constructor 36 * @returns {Notifier} notifier instance 37 * 38 * @example 39 * var notifier = new Notifier(); 40 */ 41 function Notifier() { 42 if ( !(this instanceof Notifier) ) { 43 return new Notifier(); 44 } 45 return this; 46 } 47 48 /** 49 * Notifies whether a new version is available. 50 * 51 * @private 52 * @name notify 53 * @memberof Notifier.prototype 54 * @type {Function} 55 */ 56 setReadOnly( Notifier.prototype, 'notify', noop ); 57 58 59 // EXPORTS // 60 61 module.exports = Notifier;