#
Module: @kosko/yaml#
Index#
References- LoadOptions
- Manifest
- ResourceKind
- ResourceModule
- getResourceModule
- loadFile
- loadString
- loadUrl
- resetResourceModules
- setResourceModule
#
Interfaces#
Functions#
References#
LoadOptionsRe-exports: LoadOptions
#
ManifestRe-exports: Manifest
#
ResourceKindRe-exports: ResourceKind
#
ResourceModuleRe-exports: ResourceModule
#
getResourceModuleRe-exports: getResourceModule
#
loadFileRe-exports: loadFile
#
loadStringRe-exports: loadString
#
loadUrlRe-exports: loadUrl
#
resetResourceModulesRe-exports: resetResourceModules
#
setResourceModuleRe-exports: setResourceModule
#
Functions#
getResourceModuleâ–¸ getResourceModule(res
: ResourceKind): ResourceModule | undefined
Defined in packages/yaml/src/module.ts:60
#
Parameters:Name | Type |
---|---|
res | ResourceKind |
Returns: ResourceModule | undefined
#
loadFileâ–¸ loadFile(path
: string, options?
: LoadOptions): (Anonymous function)
Defined in packages/yaml/src/load.ts:122
Load a Kubernetes YAML file from path.
#
Parameters:Name | Type | Description |
---|---|---|
path | string | Path to the Kubernetes YAML file. |
options? | LoadOptions |
Returns: (Anonymous function)
#
loadStringâ–¸ loadString(content
: string, __namedParameters?
: { transform: (x: Manifest) => Manifest }): ReadonlyArray<Manifest>
Defined in packages/yaml/src/load.ts:87
Load a Kubernetes YAML file from a string.
#
Examples#
Transform manifests#
Filter manifestsValues are removed from array if transform
function returns a falsy value,
such as null
or undefined
.
#
Parameters:Name | Type | Default value |
---|---|---|
content | string | - |
__namedParameters | { transform: (x: Manifest) => Manifest } | {} |
Returns: ReadonlyArray<Manifest>
#
loadUrlâ–¸ loadUrl(url
: RequestInfo, options?
: LoadOptions & RequestInit): function
Defined in packages/yaml/src/load.ts:137
Load a Kubernetes YAML file from url.
#
Parameters:Name | Type | Default value | Description |
---|---|---|---|
url | RequestInfo | - | URL to the Kubernetes YAML file. |
options | LoadOptions & RequestInit | {} | (https://github.com/node-fetch/node-fetch#options) for the HTTP(S) request. |
Returns: function
#
resetResourceModulesâ–¸ resetResourceModules(): void
Defined in packages/yaml/src/module.ts:66
Returns: void
#
setResourceModuleâ–¸ setResourceModule(res
: ResourceKind, mod
: ResourceModule): void
Defined in packages/yaml/src/module.ts:22
#
Parameters:Name | Type |
---|---|
res | ResourceKind |
mod | ResourceModule |
Returns: void