The highest tagged major version is
Documentation
¶
Overview ¶
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
nolint: lll, goconst
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
nolint: lll, goconst
Index ¶
- func GeneratePackage(tool string, pkg *schema.Package, extraFiles map[string][]byte) (map[string][]byte, error)
- func GenerateProgram(program *hcl2.Program) (map[string][]byte, hcl.Diagnostics, error)
- func GetDocLinkForBuiltInType(typeName string) string
- type DocLanguageHelper
- func (d DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType(packageName, modName, typeName string, input bool) string
- func (d DocLanguageHelper) GetDocLinkForResourceInputOrOutputType(packageName, modName, typeName string, input bool) string
- func (d DocLanguageHelper) GetDocLinkForResourceType(packageName, modName, typeName string) string
- func (d DocLanguageHelper) GetLanguageTypeString(pkg *schema.Package, moduleName string, t schema.Type, input, optional bool) string
- func (d DocLanguageHelper) GetPropertyName(p *schema.Property) (string, error)
- func (d DocLanguageHelper) GetResourceFunctionResultName(resourceName string) string
- type NodePackageInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GeneratePackage ¶
func GenerateProgram ¶ added in v1.14.1
func GetDocLinkForBuiltInType ¶
GetDocLinkForBuiltInType returns the URL for a built-in type.
Types ¶
type DocLanguageHelper ¶
type DocLanguageHelper struct{}
DocLanguageHelper is the NodeJS-specific implementation of the DocLanguageHelper.
func (DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType ¶
func (d DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType(packageName, modName, typeName string, input bool) string
GetDocLinkForFunctionInputOrOutputType returns the doc link for an input or output type of a Function.
func (DocLanguageHelper) GetDocLinkForResourceInputOrOutputType ¶
func (d DocLanguageHelper) GetDocLinkForResourceInputOrOutputType(packageName, modName, typeName string, input bool) string
GetDocLinkForResourceInputOrOutputType returns the doc link for an input or output type of a Resource.
func (DocLanguageHelper) GetDocLinkForResourceType ¶
func (d DocLanguageHelper) GetDocLinkForResourceType(packageName, modName, typeName string) string
GetDocLinkForResourceType returns the NodeJS API doc for a type belonging to a resource provider.
func (DocLanguageHelper) GetLanguageTypeString ¶
func (d DocLanguageHelper) GetLanguageTypeString(pkg *schema.Package, moduleName string, t schema.Type, input, optional bool) string
GetLanguageTypeString returns the language-specific type given a Pulumi schema type.
func (DocLanguageHelper) GetPropertyName ¶
func (d DocLanguageHelper) GetPropertyName(p *schema.Property) (string, error)
GetPropertyName returns the property name specific to NodeJS.
func (DocLanguageHelper) GetResourceFunctionResultName ¶
func (d DocLanguageHelper) GetResourceFunctionResultName(resourceName string) string
GetResourceFunctionResultName returns the name of the result type when a function is used to lookup an existing resource.
type NodePackageInfo ¶ added in v1.14.1
type NodePackageInfo struct {
PackageName string `json:"packageName,omitempty"` // Custom name for the NPM package.
PackageDescription string `json:"packageDescription,omitempty"` // Description for the NPM package.
Dependencies map[string]string `json:"dependencies,omitempty"` // NPM dependencies to add to package.json.
DevDependencies map[string]string `json:"devDependencies,omitempty"` // NPM dev-dependencies to add to package.json.
PeerDependencies map[string]string `json:"peerDependencies,omitempty"` // NPM peer-dependencies to add to package.json.
TypeScriptVersion string `json:"typescriptVersion,omitempty"` // A specific version of TypeScript to include in package.json.
ModuleToPackage map[string]string `json:"moduleToPackage,omitempty"` // A map containing overrides for module names to package names.
}
NodePackageInfo contains NodeJS specific overrides for a package.
Source Files