ts

func Decls ¶

func Decls(dir, typename, prefix, outfile string) (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`.

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

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

func MustDecls ¶ added in v0.42.0

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

MustDecls is the same as Decls but panics on error.