broccoli-node-api

TypeScript types for the Broccoli Node Api

- broccoli-node-api
- Exports
- Node
- InputNode
- NodeCommon
- NodeMap
- TransformNode
- SourceNode
- FeatureSet
- NodeInfo
- NodeType
- NodeInfoMap
- NodeInfoCommon
- TransformNodeInfo
- CallbackObject
- SourceNodeInfo

Exports

$3

``ts
type Node = TransformNode | SourceNode;
`

Node Documentation

---

$3

`ts
type InputNode = Node | string;
`

---

$3

`ts
interface NodeCommon {
__broccoliFeatures__: FeatureSet;
__broccoliGetInfo__: (builderFeatures: FeatureSet) => T;
}
`

---

$3

`ts
interface NodeMap = {
transform: TransformNode;
source: SourceNode;
};
`

---

$3

`ts
interface TransformNode extends NodeCommon {}
`

---

$3

`ts
interface SourceNode extends NodeCommon {}
`

---

$3

`ts
interface FeatureSet {
[feature: string]: boolean;
}
`

---

$3

`ts
type NodeInfo = TransformNodeInfo | SourceNodeInfo;
`

NodeInfo Documentation

---

$3

`ts
type NodeType = "transform" | "source";
`

---

$3

`ts
interface NodeInfoMap = {
transform: TransformNodeInfo;
source: SourceNodeInfo;
};
`

---

$3

`ts
interface NodeInfoCommon {
nodeType: T;
name: string;
annotation: string | null | undefined;
instantiationStack: string;
}
`

---

$3

`ts
interface TransformNodeInfo extends NodeInfoCommon<"transform"> {
inputNodes: Node[];
setup(
features: FeatureSet,
options: { inputPaths: string[]; outputPath: string; cachePath: string }
): void;
getCallbackObject(): CallbackObject;
persistentOutput: boolean;
needsCache: boolean;
volatile: boolean;
trackInputChanges: boolean;
}
`

TransformNodeInfo Documentation

---

$3

`ts
interface CallbackObject {
build(buildChangeObject?: BuildChangeObject): Promise | void;
}
`

---

$3

`ts
interface BuildChangeObject {
changedNodes: boolean[];
}
`

---

$3

`ts
interface SourceNodeInfo extends NodeInfoCommon<"source"> {
sourceDirectory: string;
watched: boolean;
}
``

SourceNodeInfo Documentation