Frodo Library - v5.0.0-47
    Preparing search index...

    Type Alias LogTailStream

    type LogTailStream = {
        rateLimit: LogApiRateLimit | undefined;
        poll(): Promise<LogEventSkeleton[]>;
    }
    Index
    rateLimit: LogApiRateLimit | undefined

    The rate limit of the Log API as the answer to the latest poll() reported it: the limit of requests per window, how many are left, and when the window resets. It is shared by every reader of the logs of the environment, so remaining falls when other readers poll too. undefined before the first poll finished and when the latest answer did not carry the X-RateLimit-* headers.

    • Polls once for new events since the last poll (the last 15 seconds, on the very first call -- matching the underlying API's own behavior), returning only genuinely new events. Never returns the same event twice, even across repeated calls -- see createLogTailStream().

      Returns Promise<LogEventSkeleton[]>