README
internal-prop
Gives access to native objects internal properties, such as a proxy's [[Target]]
or [[Handler]]
or objects' private fields
Warning
This module is native, it means that it contains c++ code that gets compiled every time the module is installed to ensure that the binaries can be read by your machine, the problem is that node apparently uses external tools that may be not present in your machine.
If the compiled code can't be found, undefined
will be returned.
If when installing you get an error like "npm ERR! Exit handler never called!"
you can fix it in two ways:
- Downgrade
npm
and reinstallnpm i -g npm@6 npm i internal-prop
- Without deleting anything, go to your package folder and run:
cd node_modules/internal-prop npm i
If you don't have the necessary to compile the binaries npm
should tell you what you need too do to achieve that
Usage
The module gives you indipendent functions that you can use to extract internal properties of objects
const { fromProxy, fromPromise, getOwnPrivateSymbols } = require("internal-prop");
Each function accept an object and returns an array of its internal properties
If the object is not of the correct type (e.g. fromProxy(obj)
wants obj
to be a proxy) the function will return null
Supported
Proxy
fromProxy()
function- The array contains the
[[Target]]
and then the[[Handler]]
Promise
fromPromise()
function- The array contains the
[[PromiseState]]
and then the[[PromiseResult]]
- The state can be:
"fulfilled"
and the result of the promise"pending"
andnull
"rejected"
and the error
Private Fields
getOwnPrivateSymbols()
function- The array contains a list of the private keys in the object (They are a special kind of symbols)
- You can use the
privateAccess()
function to obtain an object containing a getter and a setter for each private symbol of the passed object (Except for one strange symbol that makes node crash if you try to read its value).
You can use the function like this:const { privateAccess } = require("internal-prop"); class Class { #field = 1; get() { return this.#field; } } const inst = new Class(); const priv = privateAccess(inst); console.log(priv.field, inst.get()); // 1 1 priv.field = 3; console.log(priv.field, inst.get()); // 3 3
But doesn't it break encapsulation?