Class: DocumentGroup
Defined in: documentGroup.d.ts:9
Container for multiple Document instances. It can also contain multiple AdditionalFile objects that generates additional files beside the documents.
Constructors
Constructor
new DocumentGroup(path): DocumentGroup;
Defined in: documentGroup.d.ts:10
Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
DocumentGroup
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
additionalFiles | AdditionalFile[] | Additional files in this group. Don't modify this array directly. Use DocumentGroup.addAdditionalFile instead. | documentGroup.d.ts:22 |
documents | Document[] | Documents in this group. Don't modify this array directly. Use DocumentGroup.addDocument and DocumentGroup.removeDocument instead. | documentGroup.d.ts:19 |
path | string | The path of the document group. | documentGroup.d.ts:13 |
Methods
addAdditionalFile()
addAdditionalFile(additionalFile): void;
Defined in: documentGroup.d.ts:28
Adds the given additional file to this group.
Parameters
| Parameter | Type |
|---|---|
additionalFile | AdditionalFile |
Returns
void
addDocument()
addDocument(document): void;
Defined in: documentGroup.d.ts:25
Adds the given document to this group and sets its group field to this group.
Parameters
| Parameter | Type |
|---|---|
document | Document |
Returns
void
fixNameClashes()
fixNameClashes(): void;
Defined in: documentGroup.d.ts:67
Fixes duplicate document file paths by adding an index suffix to the end the paths. Sorts the documents by their apiVersion, kind, namespace, and name to ensure consistent naming. This is useful for documents that are generated by Helm charts which may have multiple documents in a single file.
Returns
void
getComponent()
getComponent(): Component;
Defined in: documentGroup.d.ts:34
Returns the component that created this document group. Component is set when the document group is added to the builder context.
Returns
getDocument()
Call Signature
getDocument(path): Document;
Defined in: documentGroup.d.ts:37
Returns the first document that has the given path.
Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
Call Signature
getDocument(filter): Document;
Defined in: documentGroup.d.ts:40
Returns the first document that satisfies the given predicate.
Parameters
| Parameter | Type |
|---|---|
filter | (document) => boolean |
Returns
moveTo()
moveTo(group): void;
Defined in: documentGroup.d.ts:46
Removes all documents and additional files from this group and adds them to the given group.
Parameters
| Parameter | Type |
|---|---|
group | DocumentGroup |
Returns
void
removeAdditionalFile()
removeAdditionalFile(additionalFile): void;
Defined in: documentGroup.d.ts:52
Removes the given additional file from this group.
Parameters
| Parameter | Type |
|---|---|
additionalFile | AdditionalFile |
Returns
void
removeDocument()
removeDocument(document): void;
Defined in: documentGroup.d.ts:49
Removes the given document from this group and sets its group field to null.
Parameters
| Parameter | Type |
|---|---|
document | Document |
Returns
void
setNamespaces()
setNamespaces(context, namespace): void;
Defined in: documentGroup.d.ts:59
Sets the namespace of documents that are namespaced (e.g. Pod, Job, ...) to the given namespace. This is useful for documents that are generated by Helm charts where the namespace is not set correctly.
Parameters
| Parameter | Type |
|---|---|
context | BuildContext |
namespace | string |
Returns
void
sortedDocuments()
sortedDocuments(): Document[];
Defined in: documentGroup.d.ts:43
Returns the documents in this group sorted by their path.
Returns
Document[]