summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordaurnimator <quae@daurnimator.com>2018-01-06 19:32:31 +1100
committerdaurnimator <quae@daurnimator.com>2018-01-06 19:32:43 +1100
commita0fa83dc9c170542630dbc83d1732d3e7a6313e9 (patch)
treef49965560f11a43e0fcb8dbc6bae1ce9ee22cb93 /README.md
parent110636150e4b3470e21622b022bec2844d8e8b2f (diff)
downloadfengari-a0fa83dc9c170542630dbc83d1732d3e7a6313e9.tar.gz
fengari-a0fa83dc9c170542630dbc83d1732d3e7a6313e9.tar.bz2
fengari-a0fa83dc9c170542630dbc83d1732d3e7a6313e9.zip
Expose lua.luastring_of to construct a lua 'string' from raw byte values
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1b58b91..a40b3b9 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ Fengari implements Lua 5.3 semantics and will hopefully follow future Lua releas
Lua strings are 8-bits clean and can embed `\0`. Which means that invalid UTF-8/16 strings are valid Lua strings. Lua functions like `string.dump` even use strings as a way of storing binary data.
-To address that issue, Fengari uses [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) objects containing the raw bytes to implement lua strings. To push a JS string on the stack you can use `lua_pushliteral` which will convert it to an array of bytes before pushing it. To get a Lua string on the stack as a JS string you can use `lua_tojsstring` which will attempt to convert it to a UTF-16 JS string. The latter won't give you what you expect if the Lua string is not a valid UTF-16 sequence. You can also convert strings with `lua.to_luastring`, `lua.to_jsstring` and `lua.to_uristring`.
+To address that issue, Fengari uses [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) objects containing the raw bytes to implement lua strings. To push a JS string on the stack you can use `lua_pushliteral` which will convert it to an array of bytes before pushing it. To get a Lua string on the stack as a JS string you can use `lua_tojsstring` which will attempt to convert it to a UTF-16 JS string. The latter won't give you what you expect if the Lua string is not a valid UTF-16 sequence. You can also convert strings with `lua.luastring_of`, `lua.to_luastring`, `lua.to_jsstring` and `lua.to_uristring`.
### Integers