@minecraft/markup-generators-plugin 1.0.0
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/CHANGELOG.json +26 -0
- package/CHANGELOG.md +14 -0
- package/README.md +17 -0
- package/lib/generators/ChangelogJSONGenerator.d.ts +7 -0
- package/lib/generators/ChangelogJSONGenerator.js +46 -0
- package/lib/generators/ChangelogJSONGenerator.js.map +1 -0
- package/lib/generators/ChangelogMDGenerator.d.ts +9 -0
- package/lib/generators/ChangelogMDGenerator.js +54 -0
- package/lib/generators/ChangelogMDGenerator.js.map +1 -0
- package/lib/generators/MSDocsMarkdownGenerator.d.ts +26 -0
- package/lib/generators/MSDocsMarkdownGenerator.js +434 -0
- package/lib/generators/MSDocsMarkdownGenerator.js.map +1 -0
- package/lib/generators/NPMModuleGenerator.d.ts +10 -0
- package/lib/generators/NPMModuleGenerator.js +176 -0
- package/lib/generators/NPMModuleGenerator.js.map +1 -0
- package/lib/generators/TypeDocGenerator.d.ts +8 -0
- package/lib/generators/TypeDocGenerator.js +123 -0
- package/lib/generators/TypeDocGenerator.js.map +1 -0
- package/lib/generators/TypeScriptDefinitionGenerator.d.ts +9 -0
- package/lib/generators/TypeScriptDefinitionGenerator.js +64 -0
- package/lib/generators/TypeScriptDefinitionGenerator.js.map +1 -0
- package/lib/generators/TypeScriptGenerator.d.ts +10 -0
- package/lib/generators/TypeScriptGenerator.js +128 -0
- package/lib/generators/TypeScriptGenerator.js.map +1 -0
- package/lib/generators/index.d.ts +7 -0
- package/lib/generators/index.js +26 -0
- package/lib/generators/index.js.map +1 -0
- package/lib/index.d.ts +3 -0
- package/lib/index.js +30 -0
- package/lib/index.js.map +1 -0
- package/lib/msdocsGeneratorUnitTests.spec.d.ts +1 -0
- package/lib/msdocsGeneratorUnitTests.spec.js +67 -0
- package/lib/msdocsGeneratorUnitTests.spec.js.map +1 -0
- package/package.json +66 -0
- package/templates/msdocs/blocks/block.mustache +18 -0
- package/templates/msdocs/blocks/block_property.mustache +26 -0
- package/templates/msdocs/blocks/default_metadata.mustache +4 -0
- package/templates/msdocs/commands/command.mustache +52 -0
- package/templates/msdocs/commands/default_metadata.mustache +4 -0
- package/templates/msdocs/commands/enum.mustache +25 -0
- package/templates/msdocs/commands/inline_enum.mustache +15 -0
- package/templates/msdocs/commands/overload.mustache +11 -0
- package/templates/msdocs/commands/parameter.mustache +1 -0
- package/templates/msdocs/commands/summary.mustache +21 -0
- package/templates/msdocs/commands/toc.mustache +6 -0
- package/templates/msdocs/script/class.mustache +162 -0
- package/templates/msdocs/script/default_metadata.mustache +5 -0
- package/templates/msdocs/script/enum.mustache +39 -0
- package/templates/msdocs/script/examples.mustache +15 -0
- package/templates/msdocs/script/function.mustache +95 -0
- package/templates/msdocs/script/module.mustache +139 -0
- package/templates/msdocs/script/module_changelog.mustache +235 -0
- package/templates/msdocs/script/property.mustache +81 -0
- package/templates/msdocs/script/property_declaration.mustache +6 -0
- package/templates/msdocs/script/toc.mustache +24 -0
- package/templates/msdocs/script/type_alias.mustache +56 -0
- package/templates/msdocs/script/type_with_links.mustache +1 -0
- package/templates/msdocs/script/value.mustache +1 -0
- package/templates/npm/README.md.mustache +13 -0
- package/templates/npm/package.json.mustache +30 -0
- package/templates/npm/vanilla-data/README.md +3 -0
- package/templates/npm/vanilla-data/bundle.js.mustache +10 -0
- package/templates/npm/vanilla-data/data-package.json.mustache +22 -0
- package/templates/npm/vanilla-data/index.ts.mustache +3 -0
- package/templates/npm/vanilla-data/template.npmignore +1 -0
- package/templates/npm/vanilla-data/tsconfig.json +18 -0
- package/templates/ts/data_items_enum.mustache +13 -0
- package/templates/ts/module.mustache +5 -0
- package/templates/ts/module_header.mustache +9 -0
- package/templates/ts/state_mapping.mustache +50 -0
- package/templates/tsdef/class.mustache +86 -0
- package/templates/tsdef/enum.mustache +32 -0
- package/templates/tsdef/examples.mustache +10 -0
- package/templates/tsdef/function.mustache +98 -0
- package/templates/tsdef/function_argument_declaration.mustache +1 -0
- package/templates/tsdef/function_declaration.mustache +1 -0
- package/templates/tsdef/module.mustache +63 -0
- package/templates/tsdef/module_header.mustache +8 -0
- package/templates/tsdef/property.mustache +99 -0
- package/templates/tsdef/property_declaration.mustache +1 -0
- package/templates/tsdef/type.mustache +1 -0
- package/templates/tsdef/type_alias.mustache +37 -0
- package/templates/tsdef/value.mustache +1 -0
- package/templates/txt/md_changelog.mustache +247 -0
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
{{#stable_only}}
|
|
2
|
+
::: moniker range="=minecraft-bedrock-stable"
|
|
3
|
+
{{/stable_only}}
|
|
4
|
+
{{#is_prerelease}}
|
|
5
|
+
::: moniker range="=minecraft-bedrock-experimental"
|
|
6
|
+
{{/is_prerelease}}
|
|
7
|
+
### **{{{name}}}**
|
|
8
|
+
`
|
|
9
|
+
{{> function_declaration}}
|
|
10
|
+
|
|
11
|
+
`
|
|
12
|
+
{{#function_description_md}}
|
|
13
|
+
|
|
14
|
+
{{{.}}}
|
|
15
|
+
{{/function_description_md}}
|
|
16
|
+
{{#arguments.length}}
|
|
17
|
+
|
|
18
|
+
#### **Parameters**
|
|
19
|
+
{{#arguments}}
|
|
20
|
+
- **{{{name}}}**{{#type}}{{#is_optional}}?{{/is_optional}}: {{> type_with_links}}{{/type}}{{#details.default_value}} = `{{> value}}`{{/details.default_value}}
|
|
21
|
+
{{#details.supported_values.length}}
|
|
22
|
+
|
|
23
|
+
Supported values: [{{#details.supported_values}}{{> value}}{{^is_last}}, {{/is_last}}{{/details.supported_values}}]
|
|
24
|
+
{{/details.supported_values.length}}
|
|
25
|
+
{{#argument_description_md}}
|
|
26
|
+
|
|
27
|
+
{{{.}}}
|
|
28
|
+
{{/argument_description_md}}
|
|
29
|
+
{{/arguments}}
|
|
30
|
+
{{/arguments.length}}
|
|
31
|
+
{{#return_type}}
|
|
32
|
+
{{^is_undefined}}
|
|
33
|
+
|
|
34
|
+
**Returns** {{> type_with_links}}{{#is_optional}} | *undefined*{{/is_optional}}{{#returns_description_md}} - {{{returns_description_md}}}{{/returns_description_md}}
|
|
35
|
+
{{/is_undefined}}
|
|
36
|
+
{{#is_prerelease}}
|
|
37
|
+
|
|
38
|
+
> [!CAUTION]
|
|
39
|
+
> This function is still in pre-release. Its signature may change or it may be removed in future releases.
|
|
40
|
+
{{/is_prerelease}}
|
|
41
|
+
{{#is_deprecated}}
|
|
42
|
+
|
|
43
|
+
> [!CAUTION]
|
|
44
|
+
> This function is deprecated and will be removed in {{{deprecated_version}}}.
|
|
45
|
+
{{#deprecated_description_md}}
|
|
46
|
+
>
|
|
47
|
+
> {{{.}}}
|
|
48
|
+
{{/deprecated_description_md}}
|
|
49
|
+
{{/is_deprecated}}
|
|
50
|
+
{{#has_runtime_conditions}}
|
|
51
|
+
|
|
52
|
+
#### Required Experiments
|
|
53
|
+
{{#runtime_conditions}}
|
|
54
|
+
- {{.}}
|
|
55
|
+
{{/runtime_conditions}}
|
|
56
|
+
|
|
57
|
+
{{/has_runtime_conditions}}
|
|
58
|
+
{{#msdocs_has_comments}}
|
|
59
|
+
|
|
60
|
+
Notes:
|
|
61
|
+
{{#call_disallowed_in_read_only}}
|
|
62
|
+
- This function can't be called in read-only mode.
|
|
63
|
+
{{/call_disallowed_in_read_only}}
|
|
64
|
+
{{#call_allowed_in_early_execution}}
|
|
65
|
+
- This function can be called in early-execution mode.
|
|
66
|
+
{{/call_allowed_in_early_execution}}
|
|
67
|
+
{{#error_types.length}}
|
|
68
|
+
- This function can throw errors.
|
|
69
|
+
- Throws {{#error_types}}{{> type_with_links}}{{^is_last}}, {{/is_last}}{{/error_types}}
|
|
70
|
+
{{/error_types.length}}
|
|
71
|
+
{{^error_types.length}}
|
|
72
|
+
{{#throws_description_md.length}}
|
|
73
|
+
- This function can throw errors.
|
|
74
|
+
{{#throws_description_md}}
|
|
75
|
+
- {{{.}}}
|
|
76
|
+
{{/throws_description_md}}
|
|
77
|
+
{{/throws_description_md.length}}
|
|
78
|
+
{{^throws_description_md.length}}
|
|
79
|
+
{{#is_errorable}}
|
|
80
|
+
- This function can throw errors.
|
|
81
|
+
{{/is_errorable}}
|
|
82
|
+
{{/throws_description_md.length}}
|
|
83
|
+
{{/error_types.length}}
|
|
84
|
+
{{/msdocs_has_comments}}
|
|
85
|
+
{{/return_type}}
|
|
86
|
+
{{#examples.length}}
|
|
87
|
+
|
|
88
|
+
{{> examples}}
|
|
89
|
+
{{/examples.length}}
|
|
90
|
+
{{#is_prerelease}}
|
|
91
|
+
::: moniker-end
|
|
92
|
+
{{/is_prerelease}}
|
|
93
|
+
{{#stable_only}}
|
|
94
|
+
::: moniker-end
|
|
95
|
+
{{/stable_only}}
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
---
|
|
2
|
+
{{ >default_metadata }}
|
|
3
|
+
title: {{{filepath_name}}} Module
|
|
4
|
+
description: Contents of the {{{name}}} module{{#from_module.prior_version}} (Version {{.}}){{/from_module.prior_version}}
|
|
5
|
+
{{#is_prerelease}}
|
|
6
|
+
monikerRange: "=minecraft-bedrock-experimental"
|
|
7
|
+
{{/is_prerelease}}
|
|
8
|
+
---
|
|
9
|
+
# `{{{name}}}` Module{{#from_module.prior_version}} (Version {{.}}){{/from_module.prior_version}}
|
|
10
|
+
{{#module_description_md}}
|
|
11
|
+
|
|
12
|
+
{{{.}}}
|
|
13
|
+
{{/module_description_md}}
|
|
14
|
+
{{#show_prior_warning}}
|
|
15
|
+
|
|
16
|
+
> [!IMPORTANT]
|
|
17
|
+
> This documentation is for an older version of this module.{{#prior_link}} Go to the latest documentation [*here*]({{{.}}}).{{/prior_link}}
|
|
18
|
+
{{/show_prior_warning}}
|
|
19
|
+
{{#is_prerelease}}
|
|
20
|
+
|
|
21
|
+
> [!CAUTION]
|
|
22
|
+
> This module is still in pre-release. It may change or it may be removed in future releases.
|
|
23
|
+
{{/is_prerelease}}
|
|
24
|
+
{{#display_changelog_in_toc}}{{#changelog.length}}
|
|
25
|
+
|
|
26
|
+
## [Changelog](changelog.md)
|
|
27
|
+
{{/changelog.length}}{{/display_changelog_in_toc}}
|
|
28
|
+
{{#examples.length}}
|
|
29
|
+
|
|
30
|
+
{{> examples}}
|
|
31
|
+
{{/examples.length}}
|
|
32
|
+
|
|
33
|
+
## Manifest Details
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"module_name": "{{{name}}}",
|
|
37
|
+
"version": "{{{manifest_example_version_md}}}"
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
{{#available_module_versions.length}}
|
|
41
|
+
{{#is_latest_major}}
|
|
42
|
+
This is version {{{major_version}}}.x.x of this module, which is the latest as of version {{{minecraft_version}}} of Minecraft.
|
|
43
|
+
{{/is_latest_major}}
|
|
44
|
+
|
|
45
|
+
## Available Versions
|
|
46
|
+
{{#available_module_versions}}
|
|
47
|
+
- `{{{.}}}`
|
|
48
|
+
{{/available_module_versions}}
|
|
49
|
+
{{/available_module_versions.length}}
|
|
50
|
+
{{#previous_module_version_chunks.length}}
|
|
51
|
+
|
|
52
|
+
### Prior Versions
|
|
53
|
+
|
|
54
|
+
{{#previous_module_version_chunks}}
|
|
55
|
+
The following API versions are from a major version that is documented here: {{{prior_version_link}}}:
|
|
56
|
+
{{#versions}}
|
|
57
|
+
- `{{{.}}}`
|
|
58
|
+
{{/versions}}
|
|
59
|
+
|
|
60
|
+
{{/previous_module_version_chunks}}
|
|
61
|
+
{{/previous_module_version_chunks.length}}
|
|
62
|
+
{{#enums.length}}
|
|
63
|
+
|
|
64
|
+
## Enumerations
|
|
65
|
+
{{#enums}}
|
|
66
|
+
- [{{enum_name}}]({{enum_name}}.md)
|
|
67
|
+
{{/enums}}
|
|
68
|
+
{{/enums.length}}
|
|
69
|
+
{{#type_aliases.length}}
|
|
70
|
+
|
|
71
|
+
# Type Aliases
|
|
72
|
+
{{#type_aliases}}
|
|
73
|
+
- [{{{name}}}]({{{name}}}.md)
|
|
74
|
+
{{/type_aliases}}
|
|
75
|
+
{{/type_aliases.length}}
|
|
76
|
+
{{#classes.length}}
|
|
77
|
+
|
|
78
|
+
## Classes
|
|
79
|
+
{{#classes}}
|
|
80
|
+
- [{{{name}}}]({{{name}}}.md)
|
|
81
|
+
{{/classes}}
|
|
82
|
+
{{/classes.length}}
|
|
83
|
+
{{#interfaces.length}}
|
|
84
|
+
|
|
85
|
+
## Interfaces
|
|
86
|
+
{{#interfaces}}
|
|
87
|
+
- [{{{name}}}]({{{name}}}.md)
|
|
88
|
+
{{/interfaces}}
|
|
89
|
+
{{/interfaces.length}}
|
|
90
|
+
{{#errors.length}}
|
|
91
|
+
|
|
92
|
+
## Errors
|
|
93
|
+
{{#errors}}
|
|
94
|
+
- [{{{name}}}]({{{name}}}.md)
|
|
95
|
+
{{/errors}}
|
|
96
|
+
{{/errors.length}}
|
|
97
|
+
{{#functions.length}}
|
|
98
|
+
|
|
99
|
+
## Functions
|
|
100
|
+
{{#functions}}
|
|
101
|
+
|
|
102
|
+
{{> function}}
|
|
103
|
+
{{/functions}}
|
|
104
|
+
{{/functions.length}}
|
|
105
|
+
{{#constants.length}}
|
|
106
|
+
|
|
107
|
+
## Constants
|
|
108
|
+
{{#constants}}
|
|
109
|
+
|
|
110
|
+
{{> property}}
|
|
111
|
+
{{/constants}}
|
|
112
|
+
{{/constants.length}}
|
|
113
|
+
{{#objects.length}}
|
|
114
|
+
|
|
115
|
+
## Objects
|
|
116
|
+
{{#objects}}
|
|
117
|
+
|
|
118
|
+
{{> property}}
|
|
119
|
+
{{/objects}}
|
|
120
|
+
{{/objects.length}}
|
|
121
|
+
{{#dependencies.length}}
|
|
122
|
+
|
|
123
|
+
## Dependencies
|
|
124
|
+
{{#dependencies}}
|
|
125
|
+
- [`{{{name}}}`](../../../{{{from_module.folder_path}}}/{{{filepath_name}}}/{{{bookmark_name}}}.md)
|
|
126
|
+
{{/dependencies}}
|
|
127
|
+
{{/dependencies.length}}
|
|
128
|
+
{{#peer_dependencies.length}}
|
|
129
|
+
|
|
130
|
+
## Peer Dependencies
|
|
131
|
+
{{#peer_dependencies}}
|
|
132
|
+
{{^is_vanilla_data}}
|
|
133
|
+
- [`{{{name}}}`](../../../{{{from_module.folder_path}}}/{{{filepath_name}}}/{{{bookmark_name}}}.md)
|
|
134
|
+
{{/is_vanilla_data}}
|
|
135
|
+
{{#is_vanilla_data}}
|
|
136
|
+
- `{{{name}}}`
|
|
137
|
+
{{/is_vanilla_data}}
|
|
138
|
+
{{/peer_dependencies}}
|
|
139
|
+
{{/peer_dependencies.length}}
|
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
---
|
|
2
|
+
{{ >default_metadata }}
|
|
3
|
+
title: {{{filepath_name}}} Changelog
|
|
4
|
+
description: Changelog of the `{{{name}}}` module
|
|
5
|
+
---
|
|
6
|
+
# `{{{name}}}` Changelog
|
|
7
|
+
|
|
8
|
+
{{#changelog.length}}
|
|
9
|
+
## Version Changes
|
|
10
|
+
{{#changelog}}
|
|
11
|
+
- [{{{version}}}](#{{{version_bookmark_name}}})
|
|
12
|
+
{{/changelog}}
|
|
13
|
+
|
|
14
|
+
{{#changelog}}
|
|
15
|
+
## {{{version}}}
|
|
16
|
+
{{#$added}}
|
|
17
|
+
#### Added `{{{name}}}` Module
|
|
18
|
+
{{/$added}}
|
|
19
|
+
{{#dependencies}}
|
|
20
|
+
{{#$added}}
|
|
21
|
+
#### Added module dependency *`{{{name}}}`*
|
|
22
|
+
{{/$added}}
|
|
23
|
+
{{#$removed}}
|
|
24
|
+
#### Removed module dependency *`{{{name}}}`*
|
|
25
|
+
{{/$removed}}
|
|
26
|
+
{{#has_changes}}{{^$added}}{{^$removed}}
|
|
27
|
+
{{#versions}}
|
|
28
|
+
{{#$added}}
|
|
29
|
+
#### Added module dependency `{{{name}}}@{{version}}`
|
|
30
|
+
{{/$added}}
|
|
31
|
+
{{#$removed}}
|
|
32
|
+
#### Removed module dependency `{{{name}}}@{{version}}`
|
|
33
|
+
{{/$removed}}
|
|
34
|
+
{{/versions}}
|
|
35
|
+
{{#types_only}}
|
|
36
|
+
{{#$changed}}
|
|
37
|
+
#### Changed module dependency `{{{name}}}` types-only from `{{$old}}` to `{{$new}}`
|
|
38
|
+
{{/$changed}}
|
|
39
|
+
{{/types_only}}
|
|
40
|
+
{{/$removed}}{{/$added}}{{/has_changes}}
|
|
41
|
+
{{/dependencies}}
|
|
42
|
+
{{#peer_dependencies}}
|
|
43
|
+
{{#$added}}
|
|
44
|
+
#### Added module peer dependency *`{{{name}}}`*
|
|
45
|
+
{{/$added}}
|
|
46
|
+
{{#$removed}}
|
|
47
|
+
#### Removed module peer dependency *`{{{name}}}`*
|
|
48
|
+
{{/$removed}}
|
|
49
|
+
{{#has_changes}}{{^$added}}{{^$removed}}
|
|
50
|
+
{{#versions}}
|
|
51
|
+
{{#$added}}
|
|
52
|
+
#### Added module peer dependency `{{{name}}}@{{version}}`
|
|
53
|
+
{{/$added}}
|
|
54
|
+
{{#$removed}}
|
|
55
|
+
#### Removed module peer dependency `{{{name}}}@{{version}}`
|
|
56
|
+
{{/$removed}}
|
|
57
|
+
{{/versions}}
|
|
58
|
+
{{#types_only}}
|
|
59
|
+
{{#$changed}}
|
|
60
|
+
#### Changed module peer dependency `{{{name}}}` types-only from `{{$old}}` to `{{$new}}`
|
|
61
|
+
{{/$changed}}
|
|
62
|
+
{{/types_only}}
|
|
63
|
+
{{/$removed}}{{/$added}}{{/has_changes}}
|
|
64
|
+
{{/peer_dependencies}}
|
|
65
|
+
{{#classes}}
|
|
66
|
+
{{#$added}}
|
|
67
|
+
#### Added *[`{{{name}}}`]({{class_name}}.md)*
|
|
68
|
+
{{/$added}}
|
|
69
|
+
{{#$removed}}
|
|
70
|
+
#### Removed *{{{name}}}*
|
|
71
|
+
{{/$removed}}
|
|
72
|
+
{{#has_changes}}{{^$added}}{{^$removed}}
|
|
73
|
+
#### Changed *[`{{{name}}}`]({{class_name}}.md)*
|
|
74
|
+
{{#base_types}}
|
|
75
|
+
{{#$added}}
|
|
76
|
+
- Added base class {{> type_with_links}}
|
|
77
|
+
{{/$added}}
|
|
78
|
+
{{#$removed}}
|
|
79
|
+
- Removed base class *{{{name}}}*
|
|
80
|
+
{{/$removed}}
|
|
81
|
+
{{/base_types}}
|
|
82
|
+
{{#properties}}
|
|
83
|
+
{{#$added}}
|
|
84
|
+
- Added property *[`{{{name}}}`]({{class_name}}.md#{{bookmark_name}})*
|
|
85
|
+
{{/$added}}
|
|
86
|
+
{{#$removed}}
|
|
87
|
+
- Removed property *{{{name}}}*
|
|
88
|
+
{{/$removed}}
|
|
89
|
+
{{#is_read_only}}
|
|
90
|
+
{{#$changed}}
|
|
91
|
+
- Changed read-only flag for *[`{{{name}}}`]({{class_name}}.md#{{bookmark_name}})* from `{{{$old}}}` to `{{{$new}}}`
|
|
92
|
+
{{/$changed}}
|
|
93
|
+
{{/is_read_only}}
|
|
94
|
+
{{#type}}
|
|
95
|
+
{{#$changed}}
|
|
96
|
+
- Changed type for *[`{{{name}}}`]({{class_name}}.md#{{bookmark_name}})* from {{#$old.type}}{{> type_with_links}}{{#is_errorable}} (throws exceptions){{/is_errorable}}{{/$old.type}} to {{#$new.type}}{{> type_with_links}}{{#is_errorable}} (throws exceptions){{/is_errorable}}{{/$new.type}}
|
|
97
|
+
{{/$changed}}
|
|
98
|
+
{{/type}}
|
|
99
|
+
{{/properties}}
|
|
100
|
+
{{#has_member_constants}}
|
|
101
|
+
{{#constants}}
|
|
102
|
+
{{#$added}}
|
|
103
|
+
- Added constant *[`{{{name}}}`]({{class_name}}.md#{{bookmark_name}})*
|
|
104
|
+
{{/$added}}
|
|
105
|
+
{{#$removed}}
|
|
106
|
+
- Removed constant *{{{name}}}*
|
|
107
|
+
{{/$removed}}
|
|
108
|
+
{{#value}}{{^$added}}{{^$removed}}
|
|
109
|
+
{{#$changed}}
|
|
110
|
+
- Changed constant *[`{{{name}}}`]({{class_name}}.md#{{bookmark_name}})* from `{{{$old}}}` to `{{{$new}}}`
|
|
111
|
+
{{/$changed}}
|
|
112
|
+
{{/$removed}}{{/$added}}{{/value}}
|
|
113
|
+
{{/constants}}
|
|
114
|
+
{{/has_member_constants}}
|
|
115
|
+
{{#has_member_functions}}
|
|
116
|
+
{{#functions}}
|
|
117
|
+
{{#$added}}
|
|
118
|
+
- Added function *[`{{{name}}}`]({{class_name}}.md#{{bookmark_name}})*
|
|
119
|
+
{{/$added}}
|
|
120
|
+
{{#$removed}}
|
|
121
|
+
- Removed function *{{{name}}}*
|
|
122
|
+
{{/$removed}}
|
|
123
|
+
{{#has_changes}}{{^$added}}{{^$removed}}
|
|
124
|
+
- Changed function *[`{{{name}}}`]({{class_name}}.md#{{bookmark_name}})*
|
|
125
|
+
{{#return_type}}
|
|
126
|
+
{{#$changed}}
|
|
127
|
+
- Changed return type from {{#$old.return_type}}{{> type_with_links}}{{#is_errorable}} (throws exceptions){{/is_errorable}}{{/$old.return_type}} to {{#$new.return_type}}{{> type_with_links}}{{#is_errorable}} (throws exceptions){{/is_errorable}}{{/$new.return_type}}
|
|
128
|
+
{{/$changed}}
|
|
129
|
+
{{/return_type}}
|
|
130
|
+
{{#arguments}}
|
|
131
|
+
{{#$added}}
|
|
132
|
+
- Added argument `{{{name}}}`
|
|
133
|
+
{{/$added}}
|
|
134
|
+
{{#$removed}}
|
|
135
|
+
- Removed argument `{{{name}}}`
|
|
136
|
+
{{/$removed}}
|
|
137
|
+
{{^$added}}{{^$removed}}
|
|
138
|
+
{{#type}}
|
|
139
|
+
{{#$changed}}
|
|
140
|
+
- Changed argument `{{{name}}}` type from {{#$old.type}}{{> type_with_links}}{{#is_errorable}} (throws exceptions){{/is_errorable}}{{/$old.type}} to {{#$new.type}}{{> type_with_links}}{{#is_errorable}} (throws exceptions){{/is_errorable}}{{/$new.type}}
|
|
141
|
+
{{/$changed}}
|
|
142
|
+
{{/type}}
|
|
143
|
+
{{/$removed}}{{/$added}}
|
|
144
|
+
{{/arguments}}
|
|
145
|
+
{{/$removed}}{{/$added}}{{/has_changes}}
|
|
146
|
+
{{/functions}}
|
|
147
|
+
{{/has_member_functions}}
|
|
148
|
+
{{/$removed}}{{/$added}}{{/has_changes}}
|
|
149
|
+
{{/classes}}
|
|
150
|
+
{{#functions}}
|
|
151
|
+
{{#$added}}
|
|
152
|
+
#### Added function `{{{name}}}`
|
|
153
|
+
{{/$added}}
|
|
154
|
+
{{#$removed}}
|
|
155
|
+
#### Removed function `{{{name}}}`
|
|
156
|
+
{{/$removed}}
|
|
157
|
+
{{#has_changes}}{{^$added}}{{^$removed}}
|
|
158
|
+
#### Changed function `{{{name}}}`
|
|
159
|
+
{{#return_type}}
|
|
160
|
+
{{#$changed}}
|
|
161
|
+
- Changed return type from {{#$old.return_type}}{{> type_with_links}}{{#is_errorable}} (throws exceptions){{/is_errorable}}{{/$old.return_type}} to {{#$new.return_type}}{{> type_with_links}}{{#is_errorable}} (throws exceptions){{/is_errorable}}{{/$new.return_type}}
|
|
162
|
+
{{/$changed}}
|
|
163
|
+
{{/return_type}}
|
|
164
|
+
{{#arguments}}
|
|
165
|
+
{{#$added}}
|
|
166
|
+
- Added argument `{{{name}}}`
|
|
167
|
+
{{/$added}}
|
|
168
|
+
{{#$removed}}
|
|
169
|
+
- Removed argument `{{{name}}}`
|
|
170
|
+
{{/$removed}}
|
|
171
|
+
{{^$added}}{{^$removed}}
|
|
172
|
+
{{#type}}
|
|
173
|
+
{{#$changed}}
|
|
174
|
+
- Changed argument `{{{name}}}` type from {{#$old.type}}{{> type_with_links}}{{/$old.type}} to {{#$new.type}}{{> type_with_links}}{{/$new.type}}
|
|
175
|
+
{{/$changed}}
|
|
176
|
+
{{/type}}
|
|
177
|
+
{{/$removed}}{{/$added}}
|
|
178
|
+
{{/arguments}}
|
|
179
|
+
{{/$removed}}{{/$added}}{{/has_changes}}
|
|
180
|
+
{{/functions}}
|
|
181
|
+
{{#enums}}
|
|
182
|
+
{{#$added}}
|
|
183
|
+
#### Added enum [`{{{name}}}`]({{{name}}}.md)
|
|
184
|
+
{{/$added}}
|
|
185
|
+
{{#$removed}}
|
|
186
|
+
#### Removed enum `{{{name}}}`
|
|
187
|
+
{{/$removed}}
|
|
188
|
+
{{#has_changes}}{{^$added}}{{^$removed}}
|
|
189
|
+
#### Changed enum [`{{{name}}}`]({{{name}}}.md)
|
|
190
|
+
{{#constants}}
|
|
191
|
+
{{#$added}}
|
|
192
|
+
- Added value `{{{name}}}`
|
|
193
|
+
{{/$added}}
|
|
194
|
+
{{#$removed}}
|
|
195
|
+
- Removed value `{{{name}}}`
|
|
196
|
+
{{/$removed}}
|
|
197
|
+
{{#value}}
|
|
198
|
+
{{#$changed}}
|
|
199
|
+
- Changed value `{{{name}}}` from `{{{$old}}}` to `{{{$new}}}`
|
|
200
|
+
{{/$changed}}
|
|
201
|
+
{{/value}}
|
|
202
|
+
{{/constants}}
|
|
203
|
+
{{/$removed}}{{/$added}}{{/has_changes}}
|
|
204
|
+
{{/enums}}
|
|
205
|
+
{{#objects}}
|
|
206
|
+
{{#$added}}
|
|
207
|
+
#### Added object `{{{name}}}`
|
|
208
|
+
{{/$added}}
|
|
209
|
+
{{#$removed}}
|
|
210
|
+
#### Removed object `{{{name}}}`
|
|
211
|
+
{{/$removed}}
|
|
212
|
+
{{#type}}
|
|
213
|
+
{{#$changed}}
|
|
214
|
+
#### Changed type for `{{{name}}}` from {{#$old.type}}{{> type_with_links}}{{#is_errorable}} (throws exceptions){{/is_errorable}}{{/$old.type}} to {{#$new.type}}{{> type_with_links}}{{#is_errorable}} (throws exceptions){{/is_errorable}}{{/$new.type}}
|
|
215
|
+
{{/$changed}}
|
|
216
|
+
{{/type}}
|
|
217
|
+
{{/objects}}
|
|
218
|
+
{{#constants}}
|
|
219
|
+
{{#$added}}
|
|
220
|
+
#### Added constant `{{{name}}}`
|
|
221
|
+
{{/$added}}
|
|
222
|
+
{{#$removed}}
|
|
223
|
+
#### Removed constant `{{{name}}}`
|
|
224
|
+
{{/$removed}}
|
|
225
|
+
{{#value}}
|
|
226
|
+
{{#$changed}}
|
|
227
|
+
#### Changed constant `{{{name}}}` value fron `{{{$old}}}` to `{{{$new}}}`
|
|
228
|
+
{{/$changed}}
|
|
229
|
+
{{/value}}
|
|
230
|
+
{{/constants}}
|
|
231
|
+
{{/changelog}}
|
|
232
|
+
{{/changelog.length}}
|
|
233
|
+
{{^changelog.length}}
|
|
234
|
+
No changes available.
|
|
235
|
+
{{/changelog.length}}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
{{#is_prerelease}}
|
|
2
|
+
::: moniker range="=minecraft-bedrock-experimental"
|
|
3
|
+
{{/is_prerelease}}
|
|
4
|
+
{{> property_declaration }}
|
|
5
|
+
|
|
6
|
+
Type: {{#type}}{{> type_with_links}}{{/type}}
|
|
7
|
+
{{#is_prerelease}}
|
|
8
|
+
|
|
9
|
+
> [!CAUTION]
|
|
10
|
+
> This property is still in pre-release. Its signature may change or it may be removed in future releases.
|
|
11
|
+
{{/is_prerelease}}
|
|
12
|
+
{{#is_deprecated}}
|
|
13
|
+
|
|
14
|
+
> [!CAUTION]
|
|
15
|
+
> This property is deprecated and will be removed in {{{deprecated_version}}}.
|
|
16
|
+
{{#deprecated_description_md}}
|
|
17
|
+
>
|
|
18
|
+
> {{{.}}}
|
|
19
|
+
{{/deprecated_description_md}}
|
|
20
|
+
{{/is_deprecated}}
|
|
21
|
+
{{#msdocs_has_comments}}
|
|
22
|
+
|
|
23
|
+
Notes:
|
|
24
|
+
{{#has_defaults}}
|
|
25
|
+
{{#default_value}}
|
|
26
|
+
- This property defaults to `{{> value}}` when undefined.
|
|
27
|
+
{{/default_value}}
|
|
28
|
+
{{/has_defaults}}
|
|
29
|
+
{{#set_disallowed_in_read_only}}
|
|
30
|
+
{{#get_disallowed_in_read_only}}
|
|
31
|
+
- This property can't be used in read-only mode.
|
|
32
|
+
{{/get_disallowed_in_read_only}}
|
|
33
|
+
{{^get_disallowed_in_read_only}}
|
|
34
|
+
- This property can't be edited in read-only mode.
|
|
35
|
+
{{/get_disallowed_in_read_only}}
|
|
36
|
+
{{/set_disallowed_in_read_only}}
|
|
37
|
+
{{^set_disallowed_in_read_only}}
|
|
38
|
+
{{#get_disallowed_in_read_only}}
|
|
39
|
+
- This property can't be read in read-only mode.
|
|
40
|
+
{{/get_disallowed_in_read_only}}
|
|
41
|
+
{{/set_disallowed_in_read_only}}
|
|
42
|
+
{{#set_allowed_in_early_execution}}
|
|
43
|
+
{{#get_allowed_in_early_execution}}
|
|
44
|
+
- This property can be used in early-execution mode.
|
|
45
|
+
{{/get_allowed_in_early_execution}}
|
|
46
|
+
{{^get_allowed_in_early_execution}}
|
|
47
|
+
- This property can be edited in early-execution mode.
|
|
48
|
+
{{/get_allowed_in_early_execution}}
|
|
49
|
+
{{/set_allowed_in_early_execution}}
|
|
50
|
+
{{^set_allowed_in_early_execution}}
|
|
51
|
+
{{#get_allowed_in_early_execution}}
|
|
52
|
+
- This property can be read in early-execution mode.
|
|
53
|
+
{{/get_allowed_in_early_execution}}
|
|
54
|
+
{{/set_allowed_in_early_execution}}
|
|
55
|
+
{{#type}}
|
|
56
|
+
{{#error_types.length}}
|
|
57
|
+
- This property can throw errors when used.
|
|
58
|
+
- Throws {{#error_types}}{{> type_with_links}}{{^is_last}}, {{/is_last}}{{/error_types}}
|
|
59
|
+
{{/error_types.length}}
|
|
60
|
+
{{^error_types.length}}
|
|
61
|
+
{{#throws_description_md.length}}
|
|
62
|
+
- This property can throw errors when used.
|
|
63
|
+
{{#throws_description_md}}
|
|
64
|
+
- {{{.}}}
|
|
65
|
+
{{/throws_description_md}}
|
|
66
|
+
{{/throws_description_md.length}}
|
|
67
|
+
{{^throws_description_md.length}}
|
|
68
|
+
{{#is_errorable}}
|
|
69
|
+
- This property can throw errors when used.
|
|
70
|
+
{{/is_errorable}}
|
|
71
|
+
{{/throws_description_md.length}}
|
|
72
|
+
{{/error_types.length}}
|
|
73
|
+
{{/type}}
|
|
74
|
+
{{/msdocs_has_comments}}
|
|
75
|
+
{{#examples.length}}
|
|
76
|
+
|
|
77
|
+
{{> examples}}
|
|
78
|
+
{{/examples.length}}
|
|
79
|
+
{{#is_prerelease}}
|
|
80
|
+
::: moniker-end
|
|
81
|
+
{{/is_prerelease}}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
### **{{{name}}}**
|
|
2
|
+
`{{^is_enum}}{{#is_static}}static {{/is_static}}{{#is_read_only}}read-only {{/is_read_only}}{{/is_enum}}{{{name}}}{{#constant_value}} = {{#type}}{{> value}}{{/type}}{{/constant_value}}{{^constant_value}}{{#type.is_optional}}?{{/type.is_optional}}: {{#type}}{{> type}}{{/type}}{{/constant_value}}{{^is_enum}};{{/is_enum}}`
|
|
3
|
+
{{#property_description_md}}
|
|
4
|
+
|
|
5
|
+
{{{.}}}
|
|
6
|
+
{{/property_description_md}}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
{{#script_modules}}
|
|
2
|
+
- name: {{{md_toc_name}}}
|
|
3
|
+
items:
|
|
4
|
+
- name: {{{md_toc_name}}}
|
|
5
|
+
href: {{{filepath_name}}}/{{{bookmark_name}}}.md
|
|
6
|
+
{{#display_changelog_in_toc}}
|
|
7
|
+
{{#changelog.length}}
|
|
8
|
+
- name: {{{md_toc_name}}} Changelog
|
|
9
|
+
href: {{{filepath_name}}}/changelog.md
|
|
10
|
+
{{/changelog.length}}
|
|
11
|
+
{{/display_changelog_in_toc}}
|
|
12
|
+
{{#enums}}
|
|
13
|
+
- name: {{{name}}}
|
|
14
|
+
href: {{{from_module.filepath_name}}}/{{{name}}}.md
|
|
15
|
+
{{/enums}}
|
|
16
|
+
{{#classes}}
|
|
17
|
+
- name: {{{name}}}
|
|
18
|
+
href: {{{from_module.filepath_name}}}/{{{name}}}.md
|
|
19
|
+
{{/classes}}
|
|
20
|
+
{{#interfaces}}
|
|
21
|
+
- name: {{{name}}}
|
|
22
|
+
href: {{{from_module.filepath_name}}}/{{{name}}}.md
|
|
23
|
+
{{/interfaces}}
|
|
24
|
+
{{/script_modules}}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
{{ >default_metadata }}
|
|
3
|
+
title: {{{from_module.filepath_name}}}.{{alias_name}} Type Alias
|
|
4
|
+
description: Contents of the {{{from_module.name}}}.{{{name}}} type alias{{#from_module.prior_version}} (Version {{.}}){{/from_module.prior_version}}.
|
|
5
|
+
{{#is_prerelease}}
|
|
6
|
+
monikerRange: "=minecraft-bedrock-experimental"
|
|
7
|
+
{{/is_prerelease}}
|
|
8
|
+
---
|
|
9
|
+
# {{{name}}} Type Alias{{#from_module.prior_version}} (Version {{.}}){{/from_module.prior_version}}
|
|
10
|
+
{{> header}}
|
|
11
|
+
{{#show_prior_warning}}
|
|
12
|
+
|
|
13
|
+
> [!IMPORTANT]
|
|
14
|
+
> This documentation is for an older version of this module.{{#prior_link}} Go to the latest documentation [*here*]({{{.}}}).{{/prior_link}}
|
|
15
|
+
{{/show_prior_warning}}
|
|
16
|
+
{{#is_prerelease}}
|
|
17
|
+
|
|
18
|
+
> [!CAUTION]
|
|
19
|
+
> This alias is still in pre-release. Its signature may change or it may be removed in future releases.
|
|
20
|
+
{{/is_prerelease}}
|
|
21
|
+
{{#is_deprecated}}
|
|
22
|
+
|
|
23
|
+
> [!CAUTION]
|
|
24
|
+
> This alias is deprecated and will be removed in {{{deprecated_version}}}.
|
|
25
|
+
{{#deprecated_description_md}}
|
|
26
|
+
>
|
|
27
|
+
> {{{.}}}
|
|
28
|
+
{{/deprecated_description_md}}
|
|
29
|
+
{{/is_deprecated}}
|
|
30
|
+
{{#alias_description_md}}
|
|
31
|
+
|
|
32
|
+
{{{.}}}
|
|
33
|
+
{{/alias_description_md}}
|
|
34
|
+
|
|
35
|
+
## Declaration
|
|
36
|
+
{{#is_script_generated}}
|
|
37
|
+
`{{{raw_script_text}}}`
|
|
38
|
+
{{/is_script_generated}}
|
|
39
|
+
{{^is_script_generated}}
|
|
40
|
+
{{#is_type_map}}
|
|
41
|
+
```ts
|
|
42
|
+
type {{{alias_name}}} = {
|
|
43
|
+
{{#mappings}}
|
|
44
|
+
'{{{name}}}': {{{value}}};
|
|
45
|
+
{{/mappings}}
|
|
46
|
+
};
|
|
47
|
+
```
|
|
48
|
+
{{/is_type_map}}
|
|
49
|
+
{{^is_type_map}}
|
|
50
|
+
THIS WILL TRIGGER AN ERROR. ONLY TYPE MAP ALIASES SUPPORTED FOR NATIVE METADATA.
|
|
51
|
+
{{/is_type_map}}
|
|
52
|
+
{{/is_script_generated}}
|
|
53
|
+
{{#examples.length}}
|
|
54
|
+
|
|
55
|
+
{{> examples}}
|
|
56
|
+
{{/examples.length}}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{{#is_data_buffer}}{{#data_buffer_type}}[{{> type}}](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/{{> type}}){{/data_buffer_type}}{{/is_data_buffer}}{{^is_data_buffer}}{{#is_generator}}Generator<{{#generator_type}}{{#yield_type}}{{> type_with_links}}{{/yield_type}}, {{#return_type}}{{> type_with_links}}{{/return_type}}, {{#next_type}}{{> type_with_links}}{{/next_type}}{{/generator_type}}>{{/is_generator}}{{^is_generator}}{{#is_map}}Record<{{#key_type}}{{> type_with_links}}{{/key_type}}, {{#value_type}}{{> type_with_links}}{{/value_type}}>{{/is_map}}{{^is_map}}{{#is_iterator_result}}IteratorResult<{{#iterator_type}}{{> type_with_links}}{{/iterator_type}}>{{/is_iterator_result}}{{^is_iterator_result}}{{#is_iterator}}Iterator<{{#iterator_type}}{{> type_with_links}}{{/iterator_type}}>{{/is_iterator}}{{^is_iterator}}{{#is_optional_type}}{{#optional_type}}{{> type_with_links}}{{/optional_type}}{{/is_optional_type}}{{^is_optional_type}}{{#is_variant}}{{#variant_types}}{{> type_with_links}}{{^is_last}} | {{/is_last}}{{/variant_types}}{{/is_variant}}{{^is_variant}}{{#is_promise}}Promise<{{#promise_type}}{{> type_with_links}}{{/promise_type}}>{{/is_promise}}{{^is_promise}}{{#is_array}}{{#element_type}}{{#is_optional_type}}{{#optional_type}}({{/optional_type}}{{/is_optional_type}}{{#is_variant}}({{/is_variant}}{{> type_with_links}}{{#is_optional_type}}{{#optional_type}} | *undefined*){{/optional_type}}{{/is_optional_type}}{{#is_variant}}){{/is_variant}}[]{{/element_type}}{{/is_array}}{{^is_array}}{{#is_undefined}}*void*{{/is_undefined}}{{^is_undefined}}{{#is_closure}}{{#closure_type}}({{#argument_types}}arg{{index}}: {{> type_with_links}}{{^is_last}}, {{/is_last}}{{/argument_types}}) => {{#return_type}}{{#is_variant}}({{/is_variant}}{{> type_with_links}}{{#is_variant}}){{/is_variant}}{{/return_type}}{{/closure_type}}{{^closure_type}}() => void{{/closure_type}}{{/is_closure}}{{^is_closure}}{{#argument_valid_values.length}}{{#argument_valid_values}}`'{{argument_valid_value}}'`{{^argument_valid_value_end}}, {{/argument_valid_value_end}}{{/argument_valid_values}}{{/argument_valid_values.length}}{{^argument_valid_values}}{{#is_bind_type}}[{{/is_bind_type}}*{{#from_module.is_external_module}}{{{from_module.name}}}.{{/from_module.is_external_module}}{{{name}}}*{{#is_bind_type}}]({{#from_module.is_external_module}}../../../{{{from_module.folder_path}}}/{{{from_module.filepath_name}}}/{{/from_module.is_external_module}}{{{name}}}.md){{/is_bind_type}}{{/argument_valid_values}}{{/is_closure}}{{/is_undefined}}{{/is_array}}{{/is_promise}}{{/is_variant}}{{/is_optional_type}}{{/is_iterator}}{{/is_iterator_result}}{{/is_map}}{{/is_generator}}{{/is_data_buffer}}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{{#type.is_string}}"{{/type.is_string}}{{#type.is_array}}[{{#value}}{{{value}}}{{^is_last}}, {{/is_last}}{{/value}}]{{/type.is_array}}{{^type.is_array}}{{{value}}}{{/type.is_array}}{{#type.is_string}}"{{/type.is_string}}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# `{{{name}}}`
|
|
2
|
+
{{#module_description_md}}
|
|
3
|
+
|
|
4
|
+
{{{.}}}
|
|
5
|
+
{{/module_description_md}}
|
|
6
|
+
{{#version_is_prerelease}}
|
|
7
|
+
|
|
8
|
+
## **NOTE: This version of this module is still in pre-release. It may change or it may be removed in future releases.**
|
|
9
|
+
{{/version_is_prerelease}}
|
|
10
|
+
|
|
11
|
+
See full documentation for this module here:
|
|
12
|
+
|
|
13
|
+
https://learn.microsoft.com/en-us/minecraft/creator/{{{from_module.folder_path}}}/{{{filepath_name}}}/{{{bookmark_name}}}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "{{{name}}}",
|
|
3
|
+
"version": "{{{version}}}",
|
|
4
|
+
"description": "{{{description}}}",
|
|
5
|
+
"contributors": [
|
|
6
|
+
{
|
|
7
|
+
"name": "Jake Shirley",
|
|
8
|
+
"email": "jake@xbox.com"
|
|
9
|
+
},
|
|
10
|
+
{
|
|
11
|
+
"name": "Mike Ammerlaan",
|
|
12
|
+
"email": "mikeam@microsoft.com"
|
|
13
|
+
}
|
|
14
|
+
],
|
|
15
|
+
{{#dependencies.length}}
|
|
16
|
+
"dependencies": {
|
|
17
|
+
{{#dependencies}}
|
|
18
|
+
"{{{name}}}": "{{#versions}}{{#version_selector}}{{{.}}}{{/version_selector}}{{{version}}}{{^is_last}} || {{/is_last}}{{/versions}}"{{^is_last}},{{/is_last}}
|
|
19
|
+
{{/dependencies}}
|
|
20
|
+
},
|
|
21
|
+
{{/dependencies.length}}
|
|
22
|
+
{{#peer_dependencies.length}}
|
|
23
|
+
"peerDependencies": {
|
|
24
|
+
{{#peer_dependencies}}
|
|
25
|
+
"{{{name}}}": "{{#versions}}{{#version_selector}}{{{.}}}{{/version_selector}}{{{version}}}{{^is_last}} || {{/is_last}}{{/versions}}"{{^is_last}},{{/is_last}}
|
|
26
|
+
{{/peer_dependencies}}
|
|
27
|
+
},
|
|
28
|
+
{{/peer_dependencies.length}}
|
|
29
|
+
"license": "MIT"
|
|
30
|
+
}
|