Skip to content

doc: use ffi.suffix for library paths in examples #64805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ganjanggejang wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −14
Open

doc: use ffi.suffix for library paths in examples #64805

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions doc/api/ffi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,20 +202,20 @@ so it can be used with the [`using`][] declaration. Disposing the returned
object closes the library handle.

```mjs
import { dlopen } from 'node:ffi';
import { dlopen, suffix } from 'node:ffi';

{
using handle = dlopen('./mylib.so', {
using handle = dlopen(`./mylib.${suffix}`, {
add_i32: { arguments: ['i32', 'i32'], return: 'i32' },
});
console.log(handle.functions.add_i32(20, 22));
} // handle.lib.close() is invoked automatically here.
```

```mjs
import { dlopen } from 'node:ffi';
import { dlopen, suffix } from 'node:ffi';

const { lib, functions } = dlopen('./mylib.so', {
const { lib, functions } = dlopen(`./mylib.${suffix}`, {
add_i32: { arguments: ['i32', 'i32'], return: 'i32' },
string_length: { arguments: ['pointer'], return: 'u64' },
});
Expand All @@ -224,9 +224,9 @@ console.log(functions.add_i32(20, 22));
```

```cjs
const { dlopen } = require('node:ffi');
const { dlopen, suffix } = require('node:ffi');

const { lib, functions } = dlopen('./mylib.so', {
const { lib, functions } = dlopen(`./mylib.${suffix}`, {
add_i32: { arguments: ['i32', 'i32'], return: 'i32' },
string_length: { arguments: ['pointer'], return: 'u64' },
});
Expand Down Expand Up @@ -278,9 +278,9 @@ Loads the dynamic library without resolving any functions eagerly.
On Windows passing `null` is not supported.

```cjs
const { DynamicLibrary } = require('node:ffi');
const { DynamicLibrary, suffix } = require('node:ffi');

const lib = new DynamicLibrary('./mylib.so');
const lib = new DynamicLibrary(`./mylib.${suffix}`);
```

### `library.path`
Expand Down Expand Up @@ -310,10 +310,10 @@ library instance can be managed with the [`using`][] declaration. Leaving the
enclosing scope invokes `library.close()` automatically.

```mjs
import { DynamicLibrary } from 'node:ffi';
import { DynamicLibrary, suffix } from 'node:ffi';

{
using lib = new DynamicLibrary('./mylib.so');
using lib = new DynamicLibrary(`./mylib.${suffix}`);
// Use `lib` here; `lib.close()` is called when the block exits.
}
```
Expand Down Expand Up @@ -365,9 +365,9 @@ If the same symbol has already been resolved, requesting it again with a
different signature throws.

```cjs
const { DynamicLibrary } = require('node:ffi');
const { DynamicLibrary, suffix } = require('node:ffi');

const lib = new DynamicLibrary('./mylib.so');
const lib = new DynamicLibrary(`./mylib.${suffix}`);
const add = lib.getFunction('add_i32', {
arguments: ['i32', 'i32'],
return: 'i32',
Expand Down Expand Up @@ -415,9 +415,9 @@ The return value is the callback pointer address as a `bigint`. It can be
passed to native functions expecting a callback pointer.

```cjs
const { DynamicLibrary } = require('node:ffi');
const { DynamicLibrary, suffix } = require('node:ffi');

const lib = new DynamicLibrary('./mylib.so');
const lib = new DynamicLibrary(`./mylib.${suffix}`);

const callback = lib.registerCallback(
{ arguments: ['i32'], return: 'i32' },
Expand Down
Loading