Skip to content

[TypeScript] Add declaration for removeSignalHandlers() #1023

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

Merged
merged 1 commit into from
Jan 26, 2025
Merged

[TypeScript] Add declaration for removeSignalHandlers() #1023

Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions test/types/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ rclnodejs.isShutdown();
// $ExpectType void
rclnodejs.shutdown();

// $ExpectType void
rclnodejs.removeSignalHandlers();

// ---- DistroUtil ----

// $ExpectType DistroId
Expand Down
7 changes: 7 additions & 0 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,13 @@ declare module 'rclnodejs' {
type: T
): MessageType<T>;

/**
* Removes the default signal handler installed by rclnodejs. After calling this, rclnodejs
* will no longer clean itself up when a SIGINT is received, it is the application's
* responsibility to properly shut down all nodes and contexts.
*/
function removeSignalHandlers(): void;

/**
* Get a list of action names and types for action clients associated with a node.
* @param node - The node used for discovery.
Expand Down
Loading