@pulumi/pulumi 3.124.0 → 3.124.1-alpha.x47fa329

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.
package/invoke.d.ts CHANGED
@@ -1,4 +1,8 @@
1
1
  import { ProviderResource, Resource } from "./resource";
2
+ /**
3
+ * {@link InvokeOptions} is a bag of options that control the behavior of a call
4
+ * to `runtime.invoke`.
5
+ */
2
6
  export interface InvokeOptions {
3
7
  /**
4
8
  * An optional parent to use for default options for this invoke (e.g. the default provider to use).
@@ -10,8 +14,8 @@ export interface InvokeOptions {
10
14
  */
11
15
  provider?: ProviderResource;
12
16
  /**
13
- * An optional version, corresponding to the version of the provider plugin that should be used when performing this
14
- * invoke.
17
+ * An optional version, corresponding to the version of the provider plugin
18
+ * that should be used when performing this invoke.
15
19
  */
16
20
  version?: string;
17
21
  /**
@@ -1,7 +1,8 @@
1
1
  import { Input, Output } from "../output";
2
2
  /**
3
- * toObject takes an array of T values, and a selector that produces key/value pairs from those inputs,
4
- * and converts this array into an output object with those keys and values.
3
+ * {@link toObject} takes an array of T values, and a selector that produces
4
+ * key/value pairs from those inputs, and converts this array into an output
5
+ * object with those keys and values.
5
6
  *
6
7
  * For instance, given an array as follows
7
8
  *
@@ -16,9 +17,10 @@ export declare function toObject<T, V>(iter: Input<Input<T>[]>, selector: (t: T)
16
17
  [key: string]: V;
17
18
  }>;
18
19
  /**
19
- * groupBy takes an array of T values, and a selector that prduces key/value pairs from those inputs,
20
- * and converts this array into an output object, with those keys, and where each property is an array of values,
21
- * in the case that the same key shows up multiple times in the input.
20
+ * {@link groupBy} takes an array of T values, and a selector that prduces
21
+ * key/value pairs from those inputs, and converts this array into an output
22
+ * object, with those keys, and where each property is an array of values, in
23
+ * the case that the same key shows up multiple times in the input.
22
24
  *
23
25
  * For instance, given an array as follows
24
26
  *
package/iterable/index.js CHANGED
@@ -15,8 +15,9 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  const output_1 = require("../output");
17
17
  /**
18
- * toObject takes an array of T values, and a selector that produces key/value pairs from those inputs,
19
- * and converts this array into an output object with those keys and values.
18
+ * {@link toObject} takes an array of T values, and a selector that produces
19
+ * key/value pairs from those inputs, and converts this array into an output
20
+ * object with those keys and values.
20
21
  *
21
22
  * For instance, given an array as follows
22
23
  *
@@ -44,9 +45,10 @@ function toObject(iter, selector) {
44
45
  }
45
46
  exports.toObject = toObject;
46
47
  /**
47
- * groupBy takes an array of T values, and a selector that prduces key/value pairs from those inputs,
48
- * and converts this array into an output object, with those keys, and where each property is an array of values,
49
- * in the case that the same key shows up multiple times in the input.
48
+ * {@link groupBy} takes an array of T values, and a selector that prduces
49
+ * key/value pairs from those inputs, and converts this array into an output
50
+ * object, with those keys, and where each property is an array of values, in
51
+ * the case that the same key shows up multiple times in the input.
50
52
  *
51
53
  * For instance, given an array as follows
52
54
  *
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../iterable/index.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;AAEjC,sCAA0C;AAE1C;;;;;;;;;;;;GAYG;AACH,SAAgB,QAAQ,CACpB,IAAuB,EACvB,QAAoD;IAEpD,OAAO,eAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACvC,MAAM,KAAK,GAAuC,EAAE,CAAC;QACrD,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE;YACnB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAM,CAAC,CAAC,CAAC,CAAC;SAChC;QACD,OAAO,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;YACvC,MAAM,GAAG,GAAyB,EAAE,CAAC;YACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACpB,GAAG,CAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;aAClC;YACD,OAAO,GAAG,CAAC;QACf,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC;AAjBD,4BAiBC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,OAAO,CACnB,IAAuB,EACvB,QAAoD;IAEpD,OAAO,eAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACvC,MAAM,KAAK,GAAuC,EAAE,CAAC;QACrD,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE;YACnB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAM,CAAC,CAAC,CAAC,CAAC;SAChC;QACD,OAAO,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;YACvC,MAAM,GAAG,GAA2B,EAAE,CAAC;YACvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACpB,IAAI,CAAC,GAAG,GAAG,CAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzB,IAAI,CAAC,CAAC,EAAE;oBACJ,CAAC,GAAG,EAAE,CAAC;oBACP,GAAG,CAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;iBACxB;gBACD,CAAC,CAAC,IAAI,CAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;aACvB;YACD,OAAO,GAAG,CAAC;QACf,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC;AAtBD,0BAsBC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../iterable/index.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;AAEjC,sCAA0C;AAE1C;;;;;;;;;;;;;GAaG;AACH,SAAgB,QAAQ,CACpB,IAAuB,EACvB,QAAoD;IAEpD,OAAO,eAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACvC,MAAM,KAAK,GAAuC,EAAE,CAAC;QACrD,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE;YACnB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAM,CAAC,CAAC,CAAC,CAAC;SAChC;QACD,OAAO,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;YACvC,MAAM,GAAG,GAAyB,EAAE,CAAC;YACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACpB,GAAG,CAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;aAClC;YACD,OAAO,GAAG,CAAC;QACf,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC;AAjBD,4BAiBC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,OAAO,CACnB,IAAuB,EACvB,QAAoD;IAEpD,OAAO,eAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACvC,MAAM,KAAK,GAAuC,EAAE,CAAC;QACrD,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE;YACnB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAM,CAAC,CAAC,CAAC,CAAC;SAChC;QACD,OAAO,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;YACvC,MAAM,GAAG,GAA2B,EAAE,CAAC;YACvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACpB,IAAI,CAAC,GAAG,GAAG,CAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzB,IAAI,CAAC,CAAC,EAAE;oBACJ,CAAC,GAAG,EAAE,CAAC;oBACP,GAAG,CAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;iBACxB;gBACD,CAAC,CAAC,IAAI,CAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;aACvB;YACD,OAAO,GAAG,CAAC;QACf,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC;AAtBD,0BAsBC"}
package/log/index.d.ts CHANGED
@@ -1,21 +1,24 @@
1
1
  import * as resourceTypes from "../resource";
2
2
  /**
3
- * hasErrors returns true if any errors have occurred in the program.
3
+ * Returns true if any errors have occurred in the program.
4
4
  */
5
5
  export declare function hasErrors(): boolean;
6
6
  /**
7
- * debug logs a debug-level message that is generally hidden from end-users.
7
+ * Logs a debug-level message that is generally hidden from end-users.
8
8
  */
9
9
  export declare function debug(msg: string, resource?: resourceTypes.Resource, streamId?: number, ephemeral?: boolean): Promise<void>;
10
10
  /**
11
- * info logs an informational message that is generally printed to stdout during resource operations.
11
+ * Logs an informational message that is generally printed to standard output
12
+ * during resource operations.
12
13
  */
13
14
  export declare function info(msg: string, resource?: resourceTypes.Resource, streamId?: number, ephemeral?: boolean): Promise<void>;
14
15
  /**
15
- * warn logs a warning to indicate that something went wrong, but not catastrophically so.
16
+ * Logs a warning to indicate that something went wrong, but not
17
+ * catastrophically so.
16
18
  */
17
19
  export declare function warn(msg: string, resource?: resourceTypes.Resource, streamId?: number, ephemeral?: boolean): Promise<void>;
18
20
  /**
19
- * error logs a fatal condition. Consider raising an exception after calling error to stop the Pulumi program.
21
+ * Logs a fatal condition. Consider raising an exception after calling error to
22
+ * stop the Pulumi program.
20
23
  */
21
24
  export declare function error(msg: string, resource?: resourceTypes.Resource, streamId?: number, ephemeral?: boolean): Promise<void>;
package/log/index.js CHANGED
@@ -31,14 +31,14 @@ const messageLevels = {
31
31
  [engproto.LogSeverity.ERROR]: "error",
32
32
  };
33
33
  /**
34
- * hasErrors returns true if any errors have occurred in the program.
34
+ * Returns true if any errors have occurred in the program.
35
35
  */
36
36
  function hasErrors() {
37
37
  return state_1.getStore().logErrorCount > 0;
38
38
  }
39
39
  exports.hasErrors = hasErrors;
40
40
  /**
41
- * debug logs a debug-level message that is generally hidden from end-users.
41
+ * Logs a debug-level message that is generally hidden from end-users.
42
42
  */
43
43
  function debug(msg, resource, streamId, ephemeral) {
44
44
  const engine = settings_1.getEngine();
@@ -51,7 +51,8 @@ function debug(msg, resource, streamId, ephemeral) {
51
51
  }
52
52
  exports.debug = debug;
53
53
  /**
54
- * info logs an informational message that is generally printed to stdout during resource operations.
54
+ * Logs an informational message that is generally printed to standard output
55
+ * during resource operations.
55
56
  */
56
57
  function info(msg, resource, streamId, ephemeral) {
57
58
  const engine = settings_1.getEngine();
@@ -65,7 +66,8 @@ function info(msg, resource, streamId, ephemeral) {
65
66
  }
66
67
  exports.info = info;
67
68
  /**
68
- * warn logs a warning to indicate that something went wrong, but not catastrophically so.
69
+ * Logs a warning to indicate that something went wrong, but not
70
+ * catastrophically so.
69
71
  */
70
72
  function warn(msg, resource, streamId, ephemeral) {
71
73
  const engine = settings_1.getEngine();
@@ -79,7 +81,8 @@ function warn(msg, resource, streamId, ephemeral) {
79
81
  }
80
82
  exports.warn = warn;
81
83
  /**
82
- * error logs a fatal condition. Consider raising an exception after calling error to stop the Pulumi program.
84
+ * Logs a fatal condition. Consider raising an exception after calling error to
85
+ * stop the Pulumi program.
83
86
  */
84
87
  function error(msg, resource, streamId, ephemeral) {
85
88
  state_1.getStore().logErrorCount++; // remember the error so we can suppress leaks.
package/log/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../log/index.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;;;;;;;AAKjC,6DAA+C;AAE/C,kDAA8D;AAC9D,4CAA4C;AAE5C,IAAI,OAAO,GAAiB,OAAO,CAAC,OAAO,EAAE,CAAC;AAE9C,MAAM,aAAa,GAAG;IAClB,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO;IACrC,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM;IACnC,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM;IACtC,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO;CACxC,CAAC;AAEF;;GAEG;AACH,SAAgB,SAAS;IACrB,OAAO,gBAAQ,EAAE,CAAC,aAAa,GAAG,CAAC,CAAC;AACxC,CAAC;AAFD,8BAEC;AAED;;GAEG;AACH,SAAgB,KAAK,CAAC,GAAW,EAAE,QAAiC,EAAE,QAAiB,EAAE,SAAmB;IACxG,MAAM,MAAM,GAAG,oBAAS,EAAE,CAAC;IAC3B,IAAI,MAAM,EAAE;QACR,OAAO,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;KACtF;SAAM;QACH,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;KAC5B;AACL,CAAC;AAPD,sBAOC;AAED;;GAEG;AACH,SAAgB,IAAI,CAAC,GAAW,EAAE,QAAiC,EAAE,QAAiB,EAAE,SAAmB;IACvG,MAAM,MAAM,GAAG,oBAAS,EAAE,CAAC;IAC3B,IAAI,MAAM,EAAE;QACR,OAAO,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;KACrF;SAAM;QACH,OAAO,CAAC,GAAG,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC;QACtC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;KAC5B;AACL,CAAC;AARD,oBAQC;AAED;;GAEG;AACH,SAAgB,IAAI,CAAC,GAAW,EAAE,QAAiC,EAAE,QAAiB,EAAE,SAAmB;IACvG,MAAM,MAAM,GAAG,oBAAS,EAAE,CAAC;IAC3B,IAAI,MAAM,EAAE;QACR,OAAO,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;KACxF;SAAM;QACH,OAAO,CAAC,IAAI,CAAC,sBAAsB,GAAG,EAAE,CAAC,CAAC;QAC1C,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;KAC5B;AACL,CAAC;AARD,oBAQC;AAED;;GAEG;AACH,SAAgB,KAAK,CAAC,GAAW,EAAE,QAAiC,EAAE,QAAiB,EAAE,SAAmB;IACxG,gBAAQ,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC,+CAA+C;IAE3E,MAAM,MAAM,GAAG,oBAAS,EAAE,CAAC;IAC3B,IAAI,MAAM,EAAE;QACR,OAAO,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;KACtF;SAAM;QACH,OAAO,CAAC,KAAK,CAAC,oBAAoB,GAAG,EAAE,CAAC,CAAC;QACzC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;KAC5B;AACL,CAAC;AAVD,sBAUC;AAED,SAAS,GAAG,CACR,MAA4B,EAC5B,GAAyB,EACzB,GAAW,EACX,QAA4C,EAC5C,QAA4B,EAC5B,SAA8B;IAE9B,4CAA4C;IAC5C,MAAM,SAAS,GAAe,uBAAY,EAAE,CAAC;IAE7C,MAAM,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAE3E,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE;QAC3D,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACzC,IAAI;gBACA,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACtC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBACrB,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;gBACpB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAChB,GAAG,CAAC,WAAW,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;gBACvD,GAAG,CAAC,YAAY,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;gBACrC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE;oBACjB,OAAO,EAAE,CAAC,CAAC,2BAA2B;oBACtC,SAAS,EAAE,CAAC,CAAC,gCAAgC;gBACjD,CAAC,CAAC,CAAC;aACN;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,CAAC,GAAG,CAAC,CAAC;aACf;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACzB,wCAAwC;QACxC,IAAI,GAAG,KAAK,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE;YACpC,wEAAwE;YACxE,OAAO,CAAC,KAAK,CACT,2CAA2C,GAAG,wBAAwB,GAAG,wBAAwB,aAAa,CAAC,GAAG,CAAC,EAAE,CACxH,CAAC;SACL;QACD,6FAA6F;QAC7F,SAAS,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;AACP,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../log/index.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;;;;;;;AAKjC,6DAA+C;AAE/C,kDAA8D;AAC9D,4CAA4C;AAE5C,IAAI,OAAO,GAAiB,OAAO,CAAC,OAAO,EAAE,CAAC;AAE9C,MAAM,aAAa,GAAG;IAClB,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO;IACrC,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM;IACnC,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM;IACtC,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO;CACxC,CAAC;AAEF;;GAEG;AACH,SAAgB,SAAS;IACrB,OAAO,gBAAQ,EAAE,CAAC,aAAa,GAAG,CAAC,CAAC;AACxC,CAAC;AAFD,8BAEC;AAED;;GAEG;AACH,SAAgB,KAAK,CAAC,GAAW,EAAE,QAAiC,EAAE,QAAiB,EAAE,SAAmB;IACxG,MAAM,MAAM,GAAG,oBAAS,EAAE,CAAC;IAC3B,IAAI,MAAM,EAAE;QACR,OAAO,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;KACtF;SAAM;QACH,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;KAC5B;AACL,CAAC;AAPD,sBAOC;AAED;;;GAGG;AACH,SAAgB,IAAI,CAAC,GAAW,EAAE,QAAiC,EAAE,QAAiB,EAAE,SAAmB;IACvG,MAAM,MAAM,GAAG,oBAAS,EAAE,CAAC;IAC3B,IAAI,MAAM,EAAE;QACR,OAAO,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;KACrF;SAAM;QACH,OAAO,CAAC,GAAG,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC;QACtC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;KAC5B;AACL,CAAC;AARD,oBAQC;AAED;;;GAGG;AACH,SAAgB,IAAI,CAAC,GAAW,EAAE,QAAiC,EAAE,QAAiB,EAAE,SAAmB;IACvG,MAAM,MAAM,GAAG,oBAAS,EAAE,CAAC;IAC3B,IAAI,MAAM,EAAE;QACR,OAAO,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;KACxF;SAAM;QACH,OAAO,CAAC,IAAI,CAAC,sBAAsB,GAAG,EAAE,CAAC,CAAC;QAC1C,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;KAC5B;AACL,CAAC;AARD,oBAQC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAC,GAAW,EAAE,QAAiC,EAAE,QAAiB,EAAE,SAAmB;IACxG,gBAAQ,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC,+CAA+C;IAE3E,MAAM,MAAM,GAAG,oBAAS,EAAE,CAAC;IAC3B,IAAI,MAAM,EAAE;QACR,OAAO,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;KACtF;SAAM;QACH,OAAO,CAAC,KAAK,CAAC,oBAAoB,GAAG,EAAE,CAAC,CAAC;QACzC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;KAC5B;AACL,CAAC;AAVD,sBAUC;AAED,SAAS,GAAG,CACR,MAA4B,EAC5B,GAAyB,EACzB,GAAW,EACX,QAA4C,EAC5C,QAA4B,EAC5B,SAA8B;IAE9B,4CAA4C;IAC5C,MAAM,SAAS,GAAe,uBAAY,EAAE,CAAC;IAE7C,MAAM,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAE3E,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE;QAC3D,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACzC,IAAI;gBACA,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACtC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBACrB,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;gBACpB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAChB,GAAG,CAAC,WAAW,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;gBACvD,GAAG,CAAC,YAAY,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;gBACrC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE;oBACjB,OAAO,EAAE,CAAC,CAAC,2BAA2B;oBACtC,SAAS,EAAE,CAAC,CAAC,gCAAgC;gBACjD,CAAC,CAAC,CAAC;aACN;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,CAAC,GAAG,CAAC,CAAC;aACf;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACzB,wCAAwC;QACxC,IAAI,GAAG,KAAK,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE;YACpC,wEAAwE;YACxE,OAAO,CAAC,KAAK,CACT,2CAA2C,GAAG,wBAAwB,GAAG,wBAAwB,aAAa,CAAC,GAAG,CAAC,EAAE,CACxH,CAAC;SACL;QACD,6FAA6F;QAC7F,SAAS,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;AACP,CAAC"}
package/metadata.d.ts CHANGED
@@ -1,12 +1,12 @@
1
1
  /**
2
- * getOrganization returns the current organization name.
2
+ * Returns the current organization name.
3
3
  */
4
4
  export declare function getOrganization(): string;
5
5
  /**
6
- * getProject returns the current project name. It throws an exception if none is registered.
6
+ * Returns the current project name. Throws an exception if none is registered.
7
7
  */
8
8
  export declare function getProject(): string;
9
9
  /**
10
- * getStack returns the current stack name. It throws an exception if none is registered.
10
+ * Returns the current stack name. Throws an exception if none is registered.
11
11
  */
12
12
  export declare function getStack(): string;
package/metadata.js CHANGED
@@ -23,21 +23,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
23
23
  // This file exports metadata about the context in which a program is being run.
24
24
  const settings = __importStar(require("./runtime/settings"));
25
25
  /**
26
- * getOrganization returns the current organization name.
26
+ * Returns the current organization name.
27
27
  */
28
28
  function getOrganization() {
29
29
  return settings.getOrganization();
30
30
  }
31
31
  exports.getOrganization = getOrganization;
32
32
  /**
33
- * getProject returns the current project name. It throws an exception if none is registered.
33
+ * Returns the current project name. Throws an exception if none is registered.
34
34
  */
35
35
  function getProject() {
36
36
  return settings.getProject();
37
37
  }
38
38
  exports.getProject = getProject;
39
39
  /**
40
- * getStack returns the current stack name. It throws an exception if none is registered.
40
+ * Returns the current stack name. Throws an exception if none is registered.
41
41
  */
42
42
  function getStack() {
43
43
  return settings.getStack();
package/output.d.ts CHANGED
@@ -1,7 +1,11 @@
1
1
  import { Resource } from "./resource";
2
2
  /**
3
- * [output] takes any Input value and converts it into an Output, deeply unwrapping nested Input
4
- * values as necessary.
3
+ * @Internal
4
+ */
5
+ export declare function getAllResources<T>(op: OutputInstance<T>): Promise<Set<Resource>>;
6
+ /**
7
+ * {@link output} takes any {@link Input} value and converts it into an
8
+ * {@link Output}, deeply unwrapping nested {@link Input} values as necessary.
5
9
  *
6
10
  * The expected way to use this function is like so:
7
11
  *
@@ -19,21 +23,25 @@ import { Resource } from "./resource";
19
23
  export declare function output<T>(val: Input<T>): Output<Unwrap<T>>;
20
24
  export declare function output<T>(val: Input<T> | undefined): Output<Unwrap<T | undefined>>;
21
25
  /**
22
- * [secret] behaves the same as [output] except the returned output is marked as containing sensitive data.
26
+ * {@link secret} behaves the same as {@link output} except the returned output
27
+ * is marked as containing sensitive data.
23
28
  */
24
29
  export declare function secret<T>(val: Input<T>): Output<Unwrap<T>>;
25
30
  export declare function secret<T>(val: Input<T> | undefined): Output<Unwrap<T | undefined>>;
26
31
  /**
27
- * [unsecret] behaves the same as [output] except the returned output takes the existing output and unwraps the secret
32
+ * {@link unsecret} behaves the same as {@link output} except the returned
33
+ * output takes the existing output and unwraps the secret.
28
34
  */
29
35
  export declare function unsecret<T>(val: Output<T>): Output<T>;
30
36
  /**
31
- * [isSecret] returns `true` if and only if the provided [Output] is a secret.
37
+ * {@link isSecret} returns `true` if and only if the provided {@link Output} is
38
+ * a secret.
32
39
  */
33
40
  export declare function isSecret<T>(val: Output<T>): Promise<boolean>;
34
41
  /**
35
- * Allows for multiple Output objects to be combined into a single Output object. The single Output
36
- * will depend on the union of Resources that the individual dependencies depend on.
42
+ * Allows for multiple {@link Output} objects to be combined into a single
43
+ * {@link Output} object. The single {@link Output} will depend on the union of
44
+ * {@link Resources} that the individual dependencies depend on.
37
45
  *
38
46
  * This can be used in the following manner:
39
47
  *
@@ -44,8 +52,8 @@ export declare function isSecret<T>(val: Output<T>): Promise<boolean>;
44
52
  * var d3: Output<ResultType> = Output.all([d1, d2]).apply(([s, n]) => ...);
45
53
  * ```
46
54
  *
47
- * In this example, taking a dependency on d3 means a resource will depend on all the resources of
48
- * d1 and d2.
55
+ * In this example, taking a dependency on `d3` means a resource will depend on
56
+ * all the resources of `d1` and `d2`.
49
57
  */
50
58
  export declare function all<T>(val: Record<string, Input<T>>): Output<Record<string, Unwrap<T>>>;
51
59
  export declare function all<T1, T2, T3, T4, T5, T6, T7, T8>(values: [Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>]): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>, Unwrap<T7>, Unwrap<T8>]>;
@@ -57,26 +65,29 @@ export declare function all<T1, T2, T3>(values: [Input<T1>, Input<T2>, Input<T3>
57
65
  export declare function all<T1, T2>(values: [Input<T1>, Input<T2>]): Output<[Unwrap<T1>, Unwrap<T2>]>;
58
66
  export declare function all<T>(ds: Input<T>[]): Output<Unwrap<T>[]>;
59
67
  /**
60
- * isUnknown returns true if the given value is unknown.
68
+ * Returns true if the given value is unknown.
61
69
  */
62
70
  export declare function isUnknown(val: any): boolean;
63
71
  /**
64
- * containsUnknowns returns true if the given value is or contains unknown values.
72
+ * Returns true if the given value is or contains unknown values.
65
73
  */
66
74
  export declare function containsUnknowns(value: any): boolean;
67
75
  /**
68
- * [Input] is a property input for a resource. It may be a promptly available T, a promise for one,
69
- * or the output from a existing Resource.
76
+ * {@link Input} is a property input for a resource. It may be a promptly
77
+ * available `T`, a promise for one, or the {@link Output} from a existing
78
+ * {@link Resource}.
70
79
  */
71
80
  export declare type Input<T> = T | Promise<T> | OutputInstance<T>;
72
81
  /**
73
- * [Inputs] is a map of property name to property input, one for each resource property value.
82
+ * {@link Inputs} is a map of property name to property input, one for each
83
+ * resource property value.
74
84
  */
75
85
  export declare type Inputs = Record<string, Input<any>>;
76
86
  /**
77
- * The 'Unwrap' type allows us to express the operation of taking a type, with potentially deeply
78
- * nested Promises and Outputs and to then get that same type with all the Promises and Outputs
79
- * replaced with their wrapped type. Note that this Unwrapping is 'deep'. So if you had:
87
+ * The {@link Unwrap} type allows us to express the operation of taking a type,
88
+ * with potentially deeply nested {@link Promise}s and {@link Output}s and to
89
+ * then get that same type with all the promises and outputs replaced with their
90
+ * wrapped type. Note that this unwrapping is "deep". So if you had:
80
91
  *
81
92
  * `type X = { A: Promise<{ B: Output<{ c: Input<boolean> }> }> }`
82
93
  *
@@ -84,18 +95,20 @@ export declare type Inputs = Record<string, Input<any>>;
84
95
  *
85
96
  * `... = { A: { B: { C: boolean } } }`
86
97
  *
87
- * Unwrapping sees through Promises, Outputs, Arrays and Objects.
98
+ * Unwrapping sees through promises, outputs, arrays and objects.
88
99
  *
89
- * Note: due to TypeScript limitations there are some things that cannot be expressed. Specifically,
90
- * if you had a `Promise<Output<T>>` then the Unwrap type would not be able to undo both of those
91
- * wraps. In practice that should be ok. Values in an object graph should not wrap Outputs in
92
- * Promises. Instead, any code that needs to work Outputs and also be async should either create
93
- * the Output with the Promise (which will collapse into just an Output). Or, it should start with
94
- * an Output and call [apply] on it, passing in an async function. This will also collapse and just
95
- * produce an Output.
100
+ * Note: due to TypeScript limitations there are some things that cannot be
101
+ * expressed. Specifically, if you had a `Promise<Output<T>>` then the {@link
102
+ * Unwrap} type would not be able to undo both of those wraps. In practice that
103
+ * should be OK. Values in an object graph should not wrap outputs in promises.
104
+ * Instead, any code that needs to work Outputs and also be async should either
105
+ * create the output with the promise (which will collapse into just an output).
106
+ * Or, it should start with an output and call `apply` on it, passing in an
107
+ * `async` function. This will also collapse and just produce an output.
96
108
  *
97
- * In other words, this should not be used as the shape of an object: `{ a: Promise<Output<...>> }`.
98
- * It should always either be `{ a: Promise<NonOutput> }` or just `{ a: Output<...> }`.
109
+ * In other words, this should not be used as the shape of an object: `{ a:
110
+ * Promise<Output<...>> }`. It should always either be `{ a: Promise<NonOutput>
111
+ * }` or just `{ a: Output<...> }`.
99
112
  */
100
113
  export declare type Unwrap<T> = T extends Promise<infer U1> ? UnwrapSimple<U1> : T extends OutputInstance<infer U2> ? UnwrapSimple<U2> : UnwrapSimple<T>;
101
114
  declare type primitive = Function | string | number | boolean | undefined | null;
@@ -108,35 +121,40 @@ export declare type UnwrappedObject<T> = {
108
121
  [P in keyof T]: Unwrap<T[P]>;
109
122
  };
110
123
  /**
111
- * Instance side of the [Output<T>] type. Exposes the deployment-time and run-time mechanisms
112
- * for working with the underlying value of an [Output<T>].
124
+ * Instance side of the {@link Output} type. Exposes the deployment-time and
125
+ * run-time mechanisms for working with the underlying value of an {@link Output}.
113
126
  */
114
127
  export interface OutputInstance<T> {
115
128
  /**
116
- * Transforms the data of the output with the provided func. The result remains a
117
- * Output so that dependent resources can be properly tracked.
129
+ * Transforms the data of the output with the provided `func`. The result
130
+ * remains an {@link Output} so that dependent resources can be properly
131
+ * tracked.
118
132
  *
119
- * 'func' is not allowed to make resources.
133
+ * `func` is not allowed to make resources.
120
134
  *
121
- * 'func' can return other Outputs. This can be handy if you have a Output<SomeVal>
122
- * and you want to get a transitive dependency of it. i.e.
135
+ * `func` can return other {@link Output}s. This can be handy if you have an
136
+ * `Output<SomeVal>` and you want to get a transitive dependency of it,
137
+ * i.e.
123
138
  *
124
139
  * ```ts
125
140
  * var d1: Output<SomeVal>;
126
141
  * var d2 = d1.apply(v => v.x.y.OtherOutput); // getting an output off of 'v'.
127
142
  * ```
128
143
  *
129
- * In this example, taking a dependency on d2 means a resource will depend on all the resources
130
- * of d1. It will *also* depend on the resources of v.x.y.OtherDep.
144
+ * In this example, taking a dependency on `d2` means a resource will depend
145
+ * on all the resources of `d1`. It will *also* depend on the resources of
146
+ * `v.x.y.OtherDep`.
131
147
  *
132
- * Importantly, the Resources that d2 feels like it will depend on are the same resources as d1.
133
- * If you need have multiple Outputs and a single Output is needed that combines both
134
- * set of resources, then 'pulumi.all' should be used instead.
148
+ * Importantly, the resources that `d2` feels like it will depend on are the
149
+ * same resources as `d1`. If you need have multiple outputs and a single
150
+ * output is needed that combines both set of resources, then `pulumi.all`
151
+ * should be used instead.
135
152
  *
136
- * This function will be called execution of a 'pulumi up' or 'pulumi preview' request, but it
137
- * will ont run when the values of the output are unknown. It is not
138
- * available for functions that end up executing in the cloud during runtime. To get the value
139
- * of the Output during cloud runtime execution, use `get()`.
153
+ * This function will be called during the execution of a `pulumi up` or
154
+ * `pulumi preview` operation, but it will not run when the values of the
155
+ * output are unknown. It is not available for functions that end up
156
+ * executing in the cloud during runtime. To get the value of the Output
157
+ * during cloud runtime execution, use `get()`.
140
158
  */
141
159
  apply<U>(func: (t: T) => Promise<U>): Output<U>;
142
160
  apply<U>(func: (t: T) => OutputInstance<U>): Output<U>;
@@ -144,17 +162,18 @@ export interface OutputInstance<T> {
144
162
  /**
145
163
  * Retrieves the underlying value of this dependency.
146
164
  *
147
- * This function is only callable in code that runs in the cloud post-deployment. At this
148
- * point all Output values will be known and can be safely retrieved. During pulumi deployment
149
- * or preview execution this must not be called (and will throw). This is because doing so
150
- * would allow Output values to flow into Resources while losing the data that would allow
151
- * the dependency graph to be changed.
165
+ * This function is only callable in code that runs in the cloud
166
+ * post-deployment. At this point all {@link Output} values will be known
167
+ * and can be safely retrieved. During Pulumi deployment or preview
168
+ * execution this must not be called (and will throw). This is because doing
169
+ * so would allow output values to flow into resources while losing the data
170
+ * that would allow the dependency graph to be changed.
152
171
  */
153
172
  get(): T;
154
173
  }
155
174
  /**
156
- * Static side of the [Output<T>] type. Can be used to [create] Outputs as well as test
157
- * arbitrary values to see if they are [Output]s.
175
+ * Static side of the {@link Output} type. Can be used to create outputs as well
176
+ * as test arbitrary values to see if they are {@link Output}s.
158
177
  */
159
178
  export interface OutputConstructor {
160
179
  create<T>(val: Input<T>): Output<Unwrap<T>>;
@@ -162,30 +181,34 @@ export interface OutputConstructor {
162
181
  isInstance<T>(obj: any): obj is Output<T>;
163
182
  }
164
183
  /**
165
- * [Output] helps encode the relationship between Resources in a Pulumi application. Specifically an
166
- * [Output] holds onto a piece of Data and the Resource it was generated from. An [Output] value can
167
- * then be provided when constructing new Resources, allowing that new Resource to know both the
168
- * value as well as the Resource the value came from. This allows for a precise 'Resource
169
- * dependency graph' to be created, which properly tracks the relationship between resources.
170
- *
171
- * An [Output] is used in a Pulumi program differently depending on if the application is executing
172
- * at 'deployment time' (i.e. when actually running the 'pulumi' executable), or at 'run time' (i.e.
173
- * a piece of code running in some Cloud).
174
- *
175
- * At 'deployment time', the correct way to work with the underlying value is to call
176
- * [Output.apply(func)]. This allows the value to be accessed and manipulated, while still
177
- * resulting in an [Output] that is keeping track of [Resource]s appropriately. At deployment time
178
- * the underlying value may or may not exist (for example, if a preview is being performed). In
179
- * this case, the 'func' callback will not be executed, and calling [.apply] will immediately return
180
- * an [Output] that points to the [undefined] value. During a normal [update] though, the 'func'
181
- * callbacks should always be executed.
182
- *
183
- * At 'run time', the correct way to work with the underlying value is to simply call [Output.get]
184
- * which will be promptly return the entire value. This will be a simple JavaScript object that can
185
- * be manipulated as necessary.
186
- *
187
- * To ease with using [Output]s at 'deployment time', pulumi will 'lift' simple data properties of
188
- * an underlying value to the [Output] itself. For example:
184
+ * {@link Output} helps encode the relationship between {@link Resource}s in a
185
+ * Pulumi application. Specifically, an {@link Output} holds onto a piece of
186
+ * data and the resource it was generated from. An output value can then be
187
+ * provided when constructing new resources, allowing that new resource to know
188
+ * both the value as well as the resource the value came from. This allows for
189
+ * a precise resource dependency graph to be created, which properly tracks the
190
+ * relationship between resources.
191
+ *
192
+ * An output is used in a Pulumi program differently depending on if the
193
+ * application is executing at "deployment time" (i.e. when actually running the
194
+ * `pulumi` executable), or at "run time" (i.e. a piece of code running in some
195
+ * cloud).
196
+ *
197
+ * At "deployment time", the correct way to work with the underlying value is to
198
+ * call {@link Output.apply}. This allows the value to be accessed and
199
+ * manipulated, while still resulting in an output that is keeping track of
200
+ * {@link Resource}s appropriately. At deployment time the underlying value may
201
+ * or may not exist (for example, if a preview is being performed). In this
202
+ * case, the `func` callback will not be executed, and calling `.apply` will
203
+ * immediately return an output that points to the `undefined` value. During a
204
+ * normal update though, the `func` callbacks should always be executed.
205
+ *
206
+ * At "run time", the correct way to work with the underlying value is to simply
207
+ * call {@link Output.get} which will be promptly return the entire value. This
208
+ * will be a simple JavaScript object that can be manipulated as necessary.
209
+ *
210
+ * To ease with using outputs at deployment time, Pulumi will "lift" simple data
211
+ * properties of an underlying value to the output itself. For example:
189
212
  *
190
213
  * ```ts
191
214
  * const o: Output<{ name: string, age: number, orders: Order[] }> = ...;
@@ -206,9 +229,10 @@ export interface OutputConstructor {
206
229
  export declare type Output<T> = OutputInstance<T> & Lifted<T>;
207
230
  export declare const Output: OutputConstructor;
208
231
  /**
209
- * The [Lifted] type allows us to express the operation of taking a type, with potentially deeply
210
- * nested objects and arrays and to then get a type with the same properties, except whose property
211
- * types are now [Output]s of the original property type.
232
+ * The {@link Lifted} type allows us to express the operation of taking a type,
233
+ * with potentially deeply nested objects and arrays and to then get a type with
234
+ * the same properties, except whose property types are now {@link Output}s of the
235
+ * original property type.
212
236
  *
213
237
  * For example:
214
238
  *
@@ -219,12 +243,13 @@ export declare const Output: OutputConstructor;
219
243
  *
220
244
  * `... = { A: Output<string>, B: Output<{ C: Output<boolean> }> }`
221
245
  *
222
- * [Lifted] is somewhat the opposite of [Unwrap]. It's primary purpose is to allow an instance of
223
- * [Output<SomeType>] to provide simple access to the properties of [SomeType] directly on the instance
224
- * itself (instead of haveing to use [.apply]).
246
+ * {@link Lifted} is somewhat the opposite of {@link Unwrap}. Its primary
247
+ * purpose is to allow an instance of `Output<SomeType>` to provide simple
248
+ * access to the properties of `SomeType` directly on the instance itself
249
+ * (instead of haveing to use {@link Output.apply}).
225
250
  *
226
- * This lifting only happens through simple pojo objects and arrays. Functions, for example, are not
227
- * lifted. So you cannot do:
251
+ * This lifting only happens through simple objects and arrays. Functions, for
252
+ * example, are not lifted. So you cannot do:
228
253
  *
229
254
  * ```ts
230
255
  * const o: Output<string> = ...;
@@ -254,9 +279,10 @@ export declare type LiftedArray<T> = {
254
279
  readonly [n: number]: Output<T>;
255
280
  };
256
281
  /**
257
- * [concat] takes a sequence of [Inputs], stringifies each, and concatenates all values into one
258
- * final string. Individual inputs can be any sort of [Input] value. i.e. they can be [Promise]s,
259
- * [Output]s, or just plain JavaScript values. This can be used like so:
282
+ * {@link concat} takes a sequence of {@link Input}s, stringifies each one, and
283
+ * concatenates all values into one final string. Individual inputs can be any
284
+ * sort of input value: they can be promises, outputs, or just plain JavaScript
285
+ * values. Use this function like so:
260
286
  *
261
287
  * ```ts
262
288
  * // 'server' and 'loadBalancer' are both resources that expose [Output] properties.
@@ -266,24 +292,26 @@ export declare type LiftedArray<T> = {
266
292
  */
267
293
  export declare function concat(...params: Input<any>[]): Output<string>;
268
294
  /**
269
- * [interpolate] is similar to [concat] but is designed to be used as a tagged template expression.
270
- * i.e.:
295
+ * {@link interpolate} is similar to {@link concat} but is designed to be used
296
+ * as a tagged template expression, e.g.:
271
297
  *
272
298
  * ```ts
273
299
  * // 'server' and 'loadBalancer' are both resources that expose [Output] properties.
274
300
  * let val: Output<string> = pulumi.interpolate `http://${server.hostname}:${loadBalancer.port}`
275
301
  * ```
276
302
  *
277
- * As with [concat] the 'placeholders' between `${}` can be any Inputs. i.e. they can be
278
- * [Promise]s, [Output]s, or just plain JavaScript values.
303
+ * As with {@link concat}, the placeholders between `${}` can be any
304
+ * {@link Input}s: promises, outputs, or just plain JavaScript values.
279
305
  */
280
306
  export declare function interpolate(literals: TemplateStringsArray, ...placeholders: Input<any>[]): Output<string>;
281
307
  /**
282
- * [jsonStringify] Uses JSON.stringify to serialize the given Input value into a JSON string.
308
+ * {@link jsonStringify} uses {@link JSON.stringify} to serialize the given
309
+ * {@link Input} value into a JSON string.
283
310
  */
284
311
  export declare function jsonStringify(obj: Input<any>, replacer?: (this: any, key: string, value: any) => any | (number | string)[], space?: string | number): Output<string>;
285
312
  /**
286
- * [jsonParse] Uses JSON.parse to deserialize the given Input JSON string into a value.
313
+ * {@link jsonParse} Uses {@link JSON.parse} to deserialize the given {@link
314
+ * Input} JSON string into a value.
287
315
  */
288
316
  export declare function jsonParse(text: Input<string>, reviver?: (this: any, key: string, value: any) => any): Output<any>;
289
317
  export {};