28 lines
758 B
Markdown
28 lines
758 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, OSCServer} from 'ts-osc';
|
|
|
|
const client = new OSCClient("localhost", 8000);
|
|
|
|
client.send('/hello', OSCType.String, "hello");
|
|
|
|
const server = new OSCServer("0.0.0.0", 8000);
|
|
|
|
server.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 |
|