@kayahr/ed-journal

    Interface JournalOptions

    Options for reading journal files.

    interface JournalOptions {
        directory?: string;
        position?: JournalPosition | "start" | "end";
        watch?: boolean;
    }
    Index

    Properties

    directory? position? watch?

    Properties

    directory?: string

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

    position?: JournalPosition | "start" | "end"

    Optional position within the journal where to start at. Can be either a specific journal position or the string "end" to indicate starting at the end of the journal. Starting at the end only makes sense for watch mode to only watch for new events. In normal read mode you would simply read no events at all. 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.

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR