mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

refactor: improve function deprecation module (#19012)

Browse source 
* add removeFunction to deprecation module

* clarify deprecate api

* throw error

* change error msg
This commit is contained in:
Micha Hanselmann 2019-07-08 18:01:35 -07:00 • committed by Cheng Zhao
parent a90306876e
commit d79e6bbffe
3 changed files with 18 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

16
lib/common/api/deprecate.ts
View file

@ -34,9 +34,21 @@ const deprecate: ElectronInternal.DeprecationUtil = {
}
},
// remove a function with no replacement
removeFunction: (fn, removedName) => {
if (!fn) { throw Error(`'${removedName} function' is invalid or does not exist.`) }
// wrap the deprecated function to warn user
const warn = warnOnce(`${fn.name} function`)
return function (this: any) {
warn()
fn.apply(this, arguments)
}
},
// change the name of a function
function: (fn, newName) => {
const warn = warnOnce(fn.name, newName)
renameFunction: (fn, newName) => {
const warn = warnOnce(`${fn.name} function`, `${newName} function`)
return function (this: any) {
warn()
fn.apply(this, arguments)