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 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) GetResourceFunctionResultName(resourceName string) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GeneratePackage ¶
func GetDocLinkForBuiltInType ¶ added in v1.12.1
GetDocLinkForBuiltInType returns the URL for a built-in type.
Types ¶
type DocLanguageHelper ¶ added in v1.12.1
type DocLanguageHelper struct{}
DocLanguageHelper is the NodeJS-specific implementation of the DocLanguageHelper.
func (DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType ¶ added in v1.13.0
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 ¶ added in v1.13.0
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 ¶ added in v1.12.1
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 ¶ added in v1.12.1
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) GetResourceFunctionResultName ¶ added in v1.13.0
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.
Source Files