lune-org/lune
1
1
Fork 0
mirror of https://github.com/lune-org/lune.git synced 2025-04-17 02:13:52 +01:00
Code Issues Projects Releases Packages Wiki Activity

refactor: refactor and fixup inconsistencies in luau docs

Browse source
This commit is contained in:
Erica Marigold 2024-03-09 13:11:08 +05:30
parent baa03424d4
commit 090d58e0fb
No known key found for this signature in database
GPG key ID: 2768CC0C23D245D1
1 changed files with 19 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
types/luau.luau
View file

@ -2,16 +2,15 @@
@interface CompileOptions @interface CompileOptions
@within Luau @within Luau
The Luau compiler options used in generating luau bytecode The options passed to the luau compiler while compiling bytecode.
This is a dictionary that may contain one or more of the following values: This is a dictionary that may contain one or more of the following values:
* `optimizationLevel` - Sets the compiler option "optimizationLevel". Defaults to `1` * `optimizationLevel` - Sets the compiler option "optimizationLevel". Defaults to `1`.
* `coverageLevel` - Sets the compiler option "coverageLevel". Defaults to `0` * `coverageLevel` - Sets the compiler option "coverageLevel". Defaults to `0`.
* `debugLevel` - Sets the compiler option "debugLevel". Defaults to `1` * `debugLevel` - Sets the compiler option "debugLevel". Defaults to `1`.
Documentation regarding what these values represent can be found here; Documentation regarding what these values represent can be found [here](https://github.com/Roblox/luau/blob/bd229816c0a82a8590395416c81c333087f541fd/Compiler/include/luacode.h#L13-L39).
* https://github.com/Roblox/luau/blob/bd229816c0a82a8590395416c81c333087f541fd/Compiler/include/luacode.h#L13
]=] ]=]
export type CompileOptions = { export type CompileOptions = {
optimizationLevel: number?, optimizationLevel: number?,
@ -23,11 +22,11 @@ export type CompileOptions = {
@interface LoadOptions @interface LoadOptions
@within Luau @within Luau
The Luau load options are used for generating a lua function from either bytecode or sourcecode The options passed while loading a luau chunk from an arbitrary string, or bytecode.
This is a dictionary that may contain one or more of the following values: This is a dictionary that may contain one or more of the following values:
* `debugName` - The debug name of the closure. Defaults to `luau.load(...)` * `debugName` - The debug name of the closure. Defaults to `luau.load(...)`.
* `environment` - Environment values to set and/or override. Includes default globals unless overwritten. * `environment` - Environment values to set and/or override. Includes default globals unless overwritten.
]=] ]=]
export type LoadOptions = { export type LoadOptions = {
@ -53,6 +52,9 @@ export type LoadOptions = {
callableFn() callableFn()
``` ```
Since luau bytecode is highly compressible, it may also make sense to compress it using the `serde` library
while transmitting large amounts of it.
]=] ]=]
local luau = {} local luau = {}
@ -68,15 +70,16 @@ local luau = {}
```lua ```lua
local luau = require("@lune/luau") local luau = require("@lune/luau")
-- Compile the source to some highly optimized bytecode
local bytecode = luau.compile("print('Hello, World!')", { local bytecode = luau.compile("print('Hello, World!')", {
optimizationLevel: 1, optimizationLevel = 2,
coverageLevel: 0, coverageLevel = 0,
debugLevel: 1, debugLevel = 1,
}) })
``` ```
@param source The string that'll be compiled into bytecode @param source The string that will be compiled into bytecode
@param compileOptions The luau compiler options used when compiling the source string @param compileOptions The options passed to the luau compiler that will output the bytecode
@return luau bytecode @return luau bytecode
]=] ]=]
@ -104,10 +107,10 @@ end
callableFn() callableFn()
``` ```
@param source Either bytecode or sourcecode @param source Either luau bytecode or string source code
@param loadOptions The load options used when creating a callbable function @param loadOptions The options passed to luau for loading the chunk
@return luau function @return luau chunk
]=] ]=]
function luau.load(source: string, loadOptions: LoadOptions?): (...any) -> ...any function luau.load(source: string, loadOptions: LoadOptions?): (...any) -> ...any
return nil :: any return nil :: any