koffi 2.5.11 → 2.5.13

package/CHANGELOG.md

@@ -4,16 +4,26 @@
 
 ### Koffi 2.5
 
-#### Koffi 2.5.11
+#### Koffi 2.5.13 (2023-08-23)
 
-- Support casting function pointers with [koffi.as()](parameters.md#input-polymorphism)
+- Fix DLL error when using Koffi from NW.js on Windows
+- Simplify NW.js Koffi example
+
+#### Koffi 2.5.12 (2023-08-21)
+
+- Fix native module bundling for FreeBSD ARM64 and Linux RISC-V 64
+- Increase maximum number of parameters to 64
+
+#### Koffi 2.5.11 (2023-08-03)
+
+- Support casting function pointers with [koffi.as()](polymorphism.md#input-polymorphism)
 - Build in C++20 mode
 
-#### Koffi 2.5.10
+#### Koffi 2.5.10 (2023-08-01)
 
 - Fix CMake regression when client has to build Koffi
 
-#### Koffi 2.5.9
+#### Koffi 2.5.9 (2023-07-28)
 
 **Main changes:**
 
@@ -25,43 +35,43 @@
 - Add missing unload() export to TS file
 - Add export for koffi.types in TS file
 
-#### Koffi 2.5.8
+#### Koffi 2.5.8 (2023-07-26)
 
 - Add more search paths for native Koffi modules
 - Add section [about bundling](start.md#bundling-koffi) to documentation
 
-#### Koffi 2.5.7
+#### Koffi 2.5.7 (2023-07-19)
 
 - Point package to new repository
 
-#### Koffi 2.5.6
+#### Koffi 2.5.6 (2023-07-19)
 
 - Increase limit of output parameters from 16 to 32
 
-#### Koffi 2.5.5
+#### Koffi 2.5.5 (2023-07-17)
 
 - Support decoding non-char null-terminated arrays
 
-#### Koffi 2.5.4
+#### Koffi 2.5.4 (2023-07-14)
 
 - Fix `koffi.pointer()` not accepting disposable types
 - Fix potential issues when making pointers to anonymous types
 
-#### Koffi 2.5.3
+#### Koffi 2.5.3 (2023-07-05)
 
 - Add missing union exports in TS definition file
 - Fix some parameter names in TS definition file
 
-#### Koffi 2.5.2
+#### Koffi 2.5.2 (2023-07-04)
 
 - Default initialize unset object/struct members
 
-#### Koffi 2.5.1
+#### Koffi 2.5.1 (2023-06-20)
 
 - Fix crash with some struct types in System V 64 ABI
 - Always use direct passthrough for buffer arguments
 
-#### Koffi 2.5.0
+#### Koffi 2.5.0 (2023-06-20)
 
 **New features:**
 
@@ -74,12 +84,12 @@
 
 ### Koffi 2.4
 
-#### Koffi 2.4.2
+#### Koffi 2.4.2 (2023-06-04)
 
 - Support calling variadic function pointers
 - Add documentation for function pointers
 
-#### Koffi 2.4.1
+#### Koffi 2.4.1 (2023-06-03)
 
 **Main changes:**
 
@@ -96,49 +106,49 @@
 
 ### Koffi 2.3
 
-#### Koffi 2.3.20
+#### Koffi 2.3.20 (2023-05-15)
 
 - Support explicit library unloading with `lib.unload()`
 
-#### Koffi 2.3.19
+#### Koffi 2.3.19 (2023-04-21)
 
 - Actually allow non-ambiguous [string] values for `void *` arguments
 
-#### Koffi 2.3.18
+#### Koffi 2.3.18 (2023-04-21)
 
 - Fix possible crash on exit caused by unregistered callbacks
 
-#### Koffi 2.3.17
+#### Koffi 2.3.17 (2023-04-20)
 
 - Allow strings for input `void *`, `int8_t *` and `int16_t *` pointer arguments
 - Support using `[string]` (single-element string arrays) for polymorphic input/output arguments
 
-#### Koffi 2.3.16
+#### Koffi 2.3.16 (2023-04-11)
 
 - Fix Windows ARM64 build to work with official Node.js version
 - Compile Windows builds with Visual Studio 2022 17.5.3
 - Support null in `koffi.free()` and `koffi.address()`
 
-#### Koffi 2.3.15
+#### Koffi 2.3.15 (2023-04-10)
 
 - Improve manual decoding of 0-terminated strings
 - Add checks around array conversion hints
 
-#### Koffi 2.3.14
+#### Koffi 2.3.14 (2023-04-05)
 
 - Add `koffi.errno()` function to get and set current errno value
 - Add `koffi.os.errno` object with valid errno codes
 
-#### Koffi 2.3.13
+#### Koffi 2.3.13 (2023-03-30)
 
 - Add `koffi.address()` to get the raw value of a wrapper pointer
 
-#### Koffi 2.3.12
+#### Koffi 2.3.12 (2023-03-30)
 
 - Fix broken syntax in TS definition file
 - Add missing exported properties in TS file
 
-#### Koffi 2.3.11
+#### Koffi 2.3.11 (2023-03-30)
 
 **Main changes:**
 
@@ -150,27 +160,27 @@
 - Avoid using `statx()` to allow compilation with glibc < 2.28
 - Reorganize NPM package files to be less convoluted
 
-#### Koffi 2.3.9
+#### Koffi 2.3.9 (2023-03-10)
 
 - Relicense under MIT license
 
-#### Koffi 2.3.8
+#### Koffi 2.3.8 (2023-02-28)
 
 - Disable non-ready union support
 - Simplify Windows stack allocation and drop NOACCESS and GUARD pages
 - Adjust Windows TEB SEH chain and GuaranteedStackBytes for Koffi calls
 
-#### Koffi 2.3.7
+#### Koffi 2.3.7 (2023-02-27)
 
 - Fix missing require in index.js ([@gastonFrecceroNapse](https://github.com/gastonFrecceroNapse))
 - Reduce NPM package bloat (from 65 MB to 20 MB) caused by changes in 2.3.6
 
-#### Koffi 2.3.6
+#### Koffi 2.3.6 (2023-02-26)
 
 - Fix broken TS definition file
 - Keep all prebuilt binaries and load correct one at runtime
 
-#### Koffi 2.3.5
+#### Koffi 2.3.5 (2023-02-24)
 
 **Main fixes:**
 
@@ -186,15 +196,15 @@
 - Mark optional properties in TS TypeInfo class
 - Minor performance improvements
 
-#### Koffi 2.3.4
+#### Koffi 2.3.4 (2023-01-31)
 
 - Fix error when installing Koffi on Windows (2.3.2)
 
-#### Koffi 2.3.2
+#### Koffi 2.3.2 (2023-01-30)
 
 **Main changes:**
 
-- Fix type parser issues (such as ignoring some [disposable qualifiers](parameters.md#heap-allocated-values))
+- Fix type parser issues (such as ignoring some [disposable qualifiers](pointers.md#disposable-types))
 - Fix crash when using disposable types in output parameters
 - Add basic [koffi.stats()](misc.md#usage-statistics) interface
 
@@ -203,18 +213,18 @@
 - Avoid CNoke dependency
 - Clear out development dependencies from package.json
 
-#### Koffi 2.3.1
+#### Koffi 2.3.1 (2023-01-3O)
 
 - Error out when trying to use ambiguous `void *` arguments (input and/or output)
 - Adjust TypeScript definitions ([@insraq](https://github.com/insraq))
 - Fix possible crash when parsing invalid prototype
 
-#### Koffi 2.3.0
+#### Koffi 2.3.0 (2023-01-25)
 
 **Main changes:**
 
 - 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](parameters.md#output-buffers)
+- Support opaque buffers (TypedArray or ArrayBuffer) values in `koffi.decode()` to [decode output buffers](polymorphism.md#output-buffers)
 - Decode non-string types as arrays when an [explicit length is passed to koffi.decode()](callbacks.md#decoding-pointer-arguments)
 
 **Other changes:**
@@ -228,21 +238,21 @@
 
 ### Koffi 2.2
 
-#### Koffi 2.2.5
+#### Koffi 2.2.5 (2023-01-23)
 
 - Relicense Koffi under LGPL 3.0
 
-#### Koffi 2.2.4
+#### Koffi 2.2.4 (2023-01-19)
 
 - Fix memory leak on Windows (in Koffi 2.2.3) when running many async calls
 - Reorganize documentation pages
 
-#### Koffi 2.2.3
+#### Koffi 2.2.3 (2023-01-17)
 
 - Support native code that uses [Structured Exception Handling (SEH)](https://learn.microsoft.com/en-us/cpp/cpp/structured-exception-handling-c-cpp) on Windows (x86, x64 and ARM64)
 - Try to use ebp/rbp as frame pointer in x86/x64 ASM code
 
-#### Koffi 2.2.2
+#### Koffi 2.2.2 (2023-01-14)
 
 **Main fixes:**
 
@@ -256,16 +266,16 @@
 - Check N-API version when module is loaded
 - Optimize callback unregistration
 
-#### Koffi 2.2.1
+#### Koffi 2.2.1 (2022-12-21)
 
 - Fix crash when [calling callback again after FFI call inside previous callback](https://github.com/Koromix/rygel/issues/15)
 
-#### Koffi 2.2.0
+#### Koffi 2.2.0 (2022-12-20)
 
 **New features:**
 
 - Add [koffi.decode()](callbacks.md#decoding-pointer-arguments) for callback pointer arguments
-- Support transparent [output string parameters](parameters.md#output-parameters)
+- Support transparent [output string parameters](output.md#string-buffer-example)
 - Add `koffi.offsetof()` utility function
 - Support optional *this* binding in `koffi.register()`
 
@@ -276,11 +286,11 @@
 
 ### Koffi 2.1
 
-#### Koffi 2.1.5
+#### Koffi 2.1.5 (2022-11-27)
 
 - Add missing README.md file to NPM package
 
-#### Koffi 2.1.4
+#### Koffi 2.1.4 (2022-11-25)
 
 **Main changes:**
 
@@ -291,24 +301,24 @@
 
 - Moved Koffi to a new repository: https://github.com/Koromix/rygel/
 
-#### Koffi 2.1.3
+#### Koffi 2.1.3 (2022-10-31)
 
 - Support up to 16 output parameters (instead of 8)
 
-#### Koffi 2.1.2
+#### Koffi 2.1.2 (2022-10-31)
 
 - Support up to 8 output parameters (instead of 4)
 
-#### Koffi 2.1.1
+#### Koffi 2.1.1 (2022-08-16)
 
 - Fix potential memory allocation bugs
 
-#### Koffi 2.1.0
+#### Koffi 2.1.0 (2022-08-13)
 
 **Main changes:**
 
-- Add [koffi.as()](parameters.md#polymorphic-parameters) to support polymorphic APIs based on `void *` parameters
-- Add [endian-sensitive integer types](types.md#endian-sensitive-types): `intX_le_t`, `intX_be_t`, `uintX_le_t`, `uintX_be_t`
+- Add [koffi.as()](polymorphism.md#input-polymorphism) to support polymorphic APIs based on `void *` parameters
+- Add [endian-sensitive integer types](input.md#endian-sensitive-types): `intX_le_t`, `intX_be_t`, `uintX_le_t`, `uintX_be_t`
 - Accept typed arrays for `void *` parameters
 - Introduce `koffi.opaque()` to replace `koffi.handle()` (which remains supported until Koffi 3.0)
 - Support JS Array and TypedArray to fill struct and array pointer members
@@ -323,15 +333,15 @@
 
 ### Koffi 2.0
 
-#### Koffi 2.0.1
+#### Koffi 2.0.1 (2022-07-30)
 
 - Return `undefined` (instead of null) for `void` functions
 
-#### Koffi 2.0.0
+#### Koffi 2.0.0 (2022-07-29)
 
 **Major new features:**
 
-- Add [disposable types](parameters.md#heap-allocated-values) for automatic disposal of C values (such as heap-allocated strings)
+- Add [disposable types](pointers.md#disposable-types) for automatic disposal of C values (such as heap-allocated strings)
 - Add support for [registered callbacks](callbacks.md#registered-callbacks), that can be called after the initial FFI call
 - Support named pointer types
 - Support complex type specifications outside of prototype parser
@@ -353,15 +363,15 @@ Consult the [migration guide](migration.md) for more information.
 
 ### Koffi 1.3
 
-#### Koffi 1.3.12
+#### Koffi 1.3.12 (2022-07-27)
 
 - Fix support for Yarn package manager
 
-#### Koffi 1.3.11
+#### Koffi 1.3.11 (2022-07-26)
 
 - Fix broken parsing of `void *` when used for first parameter
 
-#### Koffi 1.3.10
+#### Koffi 1.3.10 (2022-07-25)
 
 **Main fixes:**
 
@@ -373,11 +383,11 @@ Consult the [migration guide](migration.md) for more information.
 
 - Various documentation fixes and improvements
 
-#### Koffi 1.3.9
+#### Koffi 1.3.9 (2022-07-15)
 
 - Fix prebuild compatibility with Electron on Windows x64
 
-#### Koffi 1.3.8
+#### Koffi 1.3.8 (2022-07-12)
 
 **Main changes:**
 
@@ -388,7 +398,7 @@ Consult the [migration guide](migration.md) for more information.
 
 - Fix and harmonize a few error messages
 
-#### Koffi 1.3.7
+#### Koffi 1.3.7 (2022-07-07)
 
 **Main fixes:**
 
@@ -401,7 +411,7 @@ Consult the [migration guide](migration.md) for more information.
 - Add str/str16 type aliases for string/string16
 - Various documentation fixes and improvements
 
-#### Koffi 1.3.6
+#### Koffi 1.3.6 (2022-07-01)
 
 **Main fixes:**
 
@@ -413,7 +423,7 @@ Consult the [migration guide](migration.md) for more information.
 - Prebuild with Clang for Windows x64 and Linux x64 binaries
 - Various documentation improvements
 
-#### Koffi 1.3.5
+#### Koffi 1.3.5 (2022-06-25)
 
 **Main changes:**
 
@@ -425,11 +435,11 @@ Consult the [migration guide](migration.md) for more information.
 - Reduce default async memory stack and heap size
 - Various documentation improvements
 
-#### Koffi 1.3.4
+#### Koffi 1.3.4 (2022-06-24)
 
 - Fix possible OpenBSD i386 crash with `(void)` functions
 
-#### Koffi 1.3.3
+#### Koffi 1.3.3 (2022-06-24)
 
 **Main fixes:**
 
@@ -441,16 +451,16 @@ Consult the [migration guide](migration.md) for more information.
 - Disable unsafe compiler optimizations
 - Various documentation improvements
 
-#### Koffi 1.3.2
+#### Koffi 1.3.2 (2022-06-23)
 
 - Support compilation in C++14 mode (graceful degradation)
 - Support older toolchains on Linux (tested on Debian 9)
 
-#### Koffi 1.3.1
+#### Koffi 1.3.1 (2022-06-22)
 
 - The prebuilt binary is tested when Koffi is installed, and a rebuild happens if it fails to load
 
-#### Koffi 1.3.0
+#### Koffi 1.3.0 (2022-06-22)
 
 **Major changes:**
 
@@ -468,15 +478,15 @@ Consult the [migration guide](migration.md) for more information.
 
 ### Koffi 1.2
 
-#### Koffi 1.2.4
+#### Koffi 1.2.4 (2022-06-12)
 
 - Windows ARM64 is now supported
 
-#### Koffi 1.2.3
+#### Koffi 1.2.3 (2022-06-11)
 
 - A prebuilt binary for macOS ARM64 (M1) is now included
 
-#### Koffi 1.2.1
+#### Koffi 1.2.1 (2022-06-11)
 
 This entry documents changes since version 1.1.0.
 

package/doc/callbacks.md

@@ -1,4 +1,4 @@
-# Callbacks
+# Javascript callbacks
 
 *Changed in Koffi 2.4*
 

package/doc/conf.py

@@ -113,5 +113,6 @@ myst_number_code_blocks = ['c', 'js', 'sh', 'batch']
 
 rediraffe_redirects = {
     "changes.md": "changelog.md",
-    "bundling.md": "packaging.md"
+    "bundling.md": "packaging.md",
+    "parameters.md": "input.md"
 }

package/doc/functions.md

@@ -217,3 +217,14 @@ let delta = substract(100, 58);
 
 console.log(sum, delta); // Prints 9 and 42
 ```
+
+## Conversion of parameters
+
+By default, Koffi will only forward and translate arguments from Javascript to C. However, many C functions use pointer arguments for output values, or input/output values.
+
+Among other thing, in the the following pages you will learn more about:
+
+- How Koffi translates [input parameters](input.md) to C
+- How you can [define and use pointers](pointers.md)
+- How to deal with [output parameters](output.md)
+- How to handle [polymorphic API](polymorphism.md)

package/doc/index.rst

@@ -15,6 +15,8 @@ Koffi requires a recent `Node.js <https://nodejs.org/>`_ version with N-API vers
 
 The source code is available here: https://github.com/Koromix/rygel/ (in the *src/koffi* subdirectory).
 
+New releases are frequent, look at the :ref:`changelog<changelog>` for more information.
+
 Table of contents
 -----------------
 
@@ -24,10 +26,11 @@ Table of contents
    platforms
    start
    functions
-   types
+   input
    pointers
+   output
+   polymorphism
    unions
-   parameters
    callbacks
    misc
    packaging

package/doc/{types.md → input.md}

@@ -1,4 +1,4 @@
-# Data types
+# Input parameters
 
 ## Primitive types
 
@@ -6,47 +6,47 @@
 
 While the C standard allows for variation in the size of most integer types, Koffi enforces the same definition for most primitive types, listed below:
 
-JS type          | C type                        | Bytes | Signedness | Note
----------------- | ----------------------------- | ----- | ---------- | ---------------------------
-Undefined        | void                          | 0     |            | Only valid as a return type
-Number (integer) | int8, int8_t                  | 1     | Signed     |
-Number (integer) | uint8, uint8_t                | 1     | Unsigned   |
-Number (integer) | char                          | 1     | Signed     |
-Number (integer) | uchar, unsigned char          | 1     | Unsigned   |
-Number (integer) | char16, char16_t              | 2     | Signed     |
-Number (integer) | int16, int16_t                | 2     | Signed     |
-Number (integer) | uint16, uint16_t              | 2     | Unsigned   |
-Number (integer) | short                         | 2     | Signed     |
-Number (integer) | ushort, unsigned short        | 2     | Unsigned   |
-Number (integer) | int32, int32_t                | 4     | Signed     |
-Number (integer) | uint32, uint32_t              | 4     | Unsigned   |
-Number (integer) | int                           | 4     | Signed     |
-Number (integer) | uint, unsigned int            | 4     | Unsigned   |
-Number (integer) | int64, int64_t                | 8     | Signed     |
-Number (integer) | uint64, uint64_t              | 8     | Unsigned   |
-Number (integer) | longlong, long long           | 8     | Signed     |
-Number (integer) | ulonglong, unsigned long long | 8     | Unsigned   |
-Number (float)   | float32                       | 4     |            |
-Number (float)   | float64                       | 8     |            |
-Number (float)   | float                         | 4     |            |
-Number (float)   | double                        | 8     |            |
+C type                        | JS type          | Bytes | Signedness | Note
+----------------------------- | ---------------- | ----- | ---------- | ---------------------------
+void                          | Undefined        | 0     |            | Only valid as a return type
+int8, int8_t                  | Number (integer) | 1     | Signed     |
+uint8, uint8_t                | Number (integer) | 1     | Unsigned   |
+char                          | Number (integer) | 1     | Signed     |
+uchar, unsigned char          | Number (integer) | 1     | Unsigned   |
+char16, char16_t              | Number (integer) | 2     | Signed     |
+int16, int16_t                | Number (integer) | 2     | Signed     |
+uint16, uint16_t              | Number (integer) | 2     | Unsigned   |
+short                         | Number (integer) | 2     | Signed     |
+ushort, unsigned short        | Number (integer) | 2     | Unsigned   |
+int32, int32_t                | Number (integer) | 4     | Signed     |
+uint32, uint32_t              | Number (integer) | 4     | Unsigned   |
+int                           | Number (integer) | 4     | Signed     |
+uint, unsigned int            | Number (integer) | 4     | Unsigned   |
+int64, int64_t                | Number (integer) | 8     | Signed     |
+uint64, uint64_t              | Number (integer) | 8     | Unsigned   |
+longlong, long long           | Number (integer) | 8     | Signed     |
+ulonglong, unsigned long long | Number (integer) | 8     | Unsigned   |
+float32                       | Number (float)   | 4     |            |
+float64                       | Number (float)   | 8     |            |
+float                         | Number (float)   | 4     |            |
+double                        | Number (float)   | 8     |            |
 
 Koffi also accepts BigInt values when converting from JS to C integers. If the value exceeds the range of the C type, Koffi will convert the number to an undefined value. In the reverse direction, BigInt values are automatically used when needed for big 64-bit integers.
 
 Koffi defines a few more types that can change size depending on the OS and the architecture:
 
-JS type          | C type           | Signedness | Note
+C type           | JS type          | Signedness | Note
 ---------------- | ---------------- | ---------- | ------------------------------------------------
-Boolean          | bool             |            | Usually one byte
-Number (integer) | long             | Signed     | 4 or 8 bytes depending on platform (LP64, LLP64)
-Number (integer) | ulong            | Unsigned   | 4 or 8 bytes depending on platform (LP64, LLP64)
-Number (integer) | unsigned long    | Unsigned   | 4 or 8 bytes depending on platform (LP64, LLP64)
-Number (integer) | intptr           | Signed     | 4 or 8 bytes depending on register width
-Number (integer) | intptr_t         | Signed     | 4 or 8 bytes depending on register width
-Number (integer) | uintptr          | Unsigned   | 4 or 8 bytes depending on register width
-Number (integer) | uintptr_t        | Unsigned   | 4 or 8 bytes depending on register width
-String           | str, string      |            | JS strings are converted to and from UTF-8
-String           | str16, string16  |            | JS strings are converted to and from UTF-16 (LE)
+bool             | Boolean          |            | Usually one byte
+long             | Number (integer) | Signed     | 4 or 8 bytes depending on platform (LP64, LLP64)
+ulong            | Number (integer) | Unsigned   | 4 or 8 bytes depending on platform (LP64, LLP64)
+unsigned long    | Number (integer) | Unsigned   | 4 or 8 bytes depending on platform (LP64, LLP64)
+intptr           | Number (integer) | Signed     | 4 or 8 bytes depending on register width
+intptr_t         | Number (integer) | Signed     | 4 or 8 bytes depending on register width
+uintptr          | Number (integer) | Unsigned   | 4 or 8 bytes depending on register width
+uintptr_t        | Number (integer) | Unsigned   | 4 or 8 bytes depending on register width
+str, string      | String           |            | JS strings are converted to and from UTF-8
+str16, string16  | String           |            | JS strings are converted to and from UTF-16 (LE)
 
 Primitive types can be specified by name (in a string) or through `koffi.types`:
 
@@ -142,14 +142,14 @@ const Function2 = lib.func('Function', A, [A]);
 
 Many C libraries use some kind of object-oriented API, with a pair of functions dedicated to create and delete objects. An obvious example of this can be found in stdio.h, with the opaque `FILE *` pointer. You can open and close files with `fopen()` and `fclose()`, and manipule the opaque pointer with other functions such as `fread()` or `ftell()`.
 
-In Koffi, you can manage this with opaque types. Declare the opaque type with `koffi.opaque(name)`, and use a pointer to this type either as a return type or some kind of [output parameter](parameters.md#output-parameters) (with a double pointer).
+In Koffi, you can manage this with opaque types. Declare the opaque type with `koffi.opaque(name)`, and use a pointer to this type either as a return type or some kind of [output parameter](output.md) (with a double pointer).
 
 ```{note}
 Opaque types **have changed in version 2.0, and again in version 2.1**.
 
 In Koffi 1.x, opaque handles were defined in a way that made them usable directly as parameter and return types, obscuring the underlying pointer.
 
-Now, you must use them through a pointer, and use an array for output parameters. This is shown in the example below (look for the call to `ConcatNewOut` in the JS part), and is described in the section on [output parameters](parameters.md#output-parameters).
+Now, you must use them through a pointer, and use an array for output parameters. This is shown in the example below (look for the call to `ConcatNewOut` in the JS part), and is described in the section on [output parameters](output.md).
 
 In addition to this, you should use `koffi.opaque()` (introduced in Koffi 2.1) instead of `koffi.handle()` which is deprecated, and will be removed eventually in Koffi 3.0.
 
@@ -376,6 +376,10 @@ Koffi can also convert JS strings to fixed-sized arrays in the following cases:
 
 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)
+### Dynamic arrays (pointers)
 
 In C, dynamically-sized arrays are usually passed around as pointers. Read more about [array pointers](pointers.md#array-pointers-dynamic-arrays) in the relevant section.
+
+## Union types
+
+The declaration and use of [unions types](unions.md) will be explained in a later section, they are only briefly mentioned here if you need them.