rbxts-transformer-keys

A roblox-ts transformer which enables to obtain keys of given type.

Forked from https://github.com/kimamula/ts-transformer-keys

Requirement

TypeScript >= 3.4.1

How to use this package

This package exports 2 functions. One is $keys which is used in TypeScript codes to obtain keys of given type, while the other is a TypeScript custom transformer which is used to compile the $keys function correctly.

How to use $keys

1import { $keys } from 'rbxts-transformer-keys';
2
3interface Props {
4  id: string;
5  name: string;
6  age: number;
7}
8const keysOfProps = $keys<Props>();
9
10console.log(keysOfProps); // ['id', 'name', 'age']

How to use the custom transformer

1// tsconfig.json
2{
3  "compilerOptions": {
4    // ...
5    "plugins": [
6      { "transform": "rbxts-transformer-keys" }
7    ]
8  },
9  // ...
10}

Notes

• The $keys function can only be used as a call expression. Writing something like $keys.toString() results in a runtime error.
• $keys does not work with type generics, i.e., $keys<T>() in the following code is converted to an empty array([]).

1class MyClass<T extends object> {
2  keys() {
3    // returns [] as generics do not work
4    return $keys<T>();
5  }
6}

License

MIT