util/deprecate

We are planning to deprecate the use by Firefox add-ons of the techniques described in this document.

Don't use these techniques to develop new add-ons. Use WebExtensions instead.

If you maintain an add-on which uses the techniques described here, consider migrating it to use WebExtensions instead.

Add-ons developed using these techniques might not work with multiprocess Firefox (e10s), which is already the default in Firefox Nightly and Firefox Developer Edition, and will soon be the default in Beta and Release versions of Firefox. We have documentation on making your add-ons multiprocess-compatible, but it will be more future-proof for you to migrate to WebExtensions.

A wiki page containing resources, migration paths, office hours, and more, is available to help developers transition to the new technologies.

Experimental

Functions to deprecate code.

Globals

Functions

deprecateFunction(fun, msg)

Dump to the console the error message given in the second argument, prefixed with "DEPRECATED:", and print the stacktrace; then execute the function passed as first argument and returns its value.

It does not raise an exception, but just displays the error message and continues to execute the function.

This function is mostly used to flag usage of deprecated functions, that are still available but which we intend to remove in a future release.

Parameters

fun : function
The function to execute after the error message

msg : string
The error message to display

Returns

* : The returned value from fun

deprecateUsage(msg)

Dump to the console the error message given, prefixed with "DEPRECATED:", and print the stacktrace.

It does not raise an exception, but just displays the error message and returns.

This function is mostly used to flag usage of deprecated functions that are no longer available.

Parameters

msg : string
The error message to display

Document Tags and Contributors

 Contributors to this page: wbamberg, jsantell
 Last updated by: wbamberg,