Skip to content

Commit

Permalink
Add warning about ref-(struct,array)-napi to README
Browse files Browse the repository at this point in the history
  • Loading branch information
addaleax authored Mar 27, 2021
1 parent b5f574f commit e36f35e
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,17 @@ Generate the docs:
$ npm run docs
```

Incompatible packages
--------------------

The [`ref-struct-napi`](https://www.npmjs.com/package/ref-struct-napi) and
[`ref-array-napi`](https://www.npmjs.com/package/ref-array-napi) packages
have names that sound like they are compatible with this module.

They are not, and your application will experience crashes if you use
them together with `ref-napi`.
Use [`ref-struct-di`](https://www.npmjs.com/package/ref-struct-di)
or [`ref-array-di`](https://www.npmjs.com/package/ref-array-di) instead.

License
-------
Expand Down

0 comments on commit e36f35e

Please sign in to comment.