[JS API] organize types into enums - #9098
Open
chharvey wants to merge 1 commit into
Open
Conversation
Member
|
lgtm, but let's see what others think about the API and TypeScript stuff here. cc @brendandahl |
Member
|
This seems like a good direction to me. |
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
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.
Alternative to #9085, which renamed
binaryen.nonetobinaryen.voidand added a new
binaryen.nonereferring to the heap type.There were concerns that
binaryen.voidmapping tothe C API
BinaryenTypeNone()might be confusing.This PR moves all types from the top-level
binaryen.*namespaceinto respective enums called
Type,HeapType, andPackedType.This change plays nicely with AssemblyScript’s established
TypeScript typings
because now types are scoped in an enum space.
This is not a breaking change for the TS typings file —
e.g., a function that accepts a
Type(previously justnumber)now accepts a member of the new
Typeenum.This change also follows well-established patterns of existing enums
such as
ExpressionIdsandFeatures.binaryen.Type.nonenow usesBinaryenTypeNone()andbinaryen.HeapType.noneusesBinaryenHeapTypeNone(),so there’s no conflict across enums.
This is a breaking change for JS/TS users:
they will now have to reference types from the enum space
instead of at the top level.
E.g.
binaryen.i32becomesbinaryen.Type.i32,binaryen.anybecomesbinaryen.HeapType.any,binaryen.i8becomesbinaryen.PackedType.i8, etc.