DevComp/lune-packaging
1
0
Fork 0
mirror of https://github.com/CompeyDev/lune-packaging.git synced 2025-01-09 12:19:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make typedef comments moonwave-compatible

Browse source
This commit is contained in:
Filip Tibell 2023-07-22 11:36:09 +02:00
parent 462ccb6d15
commit 8c14c3cda3
No known key found for this signature in database
6 changed files with 39 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/typedefs/FS.luau
View file

@ -1,7 +1,7 @@
export type MetadataKind = "file" | "dir" | "symlink" export type MetadataKind = "file" | "dir" | "symlink"
--[=[ --[=[
@type MetadataPermissions @interface MetadataPermissions
@within FS @within FS
Permissions for the given file or directory. Permissions for the given file or directory.
@ -17,7 +17,7 @@ export type MetadataPermissions = {
-- FIXME: We lose doc comments here because of the union type -- FIXME: We lose doc comments here because of the union type
--[=[ --[=[
@type Metadata @interface Metadata
@within FS @within FS
Metadata for the given file or directory. Metadata for the given file or directory.
@ -51,7 +51,7 @@ export type Metadata = {
} }
--[=[ --[=[
@type WriteOptions @interface WriteOptions
@within FS @within FS
Options for filesystem APIs what write to files and/or directories. Options for filesystem APIs what write to files and/or directories.
@ -90,7 +90,7 @@ export type WriteOptions = {
return { return {
--[=[ --[=[
@within FS @within FS
@must_use @tag must_use
Reads a file at `path`. Reads a file at `path`.
@ -109,7 +109,7 @@ return {
end, end,
--[=[ --[=[
@within FS @within FS
@must_use @tag must_use
Reads entries in a directory at `path`. Reads entries in a directory at `path`.
@ -184,7 +184,7 @@ return {
removeDir = function(path: string) end, removeDir = function(path: string) end,
--[=[ --[=[
@within FS @within FS
@must_use @tag must_use
Gets metadata for the given path. Gets metadata for the given path.
@ -201,7 +201,7 @@ return {
end, end,
--[=[ --[=[
@within FS @within FS
@must_use @tag must_use
Checks if a given path is a file. Checks if a given path is a file.
@ -218,7 +218,7 @@ return {
end, end,
--[=[ --[=[
@within FS @within FS
@must_use @tag must_use
Checks if a given path is a directory. Checks if a given path is a directory.

28
docs/typedefs/Net.luau
View file

@ -1,7 +1,7 @@
export type HttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "HEAD" | "OPTIONS" | "PATCH" export type HttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "HEAD" | "OPTIONS" | "PATCH"
--[=[ --[=[
@type FetchParamsOptions @interface FetchParamsOptions
@within Net @within Net
Extra options for `FetchParams`. Extra options for `FetchParams`.
@ -15,7 +15,7 @@ export type FetchParamsOptions = {
} }
--[=[ --[=[
@type FetchParams @interface FetchParams
@within Net @within Net
Parameters for sending network requests with `net.request`. Parameters for sending network requests with `net.request`.
@ -39,8 +39,8 @@ export type FetchParams = {
} }
--[=[ --[=[
@type FetchResponse @interface FetchResponse
@within new @within Net
Response type for sending network requests with `net.request`. Response type for sending network requests with `net.request`.
@ -61,7 +61,7 @@ export type FetchResponse = {
} }
--[=[ --[=[
@type ServeRequest @interface ServeRequest
@within Net @within Net
Data type for requests in `net.serve`. Data type for requests in `net.serve`.
@ -83,7 +83,7 @@ export type ServeRequest = {
} }
--[=[ --[=[
@type ServeResponse @interface ServeResponse
@within Net @within Net
Response type for requests in `net.serve`. Response type for requests in `net.serve`.
@ -104,7 +104,7 @@ type ServeHttpHandler = (request: ServeRequest) -> string | ServeResponse
type ServeWebSocketHandler = (socket: WebSocket) -> () type ServeWebSocketHandler = (socket: WebSocket) -> ()
--[=[ --[=[
@type ServeConfig @interface ServeConfig
@within Net @within Net
Configuration for `net.serve`. Configuration for `net.serve`.
@ -120,7 +120,7 @@ export type ServeConfig = {
} }
--[=[ --[=[
@type ServeHandle @interface ServeHandle
@within Net @within Net
A handle to a currently running web server, containing a single `stop` function to gracefully shut down the web server. A handle to a currently running web server, containing a single `stop` function to gracefully shut down the web server.
@ -130,7 +130,7 @@ export type ServeHandle = {
} }
--[=[ --[=[
@type WebSocket @interface WebSocket
@within Net @within Net
A reference to a web socket connection. A reference to a web socket connection.
@ -212,7 +212,7 @@ return {
end, end,
--[=[ --[=[
@within Net @within Net
@must_use @tag must_use
Connects to a web socket at the given URL. Connects to a web socket at the given URL.
@ -241,7 +241,7 @@ return {
end, end,
--[=[ --[=[
@within Net @within Net
@must_use @tag must_use
Encodes the given value as JSON. Encodes the given value as JSON.
@ -254,7 +254,7 @@ return {
end, end,
--[=[ --[=[
@within Net @within Net
@must_use @tag must_use
Decodes the given JSON string into a lua value. Decodes the given JSON string into a lua value.
@ -266,7 +266,7 @@ return {
end, end,
--[=[ --[=[
@within Net @within Net
@must_use @tag must_use
Encodes the given string using URL encoding. Encodes the given string using URL encoding.
@ -279,7 +279,7 @@ return {
end, end,
--[=[ --[=[
@within Net @within Net
@must_use @tag must_use
Decodes the given string using URL decoding. Decodes the given string using URL decoding.

4
docs/typedefs/Process.luau
View file

@ -4,7 +4,7 @@ export type Arch = "x86_64" | "aarch64"
export type SpawnOptionsStdio = "inherit" | "default" export type SpawnOptionsStdio = "inherit" | "default"
--[=[ --[=[
@type SpawnOptions @interface SpawnOptions
@within Process @within Process
A dictionary of options for `process.spawn`, with the following available values: A dictionary of options for `process.spawn`, with the following available values:
@ -22,7 +22,7 @@ export type SpawnOptions = {
} }
--[=[ --[=[
@type SpawnResult @interface SpawnResult
@within Process @within Process
Result type for child processes in `process.spawn`. Result type for child processes in `process.spawn`.

12
docs/typedefs/Roblox.luau
View file

@ -216,7 +216,7 @@ export type DataModel =
return { return {
--[=[ --[=[
@within Roblox @within Roblox
@must_use @tag must_use
Deserializes a place into a DataModel instance. Deserializes a place into a DataModel instance.
@ -241,7 +241,7 @@ return {
end, end,
--[=[ --[=[
@within Roblox @within Roblox
@must_use @tag must_use
Deserializes a model into an array of instances. Deserializes a model into an array of instances.
@ -266,7 +266,7 @@ return {
end, end,
--[=[ --[=[
@within Roblox @within Roblox
@must_use @tag must_use
Serializes a place from a DataModel instance. Serializes a place from a DataModel instance.
@ -290,7 +290,7 @@ return {
end, end,
--[=[ --[=[
@within Roblox @within Roblox
@must_use @tag must_use
Serializes one or more instances as a model. Serializes one or more instances as a model.
@ -314,7 +314,7 @@ return {
end, end,
--[=[ --[=[
@within Roblox @within Roblox
@must_use @tag must_use
Gets the current auth cookie, for usage with Roblox web APIs. Gets the current auth cookie, for usage with Roblox web APIs.
@ -353,7 +353,7 @@ return {
end, end,
--[=[ --[=[
@within Roblox @within Roblox
@must_use @tag must_use
Gets the bundled reflection database. Gets the bundled reflection database.

8
docs/typedefs/Serde.luau
View file

@ -30,7 +30,7 @@ export type CompressDecompressFormat = "brotli" | "gzip" | "lz4" | "zlib"
return { return {
--[=[ --[=[
@within Serde @within Serde
@must_use @tag must_use
Encodes the given value using the given format. Encodes the given value using the given format.
@ -52,7 +52,7 @@ return {
end, end,
--[=[ --[=[
@within Serde @within Serde
@must_use @tag must_use
Decodes the given string using the given format into a lua value. Decodes the given string using the given format into a lua value.
@ -73,7 +73,7 @@ return {
end, end,
--[=[ --[=[
@within Serde @within Serde
@must_use @tag must_use
Compresses the given string using the given format. Compresses the given string using the given format.
@ -95,7 +95,7 @@ return {
end, end,
--[=[ --[=[
@within Serde @within Serde
@must_use @tag must_use
Decompresses the given string using the given format. Decompresses the given string using the given format.

9
docs/typedefs/Stdio.luau
View file

@ -20,7 +20,8 @@ type PromptFn = (
--[=[ --[=[
@within Stdio @within Stdio
@must_use @function prompt
@tag must_use
Prompts for user input using the wanted kind of prompt: Prompts for user input using the wanted kind of prompt:
@ -62,7 +63,7 @@ end
return { return {
--[=[ --[=[
@within Stdio @within Stdio
@must_use @tag must_use
Return an ANSI string that can be used to modify the persistent output color. Return an ANSI string that can be used to modify the persistent output color.
@ -85,7 +86,7 @@ return {
end, end,
--[=[ --[=[
@within Stdio @within Stdio
@must_use @tag must_use
Return an ANSI string that can be used to modify the persistent output style. Return an ANSI string that can be used to modify the persistent output style.
@ -108,7 +109,7 @@ return {
end, end,
--[=[ --[=[
@within Stdio @within Stdio
@must_use @tag must_use
Formats arguments into a human-readable string with syntax highlighting for tables. Formats arguments into a human-readable string with syntax highlighting for tables.