@node-red/editor-client 2.2.0 → 2.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -263,6 +263,20 @@ declare class global {
263
263
  static keys(store: string, callback: Function);
264
264
  }
265
265
  declare class env {
266
- /** Get an environment variable value */
267
- static get(name:string);
266
+ /**
267
+ * Get an environment variable value
268
+ *
269
+ * Predefined node-red variables...
270
+ * * `NR_NODE_ID` - the ID of the node
271
+ * * `NR_NODE_NAME` - the Name of the node
272
+ * * `NR_NODE_PATH` - the Path of the node
273
+ * * `NR_GROUP_ID` - the ID of the containing group
274
+ * * `NR_GROUP_NAME` - the Name of the containing group
275
+ * * `NR_FLOW_ID` - the ID of the flow the node is on
276
+ * * `NR_FLOW_NAME` - the Name of the flow the node is on
277
+ * @param name Name of the environment variable to get
278
+ * @example
279
+ * ```const flowName = env.get("NR_FLOW_NAME");```
280
+ */
281
+ static get(name:string) :string;
268
282
  }