mirror of
https://github.com/devcode-it/openstamanager.git
synced 2025-02-24 07:17:55 +01:00
90 lines
3.3 KiB
JavaScript
Vendored
90 lines
3.3 KiB
JavaScript
Vendored
/**
|
||
* @source https://github.com/flarum/core/blob/master/js/src/common/extend.js
|
||
*/
|
||
|
||
/**
|
||
* Extend an object's method by running its output through a mutating callback
|
||
* every time it is called.
|
||
*
|
||
* The callback accepts the method's return value and should perform any
|
||
* mutations directly on this value. For this reason, this function will not be
|
||
* effective on methods which return scalar values (numbers, strings, booleans).
|
||
*
|
||
* Care should be taken to extend the correct object – in most cases, a class'
|
||
* prototype will be the desired target of extension, not the class itself.
|
||
*
|
||
* @example <caption>Example usage of extending one method.</caption>
|
||
* extend(Discussion.prototype, 'badges', function(badges) {
|
||
* // do something with `badges`
|
||
* });
|
||
*
|
||
* @example <caption>Example usage of extending multiple methods.</caption>
|
||
* extend(IndexPage.prototype, ['oncreate', 'onupdate'], function(vnode) {
|
||
* // something that needs to be run on creation and update
|
||
* });
|
||
*
|
||
* @param {object} proto The prototype of the object/class that owns the method
|
||
* @param {string|string[]} methods The name or names of the method(s) to extend
|
||
* @param {function} callback A callback which mutates the method's output
|
||
*/
|
||
export function extend(proto, methods, callback) {
|
||
const allMethods = Array.isArray(methods) ? methods : [methods];
|
||
|
||
for (const method of allMethods) {
|
||
const original = proto[method];
|
||
|
||
// eslint-disable-next-line no-param-reassign
|
||
proto[method] = function (...arguments_) {
|
||
const value = original ? original.apply(this, arguments_) : undefined;
|
||
|
||
Reflect.apply(callback, this, [value, ...arguments_]);
|
||
|
||
return value;
|
||
};
|
||
|
||
Object.assign(proto[method], original);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Override an object's method by replacing it with a new function, so that the
|
||
* new function will be run every time the object's method is called.
|
||
*
|
||
* The replacement function accepts the original method as its first argument,
|
||
* which is like a call to `super`. Any arguments passed to the original method
|
||
* are also passed to the replacement.
|
||
*
|
||
* Care should be taken to extend the correct object – in most cases, a class'
|
||
* prototype will be the desired target of extension, not the class itself.
|
||
*
|
||
* @example <caption>Example usage of overriding one method.</caption>
|
||
* override(Discussion.prototype, 'badges', function(original) {
|
||
* const badges = original();
|
||
* // do something with badges
|
||
* return badges;
|
||
* });
|
||
*
|
||
* @example <caption>Example usage of overriding multiple methods.</caption>
|
||
* extend(Discussion.prototype, ['oncreate', 'onupdate'], function(original, vnode) {
|
||
* // something that needs to be run on creation and update
|
||
* });
|
||
*
|
||
* @param {object} object The object that owns the method
|
||
* @param {string|string[]} methods The name or names of the method(s) to override
|
||
* @param {function} newMethod The method to replace it with
|
||
*/
|
||
export function override(object, methods, newMethod) {
|
||
const allMethods = Array.isArray(methods) ? methods : [methods];
|
||
|
||
for (const method of allMethods) {
|
||
const original = object[method];
|
||
|
||
// eslint-disable-next-line no-param-reassign
|
||
object[method] = function (...arguments_) {
|
||
return Reflect.apply(newMethod, this, [original.bind(this), ...arguments_]);
|
||
};
|
||
|
||
Object.assign(object[method], original);
|
||
}
|
||
}
|