src/CustomEvent.js

/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/// @Copyright ~2018 ☜Samlv9☞ and other contributors
/// @MIT-LICENSE | 1.0.0 | https://api.guless.com/
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
///                                              }|
///                                              }|
///                                              }|     　 へ　　　 ／|    
///      _______     _______         ______      }|      /　│　　 ／ ／
///     /  ___  |   |_   __ \      .' ____ '.    }|     │　Z ＿,＜　／　　 /`ヽ
///    |  (__ \_|     | |__) |     | (____) |    }|     │　　　　　ヽ　　 /　　〉
///     '.___`-.      |  __ /      '_.____. |    }|      Y　　　　　`　 /　　/
///    |`\____) |    _| |  \ \_    | \____| |    }|    ｲ●　､　●　　⊂⊃〈　　/
///    |_______.'   |____| |___|    \______,'    }|    ()　 v　　　　|　＼〈
///    |=========================================\|    　>ｰ ､_　 ィ　 │ ／／
///    |> LESS IS MORE                           ||     / へ　　 /　ﾉ＜|＼＼
///    `=========================================/|    ヽ_ﾉ　　(_／　 │／／
///                                              }|     7　　　　　　  |／
///                                              }|     ＞―r￣￣`ｰ―＿`
///                                              }|
///                                              }|
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to deal
/// in the Software without restriction, including without limitation the rights
/// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
/// copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in all
/// copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
/// THE SOFTWARE.
import Event from "./Event";

/**
 * 定义携带自定义数据的事件对象。
 * @see {@link Event}
 * @since 1.0.9
 */
export default class CustomEvent extends Event {
    /**
     * 创建一个支持自定义数据的事件对象。
     * 
     * @param {String|Symbol} type - 事件类型。
     * @param {any} [data=null] - 指定附加到事件对象的数据。
     * @param {Boolean} [bubbles=false] - 指示该事件是否参与冒泡行为。
     * @param {Boolean} [cancelable=true] - 指示该事件是否可以取消默认行为。
     * @since 1.0.9
     */
    constructor( type, data = null, bubbles = false, cancelable = true ) {
        super(type, bubbles, cancelable);
        this._data = data;
    }
    
    /**
     * 重置事件状态（允许外部复用事件对象）。
     * 
     * @param {String|Symbol} type - 事件类型。
     * @param {any} [data=null] - 指定附加到事件对象的数据。
     * @param {Boolean} [bubbles=false] - 指示该事件是否参与冒泡行为。
     * @param {Boolean} [cancelable=true] - 指示该事件是否可以取消默认行为。
     * @returns {this}
     * @since 1.0.11
     */
    reset( type, data = null, bubbles = false, cancelable = false ) {
        super.reset(type, bubbles, cancelable);
        this._data = data;
        return this;
    }
    
    /**
     * 获取事件对象的自定义数据。
     * @type {any}
     * @since 1.0.9
     */
    get data() {
        return this._data;
    }
}