@gtkx/ffi 0.18.0 → 0.18.1

package/dist/registry.d.ts

@@ -38,7 +38,26 @@ export declare function getNativeClass(glibTypeName: string): NativeClass | null
  * @returns The closest registered parent class, or null
  */
 export declare const findNativeClass: (glibTypeName: string, walkHierarchy?: boolean) => NativeClass | null;
+/**
+ * Registers a native object in the identity registry.
+ *
+ * Ensures that the same native pointer always resolves to the same
+ * JavaScript wrapper, preserving object identity (`===`). The reference
+ * is weak, so objects can still be garbage collected.
+ *
+ * @param obj - The native object wrapper to register
+ */
 export declare function registerNativeObject(obj: NativeObject): void;
+/**
+ * Finds an existing JavaScript wrapper for a native pointer.
+ *
+ * Looks up the identity registry to find a previously registered wrapper
+ * for the given native handle. Returns null if no wrapper exists or if
+ * the wrapper has been garbage collected.
+ *
+ * @param handle - The native handle to look up
+ * @returns The existing wrapper, or null if not found
+ */
 export declare function findNativeObject(handle: NativeHandle): NativeObject | null;
 type GetNativeObjectResult<T extends NativeHandle | null | undefined, TClass extends NativeClass | undefined> = T extends null | undefined ? null : TClass extends NativeClass<infer U> ? U : NativeObject;
 /**

package/dist/registry.js

@@ -70,11 +70,30 @@ const objectRegistry = new Map();
 const cleanupObjectRegistry = new FinalizationRegistry((pointerId) => {
     objectRegistry.delete(pointerId);
 });
+/**
+ * Registers a native object in the identity registry.
+ *
+ * Ensures that the same native pointer always resolves to the same
+ * JavaScript wrapper, preserving object identity (`===`). The reference
+ * is weak, so objects can still be garbage collected.
+ *
+ * @param obj - The native object wrapper to register
+ */
 export function registerNativeObject(obj) {
     const pointerId = getNativeId(obj.handle);
     objectRegistry.set(pointerId, new WeakRef(obj));
     cleanupObjectRegistry.register(obj, pointerId, obj);
 }
+/**
+ * Finds an existing JavaScript wrapper for a native pointer.
+ *
+ * Looks up the identity registry to find a previously registered wrapper
+ * for the given native handle. Returns null if no wrapper exists or if
+ * the wrapper has been garbage collected.
+ *
+ * @param handle - The native handle to look up
+ * @returns The existing wrapper, or null if not found
+ */
 export function findNativeObject(handle) {
     const pointerId = getNativeId(handle);
     const ref = objectRegistry.get(pointerId);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gtkx/ffi",
-  "version": "0.18.0",
+  "version": "0.18.1",
   "description": "Generated TypeScript FFI bindings for GTKX",
   "keywords": [
     "gtkx",
@@ -51,10 +51,10 @@
     "dist"
   ],
   "dependencies": {
-    "@gtkx/native": "0.18.0"
+    "@gtkx/native": "0.18.1"
   },
   "devDependencies": {
-    "@gtkx/vitest": "0.18.0"
+    "@gtkx/vitest": "0.18.1"
   },
   "scripts": {
     "build": "tsc -b && cp ../../README.md .",