lune-org/lune
1
1
Fork 0
mirror of https://github.com/lune-org/lune.git synced 2024-12-12 04:50:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix Regex types (#250)

Browse source
This commit is contained in:
howmanysmall 2024-10-16 13:03:00 -06:00 committed by GitHub
parent 010cd36375
commit 0f4cac29aa
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 57 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

99
types/regex.luau
View file

@ -19,67 +19,82 @@ local RegexMatch = {
type RegexMatch = typeof(RegexMatch) type RegexMatch = typeof(RegexMatch)
local RegexCaptures = {}
function RegexCaptures.get(self: RegexCaptures, index: number): RegexMatch?
return nil :: any
end
function RegexCaptures.group(self: RegexCaptures, group: string): RegexMatch?
return nil :: any
end
function RegexCaptures.format(self: RegexCaptures, format: string): string
return nil :: any
end
--[=[ --[=[
@class RegexCaptures @class RegexCaptures
Captures from a regular expression. Captures from a regular expression.
]=] ]=]
local RegexCaptures = {} export type RegexCaptures = typeof(setmetatable(
{} :: {
--[=[
@within RegexCaptures
@tag Method
@method get
--[=[ Returns the match at the given index, if one exists.
@within RegexCaptures
@tag Method
Returns the match at the given index, if one exists. @param index -- The index of the match to get
@return RegexMatch -- The match, if one exists
]=]
@param index -- The index of the match to get get: (self: RegexCaptures, index: number) -> RegexMatch?,
@return RegexMatch -- The match, if one exists
]=]
function RegexCaptures.get(self: RegexCaptures, index: number): RegexMatch?
return nil :: any
end
--[=[ --[=[
@within RegexCaptures @within RegexCaptures
@tag Method @tag Method
@method group
Returns the match for the given named match group, if one exists. Returns the match for the given named match group, if one exists.
@param group -- The name of the group to get @param group -- The name of the group to get
@return RegexMatch -- The match, if one exists @return RegexMatch -- The match, if one exists
]=] ]=]
function RegexCaptures.group(self: RegexCaptures, group: string): RegexMatch? group: (self: RegexCaptures, group: string) -> RegexMatch?,
return nil :: any
end
--[=[ --[=[
@within RegexCaptures @within RegexCaptures
@tag Method @tag Method
@method format
Formats the captures using the given format string. Formats the captures using the given format string.
### Example usage ### Example usage
```lua ```lua
local regex = require("@lune/regex") local regex = require("@lune/regex")
local re = regex.new("(?<day>[0-9]{2})-(?<month>[0-9]{2})-(?<year>[0-9]{4})") local re = regex.new("(?<day>[0-9]{2})-(?<month>[0-9]{2})-(?<year>[0-9]{4})")
local caps = re:captures("On 14-03-2010, I became a Tenneessee lamb."); local caps = re:captures("On 14-03-2010, I became a Tenneessee lamb.");
assert(caps ~= nil, "Example pattern should match example text") assert(caps ~= nil, "Example pattern should match example text")
local formatted = caps:format("year=$year, month=$month, day=$day") local formatted = caps:format("year=$year, month=$month, day=$day")
print(formatted) -- "year=2010, month=03, day=14" print(formatted) -- "year=2010, month=03, day=14"
``` ```
@param format -- The format string to use @param format -- The format string to use
@return string -- The formatted string @return string -- The formatted string
]=] ]=]
function RegexCaptures.format(self: RegexCaptures, format: string): string format: (self: RegexCaptures, format: string) -> string,
return nil :: any },
end {} :: {
__len: (self: RegexCaptures) -> number,
export type RegexCaptures = typeof(RegexCaptures) }
))
local Regex = {} local Regex = {}