logdna / logdna/tail-file-node

Pause tailing the file

Open
#48 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
37
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Hi,

I wonder if it would be possible to include a pause and resume method.

I am assuming that it should be fairly simple:

```javascript
pause() {
if (this[kQuitting]) return

clearTimeout(this[kPollTimer])
this.paused = true
}

async resume() {
if (!this.paused) return

this[kStartPos] = null
this.paused = false

this._pollFileForChanges()
}
```

Side quesion: Is the assumption correct that I always (also for the pause/resume case above) get a `flush` event before any data, therefore I am always able to get `lastReadPosition` first (I need the exact start byte for each chunk).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing tailing implementation around _pollFileForChanges, kPollTimer, kStartPos, and the flush event behavior. Add pause and resume behavior as described, and verify that resumed reads preserve the expected starting position and event ordering.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.