feat: improve inspection of pointers

Author: pi0

README.md

@@ -76,6 +76,7 @@ This project is a rework of [jdiaz5513/capnp-ts](https://github.com/jdiaz5513/ca
 - Use reflection (getter setters) to access structs.
 - RPC level-1 merged from [jdiaz5513/capnp-ts#169](https://github.com/jdiaz5513/capnp-ts/pull/169).
 - List interface implements [`Array` object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) (custom methods removed).
+- Pointers had been improved to feel (inspected and serialized) like native JS values as much as possible.
 
 </details>
 

src/serialization/pointers/bool-list.ts

@@ -28,7 +28,7 @@ export class BoolList extends List<boolean> {
     c.segment.setUint8(byteOffset, value ? v | bitMask : v & ~bitMask);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Bool_${super.toString()}`;
   }
 }

src/serialization/pointers/composite-list.ts

@@ -28,7 +28,7 @@ export function CompositeList<T extends Struct>(
       copyFrom(value, this.get(index));
     }
 
-    toString(): string {
+    [Symbol.toStringTag](): string {
       return `Composite_${super.toString()},cls:${CompositeClass.toString()}`;
     }
   };

src/serialization/pointers/data.ts

@@ -116,7 +116,7 @@ export class Data extends List<number> {
     return new DataView(c.segment.buffer, c.byteOffset, this.length);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Data_${super.toString()}`;
   }
 

src/serialization/pointers/float32-list.ts

@@ -22,7 +22,7 @@ export class Float32List extends List<number> {
     c.segment.setFloat32(c.byteOffset + index * 4, value);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Float32_${super.toString()}`;
   }
 }

src/serialization/pointers/float64-list.ts

@@ -22,7 +22,7 @@ export class Float64List extends List<number> {
     c.segment.setFloat64(c.byteOffset + index * 8, value);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Float64_${super.toString()}`;
   }
 }

src/serialization/pointers/int16-list.ts

@@ -22,7 +22,7 @@ export class Int16List extends List<number> {
     c.segment.setInt16(c.byteOffset + index * 2, value);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Int16_${super.toString()}`;
   }
 }

src/serialization/pointers/int32-list.ts

@@ -20,7 +20,7 @@ export class Int32List extends List<number> {
     c.segment.setInt32(c.byteOffset + index * 4, value);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Int32_${super.toString()}`;
   }
 }

src/serialization/pointers/int64-list.ts

@@ -20,7 +20,7 @@ export class Int64List extends List<bigint> {
     c.segment.setInt64(c.byteOffset + index * 8, value);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Int64_${super.toString()}`;
   }
 }

src/serialization/pointers/int8-list.ts

@@ -20,7 +20,7 @@ export class Int8List extends List<number> {
     c.segment.setInt8(c.byteOffset + index, value);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Int8_${super.toString()}`;
   }
 }

src/serialization/pointers/interface.ts

@@ -50,7 +50,7 @@ export class Interface extends Pointer {
     return getClient(this);
   }
 
-  toString(): string {
+  [Symbol.for("nodejs.util.inspect.custom")](): string {
     return format(
       "Interface_%d@%a,%d,limit:%x",
       this.segment.id,

src/serialization/pointers/list.ts

@@ -361,8 +361,8 @@ export class List<T> extends Pointer implements Array<T> {
     return this.values();
   }
 
-  [Symbol.toStringTag]() {
-    return "[object Array]";
+  toJSON(): unknown {
+    return this.toArray();
   }
 
   toString(): string {
@@ -373,7 +373,11 @@ export class List<T> extends Pointer implements Array<T> {
     return this.toString();
   }
 
-  static toString(): string {
+  [Symbol.toStringTag]() {
+    return "[object Array]";
+  }
+
+  static [Symbol.toStringTag](): string {
     return this._capnp.displayName;
   }
 }

src/serialization/pointers/orphan.ts

@@ -201,7 +201,7 @@ export class Orphan<T extends Pointer> {
     this._capnp = undefined;
   }
 
-  toString(): string {
+  [Symbol.for("nodejs.util.inspect.custom")](): string {
     return format(
       "Orphan_%d@%a,type:%s",
       this.segment.id,

src/serialization/pointers/pointer-list.ts

@@ -26,7 +26,7 @@ export function PointerList<T extends Pointer>(
       copyFrom(value, this.get(index));
     }
 
-    toString(): string {
+    [Symbol.toStringTag](): string {
       return `Pointer_${super.toString()},cls:${PointerClass.toString()}`;
     }
   };

src/serialization/pointers/pointer.ts

@@ -110,6 +110,10 @@ export class Pointer<T extends _Pointer = _Pointer> {
     }
   }
 
+  [Symbol.toStringTag](): string {
+    return format("Pointer_%d", this.segment.id);
+  }
+
   toString(): string {
     return format("->%d@%a%s", this.segment.id, this.byteOffset, dump(this));
   }
@@ -709,7 +713,7 @@ export function getTargetPointerType(p: Pointer): PointerType {
 /**
  * Get the size of the struct referenced by a pointer, following far pointers if necessary.
  *
- * @param {Pointer} p The poiner to read from.
+ * @param {Pointer} p The pointer to read from.
  * @returns {ObjectSize} The size of the struct referenced by this pointer.
  */
 

src/serialization/pointers/struct.ts

@@ -141,11 +141,11 @@ export class Struct extends Pointer<_Struct> {
     this._capnp.compositeList = compositeIndex !== undefined;
   }
 
-  static toString(): string {
+  static [Symbol.toStringTag](): string {
     return this._capnp.displayName;
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return (
       `Struct_${super.toString()}` +
       `${this._capnp.compositeIndex === undefined ? "" : `,ci:${this._capnp.compositeIndex}`}` +

src/serialization/pointers/text-list.ts

@@ -27,7 +27,7 @@ export class TextList extends List<string> {
     Text.fromPointer(c).set(0, value);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Text_${super.toString()}`;
   }
 }

src/serialization/pointers/text.ts

@@ -99,6 +99,18 @@ export class Text extends List<string> {
   }
 
   toString(): string {
+    return this.get();
+  }
+
+  toJSON(): string {
+    return this.get();
+  }
+
+  [Symbol.toPrimitive](): string {
+    return this.get();
+  }
+
+  [Symbol.toStringTag](): string {
     return `Text_${super.toString()}`;
   }
 }

src/serialization/pointers/uint16-list.ts

@@ -21,7 +21,7 @@ export class Uint16List extends List<number> {
     c.segment.setUint16(c.byteOffset + index * 2, value);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Uint16_${super.toString()}`;
   }
 }

src/serialization/pointers/uint32-list.ts

@@ -20,7 +20,7 @@ export class Uint32List extends List<number> {
     c.segment.setUint32(c.byteOffset + index * 4, value);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Uint32_${super.toString()}`;
   }
 }

src/serialization/pointers/uint64-list.ts

@@ -20,7 +20,7 @@ export class Uint64List extends List<bigint> {
     c.segment.setUint64(c.byteOffset + index * 8, value);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Uint64_${super.toString()}`;
   }
 }

src/serialization/pointers/uint8-list.ts

@@ -20,7 +20,7 @@ export class Uint8List extends List<number> {
     c.segment.setUint8(c.byteOffset + index, value);
   }
 
-  toString(): string {
+  [Symbol.toStringTag](): string {
     return `Uint8_${super.toString()}`;
   }
 }