Skip to content

Commit 43afa46

Browse files
committed
README.md: Mention what lua_gc bits are implemented
1 parent 46742ea commit 43afa46

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,18 @@ In the browser `require` and `package.loadlib` try to find a file by making sync
5757

5858
### _Missing_ features
5959

60-
- `lua_gc`/`collectgarbage`: Fengari relies on the JS garbage collector and does not implement its own.
60+
- `lua_gc`/`collectgarbage`: These functions only work when the JS garbage collector is available in the current environment:
61+
- `LUA_GCCOLLECT`
62+
- Supported in IE via `CollectGarbage`
63+
- Supported in Opera < 15 via `opera.collect`
64+
- Only supported in v8 engines (e.g. node.js, Chrome) if the process was started with `--expose-gc`
65+
- `LUA_GCSTEP`
66+
- Only supported in v8 engines (e.g. node.js, Chrome) if the process was started with `--expose-gc`
67+
- `LUA_GCCOUNT`, `LUA_GCCOUNTB`
68+
- Supported in WebKit browsers via `performance.memory`
69+
- Supported in node.js via the [`v8` library](https://nodejs.org/api/v8.html)
70+
- `LUA_GCSTOP`, `LUA_GCSETPAUSE`, `LUA_GCSETSTEPMUL`
71+
- Supported in node.js via the [`v8` library](https://nodejs.org/api/v8.html)
6172
- The following functions are only available in Node:
6273
- The entire `io` lib
6374
- `os.remove`

0 commit comments

Comments
 (0)