broccoli-node-api
Broccoli Plugin API Types
Last updated a year ago by thoov .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install broccoli-node-api 
SYNC missed versions from official npm registry.

broccoli-node-api

TypeScript types for the Broccoli Node Api

Exports

Node

type Node = TransformNode | SourceNode;

Node Documentation


InputNode

type InputNode = Node | string;

NodeCommon

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

NodeMap

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

TransformNode

interface TransformNode extends NodeCommon<TransformNodeInfo> {}

SourceNode

interface SourceNode extends NodeCommon<SourceNodeInfo> {}

FeatureSet

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

NodeInfo

type NodeInfo = TransformNodeInfo | SourceNodeInfo;

NodeInfo Documentation


NodeType

type NodeType = "transform" | "source";

NodeInfoMap

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

NodeInfoCommon

interface NodeInfoCommon<T extends NodeType> {
  nodeType: T;
  name: string;
  annotation: string | null | undefined;
  instantiationStack: string;
}

TransformNodeInfo

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


CallbackObject

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

BuildChangeObject

interface BuildChangeObject {
  changedNodes: boolean[];
}

SourceNodeInfo

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

SourceNodeInfo Documentation

Current Tags

  • 1.7.0                                ...           latest (a year ago)

8 Versions

  • 1.7.0                                ...           a year ago
  • 1.6.0                                ...           a year ago
  • 1.5.0                                ...           a year ago
  • 1.4.0                                ...           a year ago
  • 1.3.0                                ...           a year ago
  • 1.2.0                                ...           a year ago
  • 1.1.0                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
Downloads
Today 4
This Week 33
This Month 135
Last Day 10
Last Week 36
Last Month 195
Dependencies (0)
None
Dev Dependencies (0)
None

Copyright 2014 - 2016 © taobao.org |