koffi 2.3.4 → 2.3.6-beta.1

package/CHANGELOG.md

@@ -4,6 +4,29 @@
 
 ### Koffi 2.3
 
+#### Koffi 2.3.6
+
+**Main changes:**
+
+- Fix broken TS definition file
+- Keep all prebuilt binaries and load correct one at runtime
+
+#### Koffi 2.3.5
+
+**Main fixes:**
+
+- Fix rare random crashes with async callbacks
+- Fix some bugs with RISC-V 64 ABI
+
+**Other changes:**
+
+- Expose array type hint in `koffi.introspect()`
+- Add missing `koffi.array()` export in TS definition
+- Make KoffiFunction more flexible in TS definition ([@insraq](https://github.com/insraq))
+- Add a KoffiFunc<T> helper type in TS typing ([@insraq](https://github.com/insraq))
+- Mark optional properties in TS TypeInfo class
+- Minor performance improvements
+
 #### Koffi 2.3.4
 
 **Main fixes:**
@@ -37,7 +60,7 @@
 
 - Allow buffers (TypedArray or ArrayBuffer) values for input and/or output pointer arguments (for polymorphic arguments)
 - Support opaque buffers (TypedArray or ArrayBuffer) values in `koffi.decode()` to [decode output buffers](calls.md#output-buffers)
-- Decode non-string types as arrays when an [explicit length is passed to koffi.decode()](callbacks.md#pointer-arguments)
+- Decode non-string types as arrays when an [explicit length is passed to koffi.decode()](callbacks.md#decoding-pointer-arguments)
 
 **Other changes:**
 
@@ -100,7 +123,7 @@
 
 **New features:**
 
-- Add [koffi.decode()](callbacks.md#pointer-arguments) for callback pointer arguments
+- Add [koffi.decode()](callbacks.md#decoding-pointer-arguments) for callback pointer arguments
 - Support transparent [output string parameters](calls.md#output-parameters)
 - Add `koffi.offsetof()` utility function
 - Support optional *this* binding in `koffi.register()`

package/doc/changelog.md

@@ -1 +1,5 @@
+---
+tocdepth: 3
+---
+
 {{ "```{include} " ~ root ~ "/CHANGELOG.md" ~ "\n```" }}

package/doc/index.rst

@@ -11,7 +11,6 @@ Koffi is a **fast and easy-to-use C FFI module for Node.js**, featuring:
 * Javascript functions can be used as C callbacks (since 1.2.0)
 * Well-tested code base for :ref:`popular OS/architecture combinations<Supported platforms>`
 
-
 Koffi requires a recent `Node.js <https://nodejs.org/>`_ version with N-API version 8 support, see :ref:`this page<Node.js>` for more information.
 
 The source code is available here: https://github.com/Koromix/rygel/ (in the *src/koffi* subdirectory).
@@ -20,7 +19,7 @@ Table of contents
 -----------------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
    platforms
    start

package/doc/types.md

@@ -339,7 +339,7 @@ Fixed-size arrays are declared with `koffi.array(type, length)`. Just like in C,
 Koffi applies the following conversion rules when passing arrays to/from C:
 
 - **JS to C**: Koffi can take a normal Array (e.g. `[1, 2]`) or a TypedArray of the correct type (e.g. `Uint8Array` for an array of `uint8_t` numbers)
-- **C to JS** (return value, output parameters, callbacks): Koffi will use a TypedArray if possible. But you can change this behavior when you create the array type with the optional hint argument: `koffi.array('uint8_t', 64, 'array')`. For non-number types, such as arrays of strings or structs, Koffi creates normal arrays.
+- **C to JS** (return value, output parameters, callbacks): Koffi will use a TypedArray if possible. But you can change this behavior when you create the array type with the optional hint argument: `koffi.array('uint8_t', 64, 'Array')`. For non-number types, such as arrays of strings or structs, Koffi creates normal arrays.
 
 See the example below:
 
@@ -353,7 +353,7 @@ const Foo1 = koffi.struct('Foo', {
 });
 const Foo2 = koffi.struct('Foo', {
     i: 'int',
-    a16: koffi.array('int16_t', 8, 'array')
+    a16: koffi.array('int16_t', 8, 'Array')
 });
 
 // Uses an hypothetical C function that just returns the struct passed as a parameter
@@ -371,7 +371,7 @@ Koffi can also convert JS strings to fixed-sized arrays in the following cases:
 - **char arrays** are filled with the UTF-8 encoded string, truncated if needed. The buffer is always NUL-terminated.
 - **char16 (or char16_t) arrays** are filled with the UTF-16 encoded string, truncated if needed. The buffer is always NUL-terminated.
 
-The reverse case is also true, Koffi can convert a C fixed-size buffer to a JS string. This happens by default for char, char16 and char16_t arrays, but you can also explicitly ask for this with the `string` array hint (e.g. `koffi.array('char', 8, 'string')`).
+The reverse case is also true, Koffi can convert a C fixed-size buffer to a JS string. This happens by default for char, char16 and char16_t arrays, but you can also explicitly ask for this with the `String` array hint (e.g. `koffi.array('char', 8, 'String')`).
 
 ### Array pointers (dynamic arrays)
 

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "koffi",
-    "version": "2.3.4",
-    "stable": "2.3.4",
+    "version": "2.3.6-beta.1",
+    "stable": "2.3.5",
     "description": "Fast and simple C FFI (foreign function interface) for Node.js",
     "keywords": [
         "foreign",
@@ -25,8 +25,8 @@
     },
     "license": "LGPL-3.0",
     "cnoke": {
-        "prebuild": "src/koffi/build/{{version}}/koffi_{{platform}}_{{arch}}.tar.gz",
-        "require": "./src/koffi/build/koffi.node",
-        "napi": 8
+        "napi": 8,
+        "require": "./src/koffi/build/{{version}}/koffi_{{platform}}_{{arch}}/koffi.node",
+        "output": "./build/{{version}}/koffi_{{platform}}_{{arch}}"
     }
 }