more docs

Author: phpnode

README.md

@@ -40,7 +40,6 @@ async function run () {
   const {StructType, T} = realm;
 
   const Point = new StructType(
-    'Point',
     {
       r: T.UInt8,
       g: T.UInt8,
@@ -54,16 +53,16 @@ async function run () {
     }
   );
 
-  const Column = new StructType('Column', Point, 1024);
+  const Column = new StructType(Point, 1024);
 
-  const Screen = new StructType('Screen', Column, 768);
+  const Screen = new StructType(Column, 768);
 
 
   const display = new Screen();
 
   display[10][10].r = 127;
 
-  const User = new StructType('User', {
+  const User = new StructType({
     name: T.String,
     screen: Screen.ref // Store references to screens, don't embed them
   });

src/README.md

@@ -2,5 +2,5 @@
 
 * [Builtin Types](./builtins/README.md)
 * [Hash Functions](./hash-functions/README.md)
-* [Type Classes](./type-classes/README.md)
+* [Type Classes](./type-class/README.md)
 * [String Pool](./string-pool/README.md)

src/type-class/README.md

@@ -1,3 +1,13 @@
 # Type Classes
 
-Type classes represent categories of type. Each type class is assigned a range of possible ids, and each instantiation of a type class (a Type), has an id within that range.
+Type classes represent categories of type. Each type class is assigned a range of possible ids, and each instantiation of a type class (a Type), has an id within that range.
+
+Builtin Type Classes:
+
+* [ArrayType](./array-type/README.md)
+* [HashMapType](./hash-map-type/README.md)
+* [ObjectType](./object-type/README.md)
+* [PrimitiveType](./primitive-type/README.md)
+* [ReferenceType](./reference-type/README.md)
+* [StringType](./string-type/README.md)
+* [StructType](./struct-type/README.md)

src/type-class/array-type/README.md

@@ -0,0 +1,21 @@
+# ArrayType
+
+Type class for fixed length typed arrays. Takes another Type as input and produces an array type for it.
+
+Usage:
+
+```js
+const {ArrayType, T} = realm;
+const NumberArray = new ArrayType(T.Float64);
+
+const numbers = new NumberArray(3);
+
+numbers[0] === 0;
+numbers[1] === 0;
+numbers[2] === 0;
+
+numbers[1] = 123;
+
+numbers.forEach(num => console.log(num));
+
+```

src/type-class/hash-map-type/README.md

@@ -0,0 +1,17 @@
+# HashMapType
+
+A type class for typed hash maps. Takes a key type and a value type as input and produces a hash map type which can store key / values of those types.
+
+Usage:
+
+```js
+const {HashMapType, T} = realm;
+
+const StringMap = new HashMapType(T.String, T.String);
+
+const map = new StringMap();
+
+map.set('hello', 'world');
+
+console.log(map.get('hello'));
+```

src/type-class/object-type/README.md

@@ -0,0 +1,3 @@
+# ObjectType
+
+A type class for typed objects. See [T.Object](../../builtins/object/README.md) for more information.

src/type-class/primitive-type/README.md

@@ -0,0 +1,4 @@
+# PrimitiveType
+
+A type class for primitive types such as numbers, booleans etc.
+

src/type-class/reference-type/README.md

@@ -0,0 +1,4 @@
+# ReferenceType
+
+A type class for representing references to instances of other types. Takes a single Type as input and returns a new type which can store references to values of the given type.
+

src/type-class/string-type/README.md

@@ -0,0 +1,3 @@
+# StringType
+
+A type class for different kinds of [string](../../builtins/string/README.md).

src/type-class/struct-type/README.md

@@ -0,0 +1,40 @@
+# StructType
+
+A type class which can create object types with fixed layouts. Takes an object or array of fields as input and produces a type which can store objects with that shape.
+
+Usage:
+
+```js
+const {StructType, T} = realm;
+
+const Thing = new StructType({
+  name: T.String
+});
+
+const User = new StructType({
+  name: T.String,
+  likes: Thing.ref.Array
+});
+
+const things = new Thing.Array([
+  {
+    name: 'Shopping'
+  },
+  {
+    name: 'Eating Cake'
+  },
+  {
+    name: 'Reading'
+  },
+  {
+    name: 'Football'
+  }
+]);
+
+const alice = new User({
+  name: 'Alice',
+  likes: [things[0], things[1], things[2]]
+});
+
+console.log(alice.likes[0].name);
+```