Interface JournalOptions

Options for reading journal files.

interface JournalOptions {
    directory?: string;
    position?: JournalPosition | NamedJournalPosition;
    watch?: boolean;
}

Properties

directory?: string

Optional journal directory. If not specified then automatically determined by looking in popular spots.

Optional position within the journal where to start at. Can be either a specific journal position or a string with the following meaning:

"start" : Indicates the very beginning of the earliest journal file.
"end" : Indicates the end of the latest journal file. So only future events will be read (only makes sense in watch mode)
event name : Any other string is treated as a journal event name. Indicates the last (newest) position of the given event in the journal. When specifying 'FSDJump" for example then journal reading begins at the last FSDJump event found in the game. If there is no FSDJump in the whole journal then reading begins a the end of the journal (same as specifying position "end").

Defaults to "start".

watch?: boolean

Set to true to watch the journal for new events. False (default) just reads the existing journal events and does not wait for new ones.