Skip to content

fix: fix getStartPoint() requirements for not-yet-written#49

Open
xnv wants to merge 1 commit intomainfrom
fix-getsp-requirement
Open

fix: fix getStartPoint() requirements for not-yet-written#49
xnv wants to merge 1 commit intomainfrom
fix-getsp-requirement

Conversation

@xnv
Copy link
Copy Markdown
Member

@xnv xnv commented Feb 17, 2023

実態 (事実上必要な要件) に合わせて仕様説明を更新します。

  • getStartPoint() のフレーム指定は、当該フレーム「未満」ではなく「以下」を表すものとして訂正
  • getStartPoint() のタイムスタンプ指定に関する要求追加
  • getStartPoint() の、返すべき値がまだない時、失敗するのではなく書き込みを待つように要求追加

Comment thread README.md
```

開始地点情報が見つからない場合、 `StartPoint` は `null` となります。
条件に当てはまる開始地点情報が一つもない場合、当てはまる開始地点情報が保存されるまでコールバック関数は呼び出されません。
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

動作からするとこの関数は get〜 というよりも wait〜 とか呼ばれるべきに思えます (他の get〜 系メソッドと動作が違うので) が、後方互換性を考えるとなかなか変えにくいところかと思います。

(現状特に必要ありませんが、今後もし "get" の方の動作 (=値がまだない状況なら待たずに null なりエラーなり返す) が欲しくなった場合には、 opts.immediate?: boolean フラグのようなものを加えて、フラグ次第で動作を変化させる……というような機能拡張をすることになりそうだな、ということを考えています)

Comment thread README.md
オプションとしてフレーム番号を指定した場合は、そのフレーム番号以前の直近のフレームに該当する開始地点情報を取得します

オプションとしてフレーム番号を指定した場合は、フレーム番号以前の直近のフレームに該当する開始地点情報を取得します。
オプションとしてタイムスタンプを指定した場合は、その値より小さい中で直近のタイムスタンプを持つ開始地点情報を取得します。
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

不明点: タイムスタンプも未満でなく以下が返っている? (実装上は恐らくどちらでも実害はない)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant