@minecraft/server-admin 1.0.0-beta.1.19.80-preview.24 → 1.0.0-beta.1.20.0-preview.21

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.
Files changed (2) hide show
  1. package/index.d.ts +15 -1
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -18,7 +18,7 @@
18
18
  * ```json
19
19
  * {
20
20
  * "module_name": "@minecraft/server-admin",
21
- * "version": "1.0.0-beta.1.19.80-preview.24"
21
+ * "version": "1.0.0-beta.1.20.0-preview.21"
22
22
  * }
23
23
  * ```
24
24
  *
@@ -38,7 +38,9 @@ export class SecretString {
38
38
  export class ServerSecrets {
39
39
  protected constructor();
40
40
  /**
41
+ * @remarks
41
42
  * A list of available, configured server secrets.
43
+ *
42
44
  */
43
45
  readonly names: string[];
44
46
  /**
@@ -47,6 +49,9 @@ export class ServerSecrets {
47
49
  * configured in a JSON file. In certain objects, like an
48
50
  * HttpHeader, this Secret is resolved at the time of execution
49
51
  * but is not made available to the script environment.
52
+ *
53
+ * This function can't be called in read-only mode.
54
+ *
50
55
  */
51
56
  get(name: string): SecretString | undefined;
52
57
  }
@@ -57,23 +62,32 @@ export class ServerSecrets {
57
62
  export class ServerVariables {
58
63
  protected constructor();
59
64
  /**
65
+ * @remarks
60
66
  * A list of available, configured server variables.
67
+ *
61
68
  */
62
69
  readonly names: string[];
63
70
  /**
64
71
  * @remarks
65
72
  * Returns the value of variable that has been configured in a
66
73
  * dedicated server configuration JSON file.
74
+ *
75
+ * This function can't be called in read-only mode.
76
+ *
67
77
  */
68
78
  get(name: string): any | undefined;
69
79
  }
70
80
  /**
81
+ * @remarks
71
82
  * A globally available object that returns a list of
72
83
  * dedicated-server configured secrets.
84
+ *
73
85
  */
74
86
  export const secrets: ServerSecrets;
75
87
  /**
88
+ * @remarks
76
89
  * A globally available object that returns a list of
77
90
  * dedicated-server configured variables.
91
+ *
78
92
  */
79
93
  export const variables: ServerVariables;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@minecraft/server-admin",
3
- "version": "1.0.0-beta.1.19.80-preview.24",
3
+ "version": "1.0.0-beta.1.20.0-preview.21",
4
4
  "description": "",
5
5
  "contributors": [
6
6
  {