All files / transpiler/logic/symbols/types TSymbol.ts

0% Statements 0/0
0% Branches 0/0
0% Functions 0/0
0% Lines 0/0

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37                                                                         
import IBitmapSymbol from "./IBitmapSymbol";
import IEnumSymbol from "./IEnumSymbol";
import IFunctionSymbol from "./IFunctionSymbol";
import IRegisterSymbol from "./IRegisterSymbol";
import IScopeSymbol from "./IScopeSymbol";
import IStructSymbol from "./IStructSymbol";
import IVariableSymbol from "./IVariableSymbol";
 
/**
 * Discriminated union of all symbol types.
 *
 * Use the `kind` field to narrow to a specific symbol type:
 * ```typescript
 * if (symbol.kind === ESymbolKind.Struct) {
 *   // TypeScript knows symbol is IStructSymbol here
 *   for (const [fieldName, fieldInfo] of symbol.fields) { ... }
 * }
 * ```
 *
 * Or use the type guard functions from typeGuards.ts:
 * ```typescript
 * if (isStructSymbol(symbol)) {
 *   // TypeScript knows symbol is IStructSymbol here
 * }
 * ```
 */
type TSymbol =
  | IStructSymbol
  | IEnumSymbol
  | IBitmapSymbol
  | IFunctionSymbol
  | IVariableSymbol
  | IScopeSymbol
  | IRegisterSymbol;
 
export default TSymbol;