Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
20 changes: 20 additions & 0 deletions test/types/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,26 @@ subscription = node.createSubscription(
(msg) => {}
);

// $ExpectType Subscription
subscription = node.createSubscription(
TYPE_CLASS,
TOPIC,
{ isRaw: false },
(message: rclnodejs.std_msgs.msg.String) => {
const receivedMessage: rclnodejs.std_msgs.msg.String = message;
}
);

// $ExpectType Subscription receiving raw message
subscription = node.createSubscription(
TYPE_CLASS,
TOPIC,
{ isRaw: true },
(message: Buffer) => {
const receivedRawMessage: Buffer = message;
}
);

// $ExpectType string
subscription.topic;

Expand Down
2 changes: 1 addition & 1 deletion types/node.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ declare module 'rclnodejs' {
typeClass: T,
topic: string,
options: Options,
callback: SubscriptionCallback<T>
callback: SubscriptionCallback<T> | SubscriptionWithRawMessageCallback
): Subscription;

/**
Expand Down
18 changes: 17 additions & 1 deletion types/subscription.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,23 @@ declare module 'rclnodejs' {
*/
type SubscriptionCallback<T extends TypeClass<MessageTypeClassName>> =
// * @param message - The published message
(message: MessageType<T> | Buffer) => void;
(message: MessageType<T>) => void;

/**
* A callback for receiving published raw messages.
*
* @param message - The published message.
*
* @remarks
* See {@link Node#createSubscription | Node.createSubscription}
* See {@link SubscriptionContentFilter}
* See {@link Node#createPublisher | Node.createPublisher}
* See {@link Publisher}
* See {@link Subscription}
*/
type SubscriptionWithRawMessageCallback =
// * @param message - The published raw message
(message: Buffer) => void;

/**
* A ROS Subscription for published messages on a topic.
Expand Down
Loading