@alwaysblank/denden
    Preparing search index...

    Class Message<Payload>

    An Event carrying some kind of data.

    Type Parameters

    • Payload extends any = any

      Type of data carried by this message.

    Hierarchy

    • Event
      • Message
    Index

    Constructors

    • If manually creating a message outside of a Hub, using Message.create is easier to use.

      The constructor allows you to directly specify the Message.contains object, which may be useful if creating multiple Messages across different channels with the same payload.

      Type Parameters

      • Payload extends unknown = any

        Type of data carried by this message.

      Parameters

      • channel: string

        Name of the channel on which this message is originally to be dispatched.

      • payload: { payload: Payload }

        Object containing the payload.

      Returns Message<Payload>

    Properties

    AT_TARGET: 2
    bubbles: boolean

    The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.

    MDN Reference

    BUBBLING_PHASE: 3
    cancelable: boolean

    The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.

    MDN Reference

    cancelBubble: boolean

    The cancelBubble property of the Event interface is deprecated.

    MDN Reference

    CAPTURING_PHASE: 1
    channel: string

    The channel on which this Message was originally dispatched.

    This can be relevant because in some situations (i.e. when calling Hub.getMessages() or Hub.sub) Messages can be returned from across several channels.

    composed: boolean

    The read-only composed property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.

    MDN Reference

    contains: { payload: Payload }

    An object containing the payload.

    Generally you don't want to access this; you want to access payload. This is an object because we want to be able to use it as a unique identifier for Messages. Different messages would have the same scalar payload but be meaningfully distinct. Object equality in JS, however, means that ever object can be distinct, even if the actual payloads are the same.

    currentTarget: EventTarget | null

    The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.

    MDN Reference

    defaultPrevented: boolean

    The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.

    MDN Reference

    eventPhase: number

    The eventPhase read-only property of the being evaluated.

    MDN Reference

    isTrusted: boolean

    The isTrusted read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via The only exception is the click event, which initializes the isTrusted property to false in user agents.

    MDN Reference

    NONE: 0
    order: number

    A value used to order messages.

    Strictly speaking, it is set on Message creation, not on Message dispatch, but when using the methods Hub.pub Messages are created at the time of dispatch.

    returnValue: boolean

    The Event property returnValue indicates whether the default action for this event has been prevented or not.

    MDN Reference

    srcElement: EventTarget | null

    The deprecated Event.srcElement is an alias for the Event.target property.

    MDN Reference

    target: EventTarget | null

    The read-only target property of the dispatched.

    MDN Reference

    timeStamp: number

    The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.

    MDN Reference

    type: string

    The type read-only property of the Event interface returns a string containing the event's type.

    MDN Reference

    AT_TARGET: 2
    BUBBLING_PHASE: 3
    CAPTURING_PHASE: 1
    NAME: string = 'ddm::event::message'
    NONE: 0

    Accessors

    Methods

    • The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.

      MDN Reference

      Returns EventTarget[]

    • The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

      Parameters

      • type: string
      • Optionalbubbles: boolean
      • Optionalcancelable: boolean

      Returns void

      MDN Reference

    • The preventDefault() method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.

      MDN Reference

      Returns void

    • The stopImmediatePropagation() method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.

      MDN Reference

      Returns void

    • The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

      MDN Reference

      Returns void