Interface TopicEvent

An event associated with a specific topic.

interface TopicEvent {
    getProperties(): Record<string, unknown>;
    getProperty<T = unknown>(name: string): undefined | T;
    getPropertyNames(): string[];
    getTopic(): string;
    getTopicReason(): string;
    matches(filter: string | Pick<Filter, "matchCase">): boolean;
    toString(): string;
}

Methods

getProperties getProperty getPropertyNames getTopic getTopicReason matches toString

Methods

getProperties

  • getProperties(): Record<string, unknown>

  • Gets all properties as a copy.

    Returns Record<string, unknown>

    all properties as plain object.

getProperty

  • getProperty<T = unknown>(name: string): undefined | T

  • Returns a property.

    Type Parameters

    • T = unknown

    Parameters

    • name: string

      the name of the property to return

    Returns undefined | T

    The value of the property, or undefined if not found.

getPropertyNames

  • getPropertyNames(): string[]

  • Returns a list of this event's property names.

    Returns string[]

    A non-empty array with one element per property.

getTopic

  • getTopic(): string

  • Returns the topic of this event.

    Returns string

getTopicReason

  • getTopicReason(): string

  • Returns the reason of the topic (last part).

    For example if topic is 'ct/map/EXTENT_CHANGE' the reason is 'EXTENT_CHANGE'.

    Returns string

matches

  • matches(filter: string | Pick<Filter, "matchCase">): boolean

  • Tests this event's properties against the given filter using a case sensitive match.

    Parameters

    • filter: string | Pick<Filter, "matchCase">

      The filter to test.

    Returns boolean

    true if this event's properties match the filter, false otherwise.

toString

  • toString(): string

  • Returns string

    The string representation of this event.

Settings

Member Visibility

On This Page

Methods