Skip to content

feat: add ---@export #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
numToStr merged 1 commit into from
Jul 8, 2022
Merged

feat: add ---@export #30

numToStr merged 1 commit into from
Jul 8, 2022

Conversation

@numToStr
Copy link
Owner

@numToStr numToStr commented Jul 8, 2022

This tag allows us to manually tag the exported object. As the parser is unable to parse some return cases, such as return setmetatable(...)

Emmylua

---@mod module.config Configuration

local Config = {}

---Get the config
---@return number
function Config:get()
    return 3.14
end

---@export Config
return setmetatable(Config, {
    __index = function(this, k)
        return this.state[k]
    end,
    __newindex = function(this, k, v)
        this.state[k] = v
    end,
})

Help

================================================================================
Configuration                                                    *module.config*

Config:get()                                                        *Config:get*
    Get the config

    Returns: ~
        {number}

@numToStr
feat: add ---@export
b90f869 
This tag allows us to manually tag the exported object. As the parser
is unable to parse some cases, such as `return setmetatable(...)`
@numToStr numToStr merged commit f66ff82 into master Jul 8, 2022
@numToStr numToStr deleted the meta-mitigate branch July 8, 2022 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@numToStr