Class: BuildContext

Defined in: buildContext.d.ts:8

Properties

Property	Type	Description	Defined in
builderOptions	BuilderOptions	Common options that are used by the builder components.	buildContext.d.ts:12
customData	Record<string, any>	Custom data that can be used by the builder components.	buildContext.d.ts:18
kubernetesResourceInfo	KubernetesResourceInfo	Contains information about the API resources defined in the target cluster.	buildContext.d.ts:15

Methods

addAdditionalFile()

Call Signature

addAdditionalFile(additionalFile): void;

Defined in: buildContext.d.ts:79

Adds given additional file to a DocumentGroup named "".

Checks for an existing DocumentGroup with name "" and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
additionalFile	AdditionalFile

Returns

void

Call Signature

addAdditionalFile(documentGroupName, additionalFile): void;

Defined in: buildContext.d.ts:87

Adds the given additional file to a DocumentGroup with the given name during the steps.generateResources step.

Checks for an existing DocumentGroup with the same name and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
documentGroupName	string
additionalFile	AdditionalFile

Returns

void

---

addDocument()

Call Signature

addDocument(document): void;

Defined in: buildContext.d.ts:26

Adds the given document to a DocumentGroup named "".

Checks for an existing DocumentGroup with name "" and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
document	Document

Returns

void

Call Signature

addDocument(documentGroupName, document): void;

Defined in: buildContext.d.ts:34

Adds the given document to a DocumentGroup with the given name during the steps.generateResources step.

Checks for an existing DocumentGroup with the same name and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
documentGroupName	string
document	Document

Returns

void

Call Signature

addDocument(path, yamlContent): void;

Defined in: buildContext.d.ts:42

Adds a new document to a DocumentGroup named "" by parsing given YAML string as a Document.

Checks for an existing DocumentGroup with name "" and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
path	string
yamlContent	string

Returns

void

Call Signature

addDocument(
   documentGroupName, 
   path, 
   yamlContent): void;

Defined in: buildContext.d.ts:51

Adds a new document to a DocumentGroup with the given name during the steps.generateResources step by parsing given YAML string as a Document.

Checks for an existing DocumentGroup with the same name and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
documentGroupName	string
path	string
yamlContent	string

Returns

void

Call Signature

addDocument(path, root): void;

Defined in: buildContext.d.ts:59

Adds a new document to a DocumentGroup named "" by converting given object to a Document.

Checks for an existing DocumentGroup with name "" and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
path	string
root	object | Mapping

Returns

void

Call Signature

addDocument(
   documentGroupName, 
   path, 
   root): void;

Defined in: buildContext.d.ts:68

Adds a new document to a DocumentGroup with the given name during the steps.generateResources step by converting given object to a Document.

Checks for an existing DocumentGroup with the same name and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
documentGroupName	string
path	string
root	object | Mapping

Returns

void

---

addDocumentGroup()

addDocumentGroup(documentGroup): void;

Defined in: buildContext.d.ts:71

Adds given group to the document groups list.

Parameters

Parameter	Type
documentGroup	DocumentGroup

Returns

void

---

getAllDocuments()

getAllDocuments(): Document[];

Defined in: buildContext.d.ts:99

Returns all documents inside all document groups.

Returns

Document[]

---

getAllDocumentsSorted()

getAllDocumentsSorted(): Document[];

Defined in: buildContext.d.ts:102

Returns all documents inside all document groups sorted by their file path.

Returns

Document[]

---

getDocument()

Call Signature

getDocument(predicate): Document;

Defined in: buildContext.d.ts:105

Returns the first document that satisfies the given predicate. Returns null if no document is found.

Parameters

Parameter	Type
predicate	(document) => boolean

Returns

Document

Call Signature

getDocument(path): Document;

Defined in: buildContext.d.ts:108

Returns the first document that has the given path. Returns null if no document is found.

Parameters

Parameter	Type
path	string

Returns

Document

---

getDocumentGroup()

getDocumentGroup(name): DocumentGroup;

Defined in: buildContext.d.ts:93

Returns the document group that matches the specified name.

Parameters

Parameter	Type
name	string

Returns

DocumentGroup

---

getDocumentGroups()

getDocumentGroups(component?): DocumentGroup[];

Defined in: buildContext.d.ts:96

Returns all document groups. If component is provided, only returns groups added by that component.

Parameters

Parameter	Type
component?	Component

Returns

DocumentGroup[]

---

removeDocumentGroup()

removeDocumentGroup(documentGroup): void;

Defined in: buildContext.d.ts:90

Removes given group from the document groups list.

Parameters

Parameter	Type
documentGroup	DocumentGroup

Returns

void