From 43bd76e7428705001ec1a1969527dcf6f2ac0c08 Mon Sep 17 00:00:00 2001 From: daurnimator Date: Sun, 4 Feb 2018 17:36:45 -0800 Subject: [PATCH] README.md: Mention what lua_gc bits are implemented --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 458269a..85f858f 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,18 @@ In the browser `require` and `package.loadlib` try to find a file by making sync ### _Missing_ features -- `lua_gc`/`collectgarbage`: Fengari relies on the JS garbage collector and does not implement its own. +- `lua_gc`/`collectgarbage`: These functions only work when the JS garbage collector is available in the current environment: + - `LUA_GCCOLLECT` + - Supported in IE via `CollectGarbage` + - Supported in Opera < 15 via `opera.collect` + - Only supported in v8 engines (e.g. node.js, Chrome) if the process was started with `--expose-gc` + - `LUA_GCSTEP` + - Only supported in v8 engines (e.g. node.js, Chrome) if the process was started with `--expose-gc` + - `LUA_GCCOUNT`, `LUA_GCCOUNTB` + - Supported in WebKit browsers via `performance.memory` + - Supported in node.js via the [`v8` library](https://nodejs.org/api/v8.html) + - `LUA_GCSTOP`, `LUA_GCSETPAUSE`, `LUA_GCSETSTEPMUL` + - Supported in node.js via the [`v8` library](https://nodejs.org/api/v8.html) - The following functions are only available in Node: - The entire `io` lib - `os.remove`