Typescript typings: First cut #157
Conversation
Reformat, add some missing API calls, move tslint comments, add Type and arith ip constants.
| const LUA_OK: number; | ||
| const LUA_ERRRUN: number; | ||
|
|
||
| type lua_Alloc = (...a: any) => any; // TODO: define this correctly. Is alloc actually used? |
| export type lua_Type = number; | ||
| export type lua_ArithOp = number; | ||
|
|
||
| const LUA_OK: number; |
There was a problem hiding this comment.
You can type these down to actual literals provided the definitions in defs.js are actually constants, which means LUA_OK has the type 0, LUA_ERRRUN has the type 2, etc.
This will be true for constant string values as well, as well as makeshift unions of them, which will effectively rule out the rest of the value space of strings very effectively.
I'd appreciate that. I'm far from a Typescript guru, so peer comments are welcome. |
| export const FENGARI_VERSION_RELEASE: string; | ||
| export const FENGARI_VERSION_MINOR: string; | ||
|
|
||
| export type lua_String = Uint8Array; |
There was a problem hiding this comment.
I noticed that is_luastring wasn't typed (though it seems exported?).
A helpful tip about these kind of predicate functions is that they can inform the type system:
const is_luastring = (value: unknown): value is lua_String => {
// If the function returns true the type system knows that this is indeed a `lua_String`
// otherwise not
}
| } | ||
|
|
||
| export type lua_Type = number; | ||
| export type lua_ArithOp = number; |
There was a problem hiding this comment.
If you type the OP variables down to literals you can then make lua_ArithOp a union:
export type lua_ArithOp = LUA_OPADD | LUA_OPSUB | ... | LUA_OPBNOT;
|
@roddypratt did you want to keep working on this? Is it in a mergable state (the TODOs suggest not; but maybe gradual typing is a thing?) |
|
I am considering picking this up. One of the big things is that things like |
|
Closing due to staleness |
My first github PR, so please be gentle.
This is to address issue #135 by adding a typescript .d.ts file containing typings. At this stage they're incomplete (no enums, maybe missing some functions) and there's likely some confusion about where JS strings vs Lua strings are required.
I've also got a Typescript version of
lapi.test.jswhich uses the typings and passes. Not sure if that should be included in this PR?I've got similar PRs waiting in the wings for fengari-interop and fengari-web.