Module: @kosko/yaml
Interfaces
Functions
getResourceModule
▸ getResourceModule(res
): Promise
<ResourceModule
| undefined
>
Parameters
Name | Type |
---|---|
res | ResourceKind |
Returns
Promise
<ResourceModule
| undefined
>
Defined in
packages/yaml/src/module.ts:65
loadFile
▸ loadFile(path
, options?
): () => Promise
<readonly Manifest
[]>
Load a Kubernetes YAML file from path.
Parameters
Name | Type | Description |
---|---|---|
path | string | Path to the Kubernetes YAML file. |
options? | LoadOptions |
Returns
fn
▸ (): Promise
<readonly Manifest
[]>
Returns
Promise
<readonly Manifest
[]>
Defined in
loadString
▸ loadString(content
, __namedParameters?
): Promise
<readonly Manifest
[]>
Load a Kubernetes YAML file from a string.
Parameters
Name | Type |
---|---|
content | string |
__namedParameters | LoadOptions |
Returns
Promise
<readonly Manifest
[]>
Defined in
loadUrl
▸ loadUrl(url
, options?
): () => Promise
<readonly Manifest
[]>
Load a Kubernetes YAML file from url.
Parameters
Name | Type | Description |
---|---|---|
url | RequestInfo | URL to the Kubernetes YAML file. |
options | LoadOptions & RequestInit | Options for the HTTP(S) request. |
Returns
fn
▸ (): Promise
<readonly Manifest
[]>
Returns
Promise
<readonly Manifest
[]>
Defined in
resetResourceModules
▸ resetResourceModules(): void
Returns
void
Defined in
packages/yaml/src/module.ts:73
setResourceModule
▸ setResourceModule(res
, mod
): void
Parameters
Name | Type |
---|---|
res | ResourceKind |
mod | ResourceModule |
Returns
void