fix(types): mark monitor.currentStatus nullable + clarify post-create timing#16
Merged
Merged
Conversation
`Monitor.currentStatus` is computed by the probe pipeline and isn't populated on a freshly-created monitor, so a fresh dev who logs it straight after `client.monitors.create()` sees `undefined`. Wrap the generated `MonitorDto` so the field is surfaced as `string | null` with a doc comment that explains the timing, and update the README quickstart with a one-line note + `?? 'PENDING'` display pattern so the example doesn't read as broken. Round-2 DevEx friction P2 #14. Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Monitor.currentStatusas nullable so TS users see the post-create timing in their type system.undefinedprinted for a brand-new monitor.Round-2 DevEx friction P2 #14.
Test plan
npm run lint && npm run typecheck && npm test && npm run buildgreenundefinedin the printed outputMade with Cursor