stem-core/src/decorators/Deprecate.js

Frontend and core-library framework

import {decorate} from './Utils';

const DEFAULT_MSG = 'This function will be removed in future versions.';

function handleDescriptor(target, key, descriptor, [msg = DEFAULT_MSG, options = {}]) {
    if (typeof descriptor.value !== 'function') {
        throw new SyntaxError('Only functions can be marked as deprecated');
    }

    const methodSignature = `${target.constructor.name}#${key}`;

    if (options.url) {
        msg += `\n\n        See ${options.url} for more details.\n\n`;
    }

    // return {
    //     ...descriptor,
    //     value: function deprecationWrapper() {
    //         console.warn(`DEPRECATION ${methodSignature}: ${msg}`);
    //         return descriptor.value.apply(this, arguments);
    //     }
    // };
    return Object.assign({}, descriptor, {
        value: function deprecationWrapper() {
            console.warn(`DEPRECATION ${methodSignature}: ${msg}`);
            return descriptor.value.apply(this, arguments);
        }
    });
}

export function deprecate(...args) {
    return decorate(handleDescriptor, args);
}