koffi - npm Package Compare versions

Comparing version 2.8.5 to 2.8.6

CHANGELOG.md

@@ -7,2 +7,6 @@ # Changelog
 
+#### Koffi 2.8.6 (2024-04-12)
+
+- Support [loading library](functions.md#loading-options) with RTLD_DEEPBIND where supported
+
 #### Koffi 2.8.5 (2024-04-11)
@@ -9,0 +13,0 @@

doc/contribute.md

@@ -28,3 +28,3 @@ # Contributing
 - [CMake meta build system](https://cmake.org/)
-- [Node.js](https://nodejs.org/) 12 or later
+- [Node.js](https://nodejs.org/) 16 or later
 
@@ -45,3 +45,3 @@ Once this is done, run this command _from the test or the benchmark directory_ (depending on what you want to build):
 - [CMake meta build system](https://cmake.org/)
-- [Node.js](https://nodejs.org/) 12 or later
+- [Node.js](https://nodejs.org/) 16 or later
 
@@ -69,2 +69,3 @@ Once this is done, run this command _from the test or the benchmark directory_ (depending on what you want to build):
 node union.js # Run union unit tests
+node posix.js # Run POSIX-specific unit tests (not for Windows)
 node win32.js # Run Windows-specific unit tests (only on Windows)
@@ -71,0 +72,0 @@

doc/functions.md

@@ -24,3 +24,3 @@ # Function calls
 
-*New in Koffi 2.6 and Koffi 2.8.2*
+*New in Koffi 2.6, changed in Koffi 2.8.2 and Koffi 2.8.6*
 
@@ -32,3 +32,4 @@ The `load` function can take an optional object argument, with the following options:
     lazy: true, // Use RTLD_LAZY (lazy-binding) on POSIX platforms (by default, use RTLD_NOW)
-    global: true // Use RTLD_GLOBAL on POSIX platforms (by default, use RTLD_LOCAL)
+    global: true, // Use RTLD_GLOBAL on POSIX platforms (by default, use RTLD_LOCAL)
+    deep: true // Use RTLD_DEEPBIND if supported (Linux, FreeBSD)
 };
@@ -35,0 +36,0 @@

doc/start.md

@@ -112,2 +112,10 @@ # Get started
 
-Please read the [dedicated page](packaging.md) for information about bundling and packaging applications using Koffi.
+Please read the [dedicated page](packaging.md) for information about bundling and packaging applications using Koffi.
+
+## Build manually
+
+Follow the [build instrutions](contribute.md#build-from-source) if you want to build the native Koffi code yourself.
+
+```{note}
+This is only needed if you want to hack on Koffi. The official NPM package provide prebuilt binaries and you don't need to compile anything if you only want to use Koffi in Node.js.
+```

index.js

@@ -381,4 +381,4 @@ "use strict";
       name: "koffi",
-      version: "2.8.5",
-      stable: "2.8.5",
+      version: "2.8.6",
+      stable: "2.8.6",
       description: "Fast and simple C FFI (foreign function interface) for Node.js",
@@ -385,0 +385,0 @@ keywords: [

indirect.js

@@ -381,4 +381,4 @@ "use strict";
       name: "koffi",
-      version: "2.8.5",
-      stable: "2.8.5",
+      version: "2.8.6",
+      stable: "2.8.6",
       description: "Fast and simple C FFI (foreign function interface) for Node.js",
@@ -385,0 +385,0 @@ keywords: [

package.json

 {
     "name": "koffi",
-    "version": "2.8.5",
-    "stable": "2.8.5",
+    "version": "2.8.6",
+    "stable": "2.8.6",
     "description": "Fast and simple C FFI (foreign function interface) for Node.js",
@@ -6,0 +6,0 @@ "keywords": [

README.md

@@ -32,2 +32,8 @@ # Overview
 
+# Build manually
+
+Koffi is built with a custom CMake-wrapper called CNoke, which also lives in this repository. Don't try to run CMake manually because it will fail.
+
+Follow the [documented build instructions](https://koffi.dev/contribute#build-from-source) to build Koffi from source.
+
 # License
@@ -34,0 +40,0 @@

src/koffi/CMakeLists.txt

@@ -24,4 +24,8 @@ # Copyright 2023 Niels Martignène <[e-mail]>
 cmake_policy(SET CMP0091 NEW)
+
+if(NOT NODE_JS_INCLUDE_DIRS)
+    message(FATAL_ERROR "Please use CNoke to build Koffi, follow instructions here: https://koffi.dev/contribute#build-from-source")
+endif()
+
 project(koffi C CXX ASM)
-
 find_package(CNoke)
@@ -28,0 +32,0 @@

No alert changes

Improved metrics

Total package byte prevSize

69788121

0

Number of lines in readme file

43

16.22%

No dependency changes