ts-osc/README.md
2021-01-23 20:30:54 +01:00

30 lines
746 B
Markdown

# ts-osc
An easy to use, Typescript-Native OSC client.
API Docs [here](https://riksolo.pages.riksolo.com/ts-osc/)
## Usage example
```javascript
import {OSCClient, OSCType} from 'ts-osc';
const client = new OSCClient({
outHost: "localhost",
outPort: 8000,
inPort: 8000
})
client.send('/hello', OSCType.String, "hello");
client.on('message', (msg)=>{
console.log(msg);
})
```
## NPM Scripts
| Tasks | Description |
| --------------------- | --------------------------------- |
| npm run build | Build module & docs |
| npm run compile | Compile TS |
| npm run watch | Compile and watch |
| npm run clean | Clean build folder |
| npm run docs | generate docs |