roslib/dist/src/types/rosapi.d.ts

The standard ROS Javascript Library

export declare namespace rosapi {
    interface TypeDef {
        type: string;
        fieldnames: string[];
        fieldtypes: string[];
        fieldarraylen: number[];
        examples: string[];
    }
    interface ServiceResponseDetailsRequest {
        type: string;
    }
    interface ServiceResponseDetailsResponse {
        typedefs: TypeDef[];
    }
    interface ServiceRequestDetailsRequest {
        type: string;
    }
    interface ServiceRequestDetailsResponse {
        typedefs: TypeDef[];
    }
    interface PublishersRequest {
        topic: string;
    }
    interface PublishersResponse {
        publishers: string[];
    }
    interface GetParamRequest {
        name: string;
        default?: string;
    }
    interface GetParamResponsePreJazzy {
        value: string;
    }
    interface GetParamResponseFailedPostJazzy {
        value: never;
        successful: false;
        reason: string;
    }
    interface GetParamResponseSuccessPostJazzy {
        value: string;
        successful: true;
        reason: never;
    }
    type GetParamResponse = GetParamResponsePreJazzy | GetParamResponseFailedPostJazzy | GetParamResponseSuccessPostJazzy;
    interface SetParamRequest {
        name: string;
        value: string;
    }
    type SetParamResponsePreJazzy = Record<never, never>;
    interface FailedSetParamResponsePostJazzy {
        successful: false;
        reason: string;
    }
    interface SuccessfulSetParamResponsePostJazzy {
        successful: true;
        reason: never;
    }
    type SetParamResponse = SetParamResponsePreJazzy | FailedSetParamResponsePostJazzy | SuccessfulSetParamResponsePostJazzy;
    interface DeleteParamRequest {
        name: string;
    }
    type DeleteParamResponsePreJazzy = Record<never, never>;
    interface FailedDeleteParamResponsePostJazzy {
        successful: false;
        reason: string;
    }
    interface SuccessfulDeleteParamResponsePostJazzy {
        successful: true;
        reason: never;
    }
    type DeleteParamResponse = DeleteParamResponsePreJazzy | FailedDeleteParamResponsePostJazzy | SuccessfulDeleteParamResponsePostJazzy;
    type GetActionServersRequest = Record<never, never>;
    interface GetActionServersResponse {
        action_servers: string[];
    }
    type TopicsRequest = Record<never, never>;
    interface TopicsResponse {
        topics: string[];
        types: string[];
    }
    interface TopicsForTypeRequest {
        type: string;
    }
    interface TopicsForTypeResponse {
        topics: string[];
    }
    type ServicesRequest = Record<never, never>;
    interface ServicesResponse {
        services: string[];
    }
    interface ServicesForTypeRequest {
        type: string;
    }
    interface ServicesForTypeResponse {
        services: string[];
    }
    type NodesRequest = Record<never, never>;
    interface NodesResponse {
        nodes: string[];
    }
    interface NodeDetailsRequest {
        node: string;
    }
    interface NodeDetailsResponse {
        subscribing: string[];
        publishing: string[];
        services: string[];
    }
    type GetParamNamesRequest = Record<never, never>;
    interface GetParamNamesResponse {
        names: string[];
    }
    interface TopicTypeRequest {
        topic: string;
    }
    interface TopicTypeResponse {
        type: string;
    }
    interface ServiceTypeRequest {
        service: string;
    }
    interface ServiceTypeResponse {
        type: string;
    }
    interface MessageDetailsRequest {
        type: string;
    }
    interface MessageDetailsResponse {
        typedefs: TypeDef[];
    }
    type TopicsAndRawTypesRequest = Record<never, never>;
    interface TopicsAndRawTypesResponse {
        topics: string[];
        types: string[];
        typedefs_full_text: string[];
    }
}