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

BREAKING(signal): deprecate signal module #3568

Merged
merged 2 commits into from
Aug 25, 2023
Merged
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions signal/mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
* Higher level API for dealing with OS signals.
*
* @module
* @deprecated (will be removed in 1.0.0) Use the Deno signals API instead
Copy link
Collaborator

@iuioiua iuioiua Aug 25, 2023

Choose a reason for hiding this comment

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

I think it'd be best to link to the OS Signals API documentation here. Same for the other deprecation notice.

*/

import { MuxAsyncIterator } from "../async/mux_async_iterator.ts";
Expand Down Expand Up @@ -31,6 +32,8 @@ export type Disposable = { dispose: () => void };
* ```
*
* @param signals - one or more signals to listen to
*
* @deprecated (will be removed in 1.0.0) Use the Deno signals API instead
*/
export function signal(
...signals: [Deno.Signal, ...Deno.Signal[]]
Expand Down