Module: @kosko/yaml
Table of contents#
Interfaces#
Functions#
getResourceModule#
â–¸ getResourceModule(res: ResourceKind): Promise<ResourceModule | undefined>
Parameters:#
| Name | Type |
|---|---|
res | ResourceKind |
Returns: Promise<ResourceModule | undefined>
Defined in: packages/yaml/src/module.ts:62
loadFile#
â–¸ loadFile(path: string, options?: LoadOptions): function
Load a Kubernetes YAML file from path.
Parameters:#
| Name | Type | Description |
|---|---|---|
path | string | Path to the Kubernetes YAML file. |
options? | LoadOptions |
Returns: () => Promise<readonly Manifest[]>
Defined in: packages/yaml/src/load.ts:90
loadString#
â–¸ loadString(content: string, __namedParameters?: LoadOptions): Promise<readonly Manifest[]>
Load a Kubernetes YAML file from a string.
Parameters:#
| Name | Type |
|---|---|
content | string |
__namedParameters | LoadOptions |
Returns: Promise<readonly Manifest[]>
Defined in: packages/yaml/src/load.ts:55
loadUrl#
â–¸ loadUrl(url: RequestInfo, options?: LoadOptions & RequestInit): function
Load a Kubernetes YAML file from url.
Parameters:#
| Name | Type | 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: () => Promise<readonly Manifest[]>
Defined in: packages/yaml/src/load.ts:105
resetResourceModules#
â–¸ resetResourceModules(): void
Returns: void
Defined in: packages/yaml/src/module.ts:70
setResourceModule#
â–¸ setResourceModule(res: ResourceKind, mod: ResourceModule): void
Parameters:#
| Name | Type |
|---|---|
res | ResourceKind |
mod | ResourceModule |
Returns: void
Defined in: packages/yaml/src/module.ts:23