UNPKG

1.43 kBTypeScriptView Raw
1import { DocNode, IDocNodeParameters, IDocNodeParsedParameters } from './DocNode';
2/**
3 * Constructor parameters for {@link DocNodeContainer}.
4 */
5export interface IDocNodeContainerParameters extends IDocNodeParameters {
6}
7/**
8 * Constructor parameters for {@link DocNodeContainer}.
9 */
10export interface IDocNodeContainerParsedParameters extends IDocNodeParsedParameters {
11}
12/**
13 * DocNodeContainer is the base class for DocNode classes that allow arbitrary child nodes to be added by the consumer.
14 * The child classes are {@link DocParagraph} and {@link DocSection}.
15 */
16export declare abstract class DocNodeContainer extends DocNode {
17 private readonly _nodes;
18 /**
19 * Don't call this directly. Instead use {@link TSDocParser}
20 * @internal
21 */
22 constructor(parameters: IDocNodeContainerParameters | IDocNodeContainerParsedParameters, childNodes?: ReadonlyArray<DocNode>);
23 /**
24 * The nodes that were added to this container.
25 */
26 get nodes(): ReadonlyArray<DocNode>;
27 /**
28 * Append a node to the container.
29 */
30 appendNode(docNode: DocNode): void;
31 /**
32 * Append nodes to the container.
33 */
34 appendNodes(docNodes: ReadonlyArray<DocNode>): void;
35 /**
36 * Remove all nodes from the container.
37 */
38 clearNodes(): void;
39 /** @override */
40 protected onGetChildNodes(): ReadonlyArray<DocNode | undefined>;
41}
42//# sourceMappingURL=DocNodeContainer.d.ts.map
\No newline at end of file