Document extended types

adzialocha · Sep 16, 2020 · be2858c · be2858c
1 parent 547dda1
commit be2858c
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -32,6 +32,7 @@ osc-js is an [Open Sound Control](http://opensoundcontrol.org/) library for Java
 - Featuring all [OSC 1.0 specifications](http://opensoundcontrol.org/spec-1_0)
 - OSC Address pattern matching
 - Time-critical OSC Bundles with Timetags
+- Extended (nonstandard) argument types
 
 ## Documentation
 

diff --git a/src/message.js b/src/message.js
@@ -16,6 +16,21 @@ import AtomicString from './atomic/string'
 
 /**
  * A TypedMessage consists of an OSC address and an optional array of typed OSC arguments.
+ *
+ * ## Supported types
+ *
+ * - `i` - int32
+ * - `f` - float32
+ * - `s` - string
+ * - `b` - blob
+ * - `h` - int64
+ * - `t` - uint64
+ * - `d` - double
+ * - `T` - True (no argument data)
+ * - `F` - False (no argument data)
+ * - `N` - Nil (no argument data)
+ * - `I` - Infinitum (no argument data)
+ *
  */
 export class TypedMessage {
   /**