ts

Documentation

Index

• func Decls(dir, typename, prefix, outfile string, opts ...fab.FilesOpt) (fab.Target, error)
• func MustDecls(dir, typename, prefix, outfile string) fab.Target

Functions

func Decls

func Decls(dir, typename, prefix, outfile string, opts ...fab.FilesOpt) (fab.Target, error)

Decls uses tsdecls.Write to write TypeScript type declarations to `outfile` based on the Go `typename` found in the package in `dir`.

Decls is implemented in terms of fab.Files. Any opts are passed through to that function.

It is JSON-encodable (and therefore usable as the subtarget in fab.Files).

A Decls target may be specified in YAML using the tag !ts.Decls, which introduces a mapping whose fields are:

• Dir: the directory containing a Go package
• Type: the Go type to examine for producing TypeScript declarations
• Prefix: the path prefix for the generated POST URL
• Out: the output file
• Autoclean: a boolean indicating whether the output file should be added to the "autoclean registry." See fab.Autoclean for more about this feature.

Both Dir and Out are either absolute or relative to the directory containing the YAML file.

func MustDecls

func MustDecls(dir, typename, prefix, outfile string) fab.Target

MustDecls is the same as Decls but panics on error.