Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

lib: type cockpit.file.read() correctly #21145

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

lib: type cockpit.file.read() correctly #21145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg/lib/cockpit.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ declare module 'cockpit' {
}

interface FileHandle<T> {
read(): Promise<T>;
read(callback: (data: T | null) => T, tag?: FileTag): Promise<T>;
Copy link
Member

Choose a reason for hiding this comment

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

cockpit.file().read() does not take a callback. And if it would, it'd probably be optional?

Copy link
Member

@mvollmer mvollmer Oct 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

Oh, modify has been annotated as : Promise<[T, FileTag]>. Does that work?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah hmm this is all wrong :-)

replace(new_content: T | null, expected_tag?: FileTag): Promise<FileTag>;
watch(callback: FileWatchCallback<T>, options?: { read?: boolean }): FileWatchHandle;
modify(callback: (data: T | null) => T | null, initial_content?: string, initial_tag?: FileTag): Promise<[T, FileTag]>;
Expand Down