Module: @kosko/yaml

Index

References

• LoadOptions
• Manifest
• ResourceKind
• ResourceModule
• getResourceModule
• loadFile
• loadString
• loadUrl
• resetResourceModules
• setResourceModule

Interfaces

• LoadOptions
• Manifest
• ResourceKind
• ResourceModule

Functions

• getResourceModule
• loadFile
• loadString
• loadUrl
• resetResourceModules
• setResourceModule

References

LoadOptions

Re-exports: LoadOptions

---

Manifest

Re-exports: Manifest

---

ResourceKind

Re-exports: ResourceKind

---

ResourceModule

Re-exports: ResourceModule

---

getResourceModule

Re-exports: getResourceModule

---

loadFile

Re-exports: loadFile

---

loadString

Re-exports: loadString

---

loadUrl

Re-exports: loadUrl

---

resetResourceModules

Re-exports: resetResourceModules

---

setResourceModule

Re-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

loadString('', {

transform(manifest) {

if (manifest.apiVersion === "apps/v1" && manifest.kind === "Deployment") {

manifest.spec.replicas = 3;

}

return manifest;

}

});

Filter manifests

Values are removed from array if transform function returns a falsy value, such as null or undefined.

loadString('', {

transform(manifest) {

if (manifest.metadata.name === 'foo') {

return null;

}

return manifest;

}

});

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