TanTan
2a69b23b47
Dev Build / cleanup (push) Canceled after 0s
Dev Build / typecheck (push) Canceled after 0s
Dev Build / build (linux-arm64, ubuntu-24.04-arm, linux-arm64) (push) Canceled after 0s
Dev Build / build (linux-x64, ubuntu-latest, linux-x64) (push) Canceled after 0s
Dev Build / build (win-x64, windows-latest, win32-x64) (push) Canceled after 0s
Dev Build / dispatch-dev-docker (push) Skipped
37 lines
1.3 KiB
Plaintext
37 lines
1.3 KiB
Plaintext
import * as ts from 'typescript';
|
|
/**
|
|
* Retrieve only the Enum literals from a type. for example:
|
|
* - 123 --> []
|
|
* - {} --> []
|
|
* - Fruit.Apple --> [Fruit.Apple]
|
|
* - Fruit.Apple | Vegetable.Lettuce --> [Fruit.Apple, Vegetable.Lettuce]
|
|
* - Fruit.Apple | Vegetable.Lettuce | 123 --> [Fruit.Apple, Vegetable.Lettuce]
|
|
* - T extends Fruit --> [Fruit]
|
|
*/
|
|
export declare function getEnumLiterals(type: ts.Type): ts.LiteralType[];
|
|
/**
|
|
* A type can have 0 or more enum types. For example:
|
|
* - 123 --> []
|
|
* - {} --> []
|
|
* - Fruit.Apple --> [Fruit]
|
|
* - Fruit.Apple | Vegetable.Lettuce --> [Fruit, Vegetable]
|
|
* - Fruit.Apple | Vegetable.Lettuce | 123 --> [Fruit, Vegetable]
|
|
* - T extends Fruit --> [Fruit]
|
|
*/
|
|
export declare function getEnumTypes(typeChecker: ts.TypeChecker, type: ts.Type): ts.Type[];
|
|
/**
|
|
* Returns the enum key that matches the given literal node, or null if none
|
|
* match. For example:
|
|
* ```ts
|
|
* enum Fruit {
|
|
* Apple = 'apple',
|
|
* Banana = 'banana',
|
|
* }
|
|
*
|
|
* getEnumKeyForLiteral([Fruit.Apple, Fruit.Banana], 'apple') --> 'Fruit.Apple'
|
|
* getEnumKeyForLiteral([Fruit.Apple, Fruit.Banana], 'banana') --> 'Fruit.Banana'
|
|
* getEnumKeyForLiteral([Fruit.Apple, Fruit.Banana], 'cherry') --> null
|
|
* ```
|
|
*/
|
|
export declare function getEnumKeyForLiteral(enumLiterals: ts.LiteralType[], literal: unknown): string | null;
|