luau-lang/rfcs
1
0
Fork 0
mirror of https://github.com/luau-lang/rfcs.git synced 2025-04-03 18:10:56 +01:00
Code Issues Projects Releases Packages Wiki Activity

RFC: Support for thread and buffer Types in User-Defined Type Functions

Browse source
This commit is contained in:
Vyacheslav Egorov 2024-11-21 20:44:44 +02:00
parent 03608c7519
commit 6c73d66e76
1 changed files with 34 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
docs/support-for-thread-and-buffer-types-in-user-defined-type-functions.md Normal file
View file

@ -0,0 +1,34 @@
# Support for thread and buffer Types in User-Defined Type Functions
## Summary
Add support for 'thread' and 'buffer' primitive types, omitted from original user-defined type function RFC.
## Motivation
While more rarely used than 'string' or 'number', 'thread' and 'buffer' are perfectly valid primitive types already supported by Luau typechecking engine, so should be included in user-defined type function API.
Developers are already hitting this limitation and there's no specific reason to exclude these types.
## Design
We propose two new library properties and two new type tags.
No methods are added for types with these new tags.
### Update `types` Library
| Library Properties | Type | Description |
| ------------- | ------------- | ------------- |
| `thread` | `type` | an immutable instance of the built-in type `thread` |
| `buffer` | `type` | an immutable instance of the built-in type `buffer` |
### Update `type` Instance
| Instance Properties | Type | Description |
| ------------- | ------------- | ------------- |
| `tag` | `"nil" \| "unknown" \| "never" \| "any" \| "boolean" \| "number" \| "string" \| "singleton" \| "negation" \| "union" \| "intersection" \| "table" \| "function" \| "class" \| "thread" \| "buffer"` | an immutable property holding this type's tag |
## Drawback
Unclear if this proposal has any drawbacks.