Returns async iterator for the journal events.
Async iterator for the events in this journal.
Returns the current journal position which points to the next event to read.
The current journal position.
Returns the next event from the journal. When end of journal is reached then in watch mode this method waits until a new event arrives. When not in watch mode or when journal is closed this method returns null when no more events are available.
The next journal event or null when end is reached.
Returns the current fleet carrier materials data read from the FCMaterials.json file.
The current fleet carrier materials data. Null if FCMaterials.json file does not exist or is not readable.
Returns the current market data read from the Market.json file.
The current market data. Null if Market.json file does not exist or is not readable.
Returns the current modules info read from the ModulesInfo.json file.
The current modules info. Null if ModulesInfo.json file does not exist or is not readable.
Returns the current nav route read from the NavRoute.json file.
The current nav route data. Null if NavRoute.json file does not exist or is not readable.
Returns the current outfitting data read from the Outfitting.json file.
The current outfitting data. Null if Outfitting.json file does not exist or is not readable.
Returns the current contents of the ship locker from the ShipLocker.json file.
The current ship locker content. Null if ShipLocker.json file does not exist or is not readable.
Returns the current shipyard data read from the Shipyard.json file.
The current shipyard data. Null if Shipyard.json file does not exist or is not readable.
Watches the FCMaterials.json file for changes and reports any new data. It always reports the current data as first change.
Async iterator watching fleet carrier materials data changes.
Watches the Market.json file for changes and reports any new data. It always reports the current data as first change.
Async iterator watching market data changes.
Watches the ModulesInfo.json file for changes and reports any new data. It always reports the current data as first change.
Async iterator watching modules info changes.
Watches the NavRoute.json file for changes and reports any new data. It always reports the current data as first change.
Async iterator watching nav route data changes.
Watches the Outfitting.json file for changes and reports any new data. It always reports the current data as first change.
Async iterator watching outfitting data changes.
Watches the ShipLocker.json file for changes and reports any new data. It always reports the current data as first change.
Async iterator watching ship locker content changes.
Watches the Shipyard.json file for changes and reports any new data. It always reports the current data as first change.
Async iterator watching shipyard data changes.
Static findSearches for the journal directory in common spaces. First it checks for existence of directory specified with environment variable ED_JOURNAL_DIR. Then it looks into the standard directory on a windows system and then it checks to standard directory within Proton (for Linux).
If you know more common journal locations then please let me know so I can improve the search.
The found journal directory.
JournalError - When journal directory was not found.
Static findFinds the end position of the journal and returns it.
End position of the journal.
Static openOpens the journal.
Journal reader/watcher.
Reads or watches a journal directory. It implements the AsyncIterable interface so for reading/watching the journal you simply iterate of the instance of this class with a for..of loop for example. If you prefer you can also use the next method to read the next event from the journal until this method returns null to indicate the end of the journal.
In watch mode the iteration does not end and is continued every time a new event is appended to the journal by the game. Watch mode can be stopped by calling the close method. Iteration loops will end when journal is closed.