Skip to main content

Module: @kosko/yaml

Interfaces​

Functions​

getResourceModule​

▸ getResourceModule(res): Promise<ResourceModule | undefined>

Parameters​

NameType
resResourceKind

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​

NameTypeDescription
pathstringPath to the Kubernetes YAML file.
options?LoadOptions

Returns​

fn

▸ (): Promise<readonly Manifest[]>

Returns​

Promise<readonly Manifest[]>

Defined in​

packages/yaml/src/load.ts:92


loadString​

▸ loadString(content, __namedParameters?): Promise<readonly Manifest[]>

Load a Kubernetes YAML file from a string.

Parameters​

NameType
contentstring
__namedParametersLoadOptions

Returns​

Promise<readonly Manifest[]>

Defined in​

packages/yaml/src/load.ts:57


loadUrl​

▸ loadUrl(url, options?): () => Promise<readonly Manifest[]>

Load a Kubernetes YAML file from url.

Parameters​

NameTypeDescription
urlRequestInfoURL to the Kubernetes YAML file.
optionsLoadOptions & RequestInitOptions for the HTTP(S) request.

Returns​

fn

▸ (): Promise<readonly Manifest[]>

Returns​

Promise<readonly Manifest[]>

Defined in​

packages/yaml/src/load.ts:107


resetResourceModules​

▸ resetResourceModules(): void

Returns​

void

Defined in​

packages/yaml/src/module.ts:73


setResourceModule​

▸ setResourceModule(res, mod): void

Parameters​

NameType
resResourceKind
modResourceModule

Returns​

void

Defined in​

packages/yaml/src/module.ts:21