lib: type cockpit.file.read() correctly #21145
Open
Conversation
This file contains 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
read() returns the content and the read tag.
jelly
added
the
no-test
martinpitt
reviewed
Oct 21, 2024
| @@ -247,7 +247,7 @@ declare module 'cockpit' { | |||
| } | |||
|
|
|||
| interface FileHandle<T> { | |||
| read(): Promise<T>; | |||
| read(callback: (data: T | null) => T, tag?: FileTag): Promise<T>; | |||
There was a problem hiding this comment.
cockpit.file().read() does not take a callback. And if it would, it'd probably be optional?
mvollmer
reviewed
Oct 21, 2024
| @@ -247,7 +247,7 @@ declare module 'cockpit' { | |||
| } | |||
|
|
|||
| interface FileHandle<T> { | |||
| read(): Promise<T>; | |||
| read(callback: (data: T | null) => T, tag?: FileTag): Promise<T>; | |||
There was a problem hiding this comment.
read doesn't have a callback parameter. Or am I misreading the type annotations?
I wouldn't be surprised if we can't type read correctly. It would be something like read(): Promise<T, FileTag>, no? But Promise probably takes only one type parameter.
There was a problem hiding this comment.
Oh, modify has been annotated as : Promise<[T, FileTag]>. Does that work?
There was a problem hiding this comment.
Yeah hmm this is all wrong :-)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
read() returns the content and the read tag.