@studiokeywi/banjo - v0.0.1
    Preparing search index...

    Interface WatcherConfig

    Configuration that can be applied when building a new Watcher

    interface WatcherConfig {
        because?: CheckFunction;
        begin?: NoOp;
        do?: RunFunction;
        end?: NoOp;
        every?: Chrono<Units, number>;
        for?: Chrono<Units, number>;
        unless?: CheckFunction;
        until?: CheckFunction;
        while?: CheckFunction;
    }
    Index

    Properties

    because?: CheckFunction

    An optional check function that can be used to stop a Watcher after its last step, if the check function returns false

    begin?: NoOp

    An optional function that can be run when starting a Watcher

    An optional function that will be run per step the Watcher takes

    end?: NoOp

    An optional function that can be run when stopping a Watcher

    every?: Chrono<Units, number>

    An optional amount of time to define how often a Watcher steps. Defaults to Chrono.milliseconds(100)

    for?: Chrono<Units, number>

    An optional amount of time to define how long a Watcher runs. Defaults to Chrono.seconds(5)

    unless?: CheckFunction

    An optional check function that can be used to stop a Watcher before its step, if the check function returns true

    An optional check function that can be used to stop a Watcher after its last step, if the check function returns true

    An optional check function that can be used to stop a Watcher before its step, if the check function returns false