Reference

API and configuration reference for typesugar.

Core APIs

Reference	Description
MacroContext	Full MacroContext API for macro authors
Macro Types	All 6 macro kinds and their signatures
Macro Triggers	How macros are invoked

Tools

Reference	Description
CLI	Command-line interface
Configuration	All configuration options

Packages

Reference	Description
Package Matrix	All packages with features

Quick Links

Registration Functions

// Expression macro: fn()
defineExpressionMacro(name, { expand(ctx, callExpr) {} });

// Attribute macro: @decorator
defineAttributeMacro(name, { expand(ctx, decorator, target) {} });

// Derive macro: @derive(Name)
defineDeriveMacro(name, { expand(ctx, target, typeInfo) {} });

// Tagged template: tag`...`
defineTaggedTemplateMacro(name, { expand(ctx, node) {} });

// Type macro: Type<T>
defineTypeMacro(name, { expand(ctx, typeRef) {} });

// Labeled block: label: { }
defineLabeledBlockMacro(name, { expand(ctx, block) {} });

Key Imports

// Core registration
import {
  defineExpressionMacro,
  defineAttributeMacro,
  defineDeriveMacro,
  defineTaggedTemplateMacro,
  defineTypeMacro,
  defineLabeledBlockMacro,
} from "@typesugar/core";

// Quasiquoting
import { quote, quoteStatements, quoteType, ident, raw, spread } from "@typesugar/core/quote";

// Testing
import { expandCode, expandMacro, assertExpands } from "@typesugar/testing";

// Configuration
import { config, cfg, cfgAttr } from "@typesugar/core";