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.

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

feat: Deno.{Stdin,Stdout,Stderr} interfaces #22168

Closed
wants to merge 2 commits into from

Conversation

iuioiua
Copy link
Collaborator

@iuioiua iuioiua commented Jan 29, 2024

While working on deprecation documentation, I realised that the documentation for Deno.{stdin,stdout,stderr} doesn't fully display on the runtime API documentation site (see here). I guess this is because these constants are of an object type rather than the interface.

This change introduces new interfaces so that their documentation is fully available. Alternatively, we can just fix the website to support object types. It's possible that users may confused between the types and constants. I.e. Deno.stdin and Deno.Stdin.

Copy link
Member

@crowlKats crowlKats left a comment

Choose a reason for hiding this comment

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

LGTM.
Indeed, type alias objects cant currently properly render, and its a tricky issue, so type aliases are preferred.
I know there are some differences between behaviour of interfaces and type aliases, but shouldnt be a problem for this scenario.

@mmastrac mmastrac added this to the 1.41 milestone Feb 13, 2024
@iuioiua
Copy link
Collaborator Author

iuioiua commented Feb 13, 2024

I realise we have the same issue with Deno.build, Deno.version and Temporal.Now. I'll fix those too.

This was referenced Feb 14, 2024
Copy link
Member

@crowlKats crowlKats left a comment

Choose a reason for hiding this comment

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

Blocking approval as needs further discussion

@bartlomieju bartlomieju modified the milestones: 1.41, 1.42 Mar 6, 2024
@bartlomieju bartlomieju removed this from the 1.42 milestone Mar 26, 2024
@iuioiua
Copy link
Collaborator Author

iuioiua commented May 6, 2024

Closing as type literal documentation is coming (denoland/deno_doc#564).

@iuioiua iuioiua closed this May 6, 2024
@iuioiua iuioiua deleted the stdstreams-interfaces branch May 6, 2024 02:59
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.

None yet

4 participants