luau-lang/rfcs
1
0
Fork 0
mirror of https://github.com/luau-lang/rfcs.git synced 2025-04-05 02:50:59 +01:00
Code Issues Projects Releases Packages Wiki Activity

Rename the hasonly methods to instead start with musthave as it more clearly describes what they do

Browse source
This commit is contained in:
witchiest 2025-02-28 09:37:05 -05:00 • committed by GitHub
parent f2e2cbcb10
commit c5ba91d61c
Signed by: DevComp
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/user-side-subtype-checking-methods.md
View file

@ -107,21 +107,21 @@ This RFC proposes adding 4 new methods to the [`type`](./user-defined-type-funct
| ------------- | ------------- | ------------- | | ------------- | ------------- | ------------- |
| `hassubtype(arg: string)` | `boolean` | returns true if self has a subtype of the same tag as the argument. List of available tags: "nil", "unknown", "never", "any", "boolean", "number", "string", "singleton", "negation", "union", "intersection", "table", "function", "class" | | `hassubtype(arg: string)` | `boolean` | returns true if self has a subtype of the same tag as the argument. List of available tags: "nil", "unknown", "never", "any", "boolean", "number", "string", "singleton", "negation", "union", "intersection", "table", "function", "class" |
| `hassubtypeof(arg: type)` | `boolean` | returns true if self has a subtype of the argument. | | `hassubtypeof(arg: type)` | `boolean` | returns true if self has a subtype of the argument. |
| `hasonlysubtype(arg: string)` | `boolean` | returns true if self has only a subtype of the same tag as the argument. List of available tags: "nil", "unknown", "never", "any", "boolean", "number", "string", "singleton", "negation", "union", "intersection", "table", "function", "class" | | `musthavesubtype(arg: string)` | `boolean` | returns true if self has only a subtype of the same tag as the argument. List of available tags: "nil", "unknown", "never", "any", "boolean", "number", "string", "singleton", "negation", "union", "intersection", "table", "function", "class" |
| `hasonlysubtypeof(arg: type)` | `boolean` | returns true if self has a subtype of the argument. | | `musthavesubtypeof(arg: type)` | `boolean` | returns true if self has a subtype of the argument. |
The `only` methods are diffrent with how they validate, as shown below. The `musthave` methods are diffrent with how they validate, as shown below.
### String Enum Examples ### String Enum Examples
```luau ```luau
type meow = number | "mrrp" | string type meow = number | "mrrp" | string
print(meow:hasonlysubtypeof(types.string)) -- false, because theres a number in the union. print(meow:musthavesubtypeof(types.string)) -- false, because theres a number in the union.
print(meow:hassubtypeof(types.string)) -- true, because even though theres a number, theres also types with a subtype of string, and also string itself. print(meow:hassubtypeof(types.string)) -- true, because even though theres a number, theres also types with a subtype of string, and also string itself.
type mrow = "purr" | "meow" type mrow = "purr" | "meow"
print(meow:hasonlysubtypeof(types.string)) -- true, because despite the union being made up of singletons. Those singletons have the subtype of string, so it returns true. print(meow:musthavesubtypeof(types.string)) -- true, because despite the union being made up of singletons. Those singletons have the subtype of string, so it returns true.
print(meow:hassubtypeof(types.string)) -- true print(meow:hassubtypeof(types.string)) -- true
``` ```
@ -138,19 +138,19 @@ type TwentyPercentPurityCatnip = {
name: "Average Catnip" name: "Average Catnip"
} }
print(TwentyPercentPurityCatnip:hasonlysubtypeof(BaseCatnipInfo)) -- false, because "20%" is not an option in the string enum 'CatnipPurity'. print(TwentyPercentPurityCatnip:musthavesubtypeof(BaseCatnipInfo)) -- false, because "20%" is not an option in the string enum 'CatnipPurity'.
print(TwentyPercentPurityCatnip:hassubtypeof(BaseCatnipInfo)) -- also false for the same reason print(TwentyPercentPurityCatnip:hassubtypeof(BaseCatnipInfo)) -- also false for the same reason
type WeakCatnip = BaseCatnipInfo<"10%"> & { type WeakCatnip = BaseCatnipInfo<"10%"> & {
name: "Weak Catnip" name: "Weak Catnip"
} }
print(WeakCatnip:hasonlysubtypeof(BaseCatnipInfo)) -- true, because unlike the previous example "10%" is an option in the string enum 'CatnipPurity'. print(WeakCatnip:musthavesubtypeof(BaseCatnipInfo)) -- true, because unlike the previous example "10%" is an option in the string enum 'CatnipPurity'.
print(TwentyPercentPurityCatnip:hassubtypeof(BaseCatnipInfo)) -- also true print(TwentyPercentPurityCatnip:hassubtypeof(BaseCatnipInfo)) -- also true
type FishyCatnipUnion = WeakCatnip | TwentyPercentPurityCatnip type FishyCatnipUnion = WeakCatnip | TwentyPercentPurityCatnip
print(FishyCatnipUnion:hasonlysubtypeof(BaseCatnipInfo)) -- false, because "20%" is not an option in the string enum 'CatnipPurity'. print(FishyCatnipUnion:musthavesubtypeof(BaseCatnipInfo)) -- false, because "20%" is not an option in the string enum 'CatnipPurity'.
print(TwentyPercentPurityCatnip:hassubtypeof(BaseCatnipInfo)) -- true, because atleast one of the components has the subtype of BaseCatnipInfo (WeakCatnip). print(TwentyPercentPurityCatnip:hassubtypeof(BaseCatnipInfo)) -- true, because atleast one of the components has the subtype of BaseCatnipInfo (WeakCatnip).
``` ```