Skip to content

Commit 8f94936

Browse files
committed
Expose missing types for docs
1 parent ed7eca0 commit 8f94936

File tree

2 files changed

+45
-5
lines changed

2 files changed

+45
-5
lines changed

src/RosLib.ts

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,44 @@ export {
7878
isRosbridgeAdvertiseMessage,
7979
type RosbridgeSubscribeMessage,
8080
isRosbridgeSubscribeMessage,
81+
type RosbridgeAuthMessage,
82+
type RosbridgeStatusMessage,
83+
isRosbridgeStatusMessage,
84+
type RosbridgeSetStatusLevelMessage,
85+
isRosbridgeSetStatusLevelMessage,
86+
type RosbridgeFragmentMessage,
87+
isRosbridgeFragmentMessage,
88+
type RosbridgePngMessage,
89+
isRosbridgePngMessage,
90+
type RosbridgeUnadvertiseMessage,
91+
isRosbridgeUnadvertiseMessage,
92+
type RosbridgePublishMessage,
93+
isRosbridgePublishMessage,
94+
type RosbridgeUnsubscribeMessage,
95+
isRosbridgeUnsubscribeMessage,
96+
type RosbridgeAdvertiseServiceMessage,
97+
isRosbridgeAdvertiseServiceMessage,
98+
type RosbridgeUnadvertiseServiceMessage,
99+
isRosbridgeUnadvertiseServiceMessage,
100+
type RosbridgeCallServiceMessage,
101+
isRosbridgeCallServiceMessage,
102+
type RosbridgeServiceResponseMessage,
103+
isRosbridgeServiceResponseMessage,
104+
type RosbridgeAdvertiseActionMessage,
105+
isRosbridgeAdvertiseActionMessage,
106+
type RosbridgeUnadvertiseActionMessage,
107+
isRosbridgeUnadvertiseActionMessage,
108+
type RosbridgeSendActionGoalMessage,
109+
isRosbridgeSendActionGoalMessage,
110+
type RosbridgeCancelActionGoalMessage,
111+
isRosbridgeCancelActionGoalMessage,
112+
type RosbridgeActionFeedbackMessage,
113+
isRosbridgeActionFeedbackMessage,
114+
type RosbridgeActionResultMessage,
115+
isRosbridgeActionResultMessage,
116+
type RosbridgeMessageBase,
117+
type FailedRosbridgeActionResultMessage,
118+
type SuccessfulRosbridgeActionResultMessage,
119+
type FailedRosbridgeServiceResponseMessage,
120+
type SuccessfulRosbridgeServiceResponseMessage,
81121
} from "./types/protocol.js";

src/types/protocol.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ export interface RosbridgeCallServiceMessage<TArgs = unknown>
180180
id?: string;
181181
service: string;
182182
/**
183-
* @todo this should be deeply partial when *outgoing*, because rosbridge will "fill in the blanks",
183+
* TODO this should be deeply partial when *outgoing*, because rosbridge will "fill in the blanks",
184184
* but it's not partial when *incoming* - need to figure out a way to represent this.
185185
*/
186186
args: TArgs;
@@ -202,13 +202,13 @@ interface BaseRosbridgeServiceResponseMessage extends RosbridgeMessageBase {
202202
}
203203

204204
/** If the service call failed, `values` will be a string error message. */
205-
interface FailedRosbridgeServiceResponseMessage
205+
export interface FailedRosbridgeServiceResponseMessage
206206
extends BaseRosbridgeServiceResponseMessage {
207207
values?: string;
208208
result: false;
209209
}
210210

211-
interface SuccessfulRosbridgeServiceResponseMessage<TValues = unknown>
211+
export interface SuccessfulRosbridgeServiceResponseMessage<TValues = unknown>
212212
extends BaseRosbridgeServiceResponseMessage {
213213
values: TValues;
214214
result: true;
@@ -299,13 +299,13 @@ interface RosbridgeActionResultMessageBase extends RosbridgeMessageBase {
299299
status: number;
300300
}
301301

302-
interface FailedRosbridgeActionResultMessage
302+
export interface FailedRosbridgeActionResultMessage
303303
extends RosbridgeActionResultMessageBase {
304304
result: false;
305305
values?: string;
306306
}
307307

308-
interface SuccessfulRosbridgeActionResultMessage<TResultValues = unknown>
308+
export interface SuccessfulRosbridgeActionResultMessage<TResultValues = unknown>
309309
extends RosbridgeActionResultMessageBase {
310310
values: TResultValues;
311311
result: true;

0 commit comments

Comments
 (0)