feat(api): add public API module #1432
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alex-courtis
requested changes
Jul 18, 2022
kyazdani42
force-pushed
the
feat/add-api-module
branch
from
345cc4c to
d0aa124
Compare
|
@alex-courtis i'll finish migrating the events documentation in a followup PR. |
kyazdani42
force-pushed
the
feat/add-api-module
branch
from
d0aa124 to
e8ff1b6
Compare
Documentation is fine for now; there's enough information there. We can update it over time. When we add and document the new mappings / on_attach it will become a lot clearer as the users will be able to see real usages of the API. |
alex-courtis
requested changes
Jul 18, 2022
kyazdani42
force-pushed
the
feat/add-api-module
branch
from
e8ff1b6 to
0fd1f6e
Compare
alex-courtis
approved these changes
Jul 23, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
before #1424
This PR adds an
api.luamodule.We should document the API, since it will be the only place we will allow users to import from, so we can be more flexible in our internal design changes.
We will also start changing the events API, to be more concise, and we'll add migration steps on a followup PR. This is non breaking, older apis will still work. We'll add a PR to be able to
.subscribe.EventName(handle)with an index check.This will also allow refactoring the actions to the on_attach method.
TODO: