@vuedx/compiler-tsx

Compiler TSX

A custom compiler to convert Vue template to a (functional) TSX representation for type checking.

Support

This package is part of VueDX project, maintained by Rahul Kadyan. You can 💖 sponsor him for continued development of this package and other VueDX tools.

Usage

npm add @vuedx/compiler-tsx

API

compile

More info

Signature:

declare function compile(template: string, options: Options & CompilerOptions): CodegenResult;

Parameter	Type	Description
template	string	-
options	Options & CompilerOptions	-

parse

More info

Signature:

declare function parse(template: string, options: ParserOptions): RootNode;

Parameter	Type	Description
template	string	-
options	ParserOptions	-

Types

CodegenResult

interface CodegenResult extends CodegenResult$1 {
  errors: CompilerError[];
  expressions: Array<[number, number]>;
  mappings: Array<[number, number, number, number, number]>;
}

ComponentImport

interface ComponentImport {
  name?: string;
  named?: boolean;
  path: string;
}

Options

interface Options {
  components?: Record<string, ComponentImport>;
  filename: string;
}