Class: Philiprehberger::EventEmitter::EventMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/philiprehberger/event_emitter/metadata.rb

Overview

Metadata object passed to listeners that opt in with ‘metadata: true`.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(event_name:, timestamp:) ⇒ EventMetadata

Returns a new instance of EventMetadata.

Parameters:

  • event_name (Symbol, String)

    the event name

  • timestamp (Time)

    the timestamp



15
16
17
18
# File 'lib/philiprehberger/event_emitter/metadata.rb', line 15

def initialize(event_name:, timestamp:)
  @event_name = event_name
  @timestamp = timestamp
end

Instance Attribute Details

#event_nameSymbol, String (readonly)

Returns the event name.

Returns:

  • (Symbol, String)

    the event name



8
9
10
# File 'lib/philiprehberger/event_emitter/metadata.rb', line 8

def event_name
  @event_name
end

#timestampTime (readonly)

Returns the timestamp when the event was emitted.

Returns:

  • (Time)

    the timestamp when the event was emitted



11
12
13
# File 'lib/philiprehberger/event_emitter/metadata.rb', line 11

def timestamp
  @timestamp
end