# @wayneparrott/rclnodejs-types

> TypeScript declarations for ROS2 rclnodejs node client

Latest version **0.1.8** (published 2019-11-19) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @wayneparrott/rclnodejs-types
pnpm add @wayneparrott/rclnodejs-types
yarn add @wayneparrott/rclnodejs-types
bun add @wayneparrott/rclnodejs-types
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2019-11-19 |
| First published | 2019-10-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 38.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Wayne Parrott |
| Maintainers | wayneparrott |
| Keywords | rclnodejs, ros2, ros, node, typescript, javascript |

## Links

- npm: https://www.npmjs.com/package/@wayneparrott/rclnodejs-types
- Repository: https://github.com/wayneparrott/rclnodejs-types
- Homepage: https://github.com/wayneparrott/rclnodejs-types#readme
- Issues: https://github.com/wayneparrott/rclnodejs-types/issues
- npm.io page: https://npm.io/package/@wayneparrott/rclnodejs-types

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.1.8 (latest) — 2019-11-19
- 0.1.7 — 2019-11-19
- 0.1.6 — 2019-11-11
- 0.1.5 — 2019-11-11
- 0.1.4 — 2019-11-07
- 0.1.3 — 2019-11-07
- 0.1.2 — 2019-11-06
- 0.1.1 — 2019-10-31
- 0.1.0 — 2019-10-31

## README

# TypeScript declarations for [rclnodejs](https://github.com/RobotWebTools/rclnodejs)


This project provides type declaration files (*.d.ts) for use when coding your ROS2 rclnodejs nodes, interfaces, publishers, subscribers and clients using TypeScript. 


## Installation
`npm install @wayneparrott/rclnodejs-types --save-dev`

## Configuration
In your project tsconfig.json file, update the "typeRoots" property to include @wayneparrott/rclnodejs-types as shown below:

```  
"typeRoots": [
    "node_modules/@wayneparrott/rclnodejs-types",
    "node_modules/@types"
]
```

You will also need to install the rclnodejs package separately from this project as well as the ROS2 environment:

`npm i rclnodejs`

See [ROS2](https://index.ros.org/doc/ros2/) for installation options. 

## Example
```javascript
import * as rclnodejs from 'rclnodejs';

const node: rclnodejs.Node;
const publisher: rclnodejs.Publisher;
const logger: rclnodejs.Logger;

async function init() {
  await rclnodejs.init();

  node = rclnodejs.createNode('ExampleNode');
  logger = rclnodejs.Logging.getLogger('exampleLogger')
  logger.info('node created');

  publisher = node.createPublisher('std_msgs/msg/String', 'topic');

  node.spin();
}


init();
publisher.publish('hello world');
logger.info('published msg');
node.destroy();
rclnodejs.shutdown();
  
```

## Recognition
* Thanks to the [rclnodejs]() team for their hard work in enabling JavaScript coders to be part of the Robot Operating System community. 

* Thanks to [Genuitec](https://genuitec.com) for the [CodeMix](https://www.genuitec.com/products/codemix/) plugin for Eclipse which provides great TypeScript coding tools among its many other supported languages.

---
_Source: https://npm.io/package/@wayneparrott/rclnodejs-types · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._