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

Node

1type Node = TransformNode | SourceNode;

Node Documentation

---

InputNode

1type InputNode = Node | string;

---

NodeCommon

1interface NodeCommon<T extends NodeInfo> {
2  __broccoliFeatures__: FeatureSet;
3  __broccoliGetInfo__: (builderFeatures: FeatureSet) => T;
4}

---

NodeMap

1interface NodeMap = {
2  transform: TransformNode;
3  source: SourceNode;
4};

---

TransformNode

1interface TransformNode extends NodeCommon<TransformNodeInfo> {}

---

SourceNode

1interface SourceNode extends NodeCommon<SourceNodeInfo> {}

---

FeatureSet

1interface FeatureSet {
2  [feature: string]: boolean;
3}

---

NodeInfo

1type NodeInfo = TransformNodeInfo | SourceNodeInfo;

NodeInfo Documentation

---

NodeType

1type NodeType = "transform" | "source";

---

NodeInfoMap

1interface NodeInfoMap = {
2  transform: TransformNodeInfo;
3  source: SourceNodeInfo;
4};

---

NodeInfoCommon

1interface NodeInfoCommon<T extends NodeType> {
2  nodeType: T;
3  name: string;
4  annotation: string | null | undefined;
5  instantiationStack: string;
6}

---

TransformNodeInfo

1interface TransformNodeInfo extends NodeInfoCommon<"transform"> {
2  inputNodes: Node[];
3  setup(
4    features: FeatureSet,
5    options: { inputPaths: string[]; outputPath: string; cachePath: string }
6  ): void;
7  getCallbackObject(): CallbackObject;
8  persistentOutput: boolean;
9  needsCache: boolean;
10  volatile: boolean;
11  trackInputChanges: boolean;
12}

TransformNodeInfo Documentation

---

CallbackObject

1interface CallbackObject {
2  build(buildChangeObject?: BuildChangeObject): Promise<void> | void;
3}

---

BuildChangeObject

1interface BuildChangeObject {
2  changedNodes: boolean[];
3}

---

SourceNodeInfo

1interface SourceNodeInfo extends NodeInfoCommon<"source"> {
2  sourceDirectory: string;
3  watched: boolean;
4}

SourceNodeInfo Documentation