typescript

package
v0.0.10 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 7, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const LanguageRef = "typescript"

Variables

This section is empty.

Functions

func NewImportMap

func NewImportMap(packagesImportMap map[string]string) *common.DirectImportMap

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

func (*Builder) Generate

func (jenny *Builder) Generate(context languages.Context) (codejen.Files, error)

func (*Builder) JennyName

func (jenny *Builder) JennyName() string

type Config

type Config struct {
	PathPrefix string `yaml:"path_prefix"`

	// SkipRuntime disables runtime-related code generation when enabled.
	// Note: builders can NOT be generated with this flag turned on, as they
	// rely on the runtime to function.
	SkipRuntime bool `yaml:"skip_runtime"`

	// SkipIndex disables the generation of `index.ts` files.
	SkipIndex bool `yaml:"skip_index"`

	// OverridesTemplatesDirectories holds a list of directories containing templates
	// defining blocks used to override parts of builders/types/....
	OverridesTemplatesDirectories []string `yaml:"overrides_templates"`

	// ExtraFilesTemplatesDirectories holds a list of directories containing
	// templates describing files to be added to the generated output.
	ExtraFilesTemplatesDirectories []string `yaml:"extra_files_templates"`

	// ExtraFilesTemplatesData holds additional data to be injected into the
	// templates described in ExtraFilesTemplatesDirectories.
	ExtraFilesTemplatesData map[string]string `yaml:"-"`

	// PackagesImportMap associates package names to their import path.
	PackagesImportMap map[string]string `yaml:"packages_import_map"`

	// EnumsAsUnionTypes generates enums as a union of values instead of using
	// an actual `enum` declaration.
	// If EnumsAsUnionTypes is false, an enum will be generated as:
	// “`ts
	// enum Direction {
	//   Up = "up",
	//   Down = "down",
	//   Left = "left",
	//   Right = "right",
	// }
	// “`
	// If EnumsAsUnionTypes is true, the same enum will be generated as:
	// “`ts
	// type Direction = "up" | "down" | "left" | "right";
	// “`
	EnumsAsUnionTypes bool `yaml:"enums_as_union_types"`
}

func (*Config) InterpolateParameters

func (config *Config) InterpolateParameters(interpolator func(input string) string)

type Index

type Index struct {
	Targets languages.Config
}

func (Index) Generate

func (jenny Index) Generate(context languages.Context) (codejen.Files, error)

func (Index) JennyName

func (jenny Index) JennyName() string

type Language

type Language struct {
	// contains filtered or unexported fields
}

func New

func New(config Config) *Language

func (*Language) CompilerPasses

func (language *Language) CompilerPasses() compiler.Passes

func (*Language) Jennies

func (language *Language) Jennies(globalConfig languages.Config) *codejen.JennyList[languages.Context]

func (*Language) Name

func (language *Language) Name() string

func (*Language) NullableKinds

func (language *Language) NullableKinds() languages.NullableConfig

type RawTypes

type RawTypes struct {
	// contains filtered or unexported fields
}

func (RawTypes) Generate

func (jenny RawTypes) Generate(context languages.Context) (codejen.Files, error)

func (RawTypes) JennyName

func (jenny RawTypes) JennyName() string

type Runtime

type Runtime struct {
}

func (Runtime) Generate

func (jenny Runtime) Generate(_ languages.Context) (codejen.Files, error)

func (Runtime) JennyName

func (jenny Runtime) JennyName() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL