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

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 +23 -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.19.80-stable"
22
22
  * }
23
23
  * ```
24
24
  *
@@ -29,8 +29,14 @@
29
29
  * to script; this object is just a placeholder.
30
30
  */
31
31
  export class SecretString {
32
+ /**
33
+ * @remarks
34
+ * This function can't be called in read-only mode.
35
+ *
36
+ */
32
37
  constructor(value: string);
33
38
  }
39
+
34
40
  /**
35
41
  * A collection of server secrets defined in dedicated server
36
42
  * configuration.
@@ -38,7 +44,9 @@ export class SecretString {
38
44
  export class ServerSecrets {
39
45
  protected constructor();
40
46
  /**
47
+ * @remarks
41
48
  * A list of available, configured server secrets.
49
+ *
42
50
  */
43
51
  readonly names: string[];
44
52
  /**
@@ -47,9 +55,13 @@ export class ServerSecrets {
47
55
  * configured in a JSON file. In certain objects, like an
48
56
  * HttpHeader, this Secret is resolved at the time of execution
49
57
  * but is not made available to the script environment.
58
+ *
59
+ * This function can't be called in read-only mode.
60
+ *
50
61
  */
51
62
  get(name: string): SecretString | undefined;
52
63
  }
64
+
53
65
  /**
54
66
  * A collection of server variables defined in dedicated server
55
67
  * configuration.
@@ -57,23 +69,33 @@ export class ServerSecrets {
57
69
  export class ServerVariables {
58
70
  protected constructor();
59
71
  /**
72
+ * @remarks
60
73
  * A list of available, configured server variables.
74
+ *
61
75
  */
62
76
  readonly names: string[];
63
77
  /**
64
78
  * @remarks
65
79
  * Returns the value of variable that has been configured in a
66
80
  * dedicated server configuration JSON file.
81
+ *
82
+ * This function can't be called in read-only mode.
83
+ *
67
84
  */
68
85
  get(name: string): any | undefined;
69
86
  }
87
+
70
88
  /**
89
+ * @remarks
71
90
  * A globally available object that returns a list of
72
91
  * dedicated-server configured secrets.
92
+ *
73
93
  */
74
94
  export const secrets: ServerSecrets;
75
95
  /**
96
+ * @remarks
76
97
  * A globally available object that returns a list of
77
98
  * dedicated-server configured variables.
99
+ *
78
100
  */
79
101
  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.19.80-stable",
4
4
  "description": "",
5
5
  "contributors": [
6
6
  {