diff --git a/common/changes/@typespec/compiler/add-unixtimestamp32_2023-10-17-19-30.json b/common/changes/@typespec/compiler/add-unixtimestamp32_2023-10-17-19-30.json deleted file mode 100644 index c5b621fc64..0000000000 --- a/common/changes/@typespec/compiler/add-unixtimestamp32_2023-10-17-19-30.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Add new `unixTimestamp32` scalar to standard library", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/compiler/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index 5945164bd2..0000000000 --- a/common/changes/@typespec/compiler/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/azhang_namespaceDevDoc_2023-11-07-04-52.json b/common/changes/@typespec/compiler/azhang_namespaceDevDoc_2023-11-07-04-52.json deleted file mode 100644 index 394d0e8de6..0000000000 --- a/common/changes/@typespec/compiler/azhang_namespaceDevDoc_2023-11-07-04-52.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fixing @doc and /** */ disappears from multi-segment or nested namespaces. #2642", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/big-int-decimal-doc_2023-10-26-21-09.json b/common/changes/@typespec/compiler/big-int-decimal-doc_2023-10-26-21-09.json deleted file mode 100644 index 5945164bd2..0000000000 --- a/common/changes/@typespec/compiler/big-int-decimal-doc_2023-10-26-21-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/booleanTrueFix_2023-10-17-22-35.json b/common/changes/@typespec/compiler/booleanTrueFix_2023-10-17-22-35.json deleted file mode 100644 index b62fc76e27..0000000000 --- a/common/changes/@typespec/compiler/booleanTrueFix_2023-10-17-22-35.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix issue where using `@overload` could result in incorrect `unassignable` type errors.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/compiler/circular-ref-fixes_2023-10-23-19-10.json b/common/changes/@typespec/compiler/circular-ref-fixes_2023-10-23-19-10.json deleted file mode 100644 index 5945164bd2..0000000000 --- a/common/changes/@typespec/compiler/circular-ref-fixes_2023-10-23-19-10.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/emitter-framework-circular_2023-10-10-00-25.json b/common/changes/@typespec/compiler/emitter-framework-circular_2023-10-10-00-25.json deleted file mode 100644 index 20e56ebb7e..0000000000 --- a/common/changes/@typespec/compiler/emitter-framework-circular_2023-10-10-00-25.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Add new hook for handling circular references", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-alias-of-alias_2023-11-02-15-32.json b/common/changes/@typespec/compiler/fix-alias-of-alias_2023-11-02-15-32.json deleted file mode 100644 index 5945164bd2..0000000000 --- a/common/changes/@typespec/compiler/fix-alias-of-alias_2023-11-02-15-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-augment-symbol-already-checked_2023-10-25-00-16.json b/common/changes/@typespec/compiler/fix-augment-symbol-already-checked_2023-10-25-00-16.json deleted file mode 100644 index f51e96765d..0000000000 --- a/common/changes/@typespec/compiler/fix-augment-symbol-already-checked_2023-10-25-00-16.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix: Issue where referencing a template in an alias might cause augment decorators to not be applied on types referenced in the aliased type.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-caching-invalid_2023-10-30-22-27.json b/common/changes/@typespec/compiler/fix-caching-invalid_2023-10-30-22-27.json deleted file mode 100644 index 5945164bd2..0000000000 --- a/common/changes/@typespec/compiler/fix-caching-invalid_2023-10-30-22-27.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-default-must-be-last_2023-11-06-22-32.json b/common/changes/@typespec/compiler/fix-default-must-be-last_2023-11-06-22-32.json deleted file mode 100644 index 5945164bd2..0000000000 --- a/common/changes/@typespec/compiler/fix-default-must-be-last_2023-11-06-22-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-rekeyable-map_2023-10-26-19-52.json b/common/changes/@typespec/compiler/fix-rekeyable-map_2023-10-26-19-52.json deleted file mode 100644 index 78fcaa6d25..0000000000 --- a/common/changes/@typespec/compiler/fix-rekeyable-map_2023-10-26-19-52.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "[Internal] Fix: `RekeyableMap` kept track of old value if rekeying to an existing item", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-with-visibility_2023-10-06-00-26.json b/common/changes/@typespec/compiler/fix-with-visibility_2023-10-06-00-26.json deleted file mode 100644 index 0c9934fec3..0000000000 --- a/common/changes/@typespec/compiler/fix-with-visibility_2023-10-06-00-26.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix: Properties filtered with `@withVisibility` will have their visibility removed. This prevent visibility from being applied twice and rendering invalid models", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/compiler/jsonSchema-TupleCrash_2023-10-18-19-59.json b/common/changes/@typespec/compiler/jsonSchema-TupleCrash_2023-10-18-19-59.json deleted file mode 100644 index 0f1b841379..0000000000 --- a/common/changes/@typespec/compiler/jsonSchema-TupleCrash_2023-10-18-19-59.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "`TypeEmitter` now supports Tuples.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/modelSpreadSelfError_2023-10-18-23-19.json b/common/changes/@typespec/compiler/modelSpreadSelfError_2023-10-18-23-19.json deleted file mode 100644 index 488c6690f2..0000000000 --- a/common/changes/@typespec/compiler/modelSpreadSelfError_2023-10-18-23-19.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Issue error if a model spreads itself within its declaration.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/no-code-frame-synthetic_2023-10-11-20-31.json b/common/changes/@typespec/compiler/no-code-frame-synthetic_2023-10-11-20-31.json deleted file mode 100644 index 34c348444b..0000000000 --- a/common/changes/@typespec/compiler/no-code-frame-synthetic_2023-10-11-20-31.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Stop showing empty code frame when diagnostic has no location", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/@typespec/compiler/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index 938f089ce4..0000000000 --- a/common/changes/@typespec/compiler/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/upgrade-deprecation-plugin_2023-11-01-18-24.json b/common/changes/@typespec/compiler/upgrade-deprecation-plugin_2023-11-01-18-24.json deleted file mode 100644 index 5945164bd2..0000000000 --- a/common/changes/@typespec/compiler/upgrade-deprecation-plugin_2023-11-01-18-24.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/upgrade-node18_2023-10-26-17-40.json b/common/changes/@typespec/compiler/upgrade-node18_2023-10-26-17-40.json deleted file mode 100644 index 36b0785b2a..0000000000 --- a/common/changes/@typespec/compiler/upgrade-node18_2023-10-26-17-40.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/eslint-config-typespec/upgrade-deprecation-plugin_2023-11-01-18-11.json b/common/changes/@typespec/eslint-config-typespec/upgrade-deprecation-plugin_2023-11-01-18-11.json deleted file mode 100644 index 84ae8d9473..0000000000 --- a/common/changes/@typespec/eslint-config-typespec/upgrade-deprecation-plugin_2023-11-01-18-11.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/eslint-config-typespec", - "comment": "Upgrade `deprecation` plugin to 2.0.0", - "type": "none" - } - ], - "packageName": "@typespec/eslint-config-typespec" -} \ No newline at end of file diff --git a/common/changes/@typespec/eslint-plugin/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/eslint-plugin/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index fff4fcaf90..0000000000 --- a/common/changes/@typespec/eslint-plugin/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/eslint-plugin", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/eslint-plugin" -} \ No newline at end of file diff --git a/common/changes/@typespec/eslint-plugin/fix-vulnerabilities-2023-10-22_2023-10-23-18-47.json b/common/changes/@typespec/eslint-plugin/fix-vulnerabilities-2023-10-22_2023-10-23-18-47.json deleted file mode 100644 index 331d3798b8..0000000000 --- a/common/changes/@typespec/eslint-plugin/fix-vulnerabilities-2023-10-22_2023-10-23-18-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/eslint-plugin", - "comment": "Update deprecated features preping for eslint 9", - "type": "none" - } - ], - "packageName": "@typespec/eslint-plugin" -} \ No newline at end of file diff --git a/common/changes/@typespec/html-program-viewer/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/html-program-viewer/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index ba2766951c..0000000000 --- a/common/changes/@typespec/html-program-viewer/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/html-program-viewer", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/html-program-viewer" -} \ No newline at end of file diff --git a/common/changes/@typespec/html-program-viewer/fix-default-must-be-last_2023-11-06-22-32.json b/common/changes/@typespec/html-program-viewer/fix-default-must-be-last_2023-11-06-22-32.json deleted file mode 100644 index ba2766951c..0000000000 --- a/common/changes/@typespec/html-program-viewer/fix-default-must-be-last_2023-11-06-22-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/html-program-viewer", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/html-program-viewer" -} \ No newline at end of file diff --git a/common/changes/@typespec/html-program-viewer/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/@typespec/html-program-viewer/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index 7d77d83128..0000000000 --- a/common/changes/@typespec/html-program-viewer/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/html-program-viewer", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "none" - } - ], - "packageName": "@typespec/html-program-viewer" -} \ No newline at end of file diff --git a/common/changes/@typespec/http/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/http/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index e59b9bb12e..0000000000 --- a/common/changes/@typespec/http/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/http" -} \ No newline at end of file diff --git a/common/changes/@typespec/http/fix-default-must-be-last_2023-11-06-22-32.json b/common/changes/@typespec/http/fix-default-must-be-last_2023-11-06-22-32.json deleted file mode 100644 index e59b9bb12e..0000000000 --- a/common/changes/@typespec/http/fix-default-must-be-last_2023-11-06-22-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/http" -} \ No newline at end of file diff --git a/common/changes/@typespec/http/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/@typespec/http/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index 62dd427608..0000000000 --- a/common/changes/@typespec/http/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "none" - } - ], - "packageName": "@typespec/http" -} \ No newline at end of file diff --git a/common/changes/@typespec/http/upgrade-node18_2023-10-26-17-40.json b/common/changes/@typespec/http/upgrade-node18_2023-10-26-17-40.json deleted file mode 100644 index b32ee8fc2f..0000000000 --- a/common/changes/@typespec/http/upgrade-node18_2023-10-26-17-40.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18", - "type": "none" - } - ], - "packageName": "@typespec/http" -} diff --git a/common/changes/@typespec/internal-build-utils/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/internal-build-utils/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index 09d59b43a0..0000000000 --- a/common/changes/@typespec/internal-build-utils/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/internal-build-utils", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/internal-build-utils" -} \ No newline at end of file diff --git a/common/changes/@typespec/internal-build-utils/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/@typespec/internal-build-utils/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index 562c4c4b5e..0000000000 --- a/common/changes/@typespec/internal-build-utils/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/internal-build-utils", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "none" - } - ], - "packageName": "@typespec/internal-build-utils" -} \ No newline at end of file diff --git a/common/changes/@typespec/internal-build-utils/upgrade-node18_2023-10-26-17-40.json b/common/changes/@typespec/internal-build-utils/upgrade-node18_2023-10-26-17-40.json deleted file mode 100644 index b5b7c58002..0000000000 --- a/common/changes/@typespec/internal-build-utils/upgrade-node18_2023-10-26-17-40.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/internal-build-utils", - "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18", - "type": "none" - } - ], - "packageName": "@typespec/internal-build-utils" -} diff --git a/common/changes/@typespec/json-schema/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/json-schema/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index c15d89290f..0000000000 --- a/common/changes/@typespec/json-schema/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/json-schema", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/json-schema" -} \ No newline at end of file diff --git a/common/changes/@typespec/json-schema/jsonSchema-TupleCrash_2023-10-18-19-59.json b/common/changes/@typespec/json-schema/jsonSchema-TupleCrash_2023-10-18-19-59.json deleted file mode 100644 index aa6c6f16ec..0000000000 --- a/common/changes/@typespec/json-schema/jsonSchema-TupleCrash_2023-10-18-19-59.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/json-schema", - "comment": "Add TupleLiteral support.", - "type": "none" - } - ], - "packageName": "@typespec/json-schema" -} \ No newline at end of file diff --git a/common/changes/@typespec/json-schema/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/@typespec/json-schema/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index 2ca0dfbaec..0000000000 --- a/common/changes/@typespec/json-schema/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/json-schema", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "none" - } - ], - "packageName": "@typespec/json-schema" -} \ No newline at end of file diff --git a/common/changes/@typespec/json-schema/upgrade-node18_2023-10-26-17-40.json b/common/changes/@typespec/json-schema/upgrade-node18_2023-10-26-17-40.json deleted file mode 100644 index caa2b1be76..0000000000 --- a/common/changes/@typespec/json-schema/upgrade-node18_2023-10-26-17-40.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/json-schema", - "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18", - "type": "none" - } - ], - "packageName": "@typespec/json-schema" -} diff --git a/common/changes/@typespec/library-linter/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/library-linter/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index f311c1375c..0000000000 --- a/common/changes/@typespec/library-linter/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/library-linter", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/library-linter" -} \ No newline at end of file diff --git a/common/changes/@typespec/library-linter/fix-default-must-be-last_2023-11-06-22-32.json b/common/changes/@typespec/library-linter/fix-default-must-be-last_2023-11-06-22-32.json deleted file mode 100644 index f311c1375c..0000000000 --- a/common/changes/@typespec/library-linter/fix-default-must-be-last_2023-11-06-22-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/library-linter", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/library-linter" -} \ No newline at end of file diff --git a/common/changes/@typespec/library-linter/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/@typespec/library-linter/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index ff21a84e6c..0000000000 --- a/common/changes/@typespec/library-linter/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/library-linter", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "none" - } - ], - "packageName": "@typespec/library-linter" -} \ No newline at end of file diff --git a/common/changes/@typespec/migrate/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/migrate/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index 1dc1455f96..0000000000 --- a/common/changes/@typespec/migrate/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/migrate", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/migrate" -} \ No newline at end of file diff --git a/common/changes/@typespec/migrate/upgrade-node18_2023-10-26-17-40.json b/common/changes/@typespec/migrate/upgrade-node18_2023-10-26-17-40.json deleted file mode 100644 index 54317a3cac..0000000000 --- a/common/changes/@typespec/migrate/upgrade-node18_2023-10-26-17-40.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/migrate", - "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18", - "type": "none" - } - ], - "packageName": "@typespec/migrate" -} diff --git a/common/changes/@typespec/openapi/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/openapi/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index 4697c1be8b..0000000000 --- a/common/changes/@typespec/openapi/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/openapi" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi/fix-default-must-be-last_2023-11-06-22-32.json b/common/changes/@typespec/openapi/fix-default-must-be-last_2023-11-06-22-32.json deleted file mode 100644 index 4697c1be8b..0000000000 --- a/common/changes/@typespec/openapi/fix-default-must-be-last_2023-11-06-22-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/openapi" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/@typespec/openapi/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index 2a75448a42..0000000000 --- a/common/changes/@typespec/openapi/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "none" - } - ], - "packageName": "@typespec/openapi" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi/upgrade-node18_2023-10-26-17-40.json b/common/changes/@typespec/openapi/upgrade-node18_2023-10-26-17-40.json deleted file mode 100644 index 5583184ea2..0000000000 --- a/common/changes/@typespec/openapi/upgrade-node18_2023-10-26-17-40.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi", - "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18", - "type": "none" - } - ], - "packageName": "@typespec/openapi" -} diff --git a/common/changes/@typespec/openapi3/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/openapi3/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index d9a70151de..0000000000 --- a/common/changes/@typespec/openapi3/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/booleanTrueFix_2023-10-17-22-35.json b/common/changes/@typespec/openapi3/booleanTrueFix_2023-10-17-22-35.json deleted file mode 100644 index d9a70151de..0000000000 --- a/common/changes/@typespec/openapi3/booleanTrueFix_2023-10-17-22-35.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/fix-default-must-be-last_2023-11-06-22-32.json b/common/changes/@typespec/openapi3/fix-default-must-be-last_2023-11-06-22-32.json deleted file mode 100644 index d9a70151de..0000000000 --- a/common/changes/@typespec/openapi3/fix-default-must-be-last_2023-11-06-22-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/fix-void-request-body_2023-10-27-17-39.json b/common/changes/@typespec/openapi3/fix-void-request-body_2023-10-27-17-39.json deleted file mode 100644 index a087615581..0000000000 --- a/common/changes/@typespec/openapi3/fix-void-request-body_2023-10-27-17-39.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Fix: Stops emitting an error when using `@body _: void` in operation parameters and treat it as no body.", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/fixSharedRoutes_2023-10-17-16-41.json b/common/changes/@typespec/openapi3/fixSharedRoutes_2023-10-17-16-41.json deleted file mode 100644 index ef10f95181..0000000000 --- a/common/changes/@typespec/openapi3/fixSharedRoutes_2023-10-17-16-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Fix issue where using shared routes would, in some cases, result in a \"duplicate-header\" error.", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/@typespec/openapi3/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index 66a91911f6..0000000000 --- a/common/changes/@typespec/openapi3/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/title_2023-10-20-17-49.json b/common/changes/@typespec/openapi3/title_2023-10-20-17-49.json deleted file mode 100644 index ade2b54b01..0000000000 --- a/common/changes/@typespec/openapi3/title_2023-10-20-17-49.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Support `@summary` on data types which emits the JSON Schema `title` property.", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/upgrade-node18_2023-10-26-17-40.json b/common/changes/@typespec/openapi3/upgrade-node18_2023-10-26-17-40.json deleted file mode 100644 index 8b7e3161ec..0000000000 --- a/common/changes/@typespec/openapi3/upgrade-node18_2023-10-26-17-40.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} diff --git a/common/changes/@typespec/protobuf/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/protobuf/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index 8f48e4e952..0000000000 --- a/common/changes/@typespec/protobuf/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/protobuf", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/protobuf" -} \ No newline at end of file diff --git a/common/changes/@typespec/rest/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/rest/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index 64135d54e3..0000000000 --- a/common/changes/@typespec/rest/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/rest", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/rest" -} \ No newline at end of file diff --git a/common/changes/@typespec/rest/fix-default-must-be-last_2023-11-06-22-32.json b/common/changes/@typespec/rest/fix-default-must-be-last_2023-11-06-22-32.json deleted file mode 100644 index 64135d54e3..0000000000 --- a/common/changes/@typespec/rest/fix-default-must-be-last_2023-11-06-22-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/rest", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/rest" -} \ No newline at end of file diff --git a/common/changes/@typespec/rest/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/@typespec/rest/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index b5006bf791..0000000000 --- a/common/changes/@typespec/rest/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/rest", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "none" - } - ], - "packageName": "@typespec/rest" -} \ No newline at end of file diff --git a/common/changes/@typespec/rest/upgrade-node18_2023-10-26-17-40.json b/common/changes/@typespec/rest/upgrade-node18_2023-10-26-17-40.json deleted file mode 100644 index 298a150a28..0000000000 --- a/common/changes/@typespec/rest/upgrade-node18_2023-10-26-17-40.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/rest", - "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18", - "type": "none" - } - ], - "packageName": "@typespec/rest" -} diff --git a/common/changes/@typespec/versioning/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/@typespec/versioning/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index 3c8fd8571b..0000000000 --- a/common/changes/@typespec/versioning/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/versioning", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/versioning" -} \ No newline at end of file diff --git a/common/changes/@typespec/versioning/fix-default-must-be-last_2023-11-06-22-32.json b/common/changes/@typespec/versioning/fix-default-must-be-last_2023-11-06-22-32.json deleted file mode 100644 index 3c8fd8571b..0000000000 --- a/common/changes/@typespec/versioning/fix-default-must-be-last_2023-11-06-22-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/versioning", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/versioning" -} \ No newline at end of file diff --git a/common/changes/@typespec/versioning/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/@typespec/versioning/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index 6f702ab942..0000000000 --- a/common/changes/@typespec/versioning/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/versioning", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "none" - } - ], - "packageName": "@typespec/versioning" -} \ No newline at end of file diff --git a/common/changes/@typespec/versioning/upgrade-node18_2023-10-26-17-40.json b/common/changes/@typespec/versioning/upgrade-node18_2023-10-26-17-40.json deleted file mode 100644 index bb155509bb..0000000000 --- a/common/changes/@typespec/versioning/upgrade-node18_2023-10-26-17-40.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/versioning", - "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18", - "type": "none" - } - ], - "packageName": "@typespec/versioning" -} diff --git a/common/changes/@typespec/versioning/versioning-narrowTargets_2023-10-17-21-22.json b/common/changes/@typespec/versioning/versioning-narrowTargets_2023-10-17-21-22.json deleted file mode 100644 index 090f6f6544..0000000000 --- a/common/changes/@typespec/versioning/versioning-narrowTargets_2023-10-17-21-22.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/versioning", - "comment": "Update targets for `@added`, `@removed`, `@renamedFrom`, `@madeOptional` and `@typeChangedFrom` to more clearly communicate where they can be used.", - "type": "none" - } - ], - "packageName": "@typespec/versioning" -} \ No newline at end of file diff --git a/common/changes/tmlanguage-generator/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/tmlanguage-generator/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index 529567ecbe..0000000000 --- a/common/changes/tmlanguage-generator/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "tmlanguage-generator", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "patch" - } - ], - "packageName": "tmlanguage-generator" -} \ No newline at end of file diff --git a/common/changes/tmlanguage-generator/upgrade-node18_2023-10-26-17-40.json b/common/changes/tmlanguage-generator/upgrade-node18_2023-10-26-17-40.json deleted file mode 100644 index 6f145d7957..0000000000 --- a/common/changes/tmlanguage-generator/upgrade-node18_2023-10-26-17-40.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "tmlanguage-generator", - "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18", - "type": "minor" - } - ], - "packageName": "tmlanguage-generator" -} diff --git a/common/changes/typespec-vs/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/typespec-vs/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index 815b8bb3a9..0000000000 --- a/common/changes/typespec-vs/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "typespec-vs", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "none" - } - ], - "packageName": "typespec-vs" -} \ No newline at end of file diff --git a/common/changes/typespec-vs/upgrade-node18_2023-10-26-17-40.json b/common/changes/typespec-vs/upgrade-node18_2023-10-26-17-40.json deleted file mode 100644 index 6f0b0847a9..0000000000 --- a/common/changes/typespec-vs/upgrade-node18_2023-10-26-17-40.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "typespec-vs", - "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18", - "type": "none" - } - ], - "packageName": "typespec-vs" -} diff --git a/common/changes/typespec-vscode/alexbat-maxDiffSize_2023-10-19-18-56.json b/common/changes/typespec-vscode/alexbat-maxDiffSize_2023-10-19-18-56.json deleted file mode 100644 index 4ec67f8df3..0000000000 --- a/common/changes/typespec-vscode/alexbat-maxDiffSize_2023-10-19-18-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "typespec-vscode", - "comment": "", - "type": "none" - } - ], - "packageName": "typespec-vscode" -} \ No newline at end of file diff --git a/common/changes/typespec-vscode/pkgjson-cleanup_2023-09-26-19-09.json b/common/changes/typespec-vscode/pkgjson-cleanup_2023-09-26-19-09.json deleted file mode 100644 index 35b85185b0..0000000000 --- a/common/changes/typespec-vscode/pkgjson-cleanup_2023-09-26-19-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "typespec-vscode", - "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files", - "type": "none" - } - ], - "packageName": "typespec-vscode" -} \ No newline at end of file diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index 16d4001252..62a2a198db 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -22,13 +22,13 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-plugin-typespec c8: specifier: ~8.0.1 @@ -61,7 +61,7 @@ importers: specifier: ~12.16.0 version: 12.16.0 '@typespec/bundler': - specifier: workspace:~0.1.0-alpha.2 + specifier: workspace:~0.1.0-alpha.3 version: link:../bundler json5: specifier: ^2.2.3 @@ -83,7 +83,7 @@ importers: specifier: ^7.5.2 version: 7.5.4 '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.1 @@ -128,7 +128,7 @@ importers: specifier: ~3.0.1 version: 3.0.2(rollup@3.29.4) '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler picocolors: specifier: ~1.0.0 @@ -150,7 +150,7 @@ importers: specifier: ~17.0.24 version: 17.0.29 '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.1 @@ -244,10 +244,10 @@ importers: specifier: ~17.0.24 version: 17.0.29 '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../internal-build-utils c8: specifier: ~8.0.1 @@ -280,7 +280,7 @@ importers: specifier: ~0.5.21 version: 0.5.21 tmlanguage-generator: - specifier: workspace:~0.4.5 + specifier: workspace:~0.5.0 version: link:../tmlanguage-generator typescript: specifier: ~5.2.2 @@ -341,7 +341,7 @@ importers: specifier: ^6.2.1 version: 6.9.1(eslint@8.52.0)(typescript@5.2.2) '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.1 @@ -399,10 +399,10 @@ importers: specifier: ~18.2.7 version: 18.2.14 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.1 @@ -435,16 +435,16 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-plugin-typespec '@typespec/library-linter': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -499,7 +499,7 @@ importers: specifier: ~17.0.24 version: 17.0.29 '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.1 @@ -539,19 +539,19 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-plugin-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../internal-build-utils '@typespec/library-linter': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -593,10 +593,10 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.1 @@ -629,13 +629,13 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-plugin-typespec c8: specifier: ~8.0.1 @@ -662,7 +662,7 @@ importers: ../../packages/migrate: dependencies: '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/compiler-v0.37': specifier: npm:@cadl-lang/compiler@0.37.0 @@ -708,10 +708,10 @@ importers: specifier: ~17.0.24 version: 17.0.29 '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-plugin-typespec c8: specifier: ~8.0.1 @@ -744,22 +744,22 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../http '@typespec/library-linter': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../library-linter '@typespec/rest': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../rest '@typespec/tspd': specifier: workspace:~0.46.0 @@ -799,31 +799,31 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../http '@typespec/library-linter': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../library-linter '@typespec/openapi': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../openapi '@typespec/rest': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../rest '@typespec/tspd': specifier: workspace:~0.46.0 version: link:../tspd '@typespec/versioning': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../versioning c8: specifier: ~8.0.1 @@ -859,31 +859,31 @@ importers: specifier: ~2.0.217 version: 2.0.221(react@18.2.0) '@typespec/bundler': - specifier: workspace:~0.1.0-alpha.2 + specifier: workspace:~0.1.0-alpha.3 version: link:../bundler '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/html-program-viewer': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../html-program-viewer '@typespec/http': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../http '@typespec/openapi': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../openapi3 '@typespec/protobuf': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../protobuf '@typespec/rest': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../rest '@typespec/versioning': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../versioning debounce: specifier: ~1.2.1 @@ -950,7 +950,7 @@ importers: specifier: ^4.18.0 version: 4.18.2 '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@vitejs/plugin-react': specifier: ~4.1.0 @@ -1004,34 +1004,34 @@ importers: specifier: ^11.11.1 version: 11.11.1(@types/react@18.2.34)(react@18.2.0) '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/html-program-viewer': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../html-program-viewer '@typespec/http': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../http '@typespec/json-schema': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../json-schema '@typespec/openapi': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../openapi3 '@typespec/playground': - specifier: workspace:~0.1.0-alpha.2 + specifier: workspace:~0.1.0-alpha.3 version: link:../playground '@typespec/protobuf': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../protobuf '@typespec/rest': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../rest '@typespec/versioning': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../versioning es-module-shims: specifier: ~1.8.0 @@ -1071,7 +1071,7 @@ importers: specifier: ^4.18.0 version: 4.18.2 '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@vitejs/plugin-react': specifier: ~4.1.0 @@ -1126,10 +1126,10 @@ importers: specifier: ~5.0.2 version: 5.0.5(rollup@3.29.4) '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/internal-build-utils': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../internal-build-utils mocha: specifier: ~10.2.0 @@ -1159,13 +1159,13 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-plugin-typespec '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1198,19 +1198,19 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../http '@typespec/library-linter': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1243,28 +1243,28 @@ importers: specifier: workspace:~0.45.0 version: link:../best-practices '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/html-program-viewer': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../html-program-viewer '@typespec/http': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../http '@typespec/json-schema': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../json-schema '@typespec/openapi': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../openapi3 '@typespec/rest': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../rest '@typespec/versioning': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../versioning devDependencies: '@types/mocha': @@ -1274,10 +1274,10 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../internal-build-utils autorest: specifier: ~3.3.2 @@ -1304,7 +1304,7 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/internal-build-utils': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../internal-build-utils ecmarkup: specifier: ~12.0.3 @@ -1326,7 +1326,7 @@ importers: specifier: ~3.0.2 version: 3.0.4 '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec eslint: specifier: ^8.49.0 @@ -1341,7 +1341,7 @@ importers: ../../packages/tspd: dependencies: '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler picocolors: specifier: ~1.0.0 @@ -1366,10 +1366,10 @@ importers: specifier: ~17.0.24 version: 17.0.29 '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/prettier-plugin-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../prettier-plugin-typespec c8: specifier: ~8.0.1 @@ -1405,10 +1405,10 @@ importers: ../../packages/typespec-vs: devDependencies: '@typespec/internal-build-utils': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../internal-build-utils typespec-vscode: - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../typespec-vscode ../../packages/typespec-vscode: @@ -1429,13 +1429,13 @@ importers: specifier: ~1.82.0 version: 1.82.0 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../internal-build-utils '@vscode/vsce': specifier: ~2.21.0 @@ -1477,16 +1477,16 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-plugin-typespec '@typespec/library-linter': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1556,28 +1556,28 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../eslint-config-typespec '@typespec/http': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../http '@typespec/json-schema': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../json-schema '@typespec/openapi': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../openapi3 '@typespec/protobuf': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../protobuf '@typespec/rest': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../rest '@typespec/spec': specifier: workspace:* @@ -1586,7 +1586,7 @@ importers: specifier: workspace:~0.46.0 version: link:../tspd '@typespec/versioning': - specifier: workspace:~0.49.0 + specifier: workspace:~0.50.0 version: link:../versioning dotenv: specifier: ~16.3.1 diff --git a/common/config/rush/version-policies.json b/common/config/rush/version-policies.json index 35bef259f7..c876bfc40e 100644 --- a/common/config/rush/version-policies.json +++ b/common/config/rush/version-policies.json @@ -12,13 +12,13 @@ { "definitionName": "lockStepVersion", "policyName": "typespec", - "version": "0.49.0", + "version": "0.50.0", "nextBump": "minor" }, { "definitionName": "lockStepVersion", "policyName": "playground", - "version": "0.1.0-alpha.2", + "version": "0.1.0-alpha.3", "nextBump": "prerelease" } // { diff --git a/packages/best-practices/package.json b/packages/best-practices/package.json index 974e405cbd..578bfb3fa9 100644 --- a/packages/best-practices/package.json +++ b/packages/best-practices/package.json @@ -39,14 +39,14 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.49.0" + "@typespec/compiler": "workspace:~0.50.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/eslint-plugin": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/eslint-plugin": "workspace:~0.50.0", "eslint": "^8.49.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.1", diff --git a/packages/bundle-uploader/package.json b/packages/bundle-uploader/package.json index 6e6a2ea7bb..bb7732a215 100644 --- a/packages/bundle-uploader/package.json +++ b/packages/bundle-uploader/package.json @@ -39,7 +39,7 @@ "dependencies": { "@azure/identity": "~3.3.2", "@azure/storage-blob": "~12.16.0", - "@typespec/bundler": "workspace:~0.1.0-alpha.2", + "@typespec/bundler": "workspace:~0.1.0-alpha.3", "picocolors": "~1.0.0", "semver": "^7.5.4", "json5": "^2.2.3" @@ -47,7 +47,7 @@ "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", "@types/semver": "^7.5.2", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/bundler/package.json b/packages/bundler/package.json index fecf4a8d6e..c16eda9218 100644 --- a/packages/bundler/package.json +++ b/packages/bundler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/bundler", - "version": "0.1.0-alpha.2", + "version": "0.1.0-alpha.3", "author": "Microsoft Corporation", "description": "Package to bundle a typespec library.", "homepage": "https://microsoft.github.io/typespec", @@ -44,7 +44,7 @@ "!dist/test/**" ], "dependencies": { - "@typespec/compiler": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", "@rollup/plugin-virtual": "~3.0.1", "@rollup/plugin-commonjs": "~25.0.4", "@rollup/plugin-json": "~6.0.0", @@ -58,7 +58,7 @@ "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", "eslint": "^8.49.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.1", diff --git a/packages/compiler/CHANGELOG.json b/packages/compiler/CHANGELOG.json index 3b4aab886b..9d861909fa 100644 --- a/packages/compiler/CHANGELOG.json +++ b/packages/compiler/CHANGELOG.json @@ -1,6 +1,56 @@ { "name": "@typespec/compiler", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/compiler_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "Add new `unixTimestamp32` scalar to standard library" + }, + { + "comment": "Fixing @doc and /** */ disappears from multi-segment or nested namespaces. #2642" + }, + { + "comment": "Fix issue where using `@overload` could result in incorrect `unassignable` type errors." + }, + { + "comment": "Add new hook for handling circular references" + }, + { + "comment": "Fix: Issue where referencing a template in an alias might cause augment decorators to not be applied on types referenced in the aliased type." + }, + { + "comment": "[Internal] Fix: `RekeyableMap` kept track of old value if rekeying to an existing item" + }, + { + "comment": "Fix: Properties filtered with `@withVisibility` will have their visibility removed. This prevent visibility from being applied twice and rendering invalid models" + }, + { + "comment": "`TypeEmitter` now supports Tuples." + }, + { + "comment": "Issue error if a model spreads itself within its declaration." + }, + { + "comment": "Stop showing empty code frame when diagnostic has no location" + }, + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + }, + { + "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18" + } + ], + "dependency": [ + { + "comment": "Updating dependency \"tmlanguage-generator\" from `~0.4.5` to `~0.5.0`" + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/compiler_v0.49.0", diff --git a/packages/compiler/CHANGELOG.md b/packages/compiler/CHANGELOG.md index f55ab7a102..0af78deea5 100644 --- a/packages/compiler/CHANGELOG.md +++ b/packages/compiler/CHANGELOG.md @@ -1,6 +1,24 @@ # Change Log - @typespec/compiler -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- Add new `unixTimestamp32` scalar to standard library +- Fixing @doc and /** */ disappears from multi-segment or nested namespaces. #2642 +- Fix issue where using `@overload` could result in incorrect `unassignable` type errors. +- Add new hook for handling circular references +- Fix: Issue where referencing a template in an alias might cause augment decorators to not be applied on types referenced in the aliased type. +- [Internal] Fix: `RekeyableMap` kept track of old value if rekeying to an existing item +- Fix: Properties filtered with `@withVisibility` will have their visibility removed. This prevent visibility from being applied twice and rendering invalid models +- `TypeEmitter` now supports Tuples. +- Issue error if a model spreads itself within its declaration. +- Stop showing empty code frame when diagnostic has no location +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files +- **BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18 ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/compiler/package.json b/packages/compiler/package.json index 26c6d0cc12..06177110e8 100644 --- a/packages/compiler/package.json +++ b/packages/compiler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/compiler", - "version": "0.49.0", + "version": "0.50.0", "description": "TypeSpec Compiler Preview", "author": "Microsoft Corporation", "license": "MIT", @@ -94,8 +94,8 @@ "@types/prompts": "~2.4.4", "@types/semver": "^7.5.2", "@types/yargs": "~17.0.24", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/internal-build-utils": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/internal-build-utils": "workspace:~0.50.0", "eslint": "^8.49.0", "grammarkdown": "~3.3.2", "mocha": "~10.2.0", @@ -105,7 +105,7 @@ "prettier-plugin-organize-imports": "~3.2.3", "source-map-support": "~0.5.21", "rimraf": "~5.0.1", - "tmlanguage-generator": "workspace:~0.4.5", + "tmlanguage-generator": "workspace:~0.5.0", "typescript": "~5.2.2", "vscode-oniguruma": "~2.0.1", "vscode-textmate": "~9.0.0", diff --git a/packages/eslint-config-typespec/CHANGELOG.json b/packages/eslint-config-typespec/CHANGELOG.json index 77671c05bc..7d86262f2f 100644 --- a/packages/eslint-config-typespec/CHANGELOG.json +++ b/packages/eslint-config-typespec/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/eslint-config-typespec", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/eslint-config-typespec_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "Upgrade `deprecation` plugin to 2.0.0" + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/eslint-config-typespec_v0.49.0", diff --git a/packages/eslint-config-typespec/CHANGELOG.md b/packages/eslint-config-typespec/CHANGELOG.md index 04ec8c0833..f674e85497 100644 --- a/packages/eslint-config-typespec/CHANGELOG.md +++ b/packages/eslint-config-typespec/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/eslint-config-typespec -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- Upgrade `deprecation` plugin to 2.0.0 ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/eslint-config-typespec/package.json b/packages/eslint-config-typespec/package.json index ac835f0ff0..2bcb93dd7b 100644 --- a/packages/eslint-config-typespec/package.json +++ b/packages/eslint-config-typespec/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/eslint-config-typespec", - "version": "0.49.0", + "version": "0.50.0", "description": "ESLint config for typespec packages", "main": "index.js", "repository": { diff --git a/packages/eslint-plugin-typespec/CHANGELOG.json b/packages/eslint-plugin-typespec/CHANGELOG.json index e5932ecd43..21b3e07821 100644 --- a/packages/eslint-plugin-typespec/CHANGELOG.json +++ b/packages/eslint-plugin-typespec/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/eslint-plugin", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/eslint-plugin_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "Update deprecated features preping for eslint 9" + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/eslint-plugin_v0.49.0", diff --git a/packages/eslint-plugin-typespec/CHANGELOG.md b/packages/eslint-plugin-typespec/CHANGELOG.md index 0e0c8c2af3..ea5667a609 100644 --- a/packages/eslint-plugin-typespec/CHANGELOG.md +++ b/packages/eslint-plugin-typespec/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/eslint-plugin -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- Update deprecated features preping for eslint 9 ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/eslint-plugin-typespec/package.json b/packages/eslint-plugin-typespec/package.json index fb99048c50..ae1186bbd5 100644 --- a/packages/eslint-plugin-typespec/package.json +++ b/packages/eslint-plugin-typespec/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/eslint-plugin", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "Eslint plugin providing set of rules to be used in the JS/TS code of TypeSpec libraries", "homepage": "https://microsoft.github.io/typespec", @@ -41,7 +41,7 @@ "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", "@typescript-eslint/parser": "^6.2.1", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/html-program-viewer/CHANGELOG.json b/packages/html-program-viewer/CHANGELOG.json index 836a38129e..bc6ed4aab9 100644 --- a/packages/html-program-viewer/CHANGELOG.json +++ b/packages/html-program-viewer/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/html-program-viewer", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/html-program-viewer_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/html-program-viewer_v0.49.0", diff --git a/packages/html-program-viewer/CHANGELOG.md b/packages/html-program-viewer/CHANGELOG.md index aa215e46de..edf74bc1d6 100644 --- a/packages/html-program-viewer/CHANGELOG.md +++ b/packages/html-program-viewer/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/html-program-viewer -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/html-program-viewer/package.json b/packages/html-program-viewer/package.json index 20bd7cc5bb..5c39d003e5 100644 --- a/packages/html-program-viewer/package.json +++ b/packages/html-program-viewer/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/html-program-viewer", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting an html view of the program.", "homepage": "https://microsoft.github.io/typespec", @@ -47,7 +47,7 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.49.0" + "@typespec/compiler": "workspace:~0.50.0" }, "dependencies": { "prettier": "~3.0.3", @@ -61,8 +61,8 @@ "@types/node": "~18.11.9", "@types/react": "~18.2.22", "@types/react-dom": "~18.2.7", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", "@babel/core": "^7.22.20", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/http/CHANGELOG.json b/packages/http/CHANGELOG.json index 70fa8ce82d..f2de861ae2 100644 --- a/packages/http/CHANGELOG.json +++ b/packages/http/CHANGELOG.json @@ -1,6 +1,21 @@ { "name": "@typespec/http", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/http_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + }, + { + "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18" + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/http_v0.49.0", diff --git a/packages/http/CHANGELOG.md b/packages/http/CHANGELOG.md index 392a1e7679..02b84f2aa5 100644 --- a/packages/http/CHANGELOG.md +++ b/packages/http/CHANGELOG.md @@ -1,6 +1,14 @@ # Change Log - @typespec/http -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files +- **BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18 ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/http/package.json b/packages/http/package.json index dc3e40a07a..644f222b46 100644 --- a/packages/http/package.json +++ b/packages/http/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/http", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "TypeSpec HTTP protocol binding", "homepage": "https://github.com/microsoft/typespec", @@ -49,15 +49,15 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.49.0" + "@typespec/compiler": "workspace:~0.50.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/library-linter": "workspace:~0.49.0", - "@typespec/eslint-plugin": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/library-linter": "workspace:~0.50.0", + "@typespec/eslint-plugin": "workspace:~0.50.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/internal-build-utils/CHANGELOG.json b/packages/internal-build-utils/CHANGELOG.json index 3b6fe73430..1602872224 100644 --- a/packages/internal-build-utils/CHANGELOG.json +++ b/packages/internal-build-utils/CHANGELOG.json @@ -1,6 +1,21 @@ { "name": "@typespec/internal-build-utils", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/internal-build-utils_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + }, + { + "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18" + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/internal-build-utils_v0.49.0", diff --git a/packages/internal-build-utils/CHANGELOG.md b/packages/internal-build-utils/CHANGELOG.md index cd15196657..2b57ca3490 100644 --- a/packages/internal-build-utils/CHANGELOG.md +++ b/packages/internal-build-utils/CHANGELOG.md @@ -1,6 +1,14 @@ # Change Log - @typespec/internal-build-utils -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files +- **BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18 ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/internal-build-utils/package.json b/packages/internal-build-utils/package.json index b5bbf17851..b21ebf77eb 100644 --- a/packages/internal-build-utils/package.json +++ b/packages/internal-build-utils/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/internal-build-utils", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "Internal library to TypeSpec providing helpers to build.", "homepage": "https://microsoft.github.io/typespec", @@ -48,7 +48,7 @@ "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", "@types/yargs": "~17.0.24", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", "@types/semver": "^7.5.2", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/json-schema/CHANGELOG.json b/packages/json-schema/CHANGELOG.json index 84761e5642..c16cda2dad 100644 --- a/packages/json-schema/CHANGELOG.json +++ b/packages/json-schema/CHANGELOG.json @@ -1,6 +1,24 @@ { "name": "@typespec/json-schema", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/json-schema_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "Add TupleLiteral support." + }, + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + }, + { + "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18" + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/json-schema_v0.49.0", diff --git a/packages/json-schema/CHANGELOG.md b/packages/json-schema/CHANGELOG.md index 39ee1f6867..dcf9b9077b 100644 --- a/packages/json-schema/CHANGELOG.md +++ b/packages/json-schema/CHANGELOG.md @@ -1,6 +1,15 @@ # Change Log - @typespec/json-schema -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- Add TupleLiteral support. +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files +- **BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18 ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/json-schema/package.json b/packages/json-schema/package.json index acd2abc170..19e5728891 100644 --- a/packages/json-schema/package.json +++ b/packages/json-schema/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/json-schema", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting TypeSpec to JSON Schema and converting JSON Schema to TypeSpec", "homepage": "https://github.com/microsoft/typespec", @@ -43,15 +43,15 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.49.0" + "@typespec/compiler": "workspace:~0.50.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/library-linter": "workspace:~0.49.0", - "@typespec/eslint-plugin": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/library-linter": "workspace:~0.50.0", + "@typespec/eslint-plugin": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.49.0", "mocha": "~10.2.0", @@ -61,7 +61,7 @@ "rimraf": "~5.0.1", "typescript": "~5.2.2", "ajv": "~8.12.0", - "@typespec/internal-build-utils": "workspace:~0.49.0", + "@typespec/internal-build-utils": "workspace:~0.50.0", "ajv-formats": "~2.1.1" }, "dependencies": { diff --git a/packages/library-linter/CHANGELOG.json b/packages/library-linter/CHANGELOG.json index 69472ac091..2702485bf2 100644 --- a/packages/library-linter/CHANGELOG.json +++ b/packages/library-linter/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/library-linter", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/library-linter_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/library-linter_v0.49.0", diff --git a/packages/library-linter/CHANGELOG.md b/packages/library-linter/CHANGELOG.md index b886727325..ef99bd616a 100644 --- a/packages/library-linter/CHANGELOG.md +++ b/packages/library-linter/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/library-linter -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/library-linter/package.json b/packages/library-linter/package.json index 4e20f1911a..1fa540748e 100644 --- a/packages/library-linter/package.json +++ b/packages/library-linter/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/library-linter", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "TypeSpec library for linting another library.", "homepage": "https://microsoft.github.io/typespec", @@ -47,13 +47,13 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.49.0" + "@typespec/compiler": "workspace:~0.50.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", "eslint": "^8.49.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.1", diff --git a/packages/lint/package.json b/packages/lint/package.json index 556380f6aa..e2b6c31038 100644 --- a/packages/lint/package.json +++ b/packages/lint/package.json @@ -46,14 +46,14 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.49.0" + "@typespec/compiler": "workspace:~0.50.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/eslint-plugin": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/eslint-plugin": "workspace:~0.50.0", "eslint": "^8.49.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.1", diff --git a/packages/migrate/CHANGELOG.json b/packages/migrate/CHANGELOG.json index a1863890da..54195b7a2d 100644 --- a/packages/migrate/CHANGELOG.json +++ b/packages/migrate/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/migrate", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/migrate_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18" + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/migrate_v0.49.0", diff --git a/packages/migrate/CHANGELOG.md b/packages/migrate/CHANGELOG.md index cf0db53752..509993862b 100644 --- a/packages/migrate/CHANGELOG.md +++ b/packages/migrate/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/migrate -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- **BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18 ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/migrate/package.json b/packages/migrate/package.json index 10f02d41c7..cd4e32b5b9 100644 --- a/packages/migrate/package.json +++ b/packages/migrate/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/migrate", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "Migration tool for typespec.", "homepage": "https://microsoft.github.io/typespec", @@ -38,7 +38,7 @@ "!dist/test/**" ], "dependencies": { - "@typespec/compiler": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", "@typespec/compiler-v0.37": "npm:@cadl-lang/compiler@0.37.0", "@typespec/compiler-v0.38": "npm:@cadl-lang/compiler@0.38.5", "@typespec/compiler-v0.40": "npm:@cadl-lang/compiler@0.40.0", @@ -55,9 +55,9 @@ "@types/node": "~18.11.9", "@types/semver": "^7.5.2", "@types/yargs": "~17.0.24", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/eslint-plugin": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/eslint-plugin": "workspace:~0.50.0", "c8": "~8.0.1", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/openapi/CHANGELOG.json b/packages/openapi/CHANGELOG.json index 4afc4cbf3e..bfa0cab6f9 100644 --- a/packages/openapi/CHANGELOG.json +++ b/packages/openapi/CHANGELOG.json @@ -1,6 +1,21 @@ { "name": "@typespec/openapi", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/openapi_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + }, + { + "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18" + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/openapi_v0.49.0", diff --git a/packages/openapi/CHANGELOG.md b/packages/openapi/CHANGELOG.md index 4e0967838f..086aa9ea45 100644 --- a/packages/openapi/CHANGELOG.md +++ b/packages/openapi/CHANGELOG.md @@ -1,6 +1,14 @@ # Change Log - @typespec/openapi -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files +- **BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18 ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/openapi/package.json b/packages/openapi/package.json index 077aa56bb3..d49ef560c5 100644 --- a/packages/openapi/package.json +++ b/packages/openapi/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "TypeSpec library providing OpenAPI concepts", "homepage": "https://microsoft.github.io/typespec", @@ -49,18 +49,18 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/http": "workspace:~0.49.0" + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/http": "workspace:~0.50.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/http": "workspace:~0.49.0", - "@typespec/rest": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/library-linter": "workspace:~0.49.0", - "@typespec/eslint-plugin": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/http": "workspace:~0.50.0", + "@typespec/rest": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/library-linter": "workspace:~0.50.0", + "@typespec/eslint-plugin": "workspace:~0.50.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/openapi3/CHANGELOG.json b/packages/openapi3/CHANGELOG.json index 05724cc9e2..2d7af7fb32 100644 --- a/packages/openapi3/CHANGELOG.json +++ b/packages/openapi3/CHANGELOG.json @@ -1,6 +1,30 @@ { "name": "@typespec/openapi3", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/openapi3_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "Fix: Stops emitting an error when using `@body _: void` in operation parameters and treat it as no body." + }, + { + "comment": "Fix issue where using shared routes would, in some cases, result in a \"duplicate-header\" error." + }, + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + }, + { + "comment": "Support `@summary` on data types which emits the JSON Schema `title` property." + }, + { + "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18" + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/openapi3_v0.49.0", diff --git a/packages/openapi3/CHANGELOG.md b/packages/openapi3/CHANGELOG.md index 1980574efb..a475e77aaa 100644 --- a/packages/openapi3/CHANGELOG.md +++ b/packages/openapi3/CHANGELOG.md @@ -1,6 +1,17 @@ # Change Log - @typespec/openapi3 -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- Fix: Stops emitting an error when using `@body _: void` in operation parameters and treat it as no body. +- Fix issue where using shared routes would, in some cases, result in a "duplicate-header" error. +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files +- Support `@summary` on data types which emits the JSON Schema `title` property. +- **BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18 ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/openapi3/package.json b/packages/openapi3/package.json index 541960e82e..e974ee77b6 100644 --- a/packages/openapi3/package.json +++ b/packages/openapi3/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi3", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding", "homepage": "https://microsoft.github.io/typespec", @@ -52,22 +52,22 @@ "yaml": "~2.3.2" }, "peerDependencies": { - "@typespec/versioning": "workspace:~0.49.0", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/http": "workspace:~0.49.0", - "@typespec/openapi": "workspace:~0.49.0" + "@typespec/versioning": "workspace:~0.50.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/http": "workspace:~0.50.0", + "@typespec/openapi": "workspace:~0.50.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/http": "workspace:~0.49.0", - "@typespec/rest": "workspace:~0.49.0", - "@typespec/openapi": "workspace:~0.49.0", - "@typespec/versioning": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/library-linter": "workspace:~0.49.0", - "@typespec/eslint-plugin": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/http": "workspace:~0.50.0", + "@typespec/rest": "workspace:~0.50.0", + "@typespec/openapi": "workspace:~0.50.0", + "@typespec/versioning": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/library-linter": "workspace:~0.50.0", + "@typespec/eslint-plugin": "workspace:~0.50.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/playground-website/package.json b/packages/playground-website/package.json index 1047a22d97..58a4c737a7 100644 --- a/packages/playground-website/package.json +++ b/packages/playground-website/package.json @@ -41,16 +41,16 @@ "!dist/test/**" ], "dependencies": { - "@typespec/playground": "workspace:~0.1.0-alpha.2", - "@typespec/versioning": "workspace:~0.49.0", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/http": "workspace:~0.49.0", - "@typespec/rest": "workspace:~0.49.0", - "@typespec/openapi3": "workspace:~0.49.0", - "@typespec/json-schema": "workspace:~0.49.0", - "@typespec/openapi": "workspace:~0.49.0", - "@typespec/protobuf": "workspace:~0.49.0", - "@typespec/html-program-viewer": "workspace:~0.49.0", + "@typespec/playground": "workspace:~0.1.0-alpha.3", + "@typespec/versioning": "workspace:~0.50.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/http": "workspace:~0.50.0", + "@typespec/rest": "workspace:~0.50.0", + "@typespec/openapi3": "workspace:~0.50.0", + "@typespec/json-schema": "workspace:~0.50.0", + "@typespec/openapi": "workspace:~0.50.0", + "@typespec/protobuf": "workspace:~0.50.0", + "@typespec/html-program-viewer": "workspace:~0.50.0", "@emotion/react": "^11.11.1", "react-dom": "~18.2.0", "react": "~18.2.0", @@ -66,7 +66,7 @@ "@types/react": "~18.2.22", "@types/swagger-ui-react": "^4.18.0", "@types/swagger-ui": "~3.52.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", "@vitejs/plugin-react": "~4.1.0", "c8": "~8.0.1", "cross-env": "~7.0.3", diff --git a/packages/playground/package.json b/packages/playground/package.json index e7b3116b80..17cc283bde 100644 --- a/packages/playground/package.json +++ b/packages/playground/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/playground", - "version": "0.1.0-alpha.2", + "version": "0.1.0-alpha.3", "author": "Microsoft Corporation", "description": "TypeSpec playground UI components.", "homepage": "https://microsoft.github.io/typespec", @@ -67,15 +67,15 @@ "@emotion/react": "^11.11.1", "@fluentui/react-components": "~9.32.1", "@fluentui/react-icons": "~2.0.217", - "@typespec/bundler": "workspace:~0.1.0-alpha.2", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/html-program-viewer": "workspace:~0.49.0", - "@typespec/http": "workspace:~0.49.0", - "@typespec/openapi": "workspace:~0.49.0", - "@typespec/openapi3": "workspace:~0.49.0", - "@typespec/protobuf": "workspace:~0.49.0", - "@typespec/rest": "workspace:~0.49.0", - "@typespec/versioning": "workspace:~0.49.0", + "@typespec/bundler": "workspace:~0.1.0-alpha.3", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/html-program-viewer": "workspace:~0.50.0", + "@typespec/http": "workspace:~0.50.0", + "@typespec/openapi": "workspace:~0.50.0", + "@typespec/openapi3": "workspace:~0.50.0", + "@typespec/protobuf": "workspace:~0.50.0", + "@typespec/rest": "workspace:~0.50.0", + "@typespec/versioning": "workspace:~0.50.0", "debounce": "~1.2.1", "lzutf8": "0.6.3", "monaco-editor": "~0.43.0", @@ -95,8 +95,8 @@ "@types/react": "~18.2.22", "@types/swagger-ui-react": "^4.18.0", "@types/swagger-ui": "~3.52.0", - "@typespec/bundler": "workspace:~0.1.0-alpha.2", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/bundler": "workspace:~0.1.0-alpha.3", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", "@vitejs/plugin-react": "~4.1.0", "c8": "~8.0.1", "cross-env": "~7.0.3", diff --git a/packages/prettier-plugin-typespec/CHANGELOG.json b/packages/prettier-plugin-typespec/CHANGELOG.json index f3715a0b58..180ae426af 100644 --- a/packages/prettier-plugin-typespec/CHANGELOG.json +++ b/packages/prettier-plugin-typespec/CHANGELOG.json @@ -1,6 +1,12 @@ { "name": "@typespec/prettier-plugin-typespec", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/prettier-plugin-typespec_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": {} + }, { "version": "0.49.0", "tag": "@typespec/prettier-plugin-typespec_v0.49.0", diff --git a/packages/prettier-plugin-typespec/CHANGELOG.md b/packages/prettier-plugin-typespec/CHANGELOG.md index da85d8fce8..a928c64d2a 100644 --- a/packages/prettier-plugin-typespec/CHANGELOG.md +++ b/packages/prettier-plugin-typespec/CHANGELOG.md @@ -1,6 +1,11 @@ # Change Log - @typespec/prettier-plugin-typespec -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +_Version update only_ ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/prettier-plugin-typespec/package.json b/packages/prettier-plugin-typespec/package.json index 55834088f3..8183ee6910 100644 --- a/packages/prettier-plugin-typespec/package.json +++ b/packages/prettier-plugin-typespec/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/prettier-plugin-typespec", - "version": "0.49.0", + "version": "0.50.0", "description": "", "main": "dist/index.js", "scripts": { @@ -16,8 +16,8 @@ }, "devDependencies": { "prettier_2": "npm:prettier@2.8.7", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/internal-build-utils": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/internal-build-utils": "workspace:~0.50.0", "@rollup/plugin-commonjs": "~25.0.4", "@rollup/plugin-json": "~6.0.0", "@rollup/plugin-node-resolve": "~15.2.1", diff --git a/packages/protobuf/CHANGELOG.json b/packages/protobuf/CHANGELOG.json index 8518e90a09..bb19e49458 100644 --- a/packages/protobuf/CHANGELOG.json +++ b/packages/protobuf/CHANGELOG.json @@ -1,6 +1,12 @@ { "name": "@typespec/protobuf", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/protobuf_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": {} + }, { "version": "0.49.0", "tag": "@typespec/protobuf_v0.49.0", diff --git a/packages/protobuf/CHANGELOG.md b/packages/protobuf/CHANGELOG.md index d55afd7513..2040212d28 100644 --- a/packages/protobuf/CHANGELOG.md +++ b/packages/protobuf/CHANGELOG.md @@ -1,6 +1,11 @@ # Change Log - @typespec/protobuf -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +_Version update only_ ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/protobuf/package.json b/packages/protobuf/package.json index 34a336a835..b41fe0e67e 100644 --- a/packages/protobuf/package.json +++ b/packages/protobuf/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/protobuf", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "TypeSpec library and emitter for Protobuf (gRPC)", "homepage": "https://github.com/microsoft/typespec", @@ -32,12 +32,12 @@ "regen-docs": "tspd doc . --enable-experimental --output-dir ../../docs/standard-library/protobuf/reference" }, "peerDependencies": { - "@typespec/compiler": "workspace:~0.49.0" + "@typespec/compiler": "workspace:~0.50.0" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/eslint-plugin": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/eslint-plugin": "workspace:~0.50.0", "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", "@typespec/tspd": "workspace:~0.46.0", diff --git a/packages/rest/CHANGELOG.json b/packages/rest/CHANGELOG.json index bbcfbbf10d..aa81feb6bf 100644 --- a/packages/rest/CHANGELOG.json +++ b/packages/rest/CHANGELOG.json @@ -1,6 +1,21 @@ { "name": "@typespec/rest", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/rest_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + }, + { + "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18" + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/rest_v0.49.0", diff --git a/packages/rest/CHANGELOG.md b/packages/rest/CHANGELOG.md index 8f0654099a..b3b038fab1 100644 --- a/packages/rest/CHANGELOG.md +++ b/packages/rest/CHANGELOG.md @@ -1,6 +1,14 @@ # Change Log - @typespec/rest -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files +- **BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18 ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/rest/package.json b/packages/rest/package.json index 769379bd57..d7191477cc 100644 --- a/packages/rest/package.json +++ b/packages/rest/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/rest", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "TypeSpec REST protocol binding", "homepage": "https://microsoft.github.io/typespec", @@ -49,17 +49,17 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/http": "workspace:~0.49.0" + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/http": "workspace:~0.50.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/http": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/library-linter": "workspace:~0.49.0", - "@typespec/eslint-plugin": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/http": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/library-linter": "workspace:~0.50.0", + "@typespec/eslint-plugin": "workspace:~0.50.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/samples/package.json b/packages/samples/package.json index ed03b9626f..bac2f1e518 100644 --- a/packages/samples/package.json +++ b/packages/samples/package.json @@ -44,20 +44,20 @@ ], "dependencies": { "@typespec/best-practices": "workspace:~0.45.0", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/html-program-viewer": "workspace:~0.49.0", - "@typespec/http": "workspace:~0.49.0", - "@typespec/json-schema": "workspace:~0.49.0", - "@typespec/openapi": "workspace:~0.49.0", - "@typespec/openapi3": "workspace:~0.49.0", - "@typespec/rest": "workspace:~0.49.0", - "@typespec/versioning": "workspace:~0.49.0" + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/html-program-viewer": "workspace:~0.50.0", + "@typespec/http": "workspace:~0.50.0", + "@typespec/json-schema": "workspace:~0.50.0", + "@typespec/openapi": "workspace:~0.50.0", + "@typespec/openapi3": "workspace:~0.50.0", + "@typespec/rest": "workspace:~0.50.0", + "@typespec/versioning": "workspace:~0.50.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/internal-build-utils": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/internal-build-utils": "workspace:~0.50.0", "autorest": "~3.3.2", "cross-env": "~7.0.3", "eslint": "^8.49.0", diff --git a/packages/spec/package.json b/packages/spec/package.json index 7f1f7f7242..42253e8742 100644 --- a/packages/spec/package.json +++ b/packages/spec/package.json @@ -22,6 +22,6 @@ "devDependencies": { "@types/node": "~18.11.9", "ecmarkup": "~12.0.3", - "@typespec/internal-build-utils": "workspace:~0.49.0" + "@typespec/internal-build-utils": "workspace:~0.50.0" } } diff --git a/packages/tmlanguage-generator/CHANGELOG.json b/packages/tmlanguage-generator/CHANGELOG.json index 46ed718af9..9fbe14798d 100644 --- a/packages/tmlanguage-generator/CHANGELOG.json +++ b/packages/tmlanguage-generator/CHANGELOG.json @@ -1,6 +1,28 @@ { "name": "tmlanguage-generator", "entries": [ + { + "version": "0.5.0", + "tag": "tmlanguage-generator_v0.5.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "patch": [ + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + } + ], + "dependency": [ + { + "comment": "Dependency @typespec/eslint-config-typespec version bump from workspace:~0.49.0 to workspace:~0.50.0." + } + ], + "minor": [ + { + "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18" + } + ] + } + }, { "version": "0.4.5", "tag": "tmlanguage-generator_v0.4.5", diff --git a/packages/tmlanguage-generator/CHANGELOG.md b/packages/tmlanguage-generator/CHANGELOG.md index cba4c5c538..ffe9fe5205 100644 --- a/packages/tmlanguage-generator/CHANGELOG.md +++ b/packages/tmlanguage-generator/CHANGELOG.md @@ -1,6 +1,17 @@ # Change Log - tmlanguage-generator -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.5.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Minor changes + +- **BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18 + +### Patches + +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files ## 0.4.5 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/tmlanguage-generator/package.json b/packages/tmlanguage-generator/package.json index 5791f5bd2a..817bcb887a 100644 --- a/packages/tmlanguage-generator/package.json +++ b/packages/tmlanguage-generator/package.json @@ -1,6 +1,6 @@ { "name": "tmlanguage-generator", - "version": "0.4.5", + "version": "0.5.0", "author": "Microsoft Corporation", "description": "Helper library to generate TextMate syntax highlighting tmLanguage files.", "homepage": "https://github.com/microsoft/typespec/tree/main/packages/tmlanguage-generator", @@ -39,7 +39,7 @@ "devDependencies": { "@types/node": "~18.11.9", "@types/plist": "~3.0.2", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", "eslint": "^8.49.0", "rimraf": "~5.0.1", "typescript": "~5.2.2" diff --git a/packages/tspd/package.json b/packages/tspd/package.json index 8c5bde0615..80ae65e3bc 100644 --- a/packages/tspd/package.json +++ b/packages/tspd/package.json @@ -53,16 +53,16 @@ "!dist/test/**" ], "dependencies": { - "@typespec/compiler": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", "yaml": "~2.3.2", "prettier": "~3.0.3", "picocolors": "~1.0.0", "yargs": "~17.7.2" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/prettier-plugin-typespec": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/prettier-plugin-typespec": "workspace:~0.50.0", "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", "@types/yargs": "~17.0.24", diff --git a/packages/typespec-vs/CHANGELOG.json b/packages/typespec-vs/CHANGELOG.json index a2c2addd10..e99d0762e4 100644 --- a/packages/typespec-vs/CHANGELOG.json +++ b/packages/typespec-vs/CHANGELOG.json @@ -1,6 +1,21 @@ { "name": "typespec-vs", "entries": [ + { + "version": "0.50.0", + "tag": "typespec-vs_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + }, + { + "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18" + } + ] + } + }, { "version": "0.49.0", "tag": "typespec-vs_v0.49.0", diff --git a/packages/typespec-vs/CHANGELOG.md b/packages/typespec-vs/CHANGELOG.md index 6ffc47a692..027eb114ef 100644 --- a/packages/typespec-vs/CHANGELOG.md +++ b/packages/typespec-vs/CHANGELOG.md @@ -1,6 +1,14 @@ # Change Log - typespec-vs -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files +- **BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18 ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/typespec-vs/package.json b/packages/typespec-vs/package.json index 169240e2e4..d3a323d693 100644 --- a/packages/typespec-vs/package.json +++ b/packages/typespec-vs/package.json @@ -1,7 +1,7 @@ { "name": "typespec-vs", "author": "Microsoft Corporation", - "version": "0.49.0", + "version": "0.50.0", "description": "TypeSpec Language Support for Visual Studio", "homepage": "https://microsoft.github.io/typespec", "readme": "https://github.com/microsoft/typespec/blob/main/README.md", @@ -27,7 +27,7 @@ "build": "node scripts/build.js" }, "devDependencies": { - "typespec-vscode": "workspace:~0.49.0", - "@typespec/internal-build-utils": "workspace:~0.49.0" + "typespec-vscode": "workspace:~0.50.0", + "@typespec/internal-build-utils": "workspace:~0.50.0" } } diff --git a/packages/typespec-vscode/CHANGELOG.json b/packages/typespec-vscode/CHANGELOG.json index bb36e48426..708216590e 100644 --- a/packages/typespec-vscode/CHANGELOG.json +++ b/packages/typespec-vscode/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "typespec-vscode", "entries": [ + { + "version": "0.50.0", + "tag": "typespec-vscode_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + } + ] + } + }, { "version": "0.49.0", "tag": "typespec-vscode_v0.49.0", diff --git a/packages/typespec-vscode/CHANGELOG.md b/packages/typespec-vscode/CHANGELOG.md index beaab73579..b1626a9e15 100644 --- a/packages/typespec-vscode/CHANGELOG.md +++ b/packages/typespec-vscode/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - typespec-vscode -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/typespec-vscode/package.json b/packages/typespec-vscode/package.json index 52432f70ee..4ad6fd123e 100644 --- a/packages/typespec-vscode/package.json +++ b/packages/typespec-vscode/package.json @@ -1,6 +1,6 @@ { "name": "typespec-vscode", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "TypeSpec Language Support for VS Code", "homepage": "https://microsoft.github.io/typespec", @@ -123,9 +123,9 @@ "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", "@types/vscode": "~1.82.0", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/internal-build-utils": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/internal-build-utils": "workspace:~0.50.0", "eslint": "^8.49.0", "c8": "~8.0.1", "mocha": "~10.2.0", diff --git a/packages/versioning/CHANGELOG.json b/packages/versioning/CHANGELOG.json index 8a98cea41e..7a093743a1 100644 --- a/packages/versioning/CHANGELOG.json +++ b/packages/versioning/CHANGELOG.json @@ -1,6 +1,24 @@ { "name": "@typespec/versioning", "entries": [ + { + "version": "0.50.0", + "tag": "@typespec/versioning_v0.50.0", + "date": "Wed, 08 Nov 2023 00:07:17 GMT", + "comments": { + "none": [ + { + "comment": "`TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files" + }, + { + "comment": "**BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18" + }, + { + "comment": "Update targets for `@added`, `@removed`, `@renamedFrom`, `@madeOptional` and `@typeChangedFrom` to more clearly communicate where they can be used." + } + ] + } + }, { "version": "0.49.0", "tag": "@typespec/versioning_v0.49.0", diff --git a/packages/versioning/CHANGELOG.md b/packages/versioning/CHANGELOG.md index 2f64003bae..1bfd53ffe4 100644 --- a/packages/versioning/CHANGELOG.md +++ b/packages/versioning/CHANGELOG.md @@ -1,6 +1,15 @@ # Change Log - @typespec/versioning -This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. +This log was last generated on Wed, 08 Nov 2023 00:07:17 GMT and should not be manually modified. + +## 0.50.0 +Wed, 08 Nov 2023 00:07:17 GMT + +### Updates + +- `TypeScript` use `types` entry under `exports` of `package.json` instead of legacy `typesVersions` to provide the definition files +- **BREAKING CHANGE** Dropped support for node 16, minimum node version is now 18 +- Update targets for `@added`, `@removed`, `@renamedFrom`, `@madeOptional` and `@typeChangedFrom` to more clearly communicate where they can be used. ## 0.49.0 Wed, 11 Oct 2023 23:31:35 GMT diff --git a/packages/versioning/package.json b/packages/versioning/package.json index 3099bbb8b2..a27603ab04 100644 --- a/packages/versioning/package.json +++ b/packages/versioning/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/versioning", - "version": "0.49.0", + "version": "0.50.0", "author": "Microsoft Corporation", "description": "TypeSpec library for declaring and emitting versioned APIs", "homepage": "https://microsoft.github.io/typespec", @@ -49,15 +49,15 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.49.0" + "@typespec/compiler": "workspace:~0.50.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.49.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", - "@typespec/library-linter": "workspace:~0.49.0", - "@typespec/eslint-plugin": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", + "@typespec/library-linter": "workspace:~0.50.0", + "@typespec/eslint-plugin": "workspace:~0.50.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/website/package.json b/packages/website/package.json index 594ffeb07f..4c91f31220 100644 --- a/packages/website/package.json +++ b/packages/website/package.json @@ -34,16 +34,16 @@ }, "devDependencies": { "@swc/core": "^1.3.62", - "@typespec/compiler": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.50.0", "@typespec/tspd": "workspace:~0.46.0", "@typespec/spec": "workspace:*", - "@typespec/http": "workspace:~0.49.0", - "@typespec/rest": "workspace:~0.49.0", - "@typespec/openapi": "workspace:~0.49.0", - "@typespec/openapi3": "workspace:~0.49.0", - "@typespec/protobuf": "workspace:~0.49.0", - "@typespec/versioning": "workspace:~0.49.0", - "@typespec/json-schema": "workspace:~0.49.0", + "@typespec/http": "workspace:~0.50.0", + "@typespec/rest": "workspace:~0.50.0", + "@typespec/openapi": "workspace:~0.50.0", + "@typespec/openapi3": "workspace:~0.50.0", + "@typespec/protobuf": "workspace:~0.50.0", + "@typespec/versioning": "workspace:~0.50.0", + "@typespec/json-schema": "workspace:~0.50.0", "@docusaurus/module-type-aliases": "^3.0.0", "@docusaurus/types": "^3.0.0", "@docusaurus/tsconfig": "^3.0.0", @@ -52,7 +52,7 @@ "prism-themes": "~1.9.0", "playwright": "^1.39.0", "mermaid": "~10.4.0", - "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.50.0", "eslint": "^8.49.0", "rimraf": "~5.0.1", "dotenv": "~16.3.1", diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.$onEmit.md b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.$onEmit.md deleted file mode 100644 index 39def7970f..0000000000 --- a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.$onEmit.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] $onEmit" - ---- -```ts -$onEmit(context): Promise< void > -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | `EmitContext`< [`CSharpServiceEmitterOptions`](Interface.CSharpServiceEmitterOptions.md) \> | - -## Returns - -`Promise`< `void` \> diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.getTracer.md b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.getTracer.md deleted file mode 100644 index 11ca56f1d4..0000000000 --- a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.getTracer.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] getTracer" - ---- -```ts -getTracer(program): Tracer -``` - -Returns a tracer scopped to the current library. -All trace area logged via this tracer will be prefixed with the library name. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | `Program` | - -## Returns - -`Tracer` diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.reportDiagnostic.md b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.reportDiagnostic.md deleted file mode 100644 index 1a568f8c0c..0000000000 --- a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.reportDiagnostic.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[F] reportDiagnostic" - ---- -```ts -reportDiagnostic(program, diag): void -``` - -## Type parameters - -| Parameter | -| :------ | -| `C` *extends* `"invalid-identifier"` \| `"missing-type-parent"` \| `"no-numeric"` \| `"unrecognized-scalar"` | -| `M` *extends* `string` \| `number` \| `symbol` | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | `Program` | -| `diag` | `DiagnosticReport`< `Object`, `C`, `M` \> | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Interface.CSharpServiceEmitterOptions.md b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Interface.CSharpServiceEmitterOptions.md deleted file mode 100644 index e6f9b83ada..0000000000 --- a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Interface.CSharpServiceEmitterOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] CSharpServiceEmitterOptions" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `skip-format?` | `boolean` | Skip formatting of output. Default is false (generated c-sharp files are formatted) | diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Variable.$lib.md b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Variable.$lib.md deleted file mode 100644 index ab9320c49a..0000000000 --- a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Variable.$lib.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] $lib" - ---- -```ts -const $lib: TypeSpecLibrary< Object, CSharpServiceEmitterOptions > -``` diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/_category_.json b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/_category_.json deleted file mode 100644 index eb101a8378..0000000000 --- a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/_category_.json +++ /dev/null @@ -1 +0,0 @@ -{"label":"JS Api","link":{"type":"doc","id":"index"}} \ No newline at end of file diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/index.md deleted file mode 100644 index 2f50409098..0000000000 --- a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[P] JS Api" - ---- -## Interfaces - -- [CSharpServiceEmitterOptions](Interface.CSharpServiceEmitterOptions.md) - -## Variables - -- [$lib](Variable.$lib.md) - -## Functions - -- [$onEmit](Function.$onEmit.md) -- [getTracer](Function.getTracer.md) -- [reportDiagnostic](Function.reportDiagnostic.md) diff --git a/packages/website/versioned_docs/version-latest/extending-typespec/basics.md b/packages/website/versioned_docs/version-latest/extending-typespec/basics.md index f77d012b2b..fa4b0ad6f0 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/basics.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/basics.md @@ -226,13 +226,13 @@ export const MyTestLibrary = createTestLibrary({ // ... "main": "dist/src/index.js", "exports": { - ".": "./dist/src/index.js", - "./testing": "./dist/src/testing/index.js" - }, - "typesVersions": { - "*": { - "*": ["./dist/src/index.d.ts"], - "testing": ["./dist/src/testing/index.d.ts"] + ".": { + "default": "./dist/src/index.js", + "types": "./dist/src/index.d.ts" + }, + "./testing": { + "default": "./dist/src/testing/index.js", + "types": "./dist/src/testing/index.d.ts" } } } diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-11-07.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-11-07.md new file mode 100644 index 0000000000..eb457f094b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-11-07.md @@ -0,0 +1,78 @@ +--- +title: November 2023 +--- + +# Release Notes November 2023 (2023-11-07) + +:::danger +This release contains **breaking changes** +::: + +## New Features + +### `@typespec/compiler` New Features + +- Add new `unixTimestamp32` scalar to standard library. +- Emitter Framework: Add hook for handling circular references. +- Emitter Framework: `TypeEmitter` now supports Tuples. +- Emit error diagnostic if a model spreads itself within its declaration. +- Stop showing empty code frame when diagnostic has no location. + +### `@typespec/json-schema` New Features + +- Add support for `TupleLiteral`. + +### `@typespec/openapi3` New Features + +- Support `@summary` on data types which emit the JSON Schema `title` property. + +### `@typespec/playground` New features + +- Add a format button to the playground command bar. +- Add a notification to the standalone playground when the playground has been saved. +- Add resizable panes for the editor and output. + +## Bug Fixes + +### `@typespec/compiler` Bug Fixes + +- Fix: `@doc` and jsdoc comments disappear from multi-segment or nested namespaces. +- Fix: Using `@overload` could result in incorrect `unassignable` type errors. +- Fix: Referencing a template in an alias might cause augment decorators to not be applied on types referenced in the aliased type. +- Fix: Issues with removing keys from `RekeyableMap`. +- Fix: Properties filtered with `@withVisibility` will have their visibility removed. This prevent visibility from being applied twice and rendering invalid models. + +### `@typespec/openapi3` Bug Fixes + +- Fix: Stops emitting an error when using `@body _: void` in operation parameters and treat it as no body. +- Fix: Using shared routes would, in some cases, result in a `duplicate-header` error. + +## Breaking Changes + +### Typescript types breaking change + +The `package.json` files for all packages have been changed to use the standard `types` field instead of the legacy `typesVersions` field to specify types for subpath exports. This means that packages consuming TypeSpec must use the `moduleResolution` setting with `node16` or `nodenext` in their `tsconfig.json`. +You might see the following error: + +```bash +Cannot find module '@typespec/compiler/testing'. Did you mean to set the 'moduleResolution' option to 'nodenext' +``` + +This can be resolved by changing the following in `tsconfig.json`: + +```diff +-"moduleResolution": "ESNext", ++"moduleResolution": "node16", +``` + +### Dropped Support for Node version 16 + +- All typespec packages now specify node 18 as the minimum version. Consuming packages should no longer use node 16 and update the node specification in the `engines` section of their package.json file appropriately. + +### `@typespec/playground` Breaking Changes + +- Styles must be imported seperately with `import \"@typespec/playground/styles.css\";`. + +### `@typespec/versioning` Breaking Changes + +- Update targets for `@added`, `@removed`, `@renamedFrom`, `@madeOptional` and `@typeChangedFrom` to more clearly communicate where they can be used. Specs that applied these decorators to types that could not be versioned (like `namespace`) will now receive an error diagnostic. diff --git a/packages/website/versioned_docs/version-latest/standard-library/built-in-data-types.md b/packages/website/versioned_docs/version-latest/standard-library/built-in-data-types.md index 9badf3d43e..a7d0000555 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/built-in-data-types.md +++ b/packages/website/versioned_docs/version-latest/standard-library/built-in-data-types.md @@ -186,7 +186,8 @@ scalar bytes ### `decimal` {#decimal} -A decimal number with any length and precision. +A decimal number with any length and precision. This represent any `decimal` value possible. +It is commonly represented as `BigDecimal` in some languages. ```typespec scalar decimal @@ -286,7 +287,8 @@ scalar int8 ### `integer` {#integer} -A whole number +A whole number. This represent any `integer` value possible. +It is commonly represented as `BigInteger` in some languages. ```typespec scalar integer @@ -394,6 +396,17 @@ scalar uint8 +### `unixTimestamp32` {#unixTimestamp32} + +Represent a 32-bit unix timestamp datetime with 1s of granularity. +It measures time by the number of seconds that have elapsed since 00:00:00 UTC on 1 January 1970. + +```typespec +scalar unixTimestamp32 +``` + + + ### `url` {#url} Represent a URL string as described by https://url.spec.whatwg.org/ diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$body.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$body.md index 08f4597c71..74c51eca4a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$body.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$body.md @@ -13,3 +13,7 @@ $body(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `ModelProperty` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$delete.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$delete.md index 9d1cbc7d2d..a97fdb5e37 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$delete.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$delete.md @@ -13,3 +13,7 @@ $delete(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$get.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$get.md index 81fd259857..0815e4bbf2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$get.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$get.md @@ -13,3 +13,7 @@ $get(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$head.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$head.md index 2759bf9991..63c0520514 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$head.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$head.md @@ -13,3 +13,7 @@ $head(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$header.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$header.md index d5f560f5de..a420147c29 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$header.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$header.md @@ -17,3 +17,7 @@ $header( | `context` | `DecoratorContext` | | `entity` | `ModelProperty` | | `headerNameOrOptions`? | `StringLiteral` \| `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md index 4797ed6bbe..312198ac00 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md @@ -24,6 +24,8 @@ decorator. ## Returns +`void` + ## See isApplicableMetadata diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$onValidate.md index df5dda0051..212e92eb72 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$onValidate.md @@ -12,3 +12,7 @@ $onValidate(program): void | Parameter | Type | | :------ | :------ | | `program` | `Program` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$patch.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$patch.md index a9555a332f..32efa20c4d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$patch.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$patch.md @@ -13,3 +13,7 @@ $patch(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$path.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$path.md index 50616f10c8..f7e253f31c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$path.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$path.md @@ -17,3 +17,7 @@ $path( | `context` | `DecoratorContext` | | `entity` | `ModelProperty` | | `paramName`? | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$plainData.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$plainData.md index f2ffd4286e..d61d12c6bb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$plainData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$plainData.md @@ -13,3 +13,7 @@ $plainData(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$post.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$post.md index d2b97129dc..61ab855910 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$post.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$post.md @@ -13,3 +13,7 @@ $post(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$put.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$put.md index a8011177d0..0c991e4bbe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$put.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$put.md @@ -13,3 +13,7 @@ $put(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$query.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$query.md index 2f8f230b95..1f05c53a9a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$query.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$query.md @@ -17,3 +17,7 @@ $query( | `context` | `DecoratorContext` | | `entity` | `ModelProperty` | | `queryNameOrOptions`? | `StringLiteral` \| `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$route.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$route.md index a70fe4adb5..588ec13667 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$route.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$route.md @@ -27,3 +27,7 @@ it will be used as a prefix to the route URI of the operation. | `entity` | `Type` | | `path` | `string` | | `parameters`? | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$server.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$server.md index 4456caa306..a806b45a6f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$server.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$server.md @@ -26,6 +26,8 @@ Configure the server url for the service. ## Returns +`void` + ## Optional Parameters to interpolate in the server url. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$sharedRoute.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$sharedRoute.md index c0e11dd7dd..85f083c588 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$sharedRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$sharedRoute.md @@ -20,3 +20,7 @@ route path as long as those operations are also marked with `@sharedRoute`. | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$statusCode.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$statusCode.md index cfbc299977..6fa9dcb737 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$statusCode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$statusCode.md @@ -13,3 +13,7 @@ $statusCode(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `ModelProperty` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$useAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$useAuth.md index c9be7e0c30..4616d2e7d6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$useAuth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$useAuth.md @@ -17,3 +17,7 @@ $useAuth( | `context` | `DecoratorContext` | | `serviceNamespace` | `Namespace` | | `authConfig` | `Model` \| `Tuple` \| `Union` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/DefaultRouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/DefaultRouteProducer.md index c3baa9cc3f..32fcf1d6bc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/DefaultRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/DefaultRouteProducer.md @@ -21,3 +21,7 @@ options): DiagnosticResult | `parentSegments` | `string`[] | | `overloadBase` | `undefined` \| [`HttpOperation`](../interfaces/HttpOperation.md) | | `options` | [`RouteOptions`](../interfaces/RouteOptions.md) | + +## Returns + +`DiagnosticResult`<[`RouteProducerResult`](../interfaces/RouteProducerResult.md)\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/createMetadataInfo.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/createMetadataInfo.md index fc9c4b7c80..1bb3fd0352 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/createMetadataInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/createMetadataInfo.md @@ -13,3 +13,7 @@ createMetadataInfo(program, options?): MetadataInfo | :------ | :------ | | `program` | `Program` | | `options`? | [`MetadataInfoOptions`](../interfaces/MetadataInfoOptions.md) | + +## Returns + +[`MetadataInfo`](../interfaces/MetadataInfo.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/gatherMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/gatherMetadata.md index ddecacfe31..65c998621c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/gatherMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/gatherMetadata.md @@ -26,3 +26,7 @@ properties recursively. | `visibility` | [`Visibility`](../enumerations/Visibility.md) | `undefined` | - | | `isMetadataCallback` | (`program`, `property`) => `boolean` | `isMetadata` | - | | `rootMapOut`? | `Map`<`ModelProperty`, `ModelProperty`\> | `undefined` | If provided, the map will be populated to link
nested metadata properties to their root properties. | + +## Returns + +`Set`<`ModelProperty`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllHttpServices.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllHttpServices.md index 63f1e62d6d..4a76f1e34e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllHttpServices.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllHttpServices.md @@ -15,3 +15,7 @@ Returns all the services defined. | :------ | :------ | | `program` | `Program` | | `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | + +## Returns + +[[`HttpService`](../interfaces/HttpService.md)[], readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllRoutes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllRoutes.md index 4b4588af1e..e575a001ab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllRoutes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllRoutes.md @@ -16,6 +16,8 @@ getAllRoutes(program, options?): [HttpOperation[], readonly Diagnostic[]] ## Returns +[[`HttpOperation`](../interfaces/HttpOperation.md)[], readonly `Diagnostic`[]] + ## Deprecated use `getAllHttpServices` instead diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAuthentication.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAuthentication.md index 972a1ae8e8..f477b6d616 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAuthentication.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAuthentication.md @@ -13,3 +13,7 @@ getAuthentication(program, namespace): ServiceAuthentication | undefined | :------ | :------ | | `program` | `Program` | | `namespace` | `Namespace` | + +## Returns + +[`ServiceAuthentication`](../interfaces/ServiceAuthentication.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getContentTypes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getContentTypes.md index b72f3b5765..8926f02618 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getContentTypes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getContentTypes.md @@ -17,4 +17,6 @@ Resolve the content types from a model property by looking at the value. ## Returns +[`string`[], readonly `Diagnostic`[]] + List of contnet types and any diagnostics if there was an issue. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldName.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldName.md index 524de93e36..5096ca42e6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldName.md @@ -13,3 +13,7 @@ getHeaderFieldName(program, entity): string | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldOptions.md index 96ee40708c..f9674d89d4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldOptions.md @@ -13,3 +13,7 @@ getHeaderFieldOptions(program, entity): HeaderFieldOptions | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +[`HeaderFieldOptions`](../interfaces/HeaderFieldOptions.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpOperation.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpOperation.md index 6e53c0d77e..952150aa66 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpOperation.md @@ -19,3 +19,7 @@ Return the Http Operation details for a given TypeSpec operation. | `program` | `Program` | - | | `operation` | `Operation` | Operation | | `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | Optional option on how to resolve the http details. | + +## Returns + +[[`HttpOperation`](../interfaces/HttpOperation.md), readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpService.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpService.md index 281ee897be..30d4dc0bed 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpService.md @@ -17,3 +17,7 @@ getHttpService( | `program` | `Program` | | `serviceNamespace` | `Namespace` | | `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | + +## Returns + +[[`HttpService`](../interfaces/HttpService.md), readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationParameters.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationParameters.md index 48bb22851b..1106400bcb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationParameters.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationParameters.md @@ -21,3 +21,7 @@ getOperationParameters( | `overloadBase`? | [`HttpOperation`](../interfaces/HttpOperation.md) | `undefined` | | `knownPathParamNames`? | `string`[] | `[]` | | `options`? | [`OperationParameterOptions`](../interfaces/OperationParameterOptions.md) | `{}` | + +## Returns + +[[`HttpOperationParameters`](../interfaces/HttpOperationParameters.md), readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationVerb.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationVerb.md index 20d663b6b8..c1232d91b1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationVerb.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationVerb.md @@ -13,3 +13,7 @@ getOperationVerb(program, entity): HttpVerb | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +[`HttpVerb`](../type-aliases/HttpVerb.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamName.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamName.md index e5e188999f..947c88dedf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamName.md @@ -13,3 +13,7 @@ getPathParamName(program, entity): string | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamOptions.md index d15be02de9..4b7fb1bf4a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamOptions.md @@ -13,3 +13,7 @@ getPathParamOptions(program, entity): PathParameterOptions | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +[`PathParameterOptions`](../interfaces/PathParameterOptions.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamName.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamName.md index 696a31c9dd..da9c1758b2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamName.md @@ -13,3 +13,7 @@ getQueryParamName(program, entity): string | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamOptions.md index 785bc543a6..ad13ac707b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamOptions.md @@ -13,3 +13,7 @@ getQueryParamOptions(program, entity): QueryParameterOptions | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +[`QueryParameterOptions`](../interfaces/QueryParameterOptions.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRequestVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRequestVisibility.md index 6da65bcb1b..2854af3100 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRequestVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRequestVisibility.md @@ -23,6 +23,8 @@ Determines the visibility to use for a request with the given verb. ## Returns +[`Visibility`](../enumerations/Visibility.md) + The applicable parameter visibility or visibilities for the request. ## Deprecated diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getResponsesForOperation.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getResponsesForOperation.md index 6b262563a5..a2b10e35ae 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getResponsesForOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getResponsesForOperation.md @@ -15,3 +15,7 @@ Get the responses for a given operation. | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | + +## Returns + +[[`HttpOperationResponse`](../interfaces/HttpOperationResponse.md)[], readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteOptionsForNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteOptionsForNamespace.md index 73f28e58b8..f1beff5fdd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteOptionsForNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteOptionsForNamespace.md @@ -13,3 +13,7 @@ getRouteOptionsForNamespace(program, namespace): RouteOptions | undefined | :------ | :------ | | `program` | `Program` | | `namespace` | `Namespace` | + +## Returns + +[`RouteOptions`](../interfaces/RouteOptions.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRoutePath.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRoutePath.md index 47013e291f..d883ef3f0d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRoutePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRoutePath.md @@ -13,3 +13,7 @@ getRoutePath(program, entity): RoutePath | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Interface` \| `Namespace` \| `Operation` | + +## Returns + +[`RoutePath`](../interfaces/RoutePath.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteProducer.md index dfd2808edd..8c122a8a2b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteProducer.md @@ -13,3 +13,7 @@ getRouteProducer(program, operation): RouteProducer | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | + +## Returns + +[`RouteProducer`](../type-aliases/RouteProducer.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getServers.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getServers.md index 5209b6a692..4db6a74299 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getServers.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getServers.md @@ -13,3 +13,7 @@ getServers(program, type): HttpServer[] | undefined | :------ | :------ | | `program` | `Program` | | `type` | `Namespace` | + +## Returns + +[`HttpServer`](../interfaces/HttpServer.md)[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodeDescription.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodeDescription.md index 7af635a291..d868f24e8a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodeDescription.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodeDescription.md @@ -31,3 +31,7 @@ getStatusCodeDescription(statusCode): | Parameter | Type | | :------ | :------ | | `statusCode` | `string` \| `number` \| [`HttpStatusCodeRange`](../interfaces/HttpStatusCodeRange.md) | + +## Returns + + \| `undefined` \| `"Informational"` \| `"Successful"` \| `"Redirection"` \| `"Client error"` \| `"Server error"` \| `"The request has succeeded."` \| `"The request has succeeded and a new resource has been created as a result."` \| `"The request has been accepted for processing, but processing has not yet completed."` \| `"There is no content to send for this request, but the headers may be useful. "` \| `"The URL of the requested resource has been changed permanently. The new URL is given in the response."` \| `"The client has made a conditional request and the resource has not been modified."` \| `"The server could not understand the request due to invalid syntax."` \| `"Access is unauthorized."` \| `"Access is forbidden"` \| `"The server cannot find the requested resource."` \| `"The request conflicts with the current state of the server."` \| `"Precondition failed."` \| `"Service unavailable."` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodes.md index 839f283fbe..58bcbc0ce3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodes.md @@ -13,3 +13,7 @@ getStatusCodes(program, entity): HttpStatusCodes | :------ | :------ | | `program` | `Program` | | `entity` | `ModelProperty` | + +## Returns + +[`HttpStatusCodes`](../type-aliases/HttpStatusCodes.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md index befc459194..945bb11a4f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md @@ -13,3 +13,7 @@ getStatusCodesWithDiagnostics(program, type): [HttpStatusCodes, readonly Diagnos | :------ | :------ | | `program` | `Program` | | `type` | `ModelProperty` | + +## Returns + +[[`HttpStatusCodes`](../type-aliases/HttpStatusCodes.md), readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getVisibilitySuffix.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getVisibilitySuffix.md index 4cdda1001e..dd86ca4815 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getVisibilitySuffix.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getVisibilitySuffix.md @@ -27,3 +27,7 @@ Examples (with canonicalVisibility = Visibility.Read): | :------ | :------ | :------ | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | `undefined` | | `canonicalVisibility` | `undefined` \| [`Visibility`](../enumerations/Visibility.md) | `Visibility.None` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md index 8b3844fa84..293ee6ea1e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md @@ -19,6 +19,8 @@ inapplicable metadata. ## Returns +`boolean` + ## See - isApplicableMetadata diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md index ab7e3e2f8e..a560921e4a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md @@ -20,6 +20,8 @@ includeInterfaceRoutesInNamespace( ## Returns +`void` + ## Deprecated DO NOT USE. For internal use only as a workaround. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadata.md index d67080497b..76e954e79d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadata.md @@ -28,3 +28,7 @@ given visibility. | `property` | `ModelProperty` | `undefined` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | `undefined` | | `isMetadataCallback` | (`program`, `property`) => `boolean` | `isMetadata` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadataOrBody.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadataOrBody.md index 0766374972..59755082c6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadataOrBody.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadataOrBody.md @@ -22,3 +22,7 @@ applicable with the given visibility. | `property` | `ModelProperty` | `undefined` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | `undefined` | | `isMetadataCallback` | (`program`, `property`) => `boolean` | `isMetadata` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isBody.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isBody.md index ba6a93bb59..5507e46ac0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isBody.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isBody.md @@ -13,3 +13,7 @@ isBody(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isContentTypeHeader.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isContentTypeHeader.md index f4601f390f..9eb585e9b3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isContentTypeHeader.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isContentTypeHeader.md @@ -18,4 +18,6 @@ Check if the given model property is the content type header. ## Returns +`boolean` + True if the model property is marked as a header and has the name `content-type`(case insensitive.) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isHeader.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isHeader.md index e45fcf8309..12866ccaca 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isHeader.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isHeader.md @@ -13,3 +13,7 @@ isHeader(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isMetadata.md index 3222e3c661..ee8b7f7952 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isMetadata.md @@ -16,3 +16,7 @@ metadata if it is marked `@header`, `@query`, `@path`, or `@statusCode`. | :------ | :------ | | `program` | `Program` | | `property` | `ModelProperty` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isOverloadSameEndpoint.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isOverloadSameEndpoint.md index 55c0a6446f..b1523ec426 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isOverloadSameEndpoint.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isOverloadSameEndpoint.md @@ -12,3 +12,7 @@ isOverloadSameEndpoint(overload): boolean | Parameter | Type | | :------ | :------ | | `overload` | [`HttpOperation`](../interfaces/HttpOperation.md) & `object` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isPathParam.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isPathParam.md index 56ed9917c3..234c9d49c1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isPathParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isPathParam.md @@ -13,3 +13,7 @@ isPathParam(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isQueryParam.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isQueryParam.md index 20917a8cef..ce13bfe40f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isQueryParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isQueryParam.md @@ -13,3 +13,7 @@ isQueryParam(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isSharedRoute.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isSharedRoute.md index 2aab23560f..20dcc9fea4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isSharedRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isSharedRoute.md @@ -13,3 +13,7 @@ isSharedRoute(program, operation): boolean | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isStatusCode.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isStatusCode.md index 6d2c3dbd78..8242346511 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isStatusCode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isStatusCode.md @@ -13,3 +13,7 @@ isStatusCode(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isVisible.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isVisible.md index bf10fe75fe..17710f5cd9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isVisible.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isVisible.md @@ -19,3 +19,7 @@ Determines if the given property is visible with the given visibility. | `program` | `Program` | | `property` | `ModelProperty` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/listHttpOperationsIn.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/listHttpOperationsIn.md index 4d726d7d73..39c7e922c4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/listHttpOperationsIn.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/listHttpOperationsIn.md @@ -21,3 +21,5 @@ Get all the Http Operation in the given container. | `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | Resolution options | ## Returns + +[[`HttpOperation`](../interfaces/HttpOperation.md)[], readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/reportIfNoRoutes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/reportIfNoRoutes.md index 1f91975eeb..701efb6b9d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/reportIfNoRoutes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/reportIfNoRoutes.md @@ -13,3 +13,7 @@ reportIfNoRoutes(program, routes): void | :------ | :------ | | `program` | `Program` | | `routes` | [`HttpOperation`](../interfaces/HttpOperation.md)[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolvePathAndParameters.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolvePathAndParameters.md index 94c273380e..92108b6211 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolvePathAndParameters.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolvePathAndParameters.md @@ -19,3 +19,7 @@ options): DiagnosticResult | `operation` | `Operation` | | `overloadBase` | `undefined` \| [`HttpOperation`](../interfaces/HttpOperation.md) | | `options` | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | + +## Returns + +`DiagnosticResult`<`object`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolveRequestVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolveRequestVisibility.md index a186cc04ad..c563153d8f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolveRequestVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolveRequestVisibility.md @@ -23,4 +23,6 @@ Otherwise, returns the default visibility based on the HTTP verb for the operati ## Returns +[`Visibility`](../enumerations/Visibility.md) + The applicable parameter visibility or visibilities for the request. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setAuthentication.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setAuthentication.md index 95b1e8cd32..9f03e3b29e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setAuthentication.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setAuthentication.md @@ -17,3 +17,7 @@ setAuthentication( | `program` | `Program` | | `serviceNamespace` | `Namespace` | | `auth` | [`ServiceAuthentication`](../interfaces/ServiceAuthentication.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRoute.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRoute.md index ee3af48db7..3575f13220 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRoute.md @@ -17,3 +17,7 @@ setRoute( | `context` | `DecoratorContext` | | `entity` | `Type` | | `details` | [`RoutePath`](../interfaces/RoutePath.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteOptionsForNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteOptionsForNamespace.md index 320776737e..ef381fba55 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteOptionsForNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteOptionsForNamespace.md @@ -17,3 +17,7 @@ setRouteOptionsForNamespace( | `program` | `Program` | | `namespace` | `Namespace` | | `options` | [`RouteOptions`](../interfaces/RouteOptions.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteProducer.md index 3cb9e47bc8..44395324db 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteProducer.md @@ -17,3 +17,7 @@ setRouteProducer( | `program` | `Program` | | `operation` | `Operation` | | `routeProducer` | [`RouteProducer`](../type-aliases/RouteProducer.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setSharedRoute.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setSharedRoute.md index d922723c21..5a17f9bf5e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setSharedRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setSharedRoute.md @@ -13,3 +13,7 @@ setSharedRoute(program, operation): void | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setStatusCode.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setStatusCode.md index aa7246eb1b..e09ba37432 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setStatusCode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setStatusCode.md @@ -20,6 +20,8 @@ setStatusCode( ## Returns +`void` + ## Deprecated DO NOT USE, for internal use only. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/validateRouteUnique.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/validateRouteUnique.md index c9779ec6a9..8cd61c1c45 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/validateRouteUnique.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/validateRouteUnique.md @@ -17,3 +17,7 @@ validateRouteUnique( | `program` | `Program` | | `diagnostics` | `DiagnosticCollector` | | `operations` | [`HttpOperation`](../interfaces/HttpOperation.md)[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ApiKeyAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ApiKeyAuth.md index a7f2719fa1..a67d3dba6d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ApiKeyAuth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ApiKeyAuth.md @@ -37,7 +37,7 @@ Cookie: X-API-KEY=abcdef12345 | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `description`? | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | | `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | | `in` | `TLocation` | - | - | | `name` | `TName` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/AuthorizationCodeFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/AuthorizationCodeFlow.md index 8d08d57e88..bb60acc11e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/AuthorizationCodeFlow.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/AuthorizationCodeFlow.md @@ -10,7 +10,7 @@ Authorization Code flow | Property | Type | Description | | :------ | :------ | :------ | | `authorizationUrl` | `string` | - | -| `refreshUrl?` | `string` | - | +| `refreshUrl`? | `string` | - | | `scopes` | [`OAuth2Scope`](OAuth2Scope.md)[] | - | | `tokenUrl` | `string` | - | | `type` | `"authorizationCode"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BasicAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BasicAuth.md index 64ab64df50..7ddcbfea52 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BasicAuth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BasicAuth.md @@ -18,7 +18,7 @@ For example, to authorize as demo / p@55w0rd the client would send | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `description`? | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | | `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | | `scheme` | `"basic"` | - | - | | `type` | `"http"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BearerAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BearerAuth.md index 93a3cecf47..6523723bd7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BearerAuth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BearerAuth.md @@ -18,7 +18,7 @@ The client must send this token in the Authorization header when making requests | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `description`? | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | | `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | | `scheme` | `"bearer"` | - | - | | `type` | `"http"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ClientCredentialsFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ClientCredentialsFlow.md index 5f2581ad8b..bdddc9b082 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ClientCredentialsFlow.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ClientCredentialsFlow.md @@ -9,7 +9,7 @@ Client credentials flow | Property | Type | Description | | :------ | :------ | :------ | -| `refreshUrl?` | `string` | - | +| `refreshUrl`? | `string` | - | | `scopes` | [`OAuth2Scope`](OAuth2Scope.md)[] | - | | `tokenUrl` | `string` | - | | `type` | `"clientCredentials"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HeaderFieldOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HeaderFieldOptions.md index 837614e712..fdf2b65dee 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HeaderFieldOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HeaderFieldOptions.md @@ -7,6 +7,6 @@ title: "[I] HeaderFieldOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `format?` | \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` \| `"form"` | The string format of the array. "csv" and "simple" are used interchangeably, as are
"multi" and "form". | +| `format`? | \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` \| `"form"` | The string format of the array. "csv" and "simple" are used interchangeably, as are
"multi" and "form". | | `name` | `string` | - | | `type` | `"header"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpAuthBase.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpAuthBase.md index a0f47d0f33..7c014c0c95 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpAuthBase.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpAuthBase.md @@ -14,5 +14,5 @@ title: "[I] HttpAuthBase" | Property | Type | Description | | :------ | :------ | :------ | -| `description?` | `string` | Optional description. | +| `description`? | `string` | Optional description. | | `id` | `string` | Id of the authentication scheme. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperation.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperation.md index 54b3006633..c4e64662bc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperation.md @@ -9,8 +9,8 @@ title: "[I] HttpOperation" | :------ | :------ | :------ | | `container` | [`OperationContainer`](../type-aliases/OperationContainer.md) | Parent type being the interface, namespace or global namespace. | | `operation` | `Operation` | Operation type reference. | -| `overloading?` | [`HttpOperation`](HttpOperation.md) | Overload this operation | -| `overloads?` | [`HttpOperation`](HttpOperation.md)[] | List of operations that overloads this one. | +| `overloading`? | [`HttpOperation`](HttpOperation.md) | Overload this operation | +| `overloads`? | [`HttpOperation`](HttpOperation.md)[] | List of operations that overloads this one. | | `parameters` | [`HttpOperationParameters`](HttpOperationParameters.md) | Parameters. | | `path` | `string` | Route path | | `pathSegments` | `string`[] | Path segments | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationParameters.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationParameters.md index 46ee03bfa2..74965c746c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationParameters.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationParameters.md @@ -7,7 +7,7 @@ title: "[I] HttpOperationParameters" | Property | Type | Description | | :------ | :------ | :------ | -| `body?` | [`HttpOperationRequestBody`](HttpOperationRequestBody.md) | - | -| `bodyParameter?` | `ModelProperty` | **Deprecated**

use body.parameter | -| `bodyType?` | `Type` | **Deprecated**

use body.type | +| `body`? | [`HttpOperationRequestBody`](HttpOperationRequestBody.md) | - | +| `bodyParameter`? | `ModelProperty` | **Deprecated**

use body.parameter | +| `bodyType`? | `Type` | **Deprecated**

use body.type | | `parameters` | [`HttpOperationParameter`](../type-aliases/HttpOperationParameter.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationRequestBody.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationRequestBody.md index 2a9975009b..8e64e7b764 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationRequestBody.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationRequestBody.md @@ -18,5 +18,5 @@ the `type` must be a `Model` if the content type is multipart. | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `contentTypes` | `string`[] | Content types. | [`HttpOperationBody`](HttpOperationBody.md).`contentTypes` | -| `parameter?` | `ModelProperty` | If the body was explicitly set as a property. Correspond to the property with `@body` | - | +| `parameter`? | `ModelProperty` | If the body was explicitly set as a property. Correspond to the property with `@body` | - | | `type` | `Type` | Type of the operation body. | [`HttpOperationBody`](HttpOperationBody.md).`type` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponse.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponse.md index 0696432090..a1b8a87fa1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponse.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponse.md @@ -7,7 +7,7 @@ title: "[I] HttpOperationResponse" | Property | Type | Description | | :------ | :------ | :------ | -| `description?` | `string` | Response description. | +| `description`? | `string` | Response description. | | `responses` | [`HttpOperationResponseContent`](HttpOperationResponseContent.md)[] | Responses contents. | | `statusCode` | [`StatusCode`](../type-aliases/StatusCode.md) | **Deprecated**

use [statusCodes](HttpOperationResponse.md) | | `statusCodes` | `number` \| `"*"` \| [`HttpStatusCodeRange`](HttpStatusCodeRange.md) | Status code or range of status code for the response. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponseContent.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponseContent.md index 09b3215d45..7351da6b90 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponseContent.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponseContent.md @@ -7,5 +7,5 @@ title: "[I] HttpOperationResponseContent" | Property | Type | Description | | :------ | :------ | :------ | -| `body?` | [`HttpOperationBody`](HttpOperationBody.md) | - | -| `headers?` | `Record`<`string`, `ModelProperty`\> | - | +| `body`? | [`HttpOperationBody`](HttpOperationBody.md) | - | +| `headers`? | `Record`<`string`, `ModelProperty`\> | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ImplicitFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ImplicitFlow.md index ea657e4562..1f27eeef36 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ImplicitFlow.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ImplicitFlow.md @@ -10,6 +10,6 @@ Implicit flow | Property | Type | Description | | :------ | :------ | :------ | | `authorizationUrl` | `string` | - | -| `refreshUrl?` | `string` | - | +| `refreshUrl`? | `string` | - | | `scopes` | [`OAuth2Scope`](OAuth2Scope.md)[] | - | | `type` | `"implicit"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfo.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfo.md index 0903bf3af8..d7b0b49ae5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfo.md @@ -26,6 +26,10 @@ same set of properties when non-payload properties are excluded. | `type` | `Type` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | +#### Returns + +`Type` + *** ### isEmptied() @@ -50,6 +54,10 @@ itself is also removed. | `type` | `undefined` \| `Type` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | +#### Returns + +`boolean` + *** ### isOptional() @@ -68,6 +76,10 @@ response payload for the given visibility. | `property` | `ModelProperty` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | +#### Returns + +`boolean` + *** ### isPayloadProperty() @@ -87,6 +99,10 @@ filtered out by the given visibility. | `property` | `ModelProperty` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | +#### Returns + +`boolean` + *** ### isTransformed() @@ -105,3 +121,7 @@ metadata properties. | :------ | :------ | | `type` | `undefined` \| `Type` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfoOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfoOptions.md index d31ce48a8d..cfce277f14 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfoOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfoOptions.md @@ -7,7 +7,7 @@ title: "[I] MetadataInfoOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `canonicalVisibility?` | [`Visibility`](../enumerations/Visibility.md) | The visibility to be used as the baseline against which
[MetadataInfo.isEmptied](MetadataInfo.md#isemptied) and [MetadataInfo.isTransformed](MetadataInfo.md#istransformed)
are computed. If not specified, [Visibility.None](../enumerations/Visibility.md) is used, which
will consider that any model that has fields that are only visible to
some visibilities as transformed. | +| `canonicalVisibility`? | [`Visibility`](../enumerations/Visibility.md) | The visibility to be used as the baseline against which
[MetadataInfo.isEmptied](MetadataInfo.md#isemptied) and [MetadataInfo.isTransformed](MetadataInfo.md#istransformed)
are computed. If not specified, [Visibility.None](../enumerations/Visibility.md) is used, which
will consider that any model that has fields that are only visible to
some visibilities as transformed. | ## Methods @@ -29,3 +29,7 @@ creating a separate schema schema for [Visibility.Read](../enumerations/Visibili | Parameter | Type | | :------ | :------ | | `property` | `ModelProperty` | + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OAuth2Scope.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OAuth2Scope.md index 58030f0a1f..382b113163 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OAuth2Scope.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OAuth2Scope.md @@ -7,5 +7,5 @@ title: "[I] OAuth2Scope" | Property | Type | Description | | :------ | :------ | :------ | -| `description?` | `string` | - | +| `description`? | `string` | - | | `value` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/Oauth2Auth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/Oauth2Auth.md index 1e23a42405..cc8e15800d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/Oauth2Auth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/Oauth2Auth.md @@ -22,7 +22,7 @@ For more information about OAuth 2.0, see oauth.net and RFC 6749. | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `description`? | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | | `flows` | `TFlows` | - | - | | `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | | `type` | `"oauth2"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OperationParameterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OperationParameterOptions.md index 796a441838..c0866b792f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OperationParameterOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OperationParameterOptions.md @@ -7,4 +7,4 @@ title: "[I] OperationParameterOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `verbSelector?` | [`OperationVerbSelector`](../type-aliases/OperationVerbSelector.md) | - | +| `verbSelector`? | [`OperationVerbSelector`](../type-aliases/OperationVerbSelector.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/PasswordFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/PasswordFlow.md index 4c0ba57d72..b0f220806c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/PasswordFlow.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/PasswordFlow.md @@ -10,6 +10,6 @@ Resource Owner Password flow | Property | Type | Description | | :------ | :------ | :------ | | `authorizationUrl` | `string` | - | -| `refreshUrl?` | `string` | - | +| `refreshUrl`? | `string` | - | | `scopes` | [`OAuth2Scope`](OAuth2Scope.md)[] | - | | `type` | `"password"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/QueryParameterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/QueryParameterOptions.md index 7ac6b91f02..bc24e539cf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/QueryParameterOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/QueryParameterOptions.md @@ -7,6 +7,6 @@ title: "[I] QueryParameterOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `format?` | \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` \| `"form"` | The string format of the array. "csv" and "simple" are used interchangeably, as are
"multi" and "form". | +| `format`? | \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` \| `"form"` | The string format of the array. "csv" and "simple" are used interchangeably, as are
"multi" and "form". | | `name` | `string` | - | | `type` | `"query"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteOptions.md index 6f88a4d2cb..4229c8222c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteOptions.md @@ -15,4 +15,4 @@ title: "[I] RouteOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `paramOptions?` | [`OperationParameterOptions`](OperationParameterOptions.md) | - | +| `paramOptions`? | [`OperationParameterOptions`](OperationParameterOptions.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteResolutionOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteResolutionOptions.md index 6731e98e36..9ec8a3ee4c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteResolutionOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteResolutionOptions.md @@ -11,5 +11,5 @@ title: "[I] RouteResolutionOptions" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `listOptions?` | `ListOperationOptions` | - | - | -| `paramOptions?` | [`OperationParameterOptions`](OperationParameterOptions.md) | - | [`RouteOptions`](RouteOptions.md).`paramOptions` | +| `listOptions`? | `ListOperationOptions` | - | - | +| `paramOptions`? | [`OperationParameterOptions`](OperationParameterOptions.md) | - | [`RouteOptions`](RouteOptions.md).`paramOptions` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OAuth2FlowType.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OAuth2FlowType.md index 599818333a..09f7f1aebc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OAuth2FlowType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OAuth2FlowType.md @@ -4,5 +4,5 @@ title: "[T] OAuth2FlowType" --- ```ts -type OAuth2FlowType: OAuth2Flow["type"]; +type OAuth2FlowType: OAuth2Flow\["type"\]; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationVerbSelector.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationVerbSelector.md index d8815ecd75..5f383d5609 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationVerbSelector.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationVerbSelector.md @@ -13,3 +13,7 @@ type OperationVerbSelector: (program, operation) => HttpVerb | undefined; | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | + +## Returns + +[`HttpVerb`](HttpVerb.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/RouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/RouteProducer.md index 336a0c4b25..e2bdd52e58 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/RouteProducer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/RouteProducer.md @@ -16,3 +16,7 @@ type RouteProducer: (program, operation, parentSegments, overloadBase, options) | `parentSegments` | `string`[] | | `overloadBase` | [`HttpOperation`](../interfaces/HttpOperation.md) \| `undefined` | | `options` | [`RouteOptions`](../interfaces/RouteOptions.md) | + +## Returns + +`DiagnosticResult`<[`RouteProducerResult`](../interfaces/RouteProducerResult.md)\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/classes/JsonSchemaEmitter.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/classes/JsonSchemaEmitter.md index 34e4a1e707..0b43be4178 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/classes/JsonSchemaEmitter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/classes/JsonSchemaEmitter.md @@ -24,6 +24,10 @@ call `createAssetEmitter` on the emitter context object. | :------ | :------ | :------ | | `emitter` | `AssetEmitter`<`Record`<`string`, `any`\>, [`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> | The asset emitter | +#### Returns + +[`JsonSchemaEmitter`](JsonSchemaEmitter.md) + #### Inherited from TypeEmitter, JSONSchemaEmitterOptions\>.constructor @@ -52,6 +56,10 @@ private #applyConstraints(type, schema): void | `type` | \| `Model` \| `ModelProperty` \| `Scalar` \| `Enum` \| `Union` | | `schema` | `ObjectBuilder`<`unknown`\> | +#### Returns + +`void` + *** ### #checkForDuplicateId() @@ -66,6 +74,10 @@ private #checkForDuplicateId(id): string | :------ | :------ | | `id` | `string` | +#### Returns + +`string` + *** ### #createDeclaration() @@ -85,6 +97,10 @@ schema): Declaration> | `name` | `string` | | `schema` | `ObjectBuilder`<`unknown`\> | +#### Returns + +`Declaration`<`Record`<`string`, `any`\>\> + *** ### #fileExtension() @@ -93,6 +109,10 @@ schema): Declaration> private #fileExtension(): "json" | "yaml" ``` +#### Returns + +`"json"` \| `"yaml"` + *** ### #getCurrentSourceFile() @@ -101,6 +121,10 @@ private #fileExtension(): "json" | "yaml" private #getCurrentSourceFile(): SourceFile ``` +#### Returns + +`SourceFile`<`object`\> + *** ### #getDeclId() @@ -116,6 +140,10 @@ private #getDeclId(type, name): string | `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | | `name` | `string` | +#### Returns + +`string` + *** ### #isStdType() @@ -130,6 +158,10 @@ private #isStdType(type): boolean | :------ | :------ | | `type` | `Type` | +#### Returns + +`boolean` + *** ### #newFileScope() @@ -146,6 +178,8 @@ private #newFileScope(type): object #### Returns +`object` + > | Member | Type | Description | > | :------ | :------ | :------ | > | `scope` | `Scope`<`Record`<`string`, `any`\>\> | - | @@ -165,6 +199,10 @@ private #requiredModelProperties(model): undefined | string[] | :------ | :------ | | `model` | `Model` | +#### Returns + +`undefined` \| `string`[] + *** ### #scalarBuiltinBaseType() @@ -179,6 +217,10 @@ private #scalarBuiltinBaseType(scalar): null | Scalar | :------ | :------ | | `scalar` | `Scalar` | +#### Returns + +`null` \| `Scalar` + *** ### arrayDeclaration() @@ -198,6 +240,10 @@ elementType): EmitterOutput | `name` | `string` | | `elementType` | `Type` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.arrayDeclaration @@ -216,6 +262,10 @@ arrayDeclarationContext(array): Context | :------ | :------ | | `array` | `Model` | +#### Returns + +`Context` + #### Overrides TypeEmitter.arrayDeclarationContext @@ -239,6 +289,10 @@ arrayDeclarationReferenceContext( | `name` | `string` | | `elementType` | `Type` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.arrayDeclarationReferenceContext @@ -258,6 +312,10 @@ arrayLiteral(array, elementType): EmitterOutput | `array` | `Model` | | `elementType` | `Type` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.arrayLiteral @@ -277,6 +335,10 @@ arrayLiteralContext(array, elementType): Context | `array` | `Model` | | `elementType` | `Type` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.arrayLiteralContext @@ -296,6 +358,10 @@ arrayLiteralReferenceContext(array, elementType): Context | `array` | `Model` | | `elementType` | `Type` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.arrayLiteralReferenceContext @@ -314,6 +380,10 @@ booleanLiteral(boolean): EmitterOutput | :------ | :------ | | `boolean` | `BooleanLiteral` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.booleanLiteral @@ -332,12 +402,48 @@ booleanLiteralContext(boolean): Context | :------ | :------ | | `boolean` | `BooleanLiteral` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.booleanLiteralContext *** +### circularReference() + +```ts +circularReference( + target, + scope, +cycle): Record | EmitEntity> +``` + +Handle circular references. When this method is called it means we are resolving a circular reference. +By default if the target is a declaration it will call to [reference](JsonSchemaEmitter.md#reference) otherwise it means we have an inline reference + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `target` | `EmitEntity`<`Record`<`string`, `any`\>\> | Reference target. | +| `scope` | `undefined` \| `Scope`<`Record`<`string`, `any`\>\> | Current scope. | +| `cycle` | `ReferenceCycle` | - | + +#### Returns + +`Record`<`string`, `any`\> \| `EmitEntity`<`Record`<`string`, `any`\>\> + +Resolved reference entity. + +#### Inherited from + +TypeEmitter.circularReference + +*** + ### declarationName() ```ts @@ -350,6 +456,10 @@ declarationName(declarationType): undefined | string | :------ | :------ | | `declarationType` | `TypeSpecDeclaration` | +#### Returns + +`undefined` \| `string` + #### Inherited from TypeEmitter.declarationName @@ -369,6 +479,10 @@ enumDeclaration(en, name): EmitterOutput | `en` | `Enum` | | `name` | `string` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.enumDeclaration @@ -387,6 +501,10 @@ enumDeclarationContext(en): Context | :------ | :------ | | `en` | `Enum` | +#### Returns + +`Context` + #### Overrides TypeEmitter.enumDeclarationContext @@ -405,6 +523,10 @@ enumMember(member): EmitterOutput> | :------ | :------ | | `member` | `EnumMember` | +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + #### Inherited from TypeEmitter.enumMember @@ -423,6 +545,10 @@ enumMemberContext(member): object | :------ | :------ | | `member` | `EnumMember` | +#### Returns + +`object` + #### Inherited from TypeEmitter.enumMemberContext @@ -441,6 +567,10 @@ enumMemberReference(member): EmitterOutput> | :------ | :------ | | `member` | `EnumMember` | +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + #### Overrides TypeEmitter.enumMemberReference @@ -459,6 +589,10 @@ enumMembers(en): EmitterOutput> | :------ | :------ | | `en` | `Enum` | +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + #### Inherited from TypeEmitter.enumMembers @@ -477,6 +611,10 @@ enumMembersContext(en): Context | :------ | :------ | | `en` | `Enum` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.enumMembersContext @@ -496,6 +634,10 @@ interfaceDeclaration(iface, name): EmitterOutput> | `iface` | `Interface` | | `name` | `string` | +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + #### Inherited from TypeEmitter.interfaceDeclaration @@ -515,6 +657,10 @@ interfaceDeclarationContext(iface, name): Context | `iface` | `Interface` | | `name` | `string` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.interfaceDeclarationContext @@ -533,6 +679,10 @@ interfaceDeclarationOperations(iface): EmitterOutput> | :------ | :------ | | `iface` | `Interface` | +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + #### Inherited from TypeEmitter.interfaceDeclarationOperations @@ -551,6 +701,10 @@ interfaceDeclarationOperationsContext(iface): Context | :------ | :------ | | `iface` | `Interface` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.interfaceDeclarationOperationsContext @@ -569,6 +723,10 @@ interfaceDeclarationOperationsReferenceContext(iface): Context | :------ | :------ | | `iface` | `Interface` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.interfaceDeclarationOperationsReferenceContext @@ -588,6 +746,10 @@ interfaceDeclarationReferenceContext(iface, name): Context | `iface` | `Interface` | | `name` | `string` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.interfaceDeclarationReferenceContext @@ -607,6 +769,10 @@ interfaceOperationDeclaration(operation, name): EmitterOutput\> + #### Inherited from TypeEmitter.interfaceOperationDeclaration @@ -626,6 +792,10 @@ interfaceOperationDeclarationContext(operation, name): Context | `operation` | `Operation` | | `name` | `string` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.interfaceOperationDeclarationContext @@ -645,6 +815,10 @@ interfaceOperationDeclarationReferenceContext(operation, name): Context | `operation` | `Operation` | | `name` | `string` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.interfaceOperationDeclarationReferenceContext @@ -664,6 +838,10 @@ intrinsic(intrinsic, name): EmitterOutput | `intrinsic` | `IntrinsicType` | | `name` | `string` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.intrinsic @@ -683,6 +861,10 @@ intrinsicContext(intrinsic, name): Context | `intrinsic` | `IntrinsicType` | | `name` | `string` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.intrinsicContext @@ -702,6 +884,10 @@ modelDeclaration(model, name): EmitterOutput | `model` | `Model` | | `name` | `string` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.modelDeclaration @@ -721,6 +907,10 @@ modelDeclarationContext(model, name): Context | `model` | `Model` | | `name` | `string` | +#### Returns + +`Context` + #### Overrides TypeEmitter.modelDeclarationContext @@ -742,6 +932,10 @@ Set reference context for a model declaration. | `model` | `Model` | | | `name` | `string` | - | +#### Returns + +`Context` + #### Inherited from TypeEmitter.modelDeclarationReferenceContext @@ -761,6 +955,10 @@ modelInstantiation(model, name): EmitterOutput> | `model` | `Model` | | `name` | `undefined` \| `string` | +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + #### Overrides TypeEmitter.modelInstantiation @@ -780,6 +978,10 @@ modelInstantiationContext(model, name): Context | `model` | `Model` | | `name` | `undefined` \| `string` | +#### Returns + +`Context` + #### Overrides TypeEmitter.modelInstantiationContext @@ -801,6 +1003,10 @@ Set reference context for a model declaration. | `model` | `Model` | | | `name` | `undefined` \| `string` | - | +#### Returns + +`Context` + #### Inherited from TypeEmitter.modelInstantiationReferenceContext @@ -819,6 +1025,10 @@ modelLiteral(model): EmitterOutput | :------ | :------ | | `model` | `Model` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.modelLiteral @@ -839,6 +1049,10 @@ Set lexical context for a model literal. | :------ | :------ | :------ | | `model` | `Model` | | +#### Returns + +`Context` + #### Inherited from TypeEmitter.modelLiteralContext @@ -859,6 +1073,10 @@ Set reference context for a model literal. | :------ | :------ | :------ | | `model` | `Model` | | +#### Returns + +`Context` + #### Inherited from TypeEmitter.modelLiteralReferenceContext @@ -877,6 +1095,10 @@ modelProperties(model): EmitterOutput | :------ | :------ | | `model` | `Model` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.modelProperties @@ -895,6 +1117,10 @@ modelPropertiesContext(model): Context | :------ | :------ | | `model` | `Model` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.modelPropertiesContext @@ -913,6 +1139,10 @@ modelPropertiesReferenceContext(model): Context | :------ | :------ | | `model` | `Model` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.modelPropertiesReferenceContext @@ -931,6 +1161,10 @@ modelPropertyLiteral(property): EmitterOutput | :------ | :------ | | `property` | `ModelProperty` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.modelPropertyLiteral @@ -951,6 +1185,10 @@ Set lexical context for a property of a model. | :------ | :------ | :------ | | `property` | `ModelProperty` | | +#### Returns + +`Context` + #### Inherited from TypeEmitter.modelPropertyLiteralContext @@ -971,6 +1209,10 @@ Set reference context for a property of a model. | :------ | :------ | :------ | | `property` | `ModelProperty` | | +#### Returns + +`Context` + #### Inherited from TypeEmitter.modelPropertyLiteralReferenceContext @@ -989,6 +1231,10 @@ modelPropertyReference(property): EmitterOutput | :------ | :------ | | `property` | `ModelProperty` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.modelPropertyReference @@ -1011,6 +1257,8 @@ Emit a namespace #### Returns +`EmitterOutput`<`Record`<`string`, `any`\>\> + Emitter output #### Inherited from @@ -1033,6 +1281,10 @@ Set lexical context for a namespace | :------ | :------ | :------ | | `namespace` | `Namespace` | | +#### Returns + +`Context` + #### Inherited from TypeEmitter.namespaceContext @@ -1053,6 +1305,10 @@ Set reference context for a namespace. | :------ | :------ | :------ | | `namespace` | `Namespace` | | +#### Returns + +`Context` + #### Inherited from TypeEmitter.namespaceReferenceContext @@ -1071,6 +1327,10 @@ numericLiteral(number): EmitterOutput | :------ | :------ | | `number` | `NumericLiteral` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.numericLiteral @@ -1089,6 +1349,10 @@ numericLiteralContext(number): Context | :------ | :------ | | `number` | `NumericLiteral` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.numericLiteralContext @@ -1108,6 +1372,10 @@ operationDeclaration(operation, name): EmitterOutput> | `operation` | `Operation` | | `name` | `string` | +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + #### Inherited from TypeEmitter.operationDeclaration @@ -1127,6 +1395,10 @@ operationDeclarationContext(operation, name): Context | `operation` | `Operation` | | `name` | `string` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.operationDeclarationContext @@ -1146,6 +1418,10 @@ operationDeclarationReferenceContext(operation, name): Context | `operation` | `Operation` | | `name` | `string` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.operationDeclarationReferenceContext @@ -1165,6 +1441,10 @@ operationParameters(operation, parameters): EmitterOutput> | `operation` | `Operation` | | `parameters` | `Model` | +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + #### Inherited from TypeEmitter.operationParameters @@ -1184,6 +1464,10 @@ operationParametersContext(operation, parameters): Context | `operation` | `Operation` | | `parameters` | `Model` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.operationParametersContext @@ -1203,6 +1487,10 @@ operationParametersReferenceContext(operation, parameters): Context | `operation` | `Operation` | | `parameters` | `Model` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.operationParametersReferenceContext @@ -1222,6 +1510,10 @@ operationReturnType(operation, returnType): EmitterOutput> | `operation` | `Operation` | | `returnType` | `Type` | +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + #### Inherited from TypeEmitter.operationReturnType @@ -1241,6 +1533,10 @@ operationReturnTypeContext(operation, returnType): Context | `operation` | `Operation` | | `returnType` | `Type` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.operationReturnTypeContext @@ -1260,6 +1556,10 @@ operationReturnTypeReferenceContext(operation, returnType): Context | `operation` | `Operation` | | `returnType` | `Type` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.operationReturnTypeReferenceContext @@ -1278,6 +1578,10 @@ programContext(program): Context | :------ | :------ | | `program` | `Program` | +#### Returns + +`Context` + #### Overrides TypeEmitter.programContext @@ -1303,6 +1607,10 @@ commonScope): object | EmitEntity> | `pathDown` | `Scope`<`Record`<`string`, `unknown`\>\>[] | | `commonScope` | `null` \| `Scope`<`Record`<`string`, `unknown`\>\> | +#### Returns + +`object` \| `EmitEntity`<`Record`<`string`, `unknown`\>\> + #### Overrides TypeEmitter.reference @@ -1322,6 +1630,10 @@ scalarDeclaration(scalar, name): EmitterOutput | `scalar` | `Scalar` | | `name` | `string` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.scalarDeclaration @@ -1340,6 +1652,10 @@ scalarDeclarationContext(scalar): Context | :------ | :------ | | `scalar` | `Scalar` | +#### Returns + +`Context` + #### Overrides TypeEmitter.scalarDeclarationContext @@ -1359,6 +1675,10 @@ scalarInstantiation(scalar, name): EmitterOutput> | `scalar` | `Scalar` | | `name` | `undefined` \| `string` | +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + #### Inherited from TypeEmitter.scalarInstantiation @@ -1378,6 +1698,10 @@ scalarInstantiationContext(scalar, name): Context | `scalar` | `Scalar` | | `name` | `undefined` \| `string` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.scalarInstantiationContext @@ -1396,6 +1720,10 @@ sourceFile(sourceFile): EmittedSourceFile | :------ | :------ | | `sourceFile` | `SourceFile`<`object`\> | +#### Returns + +`EmittedSourceFile` + #### Overrides TypeEmitter.sourceFile @@ -1414,6 +1742,10 @@ stringLiteral(string): EmitterOutput | :------ | :------ | | `string` | `StringLiteral` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.stringLiteral @@ -1432,6 +1764,10 @@ stringLiteralContext(string): Context | :------ | :------ | | `string` | `StringLiteral` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.stringLiteralContext @@ -1450,7 +1786,11 @@ tupleLiteral(tuple): EmitterOutput> | :------ | :------ | | `tuple` | `Tuple` | -#### Inherited from +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + +#### Overrides TypeEmitter.tupleLiteral @@ -1468,6 +1808,10 @@ tupleLiteralContext(tuple): Context | :------ | :------ | | `tuple` | `Tuple` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.tupleLiteralContext @@ -1486,6 +1830,10 @@ tupleLiteralReferenceContext(tuple): Context | :------ | :------ | | `tuple` | `Tuple` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.tupleLiteralReferenceContext @@ -1504,12 +1852,60 @@ tupleLiteralValues(tuple): EmitterOutput> | :------ | :------ | | `tuple` | `Tuple` | -#### Inherited from +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + +#### Overrides TypeEmitter.tupleLiteralValues *** +### tupleLiteralValuesContext() + +```ts +tupleLiteralValuesContext(tuple): Context +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `tuple` | `Tuple` | + +#### Returns + +`Context` + +#### Inherited from + +TypeEmitter.tupleLiteralValuesContext + +*** + +### tupleLiteralValuesReferenceContext() + +```ts +tupleLiteralValuesReferenceContext(tuple): Context +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `tuple` | `Tuple` | + +#### Returns + +`Context` + +#### Inherited from + +TypeEmitter.tupleLiteralValuesReferenceContext + +*** + ### unionDeclaration() ```ts @@ -1523,6 +1919,10 @@ unionDeclaration(union, name): EmitterOutput | `union` | `Union` | | `name` | `string` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.unionDeclaration @@ -1541,6 +1941,10 @@ unionDeclarationContext(union): Context | :------ | :------ | | `union` | `Union` | +#### Returns + +`Context` + #### Overrides TypeEmitter.unionDeclarationContext @@ -1559,6 +1963,10 @@ unionDeclarationReferenceContext(union): Context | :------ | :------ | | `union` | `Union` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.unionDeclarationReferenceContext @@ -1578,6 +1986,10 @@ unionInstantiation(union, name): EmitterOutput> | `union` | `Union` | | `name` | `string` | +#### Returns + +`EmitterOutput`<`Record`<`string`, `any`\>\> + #### Inherited from TypeEmitter.unionInstantiation @@ -1597,6 +2009,10 @@ unionInstantiationContext(union, name): Context | `union` | `Union` | | `name` | `string` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.unionInstantiationContext @@ -1616,6 +2032,10 @@ unionInstantiationReferenceContext(union, name): Context | `union` | `Union` | | `name` | `string` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.unionInstantiationReferenceContext @@ -1634,6 +2054,10 @@ unionLiteral(union): EmitterOutput | :------ | :------ | | `union` | `Union` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.unionLiteral @@ -1652,6 +2076,10 @@ unionLiteralContext(union): Context | :------ | :------ | | `union` | `Union` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.unionLiteralContext @@ -1670,6 +2098,10 @@ unionLiteralReferenceContext(union): Context | :------ | :------ | | `union` | `Union` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.unionLiteralReferenceContext @@ -1688,6 +2120,10 @@ unionVariant(variant): EmitterOutput | :------ | :------ | | `variant` | `UnionVariant` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.unionVariant @@ -1706,6 +2142,10 @@ unionVariantContext(union): Context | :------ | :------ | | `union` | `Union` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.unionVariantContext @@ -1724,6 +2164,10 @@ unionVariantReferenceContext(union): Context | :------ | :------ | | `union` | `Union` | +#### Returns + +`Context` + #### Inherited from TypeEmitter.unionVariantReferenceContext @@ -1742,6 +2186,10 @@ unionVariants(union): EmitterOutput | :------ | :------ | | `union` | `Union` | +#### Returns + +`EmitterOutput`<`object`\> + #### Overrides TypeEmitter.unionVariants @@ -1754,6 +2202,10 @@ TypeEmitter.unionVariants unionVariantsContext(): Context ``` +#### Returns + +`Context` + #### Inherited from TypeEmitter.unionVariantsContext @@ -1766,6 +2218,10 @@ TypeEmitter.unionVariantsContext unionVariantsReferenceContext(): Context ``` +#### Returns + +`Context` + #### Inherited from TypeEmitter.unionVariantsReferenceContext @@ -1784,6 +2240,10 @@ writeOutput(sourceFiles): Promise | :------ | :------ | | `sourceFiles` | `SourceFile`<`Record`<`string`, `any`\>\>[] | +#### Returns + +`Promise`<`void`\> + #### Overrides TypeEmitter.writeOutput diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$baseUri.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$baseUri.md index 4fb6ee2ccd..119e6ad700 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$baseUri.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$baseUri.md @@ -17,3 +17,7 @@ $baseUri( | `context` | `DecoratorContext` | | `target` | `Namespace` | | `baseUri` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contains.md index 77d35d5d4e..fcf787f237 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contains.md @@ -17,3 +17,7 @@ $contains( | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `value` | `Type` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentEncoding.md index 2dcef7681d..e870014ec8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentEncoding.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentEncoding.md @@ -17,3 +17,7 @@ $contentEncoding( | `context` | `DecoratorContext` | | `target` | `StringLiteral` \| `ModelProperty` | | `value` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentMediaType.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentMediaType.md index efdd8b2caf..9a10f6fd39 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentMediaType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentMediaType.md @@ -17,3 +17,7 @@ $contentMediaType( | `context` | `DecoratorContext` | | `target` | `StringLiteral` \| `ModelProperty` | | `value` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentSchema.md index e0ea17ecb7..f664a3f065 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentSchema.md @@ -17,3 +17,7 @@ $contentSchema( | `context` | `DecoratorContext` | | `target` | `StringLiteral` \| `ModelProperty` | | `value` | `Type` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$extension.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$extension.md index 62fa25355f..b281f98f46 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$extension.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$extension.md @@ -19,3 +19,7 @@ $extension( | `target` | `Type` | | `key` | `string` | | `value` | `Type` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$id.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$id.md index a9a22c68e0..36d72d7118 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$id.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$id.md @@ -17,3 +17,7 @@ $id( | `context` | `DecoratorContext` | | `target` | `Model` \| `Scalar` \| `Enum` \| `Union` | | `value` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$jsonSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$jsonSchema.md index d71d8272f1..79a46a5842 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$jsonSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$jsonSchema.md @@ -17,3 +17,7 @@ $jsonSchema( | `context` | `DecoratorContext` | | `target` | `Namespace` \| [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | | `baseUriOrId`? | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxContains.md index b6433ac379..7e576fdf86 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxContains.md @@ -17,3 +17,7 @@ $maxContains( | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `value` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxProperties.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxProperties.md index 3797b6ed0a..f91622f707 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxProperties.md @@ -17,3 +17,7 @@ $maxProperties( | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `value` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minContains.md index aa8d6c5779..0ae50378ee 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minContains.md @@ -17,3 +17,7 @@ $minContains( | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `value` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minProperties.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minProperties.md index 7220726f9e..a48e1f0f64 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minProperties.md @@ -17,3 +17,7 @@ $minProperties( | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `value` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$multipleOf.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$multipleOf.md index 29df2c371b..7feeb085c1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$multipleOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$multipleOf.md @@ -17,3 +17,7 @@ $multipleOf( | `context` | `DecoratorContext` | | `target` | `Model` | | `value` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$onEmit.md index c8d2de9fb2..34fd56356c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$onEmit.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$onEmit.md @@ -12,3 +12,7 @@ $onEmit(context): Promise | Parameter | Type | | :------ | :------ | | `context` | `EmitContext`<[`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> | + +## Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$prefixItems.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$prefixItems.md index efe0c3c814..f26b84cce1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$prefixItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$prefixItems.md @@ -17,3 +17,7 @@ $prefixItems( | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `value` | `Tuple` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$uniqueItems.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$uniqueItems.md index d1e815ecfc..cd02cd49ca 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$uniqueItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$uniqueItems.md @@ -13,3 +13,7 @@ $uniqueItems(context, target): void | :------ | :------ | | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$validatesRawJson.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$validatesRawJson.md index 2b38c02950..3ab8854606 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$validatesRawJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$validatesRawJson.md @@ -17,3 +17,7 @@ $validatesRawJson( | `context` | `DecoratorContext` | | `target` | `Model` | | `value` | `Type` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/findBaseUri.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/findBaseUri.md index 8278960d03..2874a653dd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/findBaseUri.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/findBaseUri.md @@ -13,3 +13,7 @@ findBaseUri(program, target): string | undefined | :------ | :------ | | `program` | `Program` | | `target` | `Namespace` \| [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getBaseUri.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getBaseUri.md index dd83a9c6c9..c94f662005 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getBaseUri.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getBaseUri.md @@ -13,3 +13,7 @@ getBaseUri(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContains.md index 17ffcc61ec..b0da5ad87f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContains.md @@ -13,3 +13,7 @@ getContains(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentEncoding.md index efff65e2a2..daaac1ade3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentEncoding.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentEncoding.md @@ -13,3 +13,7 @@ getContentEncoding(program, target): string | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentMediaType.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentMediaType.md index 774f13f7bf..a3e3c8a6c0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentMediaType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentMediaType.md @@ -13,3 +13,7 @@ getContentMediaType(program, target): string | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentSchema.md index 2ed8dd9350..52c63e3751 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentSchema.md @@ -13,3 +13,7 @@ getContentSchema(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getExtensions.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getExtensions.md index d254dde711..36a2585205 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getExtensions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getExtensions.md @@ -13,3 +13,7 @@ getExtensions(program, target): ExtensionRecord[] | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +[`ExtensionRecord`](../interfaces/ExtensionRecord.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getId.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getId.md index 468b2321a9..c1a7a41f97 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getId.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getId.md @@ -13,3 +13,7 @@ getId(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchema.md index 39392a1288..d08e1edf47 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchema.md @@ -13,3 +13,7 @@ getJsonSchema(program, target): boolean | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchemaTypes.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchemaTypes.md index 6dc439ba2f..1d0453f616 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchemaTypes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchemaTypes.md @@ -12,3 +12,7 @@ getJsonSchemaTypes(program): (Namespace | Model)[] | Parameter | Type | | :------ | :------ | | `program` | `Program` | + +## Returns + +(`Namespace` \| `Model`)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxContains.md index 1bd1d037a9..1444d48312 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxContains.md @@ -13,3 +13,7 @@ getMaxContains(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxProperties.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxProperties.md index b7fadc390d..d00b87352e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxProperties.md @@ -13,3 +13,7 @@ getMaxProperties(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinContains.md index 44059475b4..84ee972bfd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinContains.md @@ -13,3 +13,7 @@ getMinContains(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinProperties.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinProperties.md index 5ab738c867..6c748548e2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinProperties.md @@ -13,3 +13,7 @@ getMinProperties(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMultipleOf.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMultipleOf.md index f312718da3..1c0a704b15 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMultipleOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMultipleOf.md @@ -13,3 +13,7 @@ getMultipleOf(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getPrefixItems.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getPrefixItems.md index ea9a32b3d6..0e6407ad2f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getPrefixItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getPrefixItems.md @@ -13,3 +13,7 @@ getPrefixItems(program, target): Tuple | undefined | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`Tuple` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getUniqueItems.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getUniqueItems.md index 7a516e1991..1de081729c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getUniqueItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getUniqueItems.md @@ -13,3 +13,7 @@ getUniqueItems(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md index 8d6cd648bd..2b0058ce04 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md @@ -13,3 +13,7 @@ isJsonSchemaDeclaration(program, target): boolean | :------ | :------ | | `program` | `Program` | | `target` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md index 2c8423baa5..d0e8671a3e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md @@ -7,8 +7,8 @@ title: "[I] JSONSchemaEmitterOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `bundleId?` | `string` | When provided, bundle all the schemas into a single json schema document
with schemas under $defs. The provided id is the id of the root document
and is also used for the file name. | -| `emitAllModels?` | `boolean` | When true, emit all model declarations to JSON Schema without requiring
the

**Json Schema**

decorator. | -| `emitAllRefs?` | `boolean` | When true, emit all references as json schema files, even if the referenced
type does not have the `@jsonSchema` decorator or is not within a namespace
with the `@jsonSchema` decorator. | -| `file-type?` | `FileType` | Serialize the schema as either yaml or json.

**Default**

yaml, it not specified infer from the `output-file` extension | -| `int64-strategy?` | `Int64Strategy` | How to handle 64 bit integers on the wire. Options are:

* string: serialize as a string (widely interoperable)
* number: serialize as a number (not widely interoperable) | +| `bundleId`? | `string` | When provided, bundle all the schemas into a single json schema document
with schemas under $defs. The provided id is the id of the root document
and is also used for the file name. | +| `emitAllModels`? | `boolean` | When true, emit all model declarations to JSON Schema without requiring
the

**Json Schema**

decorator. | +| `emitAllRefs`? | `boolean` | When true, emit all references as json schema files, even if the referenced
type does not have the `@jsonSchema` decorator or is not within a namespace
with the `@jsonSchema` decorator. | +| `file-type`? | `FileType` | Serialize the schema as either yaml or json.

**Default**

yaml, it not specified infer from the `output-file` extension | +| `int64-strategy`? | `Int64Strategy` | How to handle 64 bit integers on the wire. Options are:

* string: serialize as a string (widely interoperable)
* number: serialize as a number (not widely interoperable) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$defaultResponse.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$defaultResponse.md index f8a37538b8..d22dfd043e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$defaultResponse.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$defaultResponse.md @@ -13,3 +13,7 @@ $defaultResponse(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$extension.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$extension.md index 8dcc3b8258..002ee5522f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$extension.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$extension.md @@ -19,3 +19,7 @@ $extension( | `entity` | `Type` | | `extensionName` | `string` | | `value` | `TypeSpecValue` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$externalDocs.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$externalDocs.md index 68ad6f4ee0..d259685b7d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$externalDocs.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$externalDocs.md @@ -24,6 +24,8 @@ Allows referencing an external resource for extended documentation. ## Returns +`void` + ## Optional description A short description of the target documentation. diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$info.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$info.md index 0141b98e84..e225208cdc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$info.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$info.md @@ -17,3 +17,7 @@ $info( | `context` | `DecoratorContext` | | `entity` | `Namespace` | | `model` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$operationId.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$operationId.md index 30665d8f6b..7a8d026add 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$operationId.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$operationId.md @@ -19,3 +19,7 @@ Set a specific operation ID. | `context` | `DecoratorContext` | Decorator Context | | `entity` | `Operation` | Decorator target | | `opId` | `string` | Operation ID. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/checkDuplicateTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/checkDuplicateTypeName.md index 94f42f3be8..596a03e178 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/checkDuplicateTypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/checkDuplicateTypeName.md @@ -19,3 +19,7 @@ checkDuplicateTypeName( | `type` | `Type` | | `name` | `string` | | `existing` | `undefined` \| `Record`<`string`, `unknown`\> | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExtensions.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExtensions.md index ea291e3d14..dbf5babdaf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExtensions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExtensions.md @@ -13,3 +13,7 @@ getExtensions(program, entity): ReadonlyMap | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`ReadonlyMap`<[`ExtensionKey`](../type-aliases/ExtensionKey.md), `any`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExternalDocs.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExternalDocs.md index cbe57a38f1..855a1c9e64 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExternalDocs.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExternalDocs.md @@ -13,3 +13,7 @@ getExternalDocs(program, entity): ExternalDocs | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +[`ExternalDocs`](../interfaces/ExternalDocs.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getInfo.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getInfo.md index 11cb22187d..866f66b07f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getInfo.md @@ -13,3 +13,7 @@ getInfo(program, entity): AdditionalInfo | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Namespace` | + +## Returns + +[`AdditionalInfo`](../interfaces/AdditionalInfo.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOpenAPITypeName.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOpenAPITypeName.md index 0cd33dcdf5..f1b32896d4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOpenAPITypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOpenAPITypeName.md @@ -28,3 +28,7 @@ namespace using the provided `TypeNameOptions`. | `type` | `Type` | | `options` | `TypeNameOptions` | | `existing`? | `Record`<`string`, `any`\> | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOperationId.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOperationId.md index 296f2bba76..f6150de6c4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOperationId.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOperationId.md @@ -16,6 +16,8 @@ getOperationId(program, entity): string | undefined ## Returns +`string` \| `undefined` + operationId set via the ## Operation Id diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getParameterKey.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getParameterKey.md index 67521629ca..5faa50ede4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getParameterKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getParameterKey.md @@ -23,3 +23,7 @@ Gets the key that is used to define a parameter in OpenAPI. | `newParam` | `unknown` | | `existingParams` | `Record`<`string`, `unknown`\> | | `options` | `TypeNameOptions` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isDefaultResponse.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isDefaultResponse.md index 0c5f649df4..0e1a024b76 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isDefaultResponse.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isDefaultResponse.md @@ -18,4 +18,6 @@ Check if the given model has been mark as a default response. ## Returns +`boolean` + boolean. diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isReadonlyProperty.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isReadonlyProperty.md index 64ca698c3d..6594fe9490 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isReadonlyProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isReadonlyProperty.md @@ -20,3 +20,7 @@ designate a read-only property. | :------ | :------ | | `program` | `Program` | | `property` | `ModelProperty` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/resolveOperationId.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/resolveOperationId.md index eb42f6d1b2..7c61cc8101 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/resolveOperationId.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/resolveOperationId.md @@ -19,6 +19,8 @@ Resolve the OpenAPI operation ID for the given operation using the following log ## Returns +`string` + Operation ID in this format `` or `_` ## Operation Id diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/setExtension.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/setExtension.md index 71e5b0c5ea..09c73e9128 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/setExtension.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/setExtension.md @@ -19,3 +19,7 @@ setExtension( | `entity` | `Type` | | `extensionName` | \`x-${string}\` | | `data` | `unknown` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/shouldInline.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/shouldInline.md index 295054eeb8..539e51977b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/shouldInline.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/shouldInline.md @@ -23,3 +23,7 @@ decorator, or chosen by default in simple cases. | :------ | :------ | | `program` | `Program` | | `type` | `Type` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/AdditionalInfo.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/AdditionalInfo.md index ecaf31b41b..8ce0ad42b4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/AdditionalInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/AdditionalInfo.md @@ -9,6 +9,6 @@ OpenAPI additional information | Property | Type | Description | | :------ | :------ | :------ | -| `contact?` | [`Contact`](Contact.md) | The contact information for the exposed API. | -| `license?` | [`License`](License.md) | The license information for the exposed API. | -| `termsOfService?` | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. | +| `contact`? | [`Contact`](Contact.md) | The contact information for the exposed API. | +| `license`? | [`License`](License.md) | The license information for the exposed API. | +| `termsOfService`? | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/Contact.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/Contact.md index c50d5c3dee..b4f3364320 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/Contact.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/Contact.md @@ -7,6 +7,6 @@ title: "[I] Contact" | Property | Type | Description | | :------ | :------ | :------ | -| `email?` | `string` | The email address of the contact person/organization. MUST be in the format of an email address. | -| `name?` | `string` | The identifying name of the contact person/organization. | -| `url?` | `string` | The URL pointing to the contact information. MUST be in the format of a URL. | +| `email`? | `string` | The email address of the contact person/organization. MUST be in the format of an email address. | +| `name`? | `string` | The identifying name of the contact person/organization. | +| `url`? | `string` | The URL pointing to the contact information. MUST be in the format of a URL. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/ExternalDocs.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/ExternalDocs.md index debe31f244..5a1375597d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/ExternalDocs.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/ExternalDocs.md @@ -7,5 +7,5 @@ title: "[I] ExternalDocs" | Property | Type | Description | | :------ | :------ | :------ | -| `description?` | `string` | - | +| `description`? | `string` | - | | `url` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/License.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/License.md index 785a5aa31c..e4880abc50 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/License.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/License.md @@ -8,4 +8,4 @@ title: "[I] License" | Property | Type | Description | | :------ | :------ | :------ | | `name` | `string` | The license name used for the API. | -| `url?` | `string` | A URL to the license used for the API. MUST be in the format of a URL. | +| `url`? | `string` | A URL to the license used for the API. MUST be in the format of a URL. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$onEmit.md index 50fae6e43c..1ea0af454d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$onEmit.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$onEmit.md @@ -12,3 +12,7 @@ $onEmit(context): Promise | Parameter | Type | | :------ | :------ | | `context` | `EmitContext`<`OpenAPI3EmitterOptions`\> | + +## Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$oneOf.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$oneOf.md index 459a442ef7..6277e79783 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$oneOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$oneOf.md @@ -13,3 +13,7 @@ $oneOf(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `ModelProperty` \| `Union` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$useRef.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$useRef.md index 7529f0ea27..5e47bd6b33 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$useRef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$useRef.md @@ -17,3 +17,7 @@ $useRef( | `context` | `DecoratorContext` | | `entity` | `Model` \| `ModelProperty` | | `refUrl` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getOneOf.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getOneOf.md index 81127ca863..3f4d727042 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getOneOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getOneOf.md @@ -13,3 +13,7 @@ getOneOf(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getRef.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getRef.md index 9a9b91c704..20ad7ec648 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getRef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getRef.md @@ -13,3 +13,7 @@ getRef(program, entity): string | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/resolveOptions.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/resolveOptions.md index 9f16f99c4d..c1a2aa96e0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/resolveOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/resolveOptions.md @@ -12,3 +12,7 @@ resolveOptions(context): ResolvedOpenAPI3EmitterOptions | Parameter | Type | | :------ | :------ | | `context` | `EmitContext`<`OpenAPI3EmitterOptions`\> | + +## Returns + +[`ResolvedOpenAPI3EmitterOptions`](../interfaces/ResolvedOpenAPI3EmitterOptions.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$externRef.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$externRef.md index fa39273374..ec81e55e26 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$externRef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$externRef.md @@ -19,3 +19,7 @@ $externRef( | `target` | `Model` | | `path` | `StringLiteral` | | `name` | `StringLiteral` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$field.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$field.md index bc746fcc8c..43af2a945a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$field.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$field.md @@ -21,3 +21,5 @@ Decorate a model property with a field index. Field indices are required for all | `fieldIndex` | `number` | | ## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$message.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$message.md index e5c6e41724..a20a75e381 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$message.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$message.md @@ -13,3 +13,7 @@ $message(ctx, target): void | :------ | :------ | | `ctx` | `DecoratorContext` | | `target` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onEmit.md index 01e6dc7191..e8aecc7c09 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onEmit.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onEmit.md @@ -14,3 +14,7 @@ Emitter main function. | Parameter | Type | | :------ | :------ | | `ctx` | `EmitContext`<`ProtobufEmitterOptions`\> | + +## Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onValidate.md index cc74dab946..54dfb22502 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onValidate.md @@ -14,3 +14,7 @@ Validation function | Parameter | Type | | :------ | :------ | | `program` | `Program` | + +## Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$package.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$package.md index d9f5e7864f..b4ce8f4a9b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$package.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$package.md @@ -19,3 +19,7 @@ Declare a Protobuf package. | `ctx` | `DecoratorContext` | decorator context | | `target` | `Namespace` | target decorator namespace | | `details`? | `Model` | - | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$reserve.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$reserve.md index 0a12d36415..a97299ce2f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$reserve.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$reserve.md @@ -17,3 +17,7 @@ $reserve( | `ctx` | `DecoratorContext` | | `target` | `Model` | | ...`reservations` | readonly (`string` \| `number` \| `Type`)[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$service.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$service.md index 7875c0597a..3f35f2324f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$service.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$service.md @@ -15,3 +15,7 @@ Decorate an interface as a service, indicating that it represents a Protobuf `se | :------ | :------ | :------ | | `ctx` | `DecoratorContext` | decorator context | | `target` | `Interface` | the decorated interface | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$stream.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$stream.md index 8daf2a13d1..e377d92751 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$stream.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$stream.md @@ -17,3 +17,7 @@ $stream( | `ctx` | `DecoratorContext` | | `target` | `Operation` | | `mode` | `EnumMember` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/isMap.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/isMap.md index 500f6c2fe9..6708926d07 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/isMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/isMap.md @@ -18,4 +18,6 @@ Determines whether a type represents a Protobuf map. ## Returns +`boolean` + true if the internal representation of a Protobuf map is bound to this type. diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/interfaces/PackageDetails.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/interfaces/PackageDetails.md index 1495e8a304..4ecd55eedf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/interfaces/PackageDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/interfaces/PackageDetails.md @@ -7,4 +7,4 @@ title: "[I] PackageDetails" | Property | Type | Description | | :------ | :------ | :------ | -| `name?` | `string` | - | +| `name`? | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md index a07892d33b..97d5b359c0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md @@ -20,6 +20,10 @@ Helper class to track duplicate instance new DuplicateTracker(): DuplicateTracker ``` +#### Returns + +[`DuplicateTracker`](DuplicateTracker.md)<`K`, `V`\> + ## Properties | Modifier | Property | Type | Description | @@ -36,6 +40,10 @@ entries(): Iterable<[K, V[]]> Return iterator of all the duplicate entries. +#### Returns + +`Iterable`<[`K`, `V`[]]\> + *** ### track() @@ -52,3 +60,7 @@ Track usage of K. | :------ | :------ | :------ | | `k` | `K` | key that is being checked for duplicate. | | `v` | `V` | value that map to the key | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md index af2e755c59..c335b20f35 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md @@ -17,6 +17,10 @@ title: "[C] EventEmitter" new EventEmitter(): EventEmitter ``` +#### Returns + +[`EventEmitter`](EventEmitter.md)<`T`\> + ## Properties | Modifier | Property | Type | Description | @@ -42,7 +46,11 @@ emit(name, ...args): void | Parameter | Type | | :------ | :------ | | `name` | `K` | -| ...`args` | `Parameters`<`T`[`K`]\> | +| ...`args` | `Parameters`<`T`\[`K`\]\> | + +#### Returns + +`void` *** @@ -64,3 +72,7 @@ on(name, listener): void | :------ | :------ | | `name` | `K` | | `listener` | (...`args`) => `any` | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/InvalidEncodingError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/InvalidEncodingError.md index 6afd92b983..bb9b641061 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/InvalidEncodingError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/InvalidEncodingError.md @@ -21,6 +21,10 @@ new InvalidEncodingError(encoding): InvalidEncodingError | :------ | :------ | | `encoding` | `string` | +#### Returns + +[`InvalidEncodingError`](InvalidEncodingError.md) + #### Overrides Error.constructor @@ -31,8 +35,8 @@ Error.constructor | :------ | :------ | :------ | :------ | :------ | | `public` | `message` | `string` | - | Error.message | | `public` | `name` | `string` | - | Error.name | -| `public` | `stack?` | `string` | - | Error.stack | -| `static` | `prepareStackTrace?` | (`err`, `stackTraces`) => `any` | - | Error.prepareStackTrace | +| `public` | `stack`? | `string` | - | Error.stack | +| `static` | `prepareStackTrace`? | (`err`, `stackTraces`) => `any` | - | Error.prepareStackTrace | | `static` | `stackTraceLimit` | `number` | - | Error.stackTraceLimit | ## Methods @@ -52,6 +56,10 @@ Create .stack property on a target object | `targetObject` | `object` | | `constructorOpt`? | `Function` | +#### Returns + +`void` + #### Inherited from Error.captureStackTrace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md index d2cb316c72..1c0daae69c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md @@ -23,6 +23,10 @@ new ProjectionError(message): ProjectionError | :------ | :------ | | `message` | `string` | +#### Returns + +[`ProjectionError`](ProjectionError.md) + #### Overrides Error.constructor @@ -33,8 +37,8 @@ Error.constructor | :------ | :------ | :------ | :------ | :------ | | `public` | `message` | `string` | - | Error.message | | `public` | `name` | `string` | - | Error.name | -| `public` | `stack?` | `string` | - | Error.stack | -| `static` | `prepareStackTrace?` | (`err`, `stackTraces`) => `any` | - | Error.prepareStackTrace | +| `public` | `stack`? | `string` | - | Error.stack | +| `static` | `prepareStackTrace`? | (`err`, `stackTraces`) => `any` | - | Error.prepareStackTrace | | `static` | `stackTraceLimit` | `number` | - | Error.stackTraceLimit | ## Methods @@ -54,6 +58,10 @@ Create .stack property on a target object | `targetObject` | `object` | | `constructorOpt`? | `Function` | +#### Returns + +`void` + #### Inherited from Error.captureStackTrace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md index 30d0da9ac1..6de8271af3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md @@ -23,6 +23,10 @@ new Queue(elements?): Queue | :------ | :------ | | `elements`? | `T`[] | +#### Returns + +[`Queue`](Queue.md)<`T`\> + ## Properties | Modifier | Property | Type | Description | @@ -38,6 +42,10 @@ new Queue(elements?): Queue dequeue(): T ``` +#### Returns + +`T` + *** ### enqueue() @@ -52,6 +60,10 @@ enqueue(...items): void | :------ | :------ | | ...`items` | `T`[] | +#### Returns + +`void` + *** ### isEmpty() @@ -59,3 +71,7 @@ enqueue(...items): void ```ts isEmpty(): boolean ``` + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md index 414168ec57..9c77414245 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md @@ -22,6 +22,10 @@ new ResolveModuleError(code, message): ResolveModuleError | `code` | `ResolveModuleErrorCode` | | `message` | `string` | +#### Returns + +[`ResolveModuleError`](ResolveModuleError.md) + #### Overrides Error.constructor @@ -33,8 +37,8 @@ Error.constructor | `public` | `code` | `ResolveModuleErrorCode` | - | - | | `public` | `message` | `string` | - | Error.message | | `public` | `name` | `string` | - | Error.name | -| `public` | `stack?` | `string` | - | Error.stack | -| `static` | `prepareStackTrace?` | (`err`, `stackTraces`) => `any` | - | Error.prepareStackTrace | +| `public` | `stack`? | `string` | - | Error.stack | +| `static` | `prepareStackTrace`? | (`err`, `stackTraces`) => `any` | - | Error.prepareStackTrace | | `static` | `stackTraceLimit` | `number` | - | Error.stackTraceLimit | ## Methods @@ -54,6 +58,10 @@ Create .stack property on a target object | `targetObject` | `object` | | `constructorOpt`? | `Function` | +#### Returns + +`void` + #### Inherited from Error.captureStackTrace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md index 1f236d3e36..142a19dead 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md @@ -22,6 +22,8 @@ Mark a type as deprecated ## Returns +`void` + ## Example ``` @deprecated("Foo is deprecated, use Bar instead.") diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md index bdfe685d63..d1cb665454 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md @@ -17,3 +17,7 @@ $discriminator( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `entity` | [`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md) | | `propertyName` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md index 475f730cad..837ffa56d6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md @@ -22,6 +22,8 @@ $doc( ## Returns +`void` + ## Doc attaches a documentation string. Works great with multi-line string literals. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md index d50bdac454..822aabe4ce 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md @@ -19,3 +19,7 @@ $encode( | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `encoding` | `string` \| [`EnumMember`](../interfaces/EnumMember.md) | | `encodeAs`? | [`Scalar`](../interfaces/Scalar.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md index 71c3a59ccc..8ee7fd92a3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md @@ -17,3 +17,7 @@ $error(context, entity): void | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `entity` | [`Model`](../interfaces/Model.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md index f02027cde4..75e3a82aa1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md @@ -17,3 +17,7 @@ $errorsDoc( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Operation`](../interfaces/Operation.md) | | `text` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md index aba42f8846..2bd92aee43 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md @@ -29,3 +29,7 @@ https://github.com/OAI/OpenAPI-Specification/blob/3.0.3/versions/3.0.3.md#dataTy | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `format` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md index 6c5bd76f9e..28215ca021 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md @@ -19,3 +19,7 @@ $friendlyName( | `target` | [`Type`](../type-aliases/Type.md) | | `friendlyName` | `string` | | `sourceObject` | `undefined` \| [`Type`](../type-aliases/Type.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$indexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$indexer.md index 2791d63a5c..9b29c8712e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$indexer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$indexer.md @@ -19,3 +19,7 @@ $indexer( | `target` | [`Type`](../type-aliases/Type.md) | | `key` | [`Scalar`](../interfaces/Scalar.md) | | `value` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md index 088d923ba7..583af24f3d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md @@ -17,3 +17,7 @@ $inspectType( | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `text` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md index 77018500f6..8304c4567e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md @@ -17,3 +17,7 @@ $inspectTypeName( | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `text` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md index 331d541f71..dbb92c3e21 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md @@ -24,3 +24,7 @@ Otherwise, the name of the target property will be used. | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `entity` | [`ModelProperty`](../interfaces/ModelProperty.md) | | `altName`? | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md index 10a657b425..65315b1f3d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md @@ -24,3 +24,7 @@ type accepts. | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | - | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | Decorator target. Must be a string. (model Foo extends string) | | `knownValues` | [`Enum`](../interfaces/Enum.md) | Must be an enum. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md index 108472004d..b96907d0b0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md @@ -20,6 +20,8 @@ $list( ## Returns +`void` + ## Deprecated Use the `listsResource` decorator in `@typespec/rest` instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md index 0ca3445573..23df1fab85 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md @@ -17,3 +17,7 @@ $maxItems( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | | `maxItems` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md index 5d8ef8b159..b3ebd75c1b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md @@ -17,3 +17,7 @@ $maxLength( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `maxLength` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md index 82f4133734..f1c3146452 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md @@ -17,3 +17,7 @@ $maxValue( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `maxValue` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md index ee5bf5cf7c..e9973d538e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md @@ -17,3 +17,7 @@ $maxValueExclusive( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `maxValueExclusive` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md index f7e0b08453..78323e0fbc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md @@ -17,3 +17,7 @@ $minItems( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | | `minItems` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md index 830679e218..a19f4146fc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md @@ -17,3 +17,7 @@ $minLength( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `minLength` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md index ec9f11ca69..cf2965d52d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md @@ -17,3 +17,7 @@ $minValue( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `minValue` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md index f1561b20e7..3ff7809fe5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md @@ -17,3 +17,7 @@ $minValueExclusive( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `minValueExclusive` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md index 89b66fb489..58734fa746 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md @@ -19,3 +19,7 @@ $overload( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | | `target` | [`Operation`](../interfaces/Operation.md) | The specializing operation declaration | | `overloadBase` | [`Operation`](../interfaces/Operation.md) | The operation to be overloaded. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md index aba0f8b70e..97ff6a8662 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md @@ -17,3 +17,7 @@ $parameterVisibility( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `entity` | [`Operation`](../interfaces/Operation.md) | | ...`visibilities` | `string`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md index c3fb9a3b9f..90bbdeafcd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md @@ -17,3 +17,7 @@ $pattern( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `pattern` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md index 169fb96647..bb942d28d9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md @@ -21,3 +21,7 @@ $projectedName( | `target` | [`Type`](../type-aliases/Type.md) | The that should have a different name. | | `projectionName` | `string` | Name of the projection (e.g. "toJson", "toCSharp") | | `projectedName` | `string` | Name of the type should have in the scope of the projection specified. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md index 35cc0598dd..5fbab40c75 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md @@ -17,3 +17,7 @@ $returnTypeVisibility( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `entity` | [`Operation`](../interfaces/Operation.md) | | ...`visibilities` | `string`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md index f7ed8de6ee..d0f5b2dff2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md @@ -17,3 +17,7 @@ $returnsDoc( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Operation`](../interfaces/Operation.md) | | `text` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md index cd98d638c6..4fe5aa9ad7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md @@ -15,3 +15,7 @@ Mark a string as a secret value that should be treated carefully to avoid exposu | :------ | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | Decorator context | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | Decorator target, either a string model or a property with type string. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md index 52c1dec7dd..44ddcd4403 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md @@ -17,3 +17,7 @@ $service( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Namespace`](../interfaces/Namespace.md) | | `options`? | [`Model`](../interfaces/Model.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md index f45349711e..074e8ac0b4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md @@ -22,6 +22,8 @@ $summary( ## Returns +`void` + ## Summary attaches a documentation string. It is typically used to give a short, single-line diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md index b83e33b273..16988bc2d4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md @@ -17,3 +17,7 @@ $tag( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Interface`](../interfaces/Interface.md) \| [`Namespace`](../interfaces/Namespace.md) \| [`Operation`](../interfaces/Operation.md) | | `tag` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md index bc3da85509..6a04edc559 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md @@ -17,3 +17,7 @@ $visibility( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) | | ...`visibilities` | `string`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md index 03da558d06..be555676c1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md @@ -17,3 +17,7 @@ $withDefaultKeyVisibility( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `entity` | [`Model`](../interfaces/Model.md) | | `visibility` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md index 6514fb752d..9182ad39ab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md @@ -13,3 +13,7 @@ $withOptionalProperties(context, target): void | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md index 5e56bf5553..d5ebda1e62 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md @@ -13,3 +13,7 @@ $withUpdateableProperties(context, target): void | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md index ebb9ee34f2..03960bef8d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md @@ -17,3 +17,7 @@ $withVisibility( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | | ...`visibilities` | `string`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md index 27aff6f317..7a3db2917c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md @@ -13,3 +13,7 @@ $withoutDefaultValues(context, target): void | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md index 7a56360362..5344ffd222 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md @@ -17,3 +17,7 @@ $withoutOmittedProperties( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | | `omitProperties` | [`StringLiteral`](../interfaces/StringLiteral.md) \| [`Union`](../interfaces/Union.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md index 9cffe02485..2b5ba67bd5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md @@ -19,3 +19,7 @@ Mark the given namespace as a service. | `program` | [`Program`](../interfaces/Program.md) | Program | | `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | | `details` | [`ServiceDetails`](../interfaces/ServiceDetails.md) | Service details | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md index 442c8893d8..c07008b981 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md @@ -46,3 +46,7 @@ Assert that the input type has one of the kinds provided | `typeDescription` | `string` | | `t` | [`Type`](../type-aliases/Type.md) | | ...`kinds` | `TKind` | + +## Returns + +`asserts t is Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md index a60c9bd905..3b9d579f9d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md @@ -22,6 +22,8 @@ cadlTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] ## Returns +[`T` \| `undefined`, [`Diagnostic`](../interfaces/Diagnostic.md)[]] + ## Deprecated use typespecTypeToJson diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md index afb4651df8..fb948326d1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md @@ -16,6 +16,8 @@ checkFormatCadl(code, prettierConfig?): Promise ## Returns +`Promise`<`boolean`\> + ## Deprecated use checkFormatTypeSpec diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md index 5f196128a0..3b0a69b84b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md @@ -18,4 +18,6 @@ Check the given is correctly formatted. ## Returns +`Promise`<`boolean`\> + true if code is formatted correctly. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md index a9f1628c04..bb7aff09c8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md @@ -19,3 +19,7 @@ oldProgram?): Promise | `mainFile` | `string` | | `options` | [`CompilerOptions`](../interfaces/CompilerOptions.md) | | `oldProgram`? | [`Program`](../interfaces/Program.md) | + +## Returns + +`Promise`<[`Program`](../interfaces/Program.md)\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md index 8b6ece8ba4..397746cf85 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md @@ -20,3 +20,7 @@ being compiled. | `condition` | `any` | Throw if this is not true. | | `message` | `string` | Error message. | | `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | Optional location in source code that might give a clue about
what got the compiler off track. | + +## Returns + +`asserts condition` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md index 17b0bff948..8da7f82134 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md @@ -22,6 +22,8 @@ createCadlLibrary(lib): TypeSpecLibrary ## Returns +[`TypeSpecLibrary`](../interfaces/TypeSpecLibrary.md)<`T`, `E`\> + ## Deprecated use createTypeSpecLibrary diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md index 144c3dd536..de80530f72 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md @@ -12,3 +12,7 @@ createChecker(program): Checker | Parameter | Type | | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | + +## Returns + +[`Checker`](../interfaces/Checker.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md index cddf71aca0..ef64dd88ef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md @@ -23,6 +23,8 @@ createDecoratorDefinition(definition): DecoratorValidator ## Returns +[`DecoratorValidator`](../interfaces/DecoratorValidator.md)<`T`, `P`, `S`\> + ## Deprecated use extern dec definition in typespec instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md index f870b155aa..fd912a73d0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md @@ -11,6 +11,8 @@ Create a new instance of the ## Returns +[`DiagnosticCollector`](../interfaces/DiagnosticCollector.md) + ## See DiagnosticCollector. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCreator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCreator.md index 175c187fb3..3150c14146 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCreator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCreator.md @@ -24,6 +24,8 @@ Create a new diagnostics creator. ## Returns +[`DiagnosticCreator`](../interfaces/DiagnosticCreator.md)<`T`\> + ## See DiagnosticCreator diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md index ba640225c0..0f5b83f52c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md @@ -18,4 +18,6 @@ Create an helper to manager project names. ## Returns +[`ProjectedNameView`](../interfaces/ProjectedNameView.md) + ProjectedNameView diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md index 14c7931fc2..df67fca4a3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md @@ -19,3 +19,7 @@ createRekeyableMap(entries?): RekeyableMap | Parameter | Type | | :------ | :------ | | `entries`? | [`K`, `V`][] | + +## Returns + +`RekeyableMap`<`K`, `V`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md index 9b37791fab..504f6bae9e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md @@ -21,3 +21,7 @@ Create a new linter rule. | Parameter | Type | | :------ | :------ | | `definition` | [`LinterRuleDefinition`](../interfaces/LinterRuleDefinition.md)<`N`, `T`\> | + +## Returns + +[`LinterRuleDefinition`](../interfaces/LinterRuleDefinition.md)<`N`, `T`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md index dc2fe545df..2f97135c1c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md @@ -13,3 +13,7 @@ createScanner(source, diagnosticHandler): Scanner | :------ | :------ | | `source` | `string` \| [`SourceFile`](../interfaces/SourceFile.md) | | `diagnosticHandler` | [`DiagnosticHandler`](../type-aliases/DiagnosticHandler.md) | + +## Returns + +[`Scanner`](../interfaces/Scanner.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md index 78f5971e55..da2a6edfc0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md @@ -12,3 +12,7 @@ createServer(host): Server | Parameter | Type | | :------ | :------ | | `host` | [`ServerHost`](../interfaces/ServerHost.md) | + +## Returns + +[`Server`](../interfaces/Server.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md index ca075aa5b0..ba61bbf773 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md @@ -13,3 +13,7 @@ createSourceFile(text, path): SourceFile | :------ | :------ | | `text` | `string` | | `path` | `string` | + +## Returns + +[`SourceFile`](../interfaces/SourceFile.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.md index 15b436490e..5657e14481 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.md @@ -20,6 +20,8 @@ createStateAccessors( ## Returns +`object` + > | Member | Type | Description | > | :------ | :------ | :------ | > | `stateMap` | <`T`\>(`key`) => `StateMapView`<`T`\> | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md index 0a1733d425..2cfb27276e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md @@ -24,6 +24,8 @@ Create a new TypeSpec library definition. ## Returns +[`TypeSpecLibrary`](../interfaces/TypeSpecLibrary.md)<`T`, `E`\> + Library with utility functions. ## Tutorial diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md index 1d93bf262d..c0e94345a8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md @@ -15,3 +15,7 @@ Helper to emit a file. | :------ | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | TypeSpec Program | | `options` | [`EmitFileOptions`](../interfaces/EmitFileOptions.md) | File Emitter options | + +## Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md index cb8b71253a..12e9afcd7c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md @@ -12,3 +12,7 @@ ensureTrailingDirectorySeparator(path): string | Parameter | Type | | :------ | :------ | | `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md index 761b39fffa..849ef16828 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md @@ -21,3 +21,7 @@ a new anonymous model with only the filtered properties. | `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | - | | `model` | [`Model`](../interfaces/Model.md) | The input model to filter. | | `filter` | (`property`) => `boolean` | The filter to apply. Properties are kept when this returns true. | + +## Returns + +[`Model`](../interfaces/Model.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md index 5ad29fb270..4336b146f5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md @@ -19,3 +19,7 @@ finishTypeForProgram(program, typeDef): T | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `typeDef` | `T` | + +## Returns + +`T` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md index 6547ba8c69..3b9605deef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md @@ -12,3 +12,7 @@ formatDiagnostic(diagnostic): string | Parameter | Type | | :------ | :------ | | `diagnostic` | [`Diagnostic`](../interfaces/Diagnostic.md) | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md index 5d9b2fb07b..484f24d9be 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md @@ -12,3 +12,7 @@ formatIdentifier(sv): string | Parameter | Type | | :------ | :------ | | `sv` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md index 192a98bad0..753468c7b3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md @@ -13,3 +13,7 @@ formatTypeSpec(code, prettierConfig?): Promise | :------ | :------ | | `code` | `string` | | `prettierConfig`? | `Options` | + +## Returns + +`Promise`<`string`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md index 84842b3203..3d95451fee 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md @@ -13,3 +13,7 @@ getAllTags(program, target): string[] | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Interface`](../interfaces/Interface.md) \| [`Namespace`](../interfaces/Namespace.md) \| [`Operation`](../interfaces/Operation.md) | + +## Returns + +`string`[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md index 926dfc20bb..47d49049a0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md @@ -22,3 +22,7 @@ getAnyExtensionFromPath("/path/to.ext/file") === "" | Parameter | Type | | :------ | :------ | | `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md index 098a86d805..aa73d5729e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md @@ -40,3 +40,7 @@ getBaseFileName("file://") === "" | Parameter | Type | | :------ | :------ | | `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md index e4892a5c03..95200328e1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md @@ -15,3 +15,7 @@ Return the deprecated message or undefined if not deprecated | :------ | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `type` | [`Type`](../type-aliases/Type.md) | Type | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md index 20c3d97981..b64f03f8cd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md @@ -15,3 +15,7 @@ Returns complete deprecation details for the given type or node | :------ | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `typeOrNode` | [`Node`](../type-aliases/Node.md) \| [`Type`](../type-aliases/Type.md) | A Type or Node to check for deprecation | + +## Returns + +[`DeprecationDetails`](../interfaces/DeprecationDetails.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md index 09e9fb5c6d..07d5e1a5a9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md @@ -12,3 +12,7 @@ getDirectoryPath(path): string | Parameter | Type | | :------ | :------ | | `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md index 7a83bf4fa8..803e1a402c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md @@ -12,3 +12,7 @@ getDiscriminatedTypes(program): [Model | Union, Discriminator][] | Parameter | Type | | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | + +## Returns + +[[`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md), [`Discriminator`](../interfaces/Discriminator.md)][] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md index c36f6f8f93..07f3096e55 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md @@ -13,3 +13,7 @@ getDiscriminatedUnion(type, discriminator): [DiscriminatedUnion, readonly Diagno | :------ | :------ | | `type` | [`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md) | | `discriminator` | [`Discriminator`](../interfaces/Discriminator.md) | + +## Returns + +[[`DiscriminatedUnion`](../interfaces/DiscriminatedUnion.md), readonly [`Diagnostic`](../interfaces/Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md index 1724d156b9..645c49827b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md @@ -13,3 +13,7 @@ getDiscriminator(program, entity): Discriminator | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `entity` | [`Type`](../type-aliases/Type.md) | + +## Returns + +[`Discriminator`](../interfaces/Discriminator.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md index 2b08b48af4..7aff9c47e6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md @@ -18,4 +18,6 @@ Get the documentation string for the given type. ## Returns +`string` \| `undefined` + Documentation value diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md index 900ff26995..9fb51757b1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md @@ -18,4 +18,6 @@ Get the documentation information for the given type. In most cases you probably ## Returns +[`DocData`](../interfaces/DocData.md) \| `undefined` + Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.md index c73a26414a..af7fc9576e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.md @@ -22,4 +22,6 @@ Get the documentation information for the given type. In most cases you probably ## Returns +[`DocData`](../interfaces/DocData.md) \| `undefined` + Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md index 2d275dcb46..4315c21417 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md @@ -28,3 +28,7 @@ best name for the remaining properties is `SomeName`. | `program` | [`Program`](../interfaces/Program.md) | - | | `model` | [`Model`](../interfaces/Model.md) | The input model | | `filter`? | (`property`) => `boolean` | An optional filter to apply to the input model's
properties. | + +## Returns + +[`Model`](../interfaces/Model.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md index 5ecc32b123..a2e2192ac4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md @@ -13,3 +13,7 @@ getEncode(program, target): EncodeData | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | + +## Returns + +[`EncodeData`](../interfaces/EncodeData.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md index b378e4f8a0..7b7d94b08e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md @@ -18,4 +18,6 @@ Get the documentation string for the return errors types of an operation. ## Returns +`string` \| `undefined` + Documentation value diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md index 8195cd85be..437425e108 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md @@ -18,4 +18,6 @@ Get the documentation information for the return errors types of an operation. I ## Returns +[`DocData`](../interfaces/DocData.md) \| `undefined` + Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md index 9693bad1a2..41898c72a0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md @@ -13,3 +13,7 @@ getFirstAncestor(node, test): Node | undefined | :------ | :------ | | `node` | [`Node`](../type-aliases/Node.md) | | `test` | [`NodeCallback`](../type-aliases/NodeCallback.md)<`boolean`\> | + +## Returns + +[`Node`](../type-aliases/Node.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md index fa56fe4d5b..edc2b18276 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md @@ -13,3 +13,7 @@ getFormat(program, target): string | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md index e4505f13ff..1f8e4c78f8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md @@ -13,3 +13,7 @@ getFriendlyName(program, target): string | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md index 401e425dc3..2403d38117 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md @@ -14,3 +14,7 @@ getFullyQualifiedSymbolName(sym, options?): string | `sym` | `undefined` \| [`Sym`](../interfaces/Sym.md) | | `options`? | `object` | | `options.useGlobalPrefixAtTopLevel`? | `boolean` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md index e3ca1cce9e..237920b3b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md @@ -12,3 +12,7 @@ getIdentifierContext(id): IdentifierContext | Parameter | Type | | :------ | :------ | | `id` | [`IdentifierNode`](../interfaces/IdentifierNode.md) | + +## Returns + +[`IdentifierContext`](../interfaces/IdentifierContext.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIndexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIndexer.md index 4863028569..3ebdf4e871 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIndexer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIndexer.md @@ -13,3 +13,7 @@ getIndexer(program, target): ModelIndexer | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +[`ModelIndexer`](../type-aliases/ModelIndexer.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md index e2a70b9377..ad759b4110 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md @@ -13,3 +13,7 @@ getKeyName(program, property): string | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md index cbd810f433..5fea8e23bf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md @@ -13,3 +13,7 @@ getKnownValues(program, target): Enum | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | + +## Returns + +[`Enum`](../interfaces/Enum.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md index 1fe0e816cd..d77ea57cad 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md @@ -16,6 +16,8 @@ getListOperationType(program, target): Model | undefined ## Returns +[`Model`](../interfaces/Model.md) \| `undefined` + ## Deprecated This function is unused and will be removed in a future release. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md index 777afc5f40..7c4b713a46 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md @@ -13,3 +13,7 @@ getLocationContext(program, type): LocationContext | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `type` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | + +## Returns + +[`LocationContext`](../type-aliases/LocationContext.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md index 7cb3e4d67d..bef35c87af 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md @@ -13,3 +13,7 @@ getMaxItems(program, target): number | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md index a50ec1b3df..a10e2bcc68 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md @@ -13,3 +13,7 @@ getMaxLength(program, target): number | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md index 2d479ac26b..d3e75be269 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md @@ -13,3 +13,7 @@ getMaxValue(program, target): number | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md index 959c9a34cc..cc245fdb02 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md @@ -13,3 +13,7 @@ getMaxValueExclusive(program, target): number | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md index 7870992962..53e57a38c0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md @@ -13,3 +13,7 @@ getMinItems(program, target): number | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md index c9744ceb9b..d47c83e38f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md @@ -13,3 +13,7 @@ getMinLength(program, target): number | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md index 207797213c..e9571d102e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md @@ -13,3 +13,7 @@ getMinValue(program, target): number | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md index 4757f840bb..d4ea937bff 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md @@ -13,3 +13,7 @@ getMinValueExclusive(program, target): number | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md index 082647b9f4..74dbc56f63 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md @@ -17,3 +17,5 @@ Return the full name of the namespace(e.g. "Foo.Bar") | `options`? | [`TypeNameOptions`](../interfaces/TypeNameOptions.md) | | ## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md index 1f6ad69ebb..786586333f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md @@ -22,6 +22,10 @@ Resolve the node in the syntax tree that that is at the given position. | `position` | `number` | Position | | `filter`? | (`node`) => `boolean` | Filter if wanting to return a parent containing node early. | +### Returns + +[`Node`](../type-aliases/Node.md) \| `undefined` + ## getNodeAtPosition(script, position, filter) ```ts @@ -44,3 +48,7 @@ getNodeAtPosition( | `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | | `position` | `number` | | `filter` | (`node`) => `node is T` | + +### Returns + +`T` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md index b99530643f..d3bc953a88 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md @@ -13,3 +13,7 @@ getNormalizedAbsolutePath(fileName, currentDirectory): string | :------ | :------ | | `fileName` | `string` | | `currentDirectory` | `undefined` \| `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md index 775cb25199..7c149fe73e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md @@ -13,3 +13,7 @@ getNormalizedAbsolutePathWithoutRoot(fileName, currentDirectory): string | :------ | :------ | | `fileName` | `string` | | `currentDirectory` | `undefined` \| `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md index ba4aa440f8..24d43d93f9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md @@ -22,3 +22,7 @@ getNormalizedPathComponents("to/dir/../file.ext", "/path/") === ["/", "path", "t | :------ | :------ | | `path` | `string` | | `currentDirectory` | `undefined` \| `string` | + +## Returns + +`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md index 44a24c99ba..72e5c14d99 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md @@ -18,4 +18,6 @@ If the given operation overloads another operation, return that operation. ## Returns +[`Operation`](../interfaces/Operation.md) \| `undefined` + The operation this operation overloads, if any. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md index 82cc080bd7..ab8f3d9870 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md @@ -18,4 +18,6 @@ Get all operations that are marked as overloads of the given operation ## Returns +[`Operation`](../interfaces/Operation.md)[] \| `undefined` + An array of operations that overload the given operation. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md index cb2984a2aa..0ab77e503a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md @@ -15,3 +15,7 @@ given property, if any. | Parameter | Type | | :------ | :------ | | `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | + +## Returns + +[`ModelProperty`](../interfaces/ModelProperty.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md index 47ea057c94..e4f504e655 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md @@ -18,6 +18,8 @@ Returns the visibilities of the parameters of the given operation, if provided w ## Returns +`string`[] \| `undefined` + ## See [$parameterVisibility]($parameterVisibility.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md index 6018d40cec..cd9695af51 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md @@ -17,4 +17,6 @@ Lookup and find the node ## Returns +[`Node`](../type-aliases/Node.md) & [`TemplateDeclarationNode`](../interfaces/TemplateDeclarationNode.md) \| `undefined` + Template Parent node if applicable diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md index 311769b9f8..0abf6ab72d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md @@ -43,3 +43,7 @@ getPathComponents("file://") === ["file://"] | :------ | :------ | :------ | | `path` | `string` | `undefined` | | `currentDirectory` | `string` | `""` | + +## Returns + +`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md index 5a94cdbcc3..9f5ec22613 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md @@ -19,3 +19,7 @@ getPathFromPathComponents(["/", "path", "to", "file.ext"]) === "/path/to/file.ex | Parameter | Type | | :------ | :------ | | `pathComponents` | readonly `string`[] | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md index a576476ddc..9375406e2f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md @@ -13,3 +13,7 @@ getPattern(program, target): string | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md index 4ec1c9bdd7..6895accf1e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md @@ -22,4 +22,6 @@ Get the projected name of the given entity for the given projection. ## Returns +`string` \| `undefined` + Projected name for the given projection diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md index d0148033fb..b8c3f85a20 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md @@ -16,4 +16,6 @@ getProjectedNames(program, target): ReadonlyMap | undefined ## Returns +`ReadonlyMap`<`string`, `string`\> \| `undefined` + Map of the projected names for the given entity. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md index 4f0e4322e5..e374afa6c2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md @@ -13,3 +13,7 @@ getProperty(type, propertyName): ModelProperty | undefined | :------ | :------ | | `type` | [`Model`](../interfaces/Model.md) | | `propertyName` | `string` | + +## Returns + +[`ModelProperty`](../interfaces/ModelProperty.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md index 07dcdac223..c1de3243fd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md @@ -14,3 +14,7 @@ Return the type of the property or the model itself. | Parameter | Type | | :------ | :------ | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | + +## Returns + +[`Type`](../type-aliases/Type.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md index 9543c34627..eb43f017d8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md @@ -22,6 +22,10 @@ Gets a relative path that can be used to traverse between `from` and `to`. | `to` | `string` | | `ignoreCase` | `boolean` | +### Returns + +`string` + ## getRelativePathFromDirectory(fromDirectory, to, getCanonicalFileName) ```ts @@ -40,3 +44,7 @@ Gets a relative path that can be used to traverse between `from` and `to`. | `fromDirectory` | `string` | | `to` | `string` | | `getCanonicalFileName` | `GetCanonicalFileName` | + +### Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md index d9b693307b..05210db4d2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md @@ -18,6 +18,8 @@ Returns the visibilities of the return type of the given operation, if provided ## Returns +`string`[] \| `undefined` + ## See [$returnTypeVisibility]($returnTypeVisibility.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md index 57cbc718ae..a28ad129ab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md @@ -18,4 +18,6 @@ Get the documentation string for the return success types of an operation. ## Returns +`string` \| `undefined` + Documentation value diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md index dfb32ab10d..225e0faaba 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md @@ -18,4 +18,6 @@ Get the documentation information for the return success types of an operation. ## Returns +[`DocData`](../interfaces/DocData.md) \| `undefined` + Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md index 146e8f71c4..de62b4b5ab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md @@ -36,3 +36,7 @@ getRootLength("http://server/path") === 14 // "http://server/" | Parameter | Type | | :------ | :------ | | `path` | `string` | + +## Returns + +`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md index dac6220099..d66035656c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md @@ -18,4 +18,6 @@ Get the service information for the given namespace. ## Returns +[`Service`](../interfaces/Service.md) \| `undefined` + Service information or undefined if namespace is not a service namespace. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md index 0519c5c2e0..f2b2e15e72 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md @@ -12,3 +12,7 @@ getSourceFileKindFromExt(path): SourceFileKind | undefined | Parameter | Type | | :------ | :------ | | `path` | `string` | + +## Returns + +[`SourceFileKind`](../type-aliases/SourceFileKind.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md index 8715826c64..c77c0cc575 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md @@ -16,6 +16,10 @@ getSourceLocation(target, options?): SourceLocation | `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | | `options`? | [`SourceLocationOptions`](../interfaces/SourceLocationOptions.md) | +### Returns + +[`SourceLocation`](../interfaces/SourceLocation.md) + ## getSourceLocation(target, options) ```ts @@ -29,6 +33,10 @@ getSourceLocation(target, options?): undefined | `target` | `undefined` \| *typeof* [`NoTarget`](../variables/NoTarget.md) | | `options`? | [`SourceLocationOptions`](../interfaces/SourceLocationOptions.md) | +### Returns + +`undefined` + ## getSourceLocation(target, options) ```ts @@ -41,3 +49,7 @@ getSourceLocation(target, options?): SourceLocation | undefined | :------ | :------ | | `target` | `undefined` \| [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | | `options`? | [`SourceLocationOptions`](../interfaces/SourceLocationOptions.md) | + +### Returns + +[`SourceLocation`](../interfaces/SourceLocation.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md index 2d75b04224..8effbe4d00 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md @@ -13,3 +13,7 @@ getSummary(program, type): string | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `type` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md index 5abc746d9f..5f0bbfc5c7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md @@ -13,3 +13,7 @@ getTags(program, target): string[] | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md index f0afc39009..c511f31f97 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md @@ -13,3 +13,7 @@ getTypeName(type, options?): string | :------ | :------ | | `type` | [`Type`](../type-aliases/Type.md) \| [`ValueType`](../interfaces/ValueType.md) | | `options`? | [`TypeNameOptions`](../interfaces/TypeNameOptions.md) | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md index d1f4c4ff4a..8231800984 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md @@ -13,3 +13,7 @@ getVisibility(program, target): string[] | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`string`[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md index a79a0b6c81..8d726b2263 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md @@ -12,3 +12,7 @@ hasParseError(node): number | true | Parameter | Type | | :------ | :------ | | `node` | [`Node`](../type-aliases/Node.md) | + +## Returns + +`number` \| `true` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md index d4adfd20dd..ab7251c8a7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md @@ -22,4 +22,6 @@ Get the projected name of the given entity for the given projection. ## Returns +`boolean` + Projected name for the given projection diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md index 9c12615003..58c9568e47 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md @@ -14,3 +14,7 @@ Determines whether a path has a trailing separator (`/` or `\\`). | Parameter | Type | | :------ | :------ | | `path` | `string` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md index cce487fbd2..efd2b86148 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md @@ -23,4 +23,6 @@ Ignore the diagnostics emitted by the diagnostic accessor pattern and just retur ## Returns +`T` + Actual result. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md index 313652ce1b..17c40de8e7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md @@ -17,3 +17,5 @@ Interpolate a path template | `predefinedVariables` | `Record`<`string`, `undefined` \| `string`\> | Variables that can be used in the path template. | ## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md index 409e3f1606..abee4537eb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md @@ -14,3 +14,7 @@ Determines whether a charCode corresponds to `/` or ``. | Parameter | Type | | :------ | :------ | | `charCode` | `number` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md index b9217fa59c..41d0e12807 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md @@ -13,3 +13,7 @@ isArrayModelType(program, type): type is ArrayModelType | :------ | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | - | | `type` | [`Model`](../interfaces/Model.md) | Model type | + +## Returns + +`type is ArrayModelType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md index 54f967b04e..4c1dc4d055 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md @@ -22,6 +22,8 @@ isCadlValueTypeOf(target, expectedType): target is InferredTypeSpecValue ## Returns +`target is InferredTypeSpecValue` + ## Deprecated use isTypeSpecValueTypeOf diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md index 3d2236928e..b30083bb6e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md @@ -12,3 +12,7 @@ isComment(token): boolean | Parameter | Type | | :------ | :------ | | `token` | [`Token`](../enumerations/Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md index d801e0f281..e0d4ea036d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md @@ -22,3 +22,5 @@ Check if the given type is declared in the specified namespace or, optionally, i | `options.recursive`? | `boolean` | - | ## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md index f8a99abd28..8916b6e7b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md @@ -16,3 +16,7 @@ Check if the type is a declared type. This include: | Parameter | Type | | :------ | :------ | | `type` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md index e18babc8df..f52fe8b53f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md @@ -15,3 +15,7 @@ Check if the given type is deprecated | :------ | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `type` | [`Type`](../type-aliases/Type.md) | Type | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md index d518300a41..06d8a0da66 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md @@ -13,3 +13,7 @@ isErrorModel(program, target): boolean | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md index 7d7dbfe785..27f4941c22 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md @@ -12,3 +12,7 @@ isErrorType(type): type is ErrorType | Parameter | Type | | :------ | :------ | | `type` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`type is ErrorType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md index e7585f42b9..bf482ade01 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md @@ -17,3 +17,5 @@ Check if the given namespace is the global namespace | `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | ## Returns + +`namespace is Namespace & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md index 15c4f80906..b92767ae14 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md @@ -12,3 +12,7 @@ isImportStatement(node): node is ImportStatementNode | Parameter | Type | | :------ | :------ | | `node` | [`Node`](../type-aliases/Node.md) | + +## Returns + +`node is ImportStatementNode` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md index 1de7bd9afa..22175e71ab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md @@ -17,3 +17,7 @@ isIntrinsicType( | `program` | [`Program`](../interfaces/Program.md) | | `type` | [`Scalar`](../interfaces/Scalar.md) | | `kind` | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md index b0e2c670e4..de827d3e63 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md @@ -13,3 +13,7 @@ isKey(program, property): boolean | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md index e15e18440b..44e74a7682 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md @@ -12,3 +12,7 @@ isKeyword(token): boolean | Parameter | Type | | :------ | :------ | | `token` | [`Token`](../enumerations/Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md index a694ab1a7a..2a766fa593 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md @@ -16,6 +16,8 @@ isListOperation(program, target): boolean ## Returns +`boolean` + ## Deprecated Use `isListOperation` in `@typespec/rest` instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md index de8bf19e0e..4d0548170c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md @@ -12,3 +12,7 @@ isModifier(token): boolean | Parameter | Type | | :------ | :------ | | `token` | [`Token`](../enumerations/Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md index a0736e7b10..f054d8aebf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md @@ -12,3 +12,7 @@ isNeverType(type): type is NeverType | Parameter | Type | | :------ | :------ | | `type` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`type is NeverType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md index 33d1d99183..41e1ce2ce3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md @@ -12,3 +12,7 @@ isNullType(type): type is NullType | Parameter | Type | | :------ | :------ | | `type` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`type is NullType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md index 4d8ca679a7..5c8fa2ab12 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md @@ -13,3 +13,7 @@ isNumericType(program, target): target is Scalar | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`target is Scalar` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md index ceb4586309..21e4b9b286 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md @@ -12,3 +12,7 @@ isPathAbsolute(path): boolean | Parameter | Type | | :------ | :------ | | `path` | `string` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md index 51e055c943..61e16dc5bc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md @@ -12,3 +12,7 @@ isProjectedProgram(program): program is ProjectedProgram | Parameter | Type | | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | + +## Returns + +`program is ProjectedProgram` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md index 5661e7072e..2219b79829 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md @@ -12,3 +12,7 @@ isPunctuation(token): boolean | Parameter | Type | | :------ | :------ | | `token` | [`Token`](../enumerations/Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md index 96d0f644fe..70514fcac7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md @@ -15,3 +15,7 @@ Check if a model is an array type. | :------ | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | - | | `type` | [`Model`](../interfaces/Model.md) | Model type | + +## Returns + +`type is ArrayModelType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md index ae5e2b48a6..54b813cccb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md @@ -13,3 +13,7 @@ isSecret(program, target): boolean | undefined | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`boolean` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md index 8a9f0b3960..2a278b6e62 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md @@ -18,4 +18,6 @@ Check if the namespace is defined as a service. ## Returns +`boolean` + Boolean diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md index 3bec936aee..da379ee03e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md @@ -12,3 +12,7 @@ isStatementKeyword(token): boolean | Parameter | Type | | :------ | :------ | | `token` | [`Token`](../enumerations/Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md index 80924c73d1..fc21666a88 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md @@ -12,3 +12,7 @@ isStdNamespace(namespace): boolean | Parameter | Type | | :------ | :------ | | `namespace` | [`Namespace`](../interfaces/Namespace.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md index efd49ecc3b..5b71a07254 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md @@ -13,3 +13,7 @@ isStringType(program, target): target is Scalar | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | | `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`target is Scalar` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md index 517ed31640..80bfbc6ea6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md @@ -14,3 +14,7 @@ Resolve if the type is a template type declaration(Non initialized template type | Parameter | Type | | :------ | :------ | | `type` | [`TemplatedType`](../type-aliases/TemplatedType.md) | + +## Returns + +`type is Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md index 24d5c94d55..1f5ffe2aca 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md @@ -14,3 +14,7 @@ Resolve if the type was created from a template type or is a template type decla | Parameter | Type | | :------ | :------ | | `type` | [`TemplatedType`](../type-aliases/TemplatedType.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md index 06a1f65608..96e75d0d93 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md @@ -14,3 +14,7 @@ Check the given type is a finished template instance. | Parameter | Type | | :------ | :------ | | `type` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`type is Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md index 6b02bc0f08..4a7db7572a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md @@ -12,3 +12,7 @@ isTrivia(token): boolean | Parameter | Type | | :------ | :------ | | `token` | [`Token`](../enumerations/Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md index 87e9641e04..40537eaccd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md @@ -24,4 +24,6 @@ Check if the given target is of any of the typespec types. ## Returns +`target is InferredTypeSpecValue` + boolean if the target is of one of the allowed types. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md index 39fa7cfefc..d96a20b145 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md @@ -12,3 +12,7 @@ isUnknownType(type): type is UnknownType | Parameter | Type | | :------ | :------ | | `type` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`type is UnknownType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md index 670d518d6b..fac8b27849 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md @@ -14,3 +14,7 @@ Determines whether a path starts with a URL scheme (e.g. starts with `http://`, | Parameter | Type | | :------ | :------ | | `path` | `string` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md index 116add3394..5b89aa6098 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md @@ -17,3 +17,7 @@ isVisible( | `program` | [`Program`](../interfaces/Program.md) | | `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | | `visibilities` | readonly `string`[] | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md index f8e9b3083f..0556ff90e5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md @@ -12,3 +12,7 @@ isVoidType(type): type is VoidType | Parameter | Type | | :------ | :------ | | `type` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`type is VoidType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md index 761a23b6c7..e78d9eea75 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md @@ -30,3 +30,7 @@ joinPaths("file:///path", "file:///to", "file.ext") === "file:///to/file.ext" | :------ | :------ | | `path` | `string` | | ...`paths` | (`undefined` \| `string`)[] | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md index 7d35fa7450..ac93da4059 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md @@ -15,3 +15,7 @@ List operations in the given container. Will list operation recursively by defau | :------ | :------ | :------ | | `container` | [`Interface`](../interfaces/Interface.md) \| [`Namespace`](../interfaces/Namespace.md) | Container. | | `options` | [`ListOperationOptions`](../interfaces/ListOperationOptions.md) | Options. | + +## Returns + +[`Operation`](../interfaces/Operation.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md index c1c8ac3dec..55d35ffebe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md @@ -17,4 +17,6 @@ List all the services defined in the typespec program ## Returns +[`Service`](../interfaces/Service.md)[] + List of service. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md index 99216e7ad4..9cb0323501 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md @@ -13,3 +13,7 @@ logDiagnostics(diagnostics, logger): void | :------ | :------ | | `diagnostics` | readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] | | `logger` | [`LogSink`](../interfaces/LogSink.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md index 064ff7e617..cd6d715306 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md @@ -20,3 +20,7 @@ when verbose output is disabled. | Parameter | Type | | :------ | :------ | | `messageOrCallback` | `string` \| (`log`) => `void` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md index 1d8cdc6aae..faeb12b857 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md @@ -17,4 +17,6 @@ Create a Semantic node listener from an event emitter. ## Returns +[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) + Semantic node listener. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md index c65ddb6121..32cca70f55 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md @@ -19,3 +19,7 @@ Mark the given type as deprecated with the provided details. | `program` | [`Program`](../interfaces/Program.md) | Program | | `type` | [`Type`](../type-aliases/Type.md) | Type | | `details` | [`DeprecationDetails`](../interfaces/DeprecationDetails.md) | Details of the deprecation | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md index 6f3fdc9654..820142d61b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md @@ -19,3 +19,7 @@ Navigate all types in the program. | `program` | [`Program`](../interfaces/Program.md) | Program to navigate. | | `listeners` | [`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) | Listener called when visiting types. | | `options` | [`NavigationOptions`](../interfaces/NavigationOptions.md) | Navigation options. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md index c9d47f66b2..bc2bd515fd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md @@ -19,3 +19,7 @@ Navigate the given type and all the types that are used in it. | `type` | [`Type`](../type-aliases/Type.md) | Type to navigate. | | `listeners` | [`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) | Listener for the types found. | | `options` | [`NavigationOptions`](../interfaces/NavigationOptions.md) | Navigation options | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md index c827c67660..fae7969c31 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md @@ -17,3 +17,7 @@ navigateTypesInNamespace( | `namespace` | [`Namespace`](../interfaces/Namespace.md) | | `listeners` | `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` | | `options` | [`NamespaceNavigationOptions`](../interfaces/NamespaceNavigationOptions.md) & [`NavigationOptions`](../interfaces/NavigationOptions.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md index 74a9fceadf..5f3c85b47a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md @@ -12,3 +12,7 @@ normalizePath(path): string | Parameter | Type | | :------ | :------ | | `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md index 9ed7a2775e..f57cabe09d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md @@ -14,3 +14,7 @@ Normalize path separators, converting `\` into `/`. | Parameter | Type | | :------ | :------ | | `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md index e75e773936..0629c218e8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md @@ -19,3 +19,7 @@ paramMessage(strings, ...keys): CallableMessage | :------ | :------ | | `strings` | readonly `string`[] | | ...`keys` | `T` | + +## Returns + +[`CallableMessage`](../interfaces/CallableMessage.md)<`T`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md index 07ce67685c..19635813f6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md @@ -13,3 +13,7 @@ parse(code, options): TypeSpecScriptNode | :------ | :------ | | `code` | `string` \| [`SourceFile`](../interfaces/SourceFile.md) | | `options` | [`ParseOptions`](../interfaces/ParseOptions.md) | + +## Returns + +[`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md index 9f01d158d4..11aeb6b5b7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md @@ -12,3 +12,7 @@ parseStandaloneTypeReference(code): [TypeReferenceNode, readonly Diagnostic[]] | Parameter | Type | | :------ | :------ | | `code` | `string` \| [`SourceFile`](../interfaces/SourceFile.md) | + +## Returns + +[[`TypeReferenceNode`](../interfaces/TypeReferenceNode.md), readonly [`Diagnostic`](../interfaces/Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md index 7ce0f39a58..370563d678 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md @@ -17,3 +17,7 @@ projectProgram( | `program` | [`Program`](../interfaces/Program.md) | | `projections` | [`ProjectionApplication`](../interfaces/ProjectionApplication.md)[] | | `startNode`? | [`Type`](../type-aliases/Type.md) | + +## Returns + +[`ProjectedProgram`](../interfaces/ProjectedProgram.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md index d1c1773efe..d98770badb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md @@ -15,3 +15,7 @@ Reduce an array of path components to a more simplified path by navigating any | Parameter | Type | | :------ | :------ | | `components` | readonly `string`[] | + +## Returns + +`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md index 63b171f7dd..277ef723b7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md @@ -19,3 +19,7 @@ removeTrailingDirectorySeparator("/path/to/file.ext/") === "/path/to/file.ext" | Parameter | Type | | :------ | :------ | | `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md index 77840af0f3..f5f7ef69ba 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md @@ -19,3 +19,7 @@ Report a deprecated diagnostic. | `program` | [`Program`](../interfaces/Program.md) | TypeSpec Program. | | `message` | `string` | Message describing the deprecation. | | `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | Target of the deprecation. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md index b8db05d492..4d8943d0b9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md @@ -15,3 +15,7 @@ Resolve the compiler options for the given entrypoint by resolving the tspconfig | :------ | :------ | :------ | | `host` | [`CompilerHost`](../interfaces/CompilerHost.md) | Compiler host | | `options` | [`ResolveCompilerOptionsOptions`](../interfaces/ResolveCompilerOptionsOptions.md) | - | + +## Returns + +`Promise`<[[`CompilerOptions`](../interfaces/CompilerOptions.md), readonly [`Diagnostic`](../interfaces/Diagnostic.md)[]]\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md index 4f233e9c6b..aa009c703f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md @@ -21,3 +21,5 @@ Resolve a module | `options` | [`ResolveModuleOptions`](../interfaces/ResolveModuleOptions.md) | | ## Returns + +`Promise`<[`ModuleResolutionResult`](../type-aliases/ModuleResolutionResult.md)\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md index b9c37cfbdd..cb260f4ffd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md @@ -22,3 +22,7 @@ resolvePath("/path", "dir", "..", "to", "file.ext") === "path/to/file.ext" | :------ | :------ | | `path` | `string` | | ...`paths` | (`undefined` \| `string`)[] | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md index 8e45b17886..ea6924d66d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md @@ -18,4 +18,6 @@ Will recursively scan all namespace, interfaces and operations contained inside ## Returns +[`UsageTracker`](../interfaces/UsageTracker.md) + Map of types to usage. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md index 2cb3d7998a..a539307729 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md @@ -28,4 +28,6 @@ Scope the current navigation to the given namespace. ## Returns +`T` + wrapped listeners that that can be used with `navigateType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md index b72dd7e61f..db6837821f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md @@ -16,6 +16,8 @@ setCadlNamespace(namespace, ...functions): void ## Returns +`void` + ## Deprecated use setTypeSpecNamespace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md index c136758acf..2d54e87e46 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md @@ -15,3 +15,7 @@ Set the TypeSpec namespace for that function. | :------ | :------ | :------ | | `namespace` | `string` | Namespace string (e.g. "Foo.Bar") | | ...`functions` | (...`args`) => `any`[] | Functions | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md index aa72c70d31..4a26a6f1ff 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md @@ -17,3 +17,7 @@ skipTrivia( | `input` | `string` | `undefined` | | `position` | `number` | `undefined` | | `endPosition` | `number` | `input.length` | + +## Returns + +`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md index d4c22456b7..4f80fb1b19 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md @@ -17,3 +17,7 @@ skipWhiteSpace( | `input` | `string` | `undefined` | | `position` | `number` | `undefined` | | `endPosition` | `number` | `input.length` | + +## Returns + +`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md index 5dcd158e9c..cd282c2bac 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md @@ -22,3 +22,7 @@ Emits diagnostics if the given type is invalid | :------ | :------ | :------ | | `typespecType` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | The type to convert to Json data | | `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | The diagnostic target in case of errors. | + +## Returns + +[`T` \| `undefined`, [`Diagnostic`](../interfaces/Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md index 9cb27e6dcc..45e8845ee2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md @@ -25,4 +25,6 @@ Useful to check for decorator usage that conflicts with another decorator. ## Returns +`boolean` + Whether the decorator application is valid diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md index 444c244585..7b3b87dcae 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md @@ -19,3 +19,7 @@ validateDecoratorParamCount( | `min` | `number` | | `max` | `undefined` \| `number` | | `parameters` | `unknown`[] | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md index ee03f0ec48..a425dbcf26 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md @@ -51,6 +51,8 @@ Validate a decorator parameter has the correct type. ## Returns +`value is InferredTypeSpecValue` + true if the value is of one of the type in the list of expected types. If not emit a diagnostic. ## Deprecated diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md index a19d37a2c6..8ffc88cb30 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md @@ -29,3 +29,5 @@ Validate the decorator target is matching the expected value. | `expectedType` | `K` \| readonly `K`[] | | ## Returns + +`target is K extends "Any" ? Type : Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md index a9712bc109..beedf0990d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md @@ -22,6 +22,8 @@ validateDecoratorTargetIntrinsic( ## Returns +`boolean` + ## Deprecated this function is deprecated use decorator definition in typespec instead or check assignability directly. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md index a69903de5c..89c5bae023 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md @@ -17,3 +17,7 @@ validateDecoratorUniqueOnNode( | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `type` | [`Type`](../type-aliases/Type.md) | | `decorator` | [`DecoratorFunction`](../interfaces/DecoratorFunction.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md index 6dee1450e0..7b1dbe1af8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md @@ -19,3 +19,7 @@ visitChildren(node, cb): T | undefined | :------ | :------ | | `node` | [`Node`](../type-aliases/Node.md) | | `cb` | [`NodeCallback`](../type-aliases/NodeCallback.md)<`T`\> | + +## Returns + +`T` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md index 76771e5930..f4a0324348 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md @@ -19,3 +19,7 @@ Properties that are overridden are not enumerated. | Parameter | Type | | :------ | :------ | | `model` | [`Model`](../interfaces/Model.md) | + +## Returns + +`Generator`<[`ModelProperty`](../interfaces/ModelProperty.md), `void`, `unknown`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.mdx b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md similarity index 100% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.mdx rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md index 8af7218489..138bec3e05 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md @@ -11,14 +11,14 @@ title: "[I] AliasStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `AliasStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `locals?` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `locals`? | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `templateParameters` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md index cfa67c80a6..860786179c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md @@ -11,11 +11,11 @@ title: "[I] AnyKeywordNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `UnknownKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md index 2f35c81548..fb1835f9f5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md @@ -11,12 +11,12 @@ title: "[I] ArrayExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `elementType` | [`Expression`](../type-aliases/Expression.md) | - | - | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ArrayExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md index ce4daf5ef1..f20c9e7c2d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md @@ -11,26 +11,26 @@ title: "[I] ArrayModelType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `baseModel?` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | [`Model`](Model.md).`baseModel` | +| `baseModel`? | [`Model`](Model.md) | Model this model extends. This represent inheritance. | [`Model`](Model.md).`baseModel` | | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`Model`](Model.md).`decorators` | | `derivedModels` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](ArrayModelType.md) | [`Model`](Model.md).`derivedModels` | | `indexer` | `object` | - | [`Model`](Model.md).`indexer` | | `indexer.key` | [`Scalar`](Scalar.md) | - | - | | `indexer.value` | [`Type`](../type-aliases/Type.md) | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`Model`](Model.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`Model`](Model.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`Model`](Model.md).`isFinished` | | `kind` | `"Model"` | - | [`Model`](Model.md).`kind` | | `name` | `string` | - | [`Model`](Model.md).`name` | -| `namespace?` | [`Namespace`](Namespace.md) | - | [`Model`](Model.md).`namespace` | -| `node?` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`Model`](Model.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`Model`](Model.md).`projector` | +| `namespace`? | [`Namespace`](Namespace.md) | - | [`Model`](Model.md).`namespace` | +| `node`? | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`Model`](Model.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`Model`](Model.md).`projector` | | `properties` | `RekeyableMap`<`string`, [`ModelProperty`](ModelProperty.md)\> | The properties of the model.

Properties are ordered in the order that they appear in source.
Properties obtained via `model is` appear before properties defined in
the model body. Properties obtained via `...` are inserted where the
spread appears in source.

Properties inherited via `model extends` are not included. Use
[walkPropertiesInherited](../functions/walkPropertiesInherited.md) to enumerate all properties in the
inheritance hierarchy. | [`Model`](Model.md).`properties` | -| `sourceModel?` | [`Model`](Model.md) | The model that is referenced via `model is`. | [`Model`](Model.md).`sourceModel` | -| `templateArguments?` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`Model`](Model.md).`templateArguments` | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`Model`](Model.md).`templateMapper` | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`Model`](Model.md).`templateNode` | +| `sourceModel`? | [`Model`](Model.md) | The model that is referenced via `model is`. | [`Model`](Model.md).`sourceModel` | +| `templateArguments`? | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`Model`](Model.md).`templateArguments` | +| `templateMapper`? | [`TypeMapper`](TypeMapper.md) | - | [`Model`](Model.md).`templateMapper` | +| `templateNode`? | [`Node`](../type-aliases/Node.md) | - | [`Model`](Model.md).`templateNode` | ## Accessors @@ -40,6 +40,10 @@ title: "[I] ArrayModelType" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -54,6 +58,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`Model`](Model.md).[`projectionsByName`](Model.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md index 0c6bbffcb2..bdd9121d7d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md @@ -12,12 +12,12 @@ title: "[I] AugmentDecoratorStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `arguments` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `AugmentDecoratorStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md index 1f5cc1b7b7..023cdc5e76 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md @@ -11,11 +11,11 @@ title: "[I] BaseNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | - | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | - | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`TextRange`](TextRange.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | | `readonly` | `kind` | [`SyntaxKind`](../enumerations/SyntaxKind.md) | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | - | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | - | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md index d1d90d6eb1..4e2f9a1b55 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md @@ -31,13 +31,13 @@ title: "[I] BaseType" | Property | Type | Description | | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | | `kind` | `string` | - | -| `node?` | [`Node`](../type-aliases/Node.md) | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | -| `projector?` | [`Projector`](Projector.md) | - | +| `node`? | [`Node`](../type-aliases/Node.md) | - | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | +| `projector`? | [`Projector`](Projector.md) | - | ## Accessors @@ -47,6 +47,10 @@ title: "[I] BaseType" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -60,3 +64,7 @@ projectionsByName(name): ProjectionStatementNode[] | Parameter | Type | | :------ | :------ | | `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md index fdb2e5f012..fe2cf2e078 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md @@ -13,5 +13,5 @@ title: "[I] BlockComment" | :------ | :------ | :------ | :------ | :------ | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`TextRange`](TextRange.md).`end` | | `readonly` | `kind` | `BlockComment` | - | - | -| `readonly` | `parsedAsDocs?` | `boolean` | If that comment was parsed as a doc comment. If parserOptions.docs=false this will always be false. | - | +| `readonly` | `parsedAsDocs`? | `boolean` | If that comment was parsed as a doc comment. If parserOptions.docs=false this will always be false. | - | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md index 80425018cc..a14c967abe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md @@ -11,13 +11,13 @@ title: "[I] BooleanLiteral" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Boolean"` | - | [`BaseType`](BaseType.md).`kind` | -| `node?` | [`BooleanLiteralNode`](BooleanLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `node`? | [`BooleanLiteralNode`](BooleanLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `value` | `boolean` | - | - | ## Accessors @@ -28,6 +28,10 @@ title: "[I] BooleanLiteral" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -42,6 +46,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md index c62e5b765a..95c90b2c0a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md @@ -11,12 +11,12 @@ title: "[I] BooleanLiteralNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `BooleanLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `value` | `boolean` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md index 07283ef526..3b5e925da2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md @@ -17,7 +17,11 @@ CallableMessage(dict): string | Parameter | Type | | :------ | :------ | -| `dict` | `Record`<`T`[`number`], `string`\> | +| `dict` | `Record`<`T`\[`number`\], `string`\> | + +## Returns + +`string` ## Properties diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md index 2e88a02ee9..2834f358a1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md @@ -21,6 +21,10 @@ title: "[I] Checker" checkProgram(): void ``` +#### Returns + +`void` + *** ### checkSourceFile() @@ -35,6 +39,10 @@ checkSourceFile(file): void | :------ | :------ | | `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | +#### Returns + +`void` + *** ### cloneType() @@ -56,6 +64,10 @@ cloneType(type, additionalProps?): T | `type` | `T` | | `additionalProps`? | `{ [P in string | number | symbol]?: T[P] }` | +#### Returns + +`T` + *** ### createAndFinishType() @@ -76,6 +88,10 @@ createAndFinishType(typeDef): T & TypePrototype | :------ | :------ | | `typeDef` | `T` | +#### Returns + +`T` & `TypePrototype` + *** ### createFunctionType() @@ -90,6 +106,10 @@ createFunctionType(fn): FunctionType | :------ | :------ | | `fn` | (...`args`) => [`Type`](../type-aliases/Type.md) | +#### Returns + +[`FunctionType`](FunctionType.md) + *** ### createLiteralType() @@ -107,6 +127,10 @@ createLiteralType(value, node?): StringLiteral | `value` | `string` | | `node`? | [`StringLiteralNode`](StringLiteralNode.md) | +##### Returns + +[`StringLiteral`](StringLiteral.md) + #### createLiteralType(value, node) ```ts @@ -120,6 +144,10 @@ createLiteralType(value, node?): NumericLiteral | `value` | `number` | | `node`? | [`NumericLiteralNode`](NumericLiteralNode.md) | +##### Returns + +[`NumericLiteral`](NumericLiteral.md) + #### createLiteralType(value, node) ```ts @@ -133,6 +161,10 @@ createLiteralType(value, node?): BooleanLiteral | `value` | `boolean` | | `node`? | [`BooleanLiteralNode`](BooleanLiteralNode.md) | +##### Returns + +[`BooleanLiteral`](BooleanLiteral.md) + #### createLiteralType(value, node) ```ts @@ -146,6 +178,10 @@ createLiteralType(value, node?): StringLiteral | NumericLiteral | BooleanLiteral | `value` | `string` \| `number` \| `boolean` | | `node`? | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) \| [`BooleanLiteralNode`](BooleanLiteralNode.md) | +##### Returns + +[`StringLiteral`](StringLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`BooleanLiteral`](BooleanLiteral.md) + #### createLiteralType(value, node) ```ts @@ -159,6 +195,10 @@ createLiteralType(value, node?): StringLiteral | NumericLiteral | BooleanLiteral | `value` | `string` \| `number` \| `boolean` | | `node`? | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) \| [`BooleanLiteralNode`](BooleanLiteralNode.md) | +##### Returns + +[`StringLiteral`](StringLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`BooleanLiteral`](BooleanLiteral.md) + *** ### createType() @@ -179,6 +219,10 @@ createType(typeDef): T & TypePrototype & object | :------ | :------ | | `typeDef` | `T` | +#### Returns + +`T` & `TypePrototype` & `object` + *** ### evalProjection() @@ -198,6 +242,10 @@ evalProjection( | `target` | [`Type`](../type-aliases/Type.md) | | `args` | [`Type`](../type-aliases/Type.md)[] | +#### Returns + +[`Type`](../type-aliases/Type.md) + *** ### finishType() @@ -218,6 +266,10 @@ finishType(typeDef): T | :------ | :------ | | `typeDef` | `T` | +#### Returns + +`T` + *** ### getGlobalNamespaceNode() @@ -226,6 +278,10 @@ finishType(typeDef): T getGlobalNamespaceNode(): NamespaceStatementNode ``` +#### Returns + +[`NamespaceStatementNode`](NamespaceStatementNode.md) + *** ### getGlobalNamespaceType() @@ -234,6 +290,10 @@ getGlobalNamespaceNode(): NamespaceStatementNode getGlobalNamespaceType(): Namespace ``` +#### Returns + +[`Namespace`](Namespace.md) + *** ### getLiteralType() @@ -250,6 +310,10 @@ getLiteralType(node): StringLiteral | :------ | :------ | | `node` | [`StringLiteralNode`](StringLiteralNode.md) | +##### Returns + +[`StringLiteral`](StringLiteral.md) + #### getLiteralType(node) ```ts @@ -262,6 +326,10 @@ getLiteralType(node): NumericLiteral | :------ | :------ | | `node` | [`NumericLiteralNode`](NumericLiteralNode.md) | +##### Returns + +[`NumericLiteral`](NumericLiteral.md) + #### getLiteralType(node) ```ts @@ -274,6 +342,10 @@ getLiteralType(node): BooleanLiteral | :------ | :------ | | `node` | [`BooleanLiteralNode`](BooleanLiteralNode.md) | +##### Returns + +[`BooleanLiteral`](BooleanLiteral.md) + #### getLiteralType(node) ```ts @@ -286,6 +358,10 @@ getLiteralType(node): LiteralType | :------ | :------ | | `node` | [`LiteralNode`](../type-aliases/LiteralNode.md) | +##### Returns + +[`LiteralType`](../type-aliases/LiteralType.md) + *** ### getMergedSymbol() @@ -300,6 +376,10 @@ getMergedSymbol(sym): undefined | Sym | :------ | :------ | | `sym` | `undefined` \| [`Sym`](Sym.md) | +#### Returns + +`undefined` \| [`Sym`](Sym.md) + *** ### getNamespaceString() @@ -317,6 +397,8 @@ getNamespaceString(type, options?): string #### Returns +`string` + #### Deprecated use `import { getNamespaceFullName } from "@typespec/compiler";` @@ -326,7 +408,7 @@ use `import { getNamespaceFullName } from "@typespec/compiler";` ### getStdType() ```ts -getStdType(name): StdTypes[T] +getStdType(name): StdTypes\[T\] ``` Std type @@ -343,6 +425,10 @@ Std type | :------ | :------ | :------ | | `name` | `T` | Name | +#### Returns + +[`StdTypes`](../type-aliases/StdTypes.md)\[`T`\] + *** ### getTypeForNode() @@ -357,6 +443,10 @@ getTypeForNode(node): Type | :------ | :------ | | `node` | [`Node`](../type-aliases/Node.md) | +#### Returns + +[`Type`](../type-aliases/Type.md) + *** ### getTypeName() @@ -374,6 +464,8 @@ getTypeName(type, options?): string #### Returns +`string` + #### Deprecated use `import { getTypeName } from "@typespec/compiler";` @@ -397,6 +489,10 @@ Check if the given type is one of the built-in standard TypeSpec Types. | `type` | [`Scalar`](Scalar.md) | Type to check | | `stdType`? | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) | If provided check is that standard type | +##### Returns + +`type is Scalar & Object` + #### isStdType(type, stdType) ```ts @@ -410,6 +506,10 @@ isStdType(type, stdType?): type is Type & Object | `type` | [`Type`](../type-aliases/Type.md) | | `stdType`? | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| `"Array"` \| `"Record"` | +##### Returns + +`type is Type & Object` + *** ### isTypeAssignableTo() @@ -433,6 +533,8 @@ Check if the source type can be assigned to the target type. #### Returns +[`boolean`, readonly [`Diagnostic`](Diagnostic.md)[]] + [related, list of diagnostics] *** @@ -449,6 +551,10 @@ mergeSourceFile(file): void | :------ | :------ | | `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`JsSourceFileNode`](JsSourceFileNode.md) | +#### Returns + +`void` + *** ### project() @@ -468,6 +574,10 @@ project( | `projection` | [`ProjectionNode`](ProjectionNode.md) | | `args`? | (`string` \| `number` \| `boolean` \| [`Type`](../type-aliases/Type.md))[] | +#### Returns + +[`Type`](../type-aliases/Type.md) + *** ### resolveCompletions() @@ -482,6 +592,10 @@ resolveCompletions(node): Map | :------ | :------ | | `node` | [`IdentifierNode`](IdentifierNode.md) | +#### Returns + +`Map`<`string`, [`TypeSpecCompletionItem`](TypeSpecCompletionItem.md)\> + *** ### resolveIdentifier() @@ -496,6 +610,10 @@ resolveIdentifier(node): undefined | Sym | :------ | :------ | | `node` | [`IdentifierNode`](IdentifierNode.md) | +#### Returns + +`undefined` \| [`Sym`](Sym.md) + *** ### resolveTypeReference() @@ -514,6 +632,8 @@ Check and resolve a type for the given type reference node. #### Returns +[`undefined` \| [`Type`](../type-aliases/Type.md), readonly [`Diagnostic`](Diagnostic.md)[]] + Resolved type and diagnostics if there was an error. *** @@ -529,3 +649,7 @@ setUsingsForFile(file): void | Parameter | Type | | :------ | :------ | | `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md index 11d7861967..eb728e448c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md @@ -8,7 +8,7 @@ title: "[I] CompilerHost" | Property | Type | Description | | :------ | :------ | :------ | | `logSink` | [`LogSink`](LogSink.md) | - | -| `parseCache?` | `WeakMap`<[`SourceFile`](SourceFile.md), [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | Optional cache to reuse the results of parsing and binding across programs. | +| `parseCache`? | `WeakMap`<[`SourceFile`](SourceFile.md), [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | Optional cache to reuse the results of parsing and binding across programs. | ## Methods @@ -24,6 +24,10 @@ fileURLToPath(url): string | :------ | :------ | | `url` | `string` | +#### Returns + +`string` + *** ### getExecutionRoot() @@ -32,6 +36,10 @@ fileURLToPath(url): string getExecutionRoot(): string ``` +#### Returns + +`string` + *** ### getJsImport() @@ -46,6 +54,10 @@ getJsImport(path): Promise> | :------ | :------ | | `path` | `string` | +#### Returns + +`Promise`<`Record`<`string`, `any`\>\> + *** ### getLibDirs() @@ -54,6 +66,10 @@ getJsImport(path): Promise> getLibDirs(): string[] ``` +#### Returns + +`string`[] + *** ### getSourceFileKind() @@ -68,6 +84,10 @@ getSourceFileKind(path): undefined | SourceFileKind | :------ | :------ | | `path` | `string` | +#### Returns + +`undefined` \| [`SourceFileKind`](../type-aliases/SourceFileKind.md) + *** ### mkdirp() @@ -84,6 +104,10 @@ create directory recursively. | :------ | :------ | :------ | | `path` | `string` | Path to the directory. | +#### Returns + +`Promise`<`undefined` \| `string`\> + *** ### pathToFileURL() @@ -98,6 +122,10 @@ pathToFileURL(path): string | :------ | :------ | | `path` | `string` | +#### Returns + +`string` + *** ### readDir() @@ -116,6 +144,8 @@ Read directory. #### Returns +`Promise`<`string`[]\> + list of file/directory in the given directory. Returns the name not the full path. *** @@ -134,6 +164,10 @@ read a utf-8 or utf-8 with bom encoded file | :------ | :------ | | `path` | `string` | +#### Returns + +`Promise`<[`SourceFile`](SourceFile.md)\> + *** ### readUrl() @@ -150,6 +184,10 @@ read a file at the given url. | :------ | :------ | | `url` | `string` | +#### Returns + +`Promise`<[`SourceFile`](SourceFile.md)\> + *** ### realpath() @@ -164,6 +202,10 @@ realpath(path): Promise | :------ | :------ | | `path` | `string` | +#### Returns + +`Promise`<`string`\> + *** ### rm() @@ -181,6 +223,10 @@ Deletes a directory or file. | `path` | `string` | Path to the directory or file. | | `options`? | [`RmOptions`](RmOptions.md) | - | +#### Returns + +`Promise`<`void`\> + *** ### stat() @@ -195,6 +241,10 @@ stat(path): Promise | :------ | :------ | | `path` | `string` | +#### Returns + +`Promise`<`object`\> + *** ### writeFile() @@ -211,3 +261,7 @@ Write the file. | :------ | :------ | :------ | | `path` | `string` | Path to the file. | | `content` | `string` | Content of the file. | + +#### Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md index 9ca4cd6625..7fba62878b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md @@ -7,19 +7,19 @@ title: "[I] CompilerOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `additionalImports?` | `string`[] | - | -| `config?` | `string` | Path to config YAML file or folder in which to search for default tspconfig.yaml file. | -| `designTimeBuild?` | `boolean` | When true, indicates that a compilation is being performed for live
analysis in the language server. | -| `emit?` | `string`[] | List or path to emitters to use. | -| `emitters?` | `Record`<`string`, `EmitterOptions`\> | **Deprecated**

use [emit](CompilerOptions.md) and [options](CompilerOptions.md) instead.

Will be removed in March 2022 sprint. | -| `ignoreDeprecated?` | `boolean` | Suppress all `deprecated` warnings. | -| `linterRuleSet?` | [`LinterRuleSet`](LinterRuleSet.md) | Ruleset to enable for linting. | -| `miscOptions?` | `Record`<`string`, `unknown`\> | - | -| `noEmit?` | `boolean` | - | -| `nostdlib?` | `boolean` | - | -| `options?` | `Record`<`string`, `EmitterOptions`\> | Emitter options.
Key value pair where the key must be the emitter name. | -| `outputDir?` | `string` | Default output directory used by emitters.

**Default**

` ./tsp-output ` | -| `outputPath?` | `string` | **Deprecated**

use outputDir. | -| `parseOptions?` | [`ParseOptions`](ParseOptions.md) | - | -| `trace?` | `string`[] | Trace area to enable. | -| `warningAsError?` | `boolean` | - | +| `additionalImports`? | `string`[] | - | +| `config`? | `string` | Path to config YAML file or folder in which to search for default tspconfig.yaml file. | +| `designTimeBuild`? | `boolean` | When true, indicates that a compilation is being performed for live
analysis in the language server. | +| `emit`? | `string`[] | List or path to emitters to use. | +| `emitters`? | `Record`<`string`, `EmitterOptions`\> | **Deprecated**

use [emit](CompilerOptions.md) and [options](CompilerOptions.md) instead.

Will be removed in March 2022 sprint. | +| `ignoreDeprecated`? | `boolean` | Suppress all `deprecated` warnings. | +| `linterRuleSet`? | [`LinterRuleSet`](LinterRuleSet.md) | Ruleset to enable for linting. | +| `miscOptions`? | `Record`<`string`, `unknown`\> | - | +| `noEmit`? | `boolean` | - | +| `nostdlib`? | `boolean` | - | +| `options`? | `Record`<`string`, `EmitterOptions`\> | Emitter options.
Key value pair where the key must be the emitter name. | +| `outputDir`? | `string` | Default output directory used by emitters.

**Default**

` ./tsp-output ` | +| `outputPath`? | `string` | **Deprecated**

use outputDir. | +| `parseOptions`? | [`ParseOptions`](ParseOptions.md) | - | +| `trace`? | `string`[] | Trace area to enable. | +| `warningAsError`? | `boolean` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md index c85ef6409f..40d4798485 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md @@ -12,16 +12,16 @@ title: "[I] Decorator" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `implementation` | (...`args`) => `void` | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Decorator"` | - | [`BaseType`](BaseType.md).`kind` | | `name` | \`@${string}\` | - | - | | `namespace` | [`Namespace`](Namespace.md) | - | - | | `node` | [`DecoratorDeclarationStatementNode`](DecoratorDeclarationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | | `parameters` | [`FunctionParameter`](FunctionParameter.md)[] | - | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `target` | [`FunctionParameter`](FunctionParameter.md) | - | - | ## Accessors @@ -32,6 +32,10 @@ title: "[I] Decorator" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -46,6 +50,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md index 610312d64d..d169c3d2bd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md @@ -9,5 +9,5 @@ title: "[I] DecoratorApplication" | :------ | :------ | :------ | | `args` | [`DecoratorArgument`](DecoratorArgument.md)[] | - | | `decorator` | [`DecoratorFunction`](DecoratorFunction.md) | - | -| `definition?` | [`Decorator`](Decorator.md) | - | -| `node?` | [`DecoratorExpressionNode`](DecoratorExpressionNode.md) \| [`AugmentDecoratorStatementNode`](AugmentDecoratorStatementNode.md) | - | +| `definition`? | [`Decorator`](Decorator.md) | - | +| `node`? | [`DecoratorExpressionNode`](DecoratorExpressionNode.md) \| [`AugmentDecoratorStatementNode`](AugmentDecoratorStatementNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md index 1b43175dc5..bccfb0842f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md @@ -8,5 +8,5 @@ title: "[I] DecoratorArgument" | Property | Type | Description | | :------ | :------ | :------ | | `jsValue` | `string` \| `number` \| `boolean` \| [`Type`](../type-aliases/Type.md) | Marshalled value for use in Javascript. | -| `node?` | [`Node`](../type-aliases/Node.md) | - | +| `node`? | [`Node`](../type-aliases/Node.md) | - | | `value` | [`Type`](../type-aliases/Type.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md index 24e6f39e37..ad185f2f8e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md @@ -39,6 +39,10 @@ Helper to call out to another decorator | `target` | `T` | - | | ...`args` | `A` | Args to pass to other decorator function | +#### Returns + +`R` + *** ### getArgumentTarget() @@ -57,6 +61,8 @@ Function that can be used to retrieve the target for a parameter at the given in #### Returns +`undefined` \| [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) + #### Example ```ts diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md index 5560aefc58..2c5e7487db 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md @@ -19,8 +19,8 @@ extern dec doc(target: Type, value: valueof string); | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | @@ -28,7 +28,7 @@ extern dec doc(target: Type, value: valueof string); | `readonly` | `modifierFlags` | [`ModifierFlags`](../enumerations/ModifierFlags.md) | - | - | | `readonly` | `modifiers` | readonly [`ExternKeywordNode`](ExternKeywordNode.md)[] | - | - | | `readonly` | `parameters` | [`FunctionParameterNode`](FunctionParameterNode.md)[] | Additional parameters | - | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`FunctionParameterNode`](FunctionParameterNode.md) | Decorator target. First parameter. | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md index 73b25848c6..b27fce0c73 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md @@ -17,5 +17,5 @@ title: "[I] DecoratorDefinition" | :------ | :------ | :------ | :------ | | `readonly` | `args` | `P` | List of positional arguments in the function. | | `readonly` | `name` | `string` | Name of the decorator. | -| `readonly` | `spreadArgs?` | `S` | **Optional**

Type of the spread args at the end of the function if applicable. | +| `readonly` | `spreadArgs`? | `S` | **Optional**

Type of the spread args at the end of the function if applicable. | | `readonly` | `target` | `T` \| readonly `T`[] | Decorator target. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md index 60f9f274cf..e0d7052bc8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md @@ -12,12 +12,12 @@ title: "[I] DecoratorExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `arguments` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `DecoratorExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md index 6a95ad3f69..be3ddd58a7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md @@ -18,8 +18,12 @@ DecoratorFunction( | `target` | `any` | | ...`customArgs` | `any`[] | +## Returns + +`void` + ## Properties | Property | Type | Description | | :------ | :------ | :------ | -| `namespace?` | `string` | - | +| `namespace`? | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md index a677ca5bcf..e875c25b5e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md @@ -14,4 +14,4 @@ title: "[I] DecoratorParamDefinition" | Modifier | Property | Type | Description | | :------ | :------ | :------ | :------ | | `readonly` | `kind` | `K` \| readonly `K`[] | Kind of the parameter | -| `readonly` | `optional?` | `boolean` | Is the parameter optional. | +| `readonly` | `optional`? | `boolean` | Is the parameter optional. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md index 3ae5c968cd..220b2ac2fa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md @@ -29,3 +29,7 @@ validate( | `context` | [`DecoratorContext`](DecoratorContext.md) | | `target` | [`InferredTypeSpecValue`](../type-aliases/InferredTypeSpecValue.md)<`T`\> | | `parameters` | `InferParameters`<`P`, `S`\> | + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md index 40ff22dacf..ee8521fb1b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md @@ -27,6 +27,10 @@ Add a diagnostic to the collection | :------ | :------ | :------ | | `diagnostic` | [`Diagnostic`](Diagnostic.md) | Diagnostic to add. | +#### Returns + +`void` + *** ### pipe() @@ -49,6 +53,10 @@ Unwrap the Diagnostic result, add all the diagnostics and return the data. | :------ | :------ | :------ | | `result` | [`DiagnosticResult`](../type-aliases/DiagnosticResult.md)<`T`\> | Accessor diagnostic result | +#### Returns + +`T` + *** ### wrap() @@ -73,6 +81,8 @@ Wrap the given value in a tuple including the diagnostics following the TypeSpec #### Returns +[`DiagnosticResult`](../type-aliases/DiagnosticResult.md)<`T`\> + #### Example ```ts diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md index 30e7130973..222507d19b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md @@ -37,6 +37,10 @@ createDiagnostic(diag): Diagnostic | :------ | :------ | | `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | +#### Returns + +[`Diagnostic`](Diagnostic.md) + *** ### reportDiagnostic() @@ -58,3 +62,7 @@ reportDiagnostic(program, diag): void | :------ | :------ | | `program` | [`Program`](Program.md) | | `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md index f67f8eca79..34cc501620 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md @@ -12,12 +12,12 @@ title: "[I] DirectiveExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `arguments` | readonly [`DirectiveArgument`](../type-aliases/DirectiveArgument.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `DirectiveExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md index 71bb214e94..daf376307d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md @@ -17,6 +17,10 @@ title: "[I] Dirent" isDirectory(): boolean ``` +#### Returns + +`boolean` + *** ### isFile() @@ -24,3 +28,7 @@ isDirectory(): boolean ```ts isFile(): boolean ``` + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md index 62d380541a..1f9c5f69be 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md @@ -12,12 +12,12 @@ title: "[I] DocErrorsTagNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | | `readonly` | `kind` | `DocErrorsTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | | `readonly` | `tagName` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md index 74a7db2828..7cca3bb7de 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md @@ -12,12 +12,12 @@ title: "[I] DocNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `Doc` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `tags` | readonly [`DocTag`](../type-aliases/DocTag.md)[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md index 7f437e1275..4485764831 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md @@ -12,13 +12,13 @@ title: "[I] DocParamTagNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | | `readonly` | `kind` | `DocParamTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | | `readonly` | `paramName` | [`IdentifierNode`](IdentifierNode.md) | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | | `readonly` | `tagName` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md index fb5cf9bb3a..473109d69f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md @@ -12,12 +12,12 @@ title: "[I] DocReturnsTagNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | | `readonly` | `kind` | `DocReturnsTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | | `readonly` | `tagName` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md index 95265ee0dc..f329c46de0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md @@ -12,12 +12,12 @@ title: "[I] DocTagBaseNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | [`SyntaxKind`](../enumerations/SyntaxKind.md) | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `tagName` | [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md index 5a682f117d..c65006bf4d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md @@ -12,13 +12,13 @@ title: "[I] DocTemplateTagNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | | `readonly` | `kind` | `DocTemplateTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | | `readonly` | `paramName` | [`IdentifierNode`](IdentifierNode.md) | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | | `readonly` | `tagName` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md index a23d1b4ebd..5401ce1f83 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md @@ -11,12 +11,12 @@ title: "[I] DocTextNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `DocText` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `text` | `string` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md index 59b330fbb7..8fd3e0df1c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md @@ -12,12 +12,12 @@ title: "[I] DocUnknownTagNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | | `readonly` | `kind` | `DocUnknownTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | | `readonly` | `tagName` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md index ce610523cc..28d3b3c462 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md @@ -38,3 +38,7 @@ Get an asset emitter to write emitted output to disk using a TypeEmitter | Parameter | Type | Description | | :------ | :------ | :------ | | `TypeEmitterClass` | *typeof* `TypeEmitter` | The TypeEmitter to construct your emitted output | + +#### Returns + +`AssetEmitter`<`T`, `TOptions`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md index 21c9a670f4..94d7ace779 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md @@ -8,5 +8,5 @@ title: "[I] EmitFileOptions" | Property | Type | Description | | :------ | :------ | :------ | | `content` | `string` | - | -| `newLine?` | [`NewLine`](../type-aliases/NewLine.md) | - | +| `newLine`? | [`NewLine`](../type-aliases/NewLine.md) | - | | `path` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md index 6deaa371f0..a0cd0161e3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md @@ -11,11 +11,11 @@ title: "[I] EmptyStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `EmptyStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md index 6762c5e474..74ee8aabf4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md @@ -12,16 +12,16 @@ title: "[I] Enum" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Enum"` | - | [`BaseType`](BaseType.md).`kind` | | `members` | `RekeyableMap`<`string`, [`EnumMember`](EnumMember.md)\> | The members of the enum.

Members are ordered in the order that they appear in source. Members
obtained via `...` are inserted where the spread appears in source. | - | | `name` | `string` | - | - | -| `namespace?` | [`Namespace`](Namespace.md) | - | - | +| `namespace`? | [`Namespace`](Namespace.md) | - | - | | `node` | [`EnumStatementNode`](EnumStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | ## Accessors @@ -31,6 +31,10 @@ title: "[I] Enum" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -45,6 +49,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md index c6347aee9d..b3c813e8ed 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md @@ -13,16 +13,16 @@ title: "[I] EnumMember" | :------ | :------ | :------ | :------ | | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | | `enum` | [`Enum`](Enum.md) | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"EnumMember"` | - | [`BaseType`](BaseType.md).`kind` | | `name` | `string` | - | - | | `node` | [`EnumMemberNode`](EnumMemberNode.md) | - | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | -| `sourceMember?` | [`EnumMember`](EnumMember.md) | when spread operators make new enum members,
this tracks the enum member we copied from. | - | -| `value?` | `string` \| `number` | - | - | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `sourceMember`? | [`EnumMember`](EnumMember.md) | when spread operators make new enum members,
this tracks the enum member we copied from. | - | +| `value`? | `string` \| `number` | - | - | ## Accessors @@ -32,6 +32,10 @@ title: "[I] EnumMember" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -46,6 +50,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md index 38ca5eea27..300b0d30be 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md @@ -12,13 +12,13 @@ title: "[I] EnumMemberNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | - | | `readonly` | `kind` | `EnumMember` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`EnumStatementNode`](EnumStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`EnumStatementNode`](EnumStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | -| `readonly` | `value?` | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) | - | - | +| `readonly` | `value`? | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md index 56fc99d21d..a9fc75964a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md @@ -11,12 +11,12 @@ title: "[I] EnumSpreadMemberNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `EnumSpreadMember` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md index 2ec544dd0a..7242b6ecdb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md @@ -12,13 +12,13 @@ title: "[I] EnumStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `EnumStatement` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `members` | readonly ([`EnumMemberNode`](EnumMemberNode.md) \| [`EnumSpreadMemberNode`](EnumSpreadMemberNode.md))[] | - | - | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md index 9cb66d9d94..d67257ef16 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md @@ -11,14 +11,14 @@ title: "[I] ErrorType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`IntrinsicType`](IntrinsicType.md).`isFinished` | | `kind` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | | `name` | `"ErrorType"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | +| `node`? | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | ## Accessors @@ -28,6 +28,10 @@ title: "[I] ErrorType" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -42,6 +46,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md index 894e5e8f5c..89c3fefd8b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md @@ -11,11 +11,11 @@ title: "[I] ExternKeywordNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ExternKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md index c8cdd0fef4..10bbd0c2b5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md @@ -11,9 +11,9 @@ title: "[I] FileLibraryMetadata" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `bugs?` | `object` | - | LibraryMetadataBase.bugs | -| `bugs.url?` | `string` | Url where to file bugs for this library. | - | -| `homepage?` | `string` | Library homepage. | LibraryMetadataBase.homepage | -| `name?` | `string` | Library name as specified in the package.json or in exported $lib. | - | +| `bugs`? | `object` | - | LibraryMetadataBase.bugs | +| `bugs.url`? | `string` | Url where to file bugs for this library. | - | +| `homepage`? | `string` | Library homepage. | LibraryMetadataBase.homepage | +| `name`? | `string` | Library name as specified in the package.json or in exported $lib. | - | | `type` | `"file"` | - | - | -| `version?` | `string` | Library version | LibraryMetadataBase.version | +| `version`? | `string` | Library version | LibraryMetadataBase.version | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md index 61a5a1db85..9578094bf1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md @@ -19,8 +19,8 @@ extern fn camelCase(value: StringLiteral): StringLiteral; | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | @@ -28,7 +28,7 @@ extern fn camelCase(value: StringLiteral): StringLiteral; | `readonly` | `modifierFlags` | [`ModifierFlags`](../enumerations/ModifierFlags.md) | - | - | | `readonly` | `modifiers` | readonly [`ExternKeywordNode`](ExternKeywordNode.md)[] | - | - | | `readonly` | `parameters` | [`FunctionParameterNode`](FunctionParameterNode.md)[] | - | - | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | -| `readonly` | `returnType?` | [`Expression`](../type-aliases/Expression.md) | - | - | +| `readonly` | `returnType`? | [`Expression`](../type-aliases/Expression.md) | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameter.md index 9991d7da9a..fad01b682c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameter.md @@ -11,15 +11,15 @@ title: "[I] FunctionParameter" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"FunctionParameter"` | - | [`BaseType`](BaseType.md).`kind` | | `name` | `string` | - | - | | `node` | [`FunctionParameterNode`](FunctionParameterNode.md) | - | [`BaseType`](BaseType.md).`node` | | `optional` | `boolean` | - | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `rest` | `boolean` | - | - | | `type` | [`Type`](../type-aliases/Type.md) \| [`ValueType`](ValueType.md) | - | - | @@ -31,6 +31,10 @@ title: "[I] FunctionParameter" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -45,6 +49,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md index 525c999fbc..e54f68b8ec 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md @@ -11,15 +11,15 @@ title: "[I] FunctionParameterNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | - | | `readonly` | `kind` | `FunctionParameter` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `optional` | `boolean` | Parameter defined with `?` | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `rest` | `boolean` | Parameter defined with `...` notation. | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | -| `readonly` | `type?` | [`Expression`](../type-aliases/Expression.md) | - | - | +| `readonly` | `type`? | [`Expression`](../type-aliases/Expression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md index 202b58404b..d2aebdda9a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md @@ -12,16 +12,16 @@ title: "[I] FunctionType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `implementation` | (...`args`) => `unknown` | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Function"` | - | [`BaseType`](BaseType.md).`kind` | | `name` | `string` | - | - | -| `namespace?` | [`Namespace`](Namespace.md) | - | - | -| `node?` | [`FunctionDeclarationStatementNode`](FunctionDeclarationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | +| `namespace`? | [`Namespace`](Namespace.md) | - | - | +| `node`? | [`FunctionDeclarationStatementNode`](FunctionDeclarationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | | `parameters` | [`FunctionParameter`](FunctionParameter.md)[] | - | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `returnType` | [`Type`](../type-aliases/Type.md) | - | - | ## Accessors @@ -32,6 +32,10 @@ title: "[I] FunctionType" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -46,6 +50,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md index b67502bf58..6bb2bb7d30 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md @@ -11,12 +11,12 @@ title: "[I] IdentifierNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `Identifier` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `sv` | `string` | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md index 0001a7e2a1..22225553f9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md @@ -11,12 +11,12 @@ title: "[I] ImportStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ImportStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `path` | [`StringLiteralNode`](StringLiteralNode.md) | - | - | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md index 78aae04109..e04dd9b04b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md @@ -12,20 +12,20 @@ title: "[I] Interface" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Interface"` | - | [`BaseType`](BaseType.md).`kind` | | `name` | `string` | - | - | -| `namespace?` | [`Namespace`](Namespace.md) | - | - | +| `namespace`? | [`Namespace`](Namespace.md) | - | - | | `node` | [`InterfaceStatementNode`](InterfaceStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | | `operations` | `RekeyableMap`<`string`, [`Operation`](Operation.md)\> | The operations of the interface.

Operations are ordered in the order that they appear in the source.
Operations obtained via `interface extends` appear before operations
declared in the interface body. | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `sourceInterfaces` | [`Interface`](Interface.md)[] | The interfaces that provide additional operations via `interface extends`.

Note that despite the same `extends` keyword in source form, this is a
different semantic relationship than the one from [Model](Model.md) to
[Model.baseModel](ArrayModelType.md). Operations from extended interfaces are copied
into [Interface.operations](Interface.md). | - | -| `templateArguments?` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | +| `templateArguments`? | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper`? | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode`? | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | ## Accessors @@ -35,6 +35,10 @@ title: "[I] Interface" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -49,6 +53,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md index f3a992398d..777c46c5bf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md @@ -12,16 +12,16 @@ title: "[I] InterfaceStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `extends` | readonly [`TypeReferenceNode`](TypeReferenceNode.md)[] | - | - | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `InterfaceStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `locals?` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `readonly` | `locals`? | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | | `readonly` | `operations` | readonly [`OperationStatementNode`](OperationStatementNode.md)[] | - | - | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `templateParameters` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md index f2ebd1f482..24f90cec9b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md @@ -11,12 +11,12 @@ title: "[I] IntersectionExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `IntersectionExpression` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `options` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md index 619457528e..b89930566a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md @@ -11,14 +11,14 @@ title: "[I] IntrinsicType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Intrinsic"` | - | [`BaseType`](BaseType.md).`kind` | | `name` | \| `"unknown"` \| `"never"` \| `"null"` \| `"void"` \| `"ErrorType"` | - | - | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `node`? | [`Node`](../type-aliases/Node.md) | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | ## Accessors @@ -28,6 +28,10 @@ title: "[I] IntrinsicType" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -42,6 +46,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md index 3f47cdc128..4056abc99c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md @@ -12,11 +12,11 @@ title: "[I] InvalidStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `InvalidStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JSONSchemaValidator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JSONSchemaValidator.md index 34ad2abc1a..926012a47e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JSONSchemaValidator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JSONSchemaValidator.md @@ -22,4 +22,6 @@ Validate the configuration against its JSON Schema. #### Returns +[`Diagnostic`](Diagnostic.md)[] + Diagnostics produced by schema validation of the configuration. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md index e67fca43ef..4cb54b67fa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md @@ -11,12 +11,12 @@ title: "[I] JsNamespaceDeclarationNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `JsNamespaceDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md index a8af98851b..75287650b4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md @@ -11,8 +11,8 @@ title: "[I] JsSourceFileNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `esmExports` | `any` | - | - | | `readonly` | `file` | [`SourceFile`](SourceFile.md) | - | - | @@ -20,6 +20,6 @@ title: "[I] JsSourceFileNode" | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `JsSourceFile` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `namespaceSymbols` | [`Sym`](Sym.md)[] | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md index b1d2e4d71d..e462b7e967 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md @@ -7,7 +7,7 @@ title: "[I] LibraryInstance" | Property | Type | Description | | :------ | :------ | :------ | -| `definition?` | [`TypeSpecLibrary`](TypeSpecLibrary.md)<`any`, `Record`<`string`, `never`\>\> | - | +| `definition`? | [`TypeSpecLibrary`](TypeSpecLibrary.md)<`any`, `Record`<`string`, `never`\>\> | - | | `entrypoint` | `undefined` \| [`JsSourceFileNode`](JsSourceFileNode.md) | - | | `metadata` | [`LibraryMetadata`](../type-aliases/LibraryMetadata.md) | - | | `module` | [`ModuleResolutionResult`](../type-aliases/ModuleResolutionResult.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md index e6df6493b6..e5c55df285 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md @@ -7,5 +7,5 @@ title: "[I] LinterDefinition" | Property | Type | Description | | :------ | :------ | :------ | -| `ruleSets?` | `Record`<`string`, [`LinterRuleSet`](LinterRuleSet.md)\> | - | +| `ruleSets`? | `Record`<`string`, [`LinterRuleSet`](LinterRuleSet.md)\> | - | | `rules` | [`LinterRuleDefinition`](LinterRuleDefinition.md)<`string`, [`DiagnosticMessages`](DiagnosticMessages.md)\>[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md index dd898a4a68..4ce08a43fb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md @@ -40,6 +40,10 @@ create(context): SemanticNodeListener | :------ | :------ | | `context` | [`LinterRuleContext`](LinterRuleContext.md)<`DM`\> | +#### Returns + +[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) + #### Inherited from [`LinterRuleDefinition`](LinterRuleDefinition.md).[`create`](LinterRuleDefinition.md#create) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md index 65a96be11b..ddc8b1e3e2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md @@ -34,3 +34,7 @@ reportDiagnostic(diag): void | Parameter | Type | | :------ | :------ | | `diag` | [`LinterRuleDiagnosticReport`](../type-aliases/LinterRuleDiagnosticReport.md)<`DM`, `M`\> | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md index 105294cd00..e77e5c4635 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md @@ -36,3 +36,7 @@ create(context): SemanticNodeListener | Parameter | Type | | :------ | :------ | | `context` | [`LinterRuleContext`](LinterRuleContext.md)<`DM`\> | + +#### Returns + +[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md index 2c2e36aab3..bdc5bec5ae 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md @@ -7,6 +7,6 @@ title: "[I] LinterRuleSet" | Property | Type | Description | | :------ | :------ | :------ | -| `disable?` | `Record`<\`${string}/${string}\`, `string`\> | Rules to disable. A rule CANNOT be in enable and disable map. | -| `enable?` | `Record`<\`${string}/${string}\`, `boolean`\> | Rules to enable/configure | -| `extends?` | \`${string}/${string}\`[] | Other ruleset this ruleset extends | +| `disable`? | `Record`<\`${string}/${string}\`, `string`\> | Rules to disable. A rule CANNOT be in enable and disable map. | +| `enable`? | `Record`<\`${string}/${string}\`, `boolean`\> | Rules to enable/configure | +| `extends`? | \`${string}/${string}\`[] | Other ruleset this ruleset extends | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md index d6db33c018..86c678fe2c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md @@ -7,4 +7,4 @@ title: "[I] ListOperationOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `recursive?` | `boolean` | If the container is a namespace look for operation in sub namespaces.

**Default**

` true ` | +| `recursive`? | `boolean` | If the container is a namespace look for operation in sub namespaces.

**Default**

` true ` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md index 35857be4e2..f8e79be3fb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md @@ -7,7 +7,7 @@ title: "[I] LogInfo" | Property | Type | Description | | :------ | :------ | :------ | -| `code?` | `string` | - | +| `code`? | `string` | - | | `level` | [`LogLevel`](../type-aliases/LogLevel.md) | - | | `message` | `string` | - | -| `target?` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | - | +| `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md index fdcbbbb13a..baf372d656 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md @@ -16,3 +16,7 @@ log(log): void | Parameter | Type | | :------ | :------ | | `log` | [`ProcessedLog`](ProcessedLog.md) | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md index 3ab0310ea7..f62b7a0739 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md @@ -17,6 +17,10 @@ error(message): void | :------ | :------ | | `message` | `string` | +#### Returns + +`void` + *** ### log() @@ -31,6 +35,10 @@ log(log): void | :------ | :------ | | `log` | [`LogInfo`](LogInfo.md) | +#### Returns + +`void` + *** ### trace() @@ -45,6 +53,10 @@ trace(message): void | :------ | :------ | | `message` | `string` | +#### Returns + +`void` + *** ### warn() @@ -58,3 +70,7 @@ warn(message): void | Parameter | Type | | :------ | :------ | | `message` | `string` | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md index 7226d7a018..86bcafd5c4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md @@ -12,13 +12,13 @@ title: "[I] MemberExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `base` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | - | | `readonly` | `kind` | `MemberExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `selector` | `"."` \| `"::"` | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md index 40a4049a7d..555c26d7c0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md @@ -11,24 +11,24 @@ title: "[I] Model" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `baseModel?` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | - | +| `baseModel`? | [`Model`](Model.md) | Model this model extends. This represent inheritance. | - | | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | | `derivedModels` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](ArrayModelType.md) | - | -| `indexer?` | [`ModelIndexer`](../type-aliases/ModelIndexer.md) | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `indexer`? | [`ModelIndexer`](../type-aliases/ModelIndexer.md) | - | - | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Model"` | - | [`BaseType`](BaseType.md).`kind` | | `name` | `string` | - | - | -| `namespace?` | [`Namespace`](Namespace.md) | - | - | -| `node?` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `namespace`? | [`Namespace`](Namespace.md) | - | - | +| `node`? | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `properties` | `RekeyableMap`<`string`, [`ModelProperty`](ModelProperty.md)\> | The properties of the model.

Properties are ordered in the order that they appear in source.
Properties obtained via `model is` appear before properties defined in
the model body. Properties obtained via `...` are inserted where the
spread appears in source.

Properties inherited via `model extends` are not included. Use
[walkPropertiesInherited](../functions/walkPropertiesInherited.md) to enumerate all properties in the
inheritance hierarchy. | - | -| `sourceModel?` | [`Model`](Model.md) | The model that is referenced via `model is`. | - | -| `templateArguments?` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | +| `sourceModel`? | [`Model`](Model.md) | The model that is referenced via `model is`. | - | +| `templateArguments`? | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper`? | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode`? | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | ## Accessors @@ -38,6 +38,10 @@ title: "[I] Model" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -52,6 +56,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md index 50941f6c05..a3b4701d9a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md @@ -11,12 +11,12 @@ title: "[I] ModelExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ModelExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `properties` | ([`ModelPropertyNode`](ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md))[] | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md index be3ac3d208..5f8e1a86ba 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md @@ -12,18 +12,18 @@ title: "[I] ModelProperty" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | -| `default?` | [`Type`](../type-aliases/Type.md) | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `default`? | [`Type`](../type-aliases/Type.md) | - | - | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"ModelProperty"` | - | [`BaseType`](BaseType.md).`kind` | -| `model?` | [`Model`](Model.md) | - | - | +| `model`? | [`Model`](Model.md) | - | - | | `name` | `string` | - | - | | `node` | [`ModelPropertyNode`](ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md) \| [`ProjectionModelPropertyNode`](ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](ProjectionModelSpreadPropertyNode.md) | - | [`BaseType`](BaseType.md).`node` | | `optional` | `boolean` | - | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | -| `sourceProperty?` | [`ModelProperty`](ModelProperty.md) | - | - | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `sourceProperty`? | [`ModelProperty`](ModelProperty.md) | - | - | | `type` | [`Type`](../type-aliases/Type.md) | - | - | ## Accessors @@ -34,6 +34,10 @@ title: "[I] ModelProperty" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -48,6 +52,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md index 39b945081a..ed43e6c992 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md @@ -12,15 +12,15 @@ title: "[I] ModelPropertyNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | -| `readonly` | `default?` | [`Expression`](../type-aliases/Expression.md) | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `default`? | [`Expression`](../type-aliases/Expression.md) | - | - | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | - | | `readonly` | `kind` | `ModelProperty` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `optional` | `boolean` | - | - | -| `readonly` | `parent?` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `value` | [`Expression`](../type-aliases/Expression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md index dc53dafffa..68f23bd325 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md @@ -11,12 +11,12 @@ title: "[I] ModelSpreadPropertyNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ModelSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md index 966190d728..af74696f73 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md @@ -12,16 +12,16 @@ title: "[I] ModelStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | -| `readonly` | `extends?` | [`Expression`](../type-aliases/Expression.md) | - | - | +| `readonly` | `extends`? | [`Expression`](../type-aliases/Expression.md) | - | - | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | -| `readonly` | `is?` | [`Expression`](../type-aliases/Expression.md) | - | - | +| `readonly` | `is`? | [`Expression`](../type-aliases/Expression.md) | - | - | | `readonly` | `kind` | `ModelStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `locals?` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `locals`? | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `properties` | readonly ([`ModelPropertyNode`](ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md))[] | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModuleLibraryMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModuleLibraryMetadata.md index 6044378c00..31a5441da8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModuleLibraryMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModuleLibraryMetadata.md @@ -13,9 +13,9 @@ Data for a library. Either loaded via a node_modules package or a standalone js | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `bugs?` | `object` | - | LibraryMetadataBase.bugs | -| `bugs.url?` | `string` | Url where to file bugs for this library. | - | -| `homepage?` | `string` | Library homepage. | LibraryMetadataBase.homepage | +| `bugs`? | `object` | - | LibraryMetadataBase.bugs | +| `bugs.url`? | `string` | Url where to file bugs for this library. | - | +| `homepage`? | `string` | Library homepage. | LibraryMetadataBase.homepage | | `name` | `string` | Library name as specified in the package.json or in exported $lib. | - | | `type` | `"module"` | - | - | -| `version?` | `string` | Library version | LibraryMetadataBase.version | +| `version`? | `string` | Library version | LibraryMetadataBase.version | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md index 3a531295e6..57b197e784 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md @@ -15,19 +15,19 @@ title: "[I] Namespace" | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | | `enums` | `Map`<`string`, [`Enum`](Enum.md)\> | The enums in the namespace.

Order is implementation-defined and may change. | - | | `functionDeclarations` | `Map`<`string`, [`FunctionType`](FunctionType.md)\> | The functions declared in the namespace.

Order is implementation-defined and may change. | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `interfaces` | `Map`<`string`, [`Interface`](Interface.md)\> | The interfaces in the namespace.

Order is implementation-defined and may change. | - | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Namespace"` | - | [`BaseType`](BaseType.md).`kind` | | `models` | `Map`<`string`, [`Model`](Model.md)\> | The models in the namespace.

Order is implementation-defined and may change. | - | | `name` | `string` | - | - | -| `namespace?` | [`Namespace`](Namespace.md) | - | - | +| `namespace`? | [`Namespace`](Namespace.md) | - | - | | `namespaces` | `Map`<`string`, [`Namespace`](Namespace.md)\> | The sub-namespaces in the namespace.

Order is implementation-defined and may change. | - | | `node` | [`JsNamespaceDeclarationNode`](JsNamespaceDeclarationNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | | `operations` | `Map`<`string`, [`Operation`](Operation.md)\> | The operations in the namespace.

Order is implementation-defined and may change. | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `scalars` | `Map`<`string`, [`Scalar`](Scalar.md)\> | The scalars in the namespace.

Order is implementation-defined and may change. | - | | `unions` | `Map`<`string`, [`Union`](Union.md)\> | The unions in the namespace.

Order is implementation-defined and may change. | - | @@ -39,6 +39,10 @@ title: "[I] Namespace" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -53,6 +57,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md index 5634ab26b8..164790c93e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md @@ -7,4 +7,4 @@ title: "[I] NamespaceNavigationOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `skipSubNamespaces?` | `boolean` | Recursively navigate sub namespaces.

**Default**

` false ` | +| `skipSubNamespaces`? | `boolean` | Recursively navigate sub namespaces.

**Default**

` false ` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md index cb497e2426..b3e83d1a73 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md @@ -12,14 +12,14 @@ title: "[I] NamespaceStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `NamespaceStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `locals?` | `SymbolTable` | - | - | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `locals`? | `SymbolTable` | - | - | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | -| `readonly` | `statements?` | [`NamespaceStatementNode`](NamespaceStatementNode.md) \| readonly [`Statement`](../type-aliases/Statement.md)[] | - | - | +| `readonly` | `statements`? | [`NamespaceStatementNode`](NamespaceStatementNode.md) \| readonly [`Statement`](../type-aliases/Statement.md)[] | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md index f41933be2a..fb9b16604c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md @@ -7,4 +7,4 @@ title: "[I] NavigationOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `includeTemplateDeclaration?` | `boolean` | Skip non instantiated templates. | +| `includeTemplateDeclaration`? | `boolean` | Skip non instantiated templates. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md index 5ce3541c66..9633a3dc1a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md @@ -11,11 +11,11 @@ title: "[I] NeverKeywordNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `NeverKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md index b385be071a..ba890fdd1f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md @@ -11,14 +11,14 @@ title: "[I] NeverType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`IntrinsicType`](IntrinsicType.md).`isFinished` | | `kind` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | | `name` | `"never"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | +| `node`? | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | ## Accessors @@ -28,6 +28,10 @@ title: "[I] NeverType" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -42,6 +46,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md index 155498500a..b1539319a6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md @@ -9,17 +9,17 @@ Type for package.json https://docs.npmjs.com/cli/v8/configuring-npm/package-json | Property | Type | Description | | :------ | :------ | :------ | -| `bugs?` | `object` | - | -| `bugs.email?` | `string` | - | -| `bugs.url?` | `string` | - | -| `dependencies?` | `Record`<`string`, `string`\> | - | -| `description?` | `string` | - | -| `devDependencies?` | `Record`<`string`, `string`\> | - | -| `homepage?` | `string` | - | -| `main?` | `string` | - | +| `bugs`? | `object` | - | +| `bugs.email`? | `string` | - | +| `bugs.url`? | `string` | - | +| `dependencies`? | `Record`<`string`, `string`\> | - | +| `description`? | `string` | - | +| `devDependencies`? | `Record`<`string`, `string`\> | - | +| `homepage`? | `string` | - | +| `main`? | `string` | - | | `name` | `string` | - | -| `peerDependencies?` | `Record`<`string`, `string`\> | - | -| `private?` | `boolean` | - | -| `tspMain?` | `string` | - | -| `type?` | `"module"` \| `"commonjs"` | - | +| `peerDependencies`? | `Record`<`string`, `string`\> | - | +| `private`? | `boolean` | - | +| `tspMain`? | `string` | - | +| `type`? | `"module"` \| `"commonjs"` | - | | `version` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md index 38d7324140..41535b9186 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md @@ -11,14 +11,14 @@ title: "[I] NullType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`IntrinsicType`](IntrinsicType.md).`isFinished` | | `kind` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | | `name` | `"null"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | +| `node`? | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | ## Accessors @@ -28,6 +28,10 @@ title: "[I] NullType" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -42,6 +46,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md index f992e84843..1bfb22cf75 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md @@ -11,13 +11,13 @@ title: "[I] NumericLiteral" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Number"` | - | [`BaseType`](BaseType.md).`kind` | -| `node?` | [`NumericLiteralNode`](NumericLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `node`? | [`NumericLiteralNode`](NumericLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `value` | `number` | - | - | | `valueAsString` | `string` | - | - | @@ -29,6 +29,10 @@ title: "[I] NumericLiteral" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -43,6 +47,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md index 39570e96e0..65ee5d3149 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md @@ -11,12 +11,12 @@ title: "[I] NumericLiteralNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `NumericLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `value` | `number` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md index a3a2d01ea6..58359c1826 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md @@ -11,13 +11,13 @@ title: "[I] ObjectType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Object"` | - | [`BaseType`](BaseType.md).`kind` | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `node`? | [`Node`](../type-aliases/Node.md) | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `properties` | `Record`<`string`, [`Type`](../type-aliases/Type.md)\> | - | - | ## Accessors @@ -28,6 +28,10 @@ title: "[I] ObjectType" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -42,6 +46,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md index d4f41a567a..c904231fe0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md @@ -12,22 +12,22 @@ title: "[I] Operation" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | -| `interface?` | [`Interface`](Interface.md) | - | - | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `interface`? | [`Interface`](Interface.md) | - | - | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Operation"` | - | [`BaseType`](BaseType.md).`kind` | | `name` | `string` | - | - | -| `namespace?` | [`Namespace`](Namespace.md) | - | - | +| `namespace`? | [`Namespace`](Namespace.md) | - | - | | `node` | [`OperationStatementNode`](OperationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | | `parameters` | [`Model`](Model.md) | - | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `returnType` | [`Type`](../type-aliases/Type.md) | - | - | -| `sourceOperation?` | [`Operation`](Operation.md) | The operation that is referenced via `op is`. | - | -| `templateArguments?` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | +| `sourceOperation`? | [`Operation`](Operation.md) | The operation that is referenced via `op is`. | - | +| `templateArguments`? | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper`? | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode`? | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | ## Accessors @@ -37,6 +37,10 @@ title: "[I] Operation" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -51,6 +55,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md index 9c315a01b3..0881f5253c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md @@ -11,13 +11,13 @@ title: "[I] OperationSignatureDeclarationNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `OperationSignatureDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `parameters` | [`ModelExpressionNode`](ModelExpressionNode.md) | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `returnType` | [`Expression`](../type-aliases/Expression.md) | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md index bb74214901..b257f95656 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md @@ -12,11 +12,11 @@ title: "[I] OperationSignatureReferenceNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `baseOperation` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `OperationSignatureReference` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md index 70e71b1070..d0b8686fea 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md @@ -12,14 +12,14 @@ title: "[I] OperationStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `OperationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `locals?` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) \| [`InterfaceStatementNode`](InterfaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `locals`? | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) \| [`InterfaceStatementNode`](InterfaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `signature` | [`OperationSignature`](../type-aliases/OperationSignature.md) | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md index dc69b899be..f5eb0b3ec6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md @@ -7,5 +7,5 @@ title: "[I] ParseOptions" | Modifier | Property | Type | Description | | :------ | :------ | :------ | :------ | -| `readonly` | `comments?` | `boolean` | When true, collect comment ranges in [TypeSpecScriptNode.comments](TypeSpecScriptNode.md). | -| `readonly` | `docs?` | `boolean` | When true, parse doc comments into [Node.docs](BaseNode.md). | +| `readonly` | `comments`? | `boolean` | When true, collect comment ranges in [TypeSpecScriptNode.comments](TypeSpecScriptNode.md). | +| `readonly` | `docs`? | `boolean` | When true, parse doc comments into [Node.docs](BaseNode.md). | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md index 4716d55258..808b00e8ab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md @@ -7,7 +7,7 @@ title: "[I] ProcessedLog" | Property | Type | Description | | :------ | :------ | :------ | -| `code?` | `string` | - | +| `code`? | `string` | - | | `level` | [`LogLevel`](../type-aliases/LogLevel.md) | - | | `message` | `string` | - | -| `sourceLocation?` | [`SourceLocation`](SourceLocation.md) | - | +| `sourceLocation`? | [`SourceLocation`](SourceLocation.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md index 37521c68a3..d7c9cbe966 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md @@ -18,7 +18,7 @@ title: "[I] Program" | `public` | `host` | [`CompilerHost`](CompilerHost.md) | - | | `public` | `jsSourceFiles` | `Map`<`string`, [`JsSourceFileNode`](JsSourceFileNode.md)\> | - | | `public` | `literalTypes` | `Map`<`string` \| `number` \| `boolean`, [`LiteralType`](../type-aliases/LiteralType.md)\> | - | -| `public` | `mainFile?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | +| `public` | `mainFile`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | | `readonly` | `projectRoot` | `string` | Project root. If a tsconfig was found/specified this is the directory for the tsconfig.json. Otherwise directory where the entrypoint is located. | | `public` | `sourceFiles` | `Map`<`string`, [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | All source files in the program, keyed by their file path. | | `public` | `stateMaps` | `Map`<`symbol`, `StateMap`\> | - | @@ -33,6 +33,10 @@ title: "[I] Program" getGlobalNamespaceType(): Namespace ``` +#### Returns + +[`Namespace`](Namespace.md) + *** ### getOption() @@ -47,6 +51,10 @@ getOption(key): undefined | string | :------ | :------ | | `key` | `string` | +#### Returns + +`undefined` \| `string` + *** ### getSourceFileLocationContext() @@ -63,6 +71,10 @@ Return location context of the given source file. | :------ | :------ | | `sourceFile` | [`SourceFile`](SourceFile.md) | +#### Returns + +[`LocationContext`](../type-aliases/LocationContext.md) + *** ### hasError() @@ -71,6 +83,10 @@ Return location context of the given source file. hasError(): boolean ``` +#### Returns + +`boolean` + *** ### loadTypeSpecScript() @@ -85,6 +101,10 @@ loadTypeSpecScript(typespecScript): Promise | :------ | :------ | | `typespecScript` | [`SourceFile`](SourceFile.md) | +#### Returns + +`Promise`<[`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> + *** ### onValidate() @@ -100,6 +120,10 @@ onValidate(cb, LibraryMetadata): void | `cb` | (`program`) => `void` \| `Promise`<`void`\> | | `LibraryMetadata` | [`LibraryMetadata`](../type-aliases/LibraryMetadata.md) | +#### Returns + +`void` + *** ### reportDiagnostic() @@ -114,6 +138,10 @@ reportDiagnostic(diagnostic): void | :------ | :------ | | `diagnostic` | [`Diagnostic`](Diagnostic.md) | +#### Returns + +`void` + *** ### reportDiagnostics() @@ -128,6 +156,10 @@ reportDiagnostics(diagnostics): void | :------ | :------ | | `diagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | +#### Returns + +`void` + *** ### reportDuplicateSymbols() @@ -142,6 +174,10 @@ reportDuplicateSymbols(symbols): void | :------ | :------ | | `symbols` | `undefined` \| `SymbolTable` | +#### Returns + +`void` + *** ### resolveTypeReference() @@ -156,6 +192,10 @@ resolveTypeReference(reference): [undefined | Type, readonly Diagnostic[]] | :------ | :------ | | `reference` | `string` | +#### Returns + +[`undefined` \| [`Type`](../type-aliases/Type.md), readonly [`Diagnostic`](Diagnostic.md)[]] + *** ### stateMap() @@ -170,6 +210,10 @@ stateMap(key): Map | :------ | :------ | | `key` | `symbol` | +#### Returns + +`Map`<[`Type`](../type-aliases/Type.md), `any`\> + *** ### stateSet() @@ -184,6 +228,10 @@ stateSet(key): Set | :------ | :------ | | `key` | `symbol` | +#### Returns + +`Set`<[`Type`](../type-aliases/Type.md)\> + *** ### trace() @@ -198,3 +246,7 @@ trace(area, message): void | :------ | :------ | | `area` | `string` | | `message` | `string` | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md index 57becaa013..d4c5cc1bdb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md @@ -25,3 +25,7 @@ If there is a projected name it returns that one otherwise return the original n | Parameter | Type | | :------ | :------ | | `target` | `Object` | + +#### Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md index 84f3d1db8f..23c2c87c73 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md @@ -18,7 +18,7 @@ title: "[I] ProjectedProgram" | `public` | `host` | [`CompilerHost`](CompilerHost.md) | - | [`Program`](Program.md).`host` | | `public` | `jsSourceFiles` | `Map`<`string`, [`JsSourceFileNode`](JsSourceFileNode.md)\> | - | [`Program`](Program.md).`jsSourceFiles` | | `public` | `literalTypes` | `Map`<`string` \| `number` \| `boolean`, [`LiteralType`](../type-aliases/LiteralType.md)\> | - | [`Program`](Program.md).`literalTypes` | -| `public` | `mainFile?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | [`Program`](Program.md).`mainFile` | +| `public` | `mainFile`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | [`Program`](Program.md).`mainFile` | | `readonly` | `projectRoot` | `string` | Project root. If a tsconfig was found/specified this is the directory for the tsconfig.json. Otherwise directory where the entrypoint is located. | [`Program`](Program.md).`projectRoot` | | `public` | `projector` | [`Projector`](Projector.md) | - | - | | `public` | `sourceFiles` | `Map`<`string`, [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | All source files in the program, keyed by their file path. | [`Program`](Program.md).`sourceFiles` | @@ -34,6 +34,10 @@ title: "[I] ProjectedProgram" getGlobalNamespaceType(): Namespace ``` +#### Returns + +[`Namespace`](Namespace.md) + #### Inherited from [`Program`](Program.md).[`getGlobalNamespaceType`](Program.md#getglobalnamespacetype) @@ -52,6 +56,10 @@ getOption(key): undefined | string | :------ | :------ | | `key` | `string` | +#### Returns + +`undefined` \| `string` + #### Inherited from [`Program`](Program.md).[`getOption`](Program.md#getoption) @@ -72,6 +80,10 @@ Return location context of the given source file. | :------ | :------ | | `sourceFile` | [`SourceFile`](SourceFile.md) | +#### Returns + +[`LocationContext`](../type-aliases/LocationContext.md) + #### Inherited from [`Program`](Program.md).[`getSourceFileLocationContext`](Program.md#getsourcefilelocationcontext) @@ -84,6 +96,10 @@ Return location context of the given source file. hasError(): boolean ``` +#### Returns + +`boolean` + #### Inherited from [`Program`](Program.md).[`hasError`](Program.md#haserror) @@ -102,6 +118,10 @@ loadTypeSpecScript(typespecScript): Promise | :------ | :------ | | `typespecScript` | [`SourceFile`](SourceFile.md) | +#### Returns + +`Promise`<[`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> + #### Inherited from [`Program`](Program.md).[`loadTypeSpecScript`](Program.md#loadtypespecscript) @@ -121,6 +141,10 @@ onValidate(cb, LibraryMetadata): void | `cb` | (`program`) => `void` \| `Promise`<`void`\> | | `LibraryMetadata` | [`LibraryMetadata`](../type-aliases/LibraryMetadata.md) | +#### Returns + +`void` + #### Inherited from [`Program`](Program.md).[`onValidate`](Program.md#onvalidate) @@ -139,6 +163,10 @@ reportDiagnostic(diagnostic): void | :------ | :------ | | `diagnostic` | [`Diagnostic`](Diagnostic.md) | +#### Returns + +`void` + #### Inherited from [`Program`](Program.md).[`reportDiagnostic`](Program.md#reportdiagnostic) @@ -157,6 +185,10 @@ reportDiagnostics(diagnostics): void | :------ | :------ | | `diagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | +#### Returns + +`void` + #### Inherited from [`Program`](Program.md).[`reportDiagnostics`](Program.md#reportdiagnostics) @@ -175,6 +207,10 @@ reportDuplicateSymbols(symbols): void | :------ | :------ | | `symbols` | `undefined` \| `SymbolTable` | +#### Returns + +`void` + #### Inherited from [`Program`](Program.md).[`reportDuplicateSymbols`](Program.md#reportduplicatesymbols) @@ -193,6 +229,10 @@ resolveTypeReference(reference): [undefined | Type, readonly Diagnostic[]] | :------ | :------ | | `reference` | `string` | +#### Returns + +[`undefined` \| [`Type`](../type-aliases/Type.md), readonly [`Diagnostic`](Diagnostic.md)[]] + #### Inherited from [`Program`](Program.md).[`resolveTypeReference`](Program.md#resolvetypereference) @@ -211,6 +251,10 @@ stateMap(key): Map | :------ | :------ | | `key` | `symbol` | +#### Returns + +`Map`<[`Type`](../type-aliases/Type.md), `any`\> + #### Inherited from [`Program`](Program.md).[`stateMap`](Program.md#statemap) @@ -229,6 +273,10 @@ stateSet(key): Set | :------ | :------ | | `key` | `symbol` | +#### Returns + +`Set`<[`Type`](../type-aliases/Type.md)\> + #### Inherited from [`Program`](Program.md).[`stateSet`](Program.md#stateset) @@ -248,6 +296,10 @@ trace(area, message): void | `area` | `string` | | `message` | `string` | +#### Returns + +`void` + #### Inherited from [`Program`](Program.md).[`trace`](Program.md#trace) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md index 70137039a5..60f561c0f8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md @@ -11,15 +11,15 @@ title: "[I] Projection" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Projection"` | - | [`BaseType`](BaseType.md).`kind` | | `node` | `undefined` | - | [`BaseType`](BaseType.md).`node` | | `nodeByKind` | `Map`<`string`, [`ProjectionStatementNode`](ProjectionStatementNode.md)\> | - | - | | `nodeByType` | `Map`<[`Type`](../type-aliases/Type.md), [`ProjectionStatementNode`](ProjectionStatementNode.md)\> | - | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | ## Accessors @@ -29,6 +29,10 @@ title: "[I] Projection" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -43,6 +47,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md index d7f7018e6a..36fe6ad5d6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md @@ -8,6 +8,6 @@ title: "[I] ProjectionApplication" | Property | Type | Description | | :------ | :------ | :------ | | `arguments` | [`DecoratorArgumentValue`](../type-aliases/DecoratorArgumentValue.md)[] | - | -| `direction?` | `"to"` \| `"from"` | - | +| `direction`? | `"to"` \| `"from"` | - | | `projectionName` | `string` | - | -| `scope?` | [`Type`](../type-aliases/Type.md) | - | +| `scope`? | [`Type`](../type-aliases/Type.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md index dbabf3f1f6..cb7cfdcd80 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md @@ -11,14 +11,14 @@ title: "[I] ProjectionArithmeticExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionArithmeticExpression` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `left` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | | `readonly` | `op` | `"+"` \| `"-"` \| `"*"` \| `"/"` | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `right` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md index 3cd344a2d3..449a972f8f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md @@ -11,12 +11,12 @@ title: "[I] ProjectionBlockExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionBlockExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `statements` | [`ProjectionExpressionStatementNode`](ProjectionExpressionStatementNode.md)[] | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md index 07e1dd56d6..9130b6d6be 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md @@ -13,12 +13,12 @@ title: "[I] ProjectionCallExpressionNode" | :------ | :------ | :------ | :------ | :------ | | `readonly` | `arguments` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md)[] | - | - | | `readonly` | `callKind` | `"method"` \| `"template"` | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionCallExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md index ecbf88c818..da98886010 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md @@ -11,12 +11,12 @@ title: "[I] ProjectionDecoratorReferenceExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionDecoratorReferenceExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md index 77b794d67d..dcdd4c0107 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md @@ -11,11 +11,11 @@ title: "[I] ProjectionEnumMemberSelectorNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionEnumMemberSelector` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md index fd423cd7a0..ef8743def7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md @@ -11,11 +11,11 @@ title: "[I] ProjectionEnumSelectorNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionEnumSelector` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md index ffab6af2ec..69535151d3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md @@ -11,14 +11,14 @@ title: "[I] ProjectionEqualityExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionEqualityExpression` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `left` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | | `readonly` | `op` | `"=="` \| `"!="` | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `right` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md index 48ceddd074..036b3e470b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md @@ -11,12 +11,12 @@ title: "[I] ProjectionExpressionStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `expr` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionExpressionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md index 5709c2bd7a..d7581d3b66 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md @@ -11,14 +11,14 @@ title: "[I] ProjectionIfExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `alternate?` | [`ProjectionIfExpressionNode`](ProjectionIfExpressionNode.md) \| [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | +| `readonly` | `alternate`? | [`ProjectionIfExpressionNode`](ProjectionIfExpressionNode.md) \| [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | | `readonly` | `consequent` | [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionIfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `test` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md index 6d4ba90aa4..7883048368 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md @@ -11,11 +11,11 @@ title: "[I] ProjectionInterfaceSelectorNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionInterfaceSelector` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md index ec3f666c25..f182941ad0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md @@ -12,13 +12,13 @@ title: "[I] ProjectionLambdaExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `body` | [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionLambdaExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `locals?` | `SymbolTable` | - | - | +| `readonly` | `locals`? | `SymbolTable` | - | - | | `readonly` | `parameters` | readonly [`ProjectionLambdaParameterDeclarationNode`](ProjectionLambdaParameterDeclarationNode.md)[] | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md index dfd6838af1..f6547a4df1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md @@ -11,12 +11,12 @@ title: "[I] ProjectionLambdaParameterDeclarationNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `ProjectionLambdaParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md index 1d6769f693..570cc68c4d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md @@ -11,14 +11,14 @@ title: "[I] ProjectionLogicalExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionLogicalExpression` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `left` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | | `readonly` | `op` | `"||"` \| `"&&"` | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `right` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md index d2470b7bd6..96a00876ce 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md @@ -12,13 +12,13 @@ title: "[I] ProjectionMemberExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `base` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | - | | `readonly` | `kind` | `ProjectionMemberExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `selector` | `"."` \| `"::"` | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md index 12953310a6..a3681b6dc0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md @@ -11,12 +11,12 @@ title: "[I] ProjectionModelExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionModelExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `properties` | ([`ProjectionModelPropertyNode`](ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](ProjectionModelSpreadPropertyNode.md))[] | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md index 662c717103..7b1e67b271 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md @@ -12,15 +12,15 @@ title: "[I] ProjectionModelPropertyNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | -| `readonly` | `default?` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `default`? | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | - | | `readonly` | `kind` | `ProjectionModelProperty` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `optional` | `boolean` | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `value` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md index 17da083af1..2bf1920ae8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md @@ -11,11 +11,11 @@ title: "[I] ProjectionModelPropertySelectorNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionModelPropertySelector` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md index 82f3d98218..f5054588d8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md @@ -11,11 +11,11 @@ title: "[I] ProjectionModelSelectorNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionModelSelector` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md index 3cde0520c6..10be744738 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md @@ -11,12 +11,12 @@ title: "[I] ProjectionModelSpreadPropertyNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionModelSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md index 7a5f624c20..51d4c8ce0b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md @@ -14,14 +14,14 @@ title: "[I] ProjectionNode" | `readonly` | `body` | readonly [`ProjectionExpressionStatementNode`](ProjectionExpressionStatementNode.md)[] | - | - | | `readonly` | `direction` | \| `"to"` \| `"from"` \| `"pre_to"` \| `"pre_from"` \| `""` | - | - | | `readonly` | `directionId` | [`IdentifierNode`](IdentifierNode.md) | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `Projection` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `locals?` | `SymbolTable` | - | - | +| `readonly` | `locals`? | `SymbolTable` | - | - | | `readonly` | `modifierIds` | readonly [`IdentifierNode`](IdentifierNode.md)[] | - | - | | `readonly` | `parameters` | [`ProjectionParameterDeclarationNode`](ProjectionParameterDeclarationNode.md)[] | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md index 188a022208..d8fe7a29c8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md @@ -11,11 +11,11 @@ title: "[I] ProjectionOperationSelectorNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionOperationSelector` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md index 28340cac97..69eb6a5faa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md @@ -11,12 +11,12 @@ title: "[I] ProjectionParameterDeclarationNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `ProjectionParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md index c85e901603..171597e409 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md @@ -12,12 +12,12 @@ title: "[I] ProjectionReferenceNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `arguments` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionReference` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md index d79122b315..f961f2f3bb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md @@ -11,14 +11,14 @@ title: "[I] ProjectionRelationalExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionRelationalExpression` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `left` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | | `readonly` | `op` | `"<="` \| `">="` \| `"<"` \| `">"` | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `right` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md index d7fa6316aa..64ed543a50 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md @@ -11,18 +11,18 @@ title: "[I] ProjectionStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | -| `readonly` | `from?` | [`ProjectionNode`](ProjectionNode.md) | - | - | +| `readonly` | `from`? | [`ProjectionNode`](ProjectionNode.md) | - | - | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `ProjectionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | -| `readonly` | `preFrom?` | [`ProjectionNode`](ProjectionNode.md) | - | - | -| `readonly` | `preTo?` | [`ProjectionNode`](ProjectionNode.md) | - | - | +| `readonly` | `preFrom`? | [`ProjectionNode`](ProjectionNode.md) | - | - | +| `readonly` | `preTo`? | [`ProjectionNode`](ProjectionNode.md) | - | - | | `readonly` | `projections` | readonly [`ProjectionNode`](ProjectionNode.md)[] | - | - | | `readonly` | `selector` | \| [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) \| [`ProjectionModelSelectorNode`](ProjectionModelSelectorNode.md) \| [`ProjectionModelPropertySelectorNode`](ProjectionModelPropertySelectorNode.md) \| [`ProjectionInterfaceSelectorNode`](ProjectionInterfaceSelectorNode.md) \| [`ProjectionOperationSelectorNode`](ProjectionOperationSelectorNode.md) \| [`ProjectionEnumSelectorNode`](ProjectionEnumSelectorNode.md) \| [`ProjectionEnumMemberSelectorNode`](ProjectionEnumMemberSelectorNode.md) \| [`ProjectionUnionSelectorNode`](ProjectionUnionSelectorNode.md) \| [`ProjectionUnionVariantSelectorNode`](ProjectionUnionVariantSelectorNode.md) | - | - | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | -| `readonly` | `to?` | [`ProjectionNode`](ProjectionNode.md) | - | - | +| `readonly` | `to`? | [`ProjectionNode`](ProjectionNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md index 872452c7bc..1511ae5532 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md @@ -11,12 +11,12 @@ title: "[I] ProjectionTupleExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionTupleExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `values` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md)[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md index 958f09466e..6d5ec30ccc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md @@ -11,13 +11,13 @@ title: "[I] ProjectionUnaryExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionUnaryExpression` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `op` | `"!"` | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md index b3abf4cc23..caec4ef715 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md @@ -11,11 +11,11 @@ title: "[I] ProjectionUnionSelectorNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionUnionSelector` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md index 5f05eecedc..74f3c1e935 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md @@ -11,11 +11,11 @@ title: "[I] ProjectionUnionVariantSelectorNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ProjectionUnionVariantSelector` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md index d4e048c656..764186638f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md @@ -7,9 +7,9 @@ title: "[I] Projector" | Property | Type | Description | | :------ | :------ | :------ | -| `parentProjector?` | [`Projector`](Projector.md) | - | -| `projectedGlobalNamespace?` | [`Namespace`](Namespace.md) | - | -| `projectedStartNode?` | [`Type`](../type-aliases/Type.md) | - | +| `parentProjector`? | [`Projector`](Projector.md) | - | +| `projectedGlobalNamespace`? | [`Namespace`](Namespace.md) | - | +| `projectedStartNode`? | [`Type`](../type-aliases/Type.md) | - | | `projectedTypes` | `Map`<[`Type`](../type-aliases/Type.md), [`Type`](../type-aliases/Type.md)\> | - | | `projections` | [`ProjectionApplication`](ProjectionApplication.md)[] | - | @@ -26,3 +26,7 @@ projectType(type): Type | Parameter | Type | | :------ | :------ | | `type` | [`Type`](../type-aliases/Type.md) | + +#### Returns + +[`Type`](../type-aliases/Type.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md index 293139afb8..c8c413f365 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md @@ -11,26 +11,26 @@ title: "[I] RecordModelType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `baseModel?` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | [`Model`](Model.md).`baseModel` | +| `baseModel`? | [`Model`](Model.md) | Model this model extends. This represent inheritance. | [`Model`](Model.md).`baseModel` | | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`Model`](Model.md).`decorators` | | `derivedModels` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](ArrayModelType.md) | [`Model`](Model.md).`derivedModels` | | `indexer` | `object` | - | [`Model`](Model.md).`indexer` | | `indexer.key` | [`Scalar`](Scalar.md) | - | - | | `indexer.value` | [`Type`](../type-aliases/Type.md) | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`Model`](Model.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`Model`](Model.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`Model`](Model.md).`isFinished` | | `kind` | `"Model"` | - | [`Model`](Model.md).`kind` | | `name` | `string` | - | [`Model`](Model.md).`name` | -| `namespace?` | [`Namespace`](Namespace.md) | - | [`Model`](Model.md).`namespace` | -| `node?` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`Model`](Model.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`Model`](Model.md).`projector` | +| `namespace`? | [`Namespace`](Namespace.md) | - | [`Model`](Model.md).`namespace` | +| `node`? | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`Model`](Model.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`Model`](Model.md).`projector` | | `properties` | `RekeyableMap`<`string`, [`ModelProperty`](ModelProperty.md)\> | The properties of the model.

Properties are ordered in the order that they appear in source.
Properties obtained via `model is` appear before properties defined in
the model body. Properties obtained via `...` are inserted where the
spread appears in source.

Properties inherited via `model extends` are not included. Use
[walkPropertiesInherited](../functions/walkPropertiesInherited.md) to enumerate all properties in the
inheritance hierarchy. | [`Model`](Model.md).`properties` | -| `sourceModel?` | [`Model`](Model.md) | The model that is referenced via `model is`. | [`Model`](Model.md).`sourceModel` | -| `templateArguments?` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`Model`](Model.md).`templateArguments` | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`Model`](Model.md).`templateMapper` | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`Model`](Model.md).`templateNode` | +| `sourceModel`? | [`Model`](Model.md) | The model that is referenced via `model is`. | [`Model`](Model.md).`sourceModel` | +| `templateArguments`? | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`Model`](Model.md).`templateArguments` | +| `templateMapper`? | [`TypeMapper`](TypeMapper.md) | - | [`Model`](Model.md).`templateMapper` | +| `templateNode`? | [`Node`](../type-aliases/Node.md) | - | [`Model`](Model.md).`templateNode` | ## Accessors @@ -40,6 +40,10 @@ title: "[I] RecordModelType" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -54,6 +58,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`Model`](Model.md).[`projectionsByName`](Model.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md index 28cdf7a4c6..adcb9a1499 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md @@ -11,9 +11,9 @@ title: "[I] ResolveCompilerOptionsOptions" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `args?` | `Record`<`string`, `string`\> | Any arguments to interpolate the config. | ConfigToOptionsOptions.args | -| `configPath?` | `string` | Explicit config path. | - | +| `args`? | `Record`<`string`, `string`\> | Any arguments to interpolate the config. | ConfigToOptionsOptions.args | +| `configPath`? | `string` | Explicit config path. | - | | `cwd` | `string` | Current working directory. This will be used to interpolate `{cwd}` in the config. | ConfigToOptionsOptions.cwd | | `entrypoint` | `string` | Absolute entrypoint path | - | -| `env?` | `Record`<`string`, `undefined` \| `string`\> | Environment variables. | ConfigToOptionsOptions.env | -| `overrides?` | `Partial`<`TypeSpecConfig`\> | Compiler options to override the config | ConfigToOptionsOptions.overrides | +| `env`? | `Record`<`string`, `undefined` \| `string`\> | Environment variables. | ConfigToOptionsOptions.env | +| `overrides`? | `Partial`<`TypeSpecConfig`\> | Compiler options to override the config | ConfigToOptionsOptions.overrides | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md index 078679676d..ea554f1dea 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md @@ -19,6 +19,10 @@ Read a utf-8 encoded file. | :------ | :------ | | `path` | `string` | +#### Returns + +`Promise`<`string`\> + *** ### realpath() @@ -35,6 +39,10 @@ Resolve the real path for the current host. | :------ | :------ | | `path` | `string` | +#### Returns + +`Promise`<`string`\> + *** ### stat() @@ -50,3 +58,7 @@ Get information about the given path | Parameter | Type | | :------ | :------ | | `path` | `string` | + +#### Returns + +`Promise`<`object`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md index 51aa932045..51fce30ee6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md @@ -8,5 +8,5 @@ title: "[I] ResolveModuleOptions" | Property | Type | Description | | :------ | :------ | :------ | | `baseDir` | `string` | - | -| `directoryIndexFiles?` | `string`[] | When resolution reach a directory without package.json look for those files to load in order.

**Default**

` ["index.mjs", "index.js"] ` | -| `resolveMain?` | (`pkg`) => `string` | - | +| `directoryIndexFiles`? | `string`[] | When resolution reach a directory without package.json look for those files to load in order.

**Default**

` ["index.mjs", "index.js"] ` | +| `resolveMain`? | (`pkg`) => `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md index 54c1f0736f..39fce9fb7d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md @@ -11,12 +11,12 @@ title: "[I] ReturnExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `Return` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `value` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md index 4633ef9b42..7599309b27 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md @@ -7,4 +7,4 @@ title: "[I] RmOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `recursive?` | `boolean` | If `true`, perform a recursive directory removal. In
recursive mode, errors are not reported if `path` does not exist, and
operations are retried on failure.

**Default**

` false ` | +| `recursive`? | `boolean` | If `true`, perform a recursive directory removal. In
recursive mode, errors are not reported if `path` does not exist, and
operations are retried on failure.

**Default**

` false ` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md index 839d509377..1586f00774 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md @@ -11,21 +11,21 @@ title: "[I] Scalar" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `baseScalar?` | [`Scalar`](Scalar.md) | Scalar this scalar extends. | - | +| `baseScalar`? | [`Scalar`](Scalar.md) | Scalar this scalar extends. | - | | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | | `derivedScalars` | [`Scalar`](Scalar.md)[] | Direct children. This is the reverse relation of

**See**

baseScalar | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Scalar"` | - | [`BaseType`](BaseType.md).`kind` | | `name` | `string` | - | - | -| `namespace?` | [`Namespace`](Namespace.md) | Namespace the scalar was defined in. | - | +| `namespace`? | [`Namespace`](Namespace.md) | Namespace the scalar was defined in. | - | | `node` | [`ScalarStatementNode`](ScalarStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | -| `templateArguments?` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `templateArguments`? | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper`? | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode`? | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | ## Accessors @@ -35,6 +35,10 @@ title: "[I] Scalar" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -49,6 +53,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md index 7e8fa55554..f427cd49bf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md @@ -12,15 +12,15 @@ title: "[I] ScalarStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | -| `readonly` | `extends?` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | +| `readonly` | `extends`? | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `ScalarStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `locals?` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `locals`? | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `templateParameters` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md index d3cd27e70a..aed98c9481 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md @@ -23,6 +23,10 @@ eof(): boolean Determine if the scanner has reached the end of the input. +#### Returns + +`boolean` + *** ### getTokenText() @@ -33,6 +37,10 @@ getTokenText(): string The exact spelling of the current token. +#### Returns + +`string` + *** ### getTokenValue() @@ -47,6 +55,10 @@ String literals are escaped and unquoted, identifiers are normalized, and all other tokens return their exact spelling sames as getTokenText(). +#### Returns + +`string` + *** ### scan() @@ -57,6 +69,10 @@ scan(): Token Advance one token. +#### Returns + +[`Token`](../enumerations/Token.md) + *** ### scanDoc() @@ -67,6 +83,10 @@ scanDoc(): DocToken Advance one token inside DocComment. Use inside [scanRange](Scanner.md#scanrange) callback over DocComment range. +#### Returns + +[`DocToken`](../type-aliases/DocToken.md) + *** ### scanRange() @@ -89,3 +109,7 @@ Reset the scanner to the given start and end positions, invoke the callback, and | :------ | :------ | | `range` | [`TextRange`](TextRange.md) | | `callback` | () => `T` | + +#### Returns + +`T` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md index 1c732148fb..801c504e01 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md @@ -24,6 +24,10 @@ buildSemanticTokens(params): Promise | :------ | :------ | | `params` | `SemanticTokensParams` | +#### Returns + +`Promise`<`SemanticTokens`\> + *** ### checkChange() @@ -38,6 +42,10 @@ checkChange(change): Promise | :------ | :------ | | `change` | `TextDocumentChangeEvent`<`TextDocument`\> | +#### Returns + +`Promise`<`void`\> + *** ### compile() @@ -52,6 +60,10 @@ compile(document): Promise | :------ | :------ | | `document` | `TextDocument` \| `TextDocumentIdentifier` | +#### Returns + +`Promise`<`undefined` \| [`Program`](Program.md)\> + *** ### complete() @@ -66,6 +78,10 @@ complete(params): Promise | :------ | :------ | | `params` | `CompletionParams` | +#### Returns + +`Promise`<`CompletionList`\> + *** ### documentClosed() @@ -80,6 +96,10 @@ documentClosed(change): void | :------ | :------ | | `change` | `TextDocumentChangeEvent`<`TextDocument`\> | +#### Returns + +`void` + *** ### findDocumentHighlight() @@ -94,6 +114,10 @@ findDocumentHighlight(params): Promise | :------ | :------ | | `params` | `DocumentHighlightParams` | +#### Returns + +`Promise`<`DocumentHighlight`[]\> + *** ### findReferences() @@ -108,6 +132,10 @@ findReferences(params): Promise | :------ | :------ | | `params` | `ReferenceParams` | +#### Returns + +`Promise`<`Location`[]\> + *** ### formatDocument() @@ -122,6 +150,10 @@ formatDocument(params): Promise | :------ | :------ | | `params` | `DocumentFormattingParams` | +#### Returns + +`Promise`<`TextEdit`[]\> + *** ### getDocumentSymbols() @@ -136,6 +168,10 @@ getDocumentSymbols(params): Promise | :------ | :------ | | `params` | `DocumentSymbolParams` | +#### Returns + +`Promise`<`DocumentSymbol`[]\> + *** ### getFoldingRanges() @@ -150,6 +186,10 @@ getFoldingRanges(getFoldingRanges): Promise | :------ | :------ | | `getFoldingRanges` | `FoldingRangeParams` | +#### Returns + +`Promise`<`FoldingRange`[]\> + *** ### getHover() @@ -164,6 +204,10 @@ getHover(params): Promise | :------ | :------ | | `params` | `HoverParams` | +#### Returns + +`Promise`<`Hover`\> + *** ### getSemanticTokens() @@ -178,6 +222,10 @@ getSemanticTokens(params): Promise | :------ | :------ | | `params` | `SemanticTokensParams` | +#### Returns + +`Promise`<[`SemanticToken`](SemanticToken.md)[]\> + *** ### getSignatureHelp() @@ -192,6 +240,10 @@ getSignatureHelp(params): Promise | :------ | :------ | | `params` | `SignatureHelpParams` | +#### Returns + +`Promise`<`undefined` \| `SignatureHelp`\> + *** ### gotoDefinition() @@ -206,6 +258,10 @@ gotoDefinition(params): Promise | :------ | :------ | | `params` | `DefinitionParams` | +#### Returns + +`Promise`<`Location`[]\> + *** ### initialize() @@ -220,6 +276,10 @@ initialize(params): Promise> | :------ | :------ | | `params` | `InitializeParams` | +#### Returns + +`Promise`<`InitializeResult`<`any`\>\> + *** ### initialized() @@ -234,6 +294,10 @@ initialized(params): void | :------ | :------ | | `params` | `InitializedParams` | +#### Returns + +`void` + *** ### log() @@ -249,6 +313,10 @@ log(message, details?): void | `message` | `string` | | `details`? | `any` | +#### Returns + +`void` + *** ### prepareRename() @@ -263,6 +331,10 @@ prepareRename(params): Promise | :------ | :------ | | `params` | `PrepareRenameParams` | +#### Returns + +`Promise`<`undefined` \| `Range`\> + *** ### rename() @@ -277,6 +349,10 @@ rename(params): Promise | :------ | :------ | | `params` | `RenameParams` | +#### Returns + +`Promise`<`WorkspaceEdit`\> + *** ### watchedFilesChanged() @@ -291,6 +367,10 @@ watchedFilesChanged(params): void | :------ | :------ | | `params` | `DidChangeWatchedFilesParams` | +#### Returns + +`void` + *** ### workspaceFoldersChanged() @@ -304,3 +384,7 @@ workspaceFoldersChanged(e): Promise | Parameter | Type | | :------ | :------ | | `e` | `WorkspaceFoldersChangeEvent` | + +#### Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md index b912a5e8e0..83b61f939e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md @@ -8,7 +8,7 @@ title: "[I] ServerHost" | Property | Type | Description | | :------ | :------ | :------ | | `compilerHost` | [`CompilerHost`](CompilerHost.md) | - | -| `throwInternalErrors?` | `boolean` | - | +| `throwInternalErrors`? | `boolean` | - | ## Methods @@ -24,6 +24,10 @@ getOpenDocumentByURL(url): undefined | TextDocument | :------ | :------ | | `url` | `string` | +#### Returns + +`undefined` \| `TextDocument` + *** ### log() @@ -38,6 +42,10 @@ log(message): void | :------ | :------ | | `message` | `string` | +#### Returns + +`void` + *** ### sendDiagnostics() @@ -51,3 +59,7 @@ sendDiagnostics(params): void | Parameter | Type | | :------ | :------ | | `params` | `PublishDiagnosticsParams` | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md index f50a90d0ce..0e155f6a1f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md @@ -11,7 +11,7 @@ title: "[I] ServerSourceFile" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `document?` | `TextDocument` | - | - | +| `readonly` | `document`? | `TextDocument` | - | - | | `readonly` | `path` | `string` | The source file path.

This is used only for diagnostics. The command line compiler will populate
it with the actual path from which the file was read, but it can actually
be an arbitrary name for other scenarios. | [`SourceFile`](SourceFile.md).`path` | | `readonly` | `text` | `string` | The source code text. | [`SourceFile`](SourceFile.md).`text` | @@ -32,6 +32,10 @@ code units) to line number and offset from line start. | :------ | :------ | | `position` | `number` | +#### Returns + +[`LineAndCharacter`](LineAndCharacter.md) + #### Inherited from [`SourceFile`](SourceFile.md).[`getLineAndCharacterOfPosition`](SourceFile.md#getlineandcharacterofposition) @@ -48,6 +52,10 @@ Array of positions in the text where each line begins. There is one entry per line, in order of lines, and each entry represents the offset in UTF-16 code units from the start of the document to the beginning of the line. +#### Returns + +readonly `number`[] + #### Inherited from [`SourceFile`](SourceFile.md).[`getLineStarts`](SourceFile.md#getlinestarts) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md index c5895d499e..a15dcbcb16 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md @@ -11,6 +11,6 @@ title: "[I] Service" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `title?` | `string` | - | [`ServiceDetails`](ServiceDetails.md).`title` | +| `title`? | `string` | - | [`ServiceDetails`](ServiceDetails.md).`title` | | `type` | [`Namespace`](Namespace.md) | - | - | -| `version?` | `string` | - | [`ServiceDetails`](ServiceDetails.md).`version` | +| `version`? | `string` | - | [`ServiceDetails`](ServiceDetails.md).`version` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md index c6af2118ae..846b50e09b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md @@ -11,5 +11,5 @@ title: "[I] ServiceDetails" | Property | Type | Description | | :------ | :------ | :------ | -| `title?` | `string` | - | -| `version?` | `string` | - | +| `title`? | `string` | - | +| `version`? | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md index 96ecc3a7de..9ffb5e46e3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md @@ -31,6 +31,10 @@ code units) to line number and offset from line start. | :------ | :------ | | `position` | `number` | +#### Returns + +[`LineAndCharacter`](LineAndCharacter.md) + *** ### getLineStarts() @@ -42,3 +46,7 @@ getLineStarts(): readonly number[] Array of positions in the text where each line begins. There is one entry per line, in order of lines, and each entry represents the offset in UTF-16 code units from the start of the document to the beginning of the line. + +#### Returns + +readonly `number`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md index f017413ccf..d0db0bb440 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md @@ -13,5 +13,5 @@ title: "[I] SourceLocation" | :------ | :------ | :------ | :------ | :------ | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`TextRange`](TextRange.md).`end` | | `public` | `file` | [`SourceFile`](SourceFile.md) | - | - | -| `public` | `isSynthetic?` | `boolean` | - | - | +| `public` | `isSynthetic`? | `boolean` | - | - | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md index 3cd8d892df..2ca6fef013 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md @@ -7,4 +7,4 @@ title: "[I] SourceLocationOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `locateId?` | `boolean` | If trying to resolve the location of a type with an ID, show the location of the ID node instead of the entire type.
This makes sure that the location range is not too large and hard to read. | +| `locateId`? | `boolean` | If trying to resolve the location of a type with an ID, show the location of the ID node instead of the entire type.
This makes sure that the location range is not too large and hard to read. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md index 78db796f29..52651eae39 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md @@ -11,13 +11,13 @@ title: "[I] StringLiteral" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"String"` | - | [`BaseType`](BaseType.md).`kind` | -| `node?` | [`StringLiteralNode`](StringLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `node`? | [`StringLiteralNode`](StringLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `value` | `string` | - | - | ## Accessors @@ -28,6 +28,10 @@ title: "[I] StringLiteral" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -42,6 +46,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md index 90140a9794..7960e80bda 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md @@ -11,12 +11,12 @@ title: "[I] StringLiteralNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `StringLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `value` | `string` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md index 06e634f494..e9fbf030ac 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md @@ -8,13 +8,13 @@ title: "[I] Sym" | Modifier | Property | Type | Description | | :------ | :------ | :------ | :------ | | `readonly` | `declarations` | readonly [`Node`](../type-aliases/Node.md)[] | Nodes which contribute to this declaration | -| `readonly` | `exports?` | `SymbolTable` | Externally visible symbols contained inside this symbol. E.g. all declarations
in a namespace, or members of an enum. | +| `readonly` | `exports`? | `SymbolTable` | Externally visible symbols contained inside this symbol. E.g. all declarations
in a namespace, or members of an enum. | | `readonly` | `flags` | [`SymbolFlags`](../enumerations/SymbolFlags.md) | - | -| `readonly` | `id?` | `number` | A unique identifier for this symbol. Used to look up the symbol links. | -| `readonly` | `members?` | `SymbolTable` | Symbols for members of this symbol which must be referenced off the parent symbol
and cannot be referenced by other means (i.e. by unqualified lookup of the symbol
name). | -| `readonly` | `metatypeMembers?` | `SymbolTable` | Symbol table | +| `readonly` | `id`? | `number` | A unique identifier for this symbol. Used to look up the symbol links. | +| `readonly` | `members`? | `SymbolTable` | Symbols for members of this symbol which must be referenced off the parent symbol
and cannot be referenced by other means (i.e. by unqualified lookup of the symbol
name). | +| `readonly` | `metatypeMembers`? | `SymbolTable` | Symbol table | | `readonly` | `name` | `string` | The name of the symbol | -| `readonly` | `parent?` | [`Sym`](Sym.md) | The symbol containing this symbol, if any. E.g. for things declared in
a namespace, this refers to the namespace. | -| `readonly` | `symbolSource?` | [`Sym`](Sym.md) | For using symbols, this is the used symbol. | -| `readonly` | `type?` | [`Type`](../type-aliases/Type.md) | For late-bound symbols, this is the type referenced by the symbol. | -| `readonly` | `value?` | (...`args`) => `any` | - | +| `readonly` | `parent`? | [`Sym`](Sym.md) | The symbol containing this symbol, if any. E.g. for things declared in
a namespace, this refers to the namespace. | +| `readonly` | `symbolSource`? | [`Sym`](Sym.md) | For using symbols, this is the used symbol. | +| `readonly` | `type`? | [`Type`](../type-aliases/Type.md) | For late-bound symbols, this is the type referenced by the symbol. | +| `readonly` | `value`? | (...`args`) => `any` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md index e36931875f..2476fcf78f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md @@ -7,6 +7,6 @@ title: "[I] SymbolLinks" | Property | Type | Description | | :------ | :------ | :------ | -| `declaredType?` | [`Type`](../type-aliases/Type.md) | - | -| `instantiations?` | [`TypeInstantiationMap`](TypeInstantiationMap.md) | - | -| `type?` | [`Type`](../type-aliases/Type.md) | - | +| `declaredType`? | [`Type`](../type-aliases/Type.md) | - | +| `instantiations`? | [`TypeInstantiationMap`](TypeInstantiationMap.md) | - | +| `type`? | [`Type`](../type-aliases/Type.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md index 8167575c7c..01d92627bc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md @@ -16,5 +16,5 @@ title: "[I] TemplateDeclarationNode" | Modifier | Property | Type | Description | | :------ | :------ | :------ | :------ | -| `readonly` | `locals?` | `SymbolTable` | - | +| `readonly` | `locals`? | `SymbolTable` | - | | `readonly` | `templateParameters` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md index c9b333f356..8a6fa1580f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md @@ -11,15 +11,15 @@ title: "[I] TemplateParameter" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `constraint?` | [`Type`](../type-aliases/Type.md) \| [`ValueType`](ValueType.md) | - | - | -| `default?` | [`Type`](../type-aliases/Type.md) | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `constraint`? | [`Type`](../type-aliases/Type.md) \| [`ValueType`](ValueType.md) | - | - | +| `default`? | [`Type`](../type-aliases/Type.md) | - | - | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"TemplateParameter"` | - | [`BaseType`](BaseType.md).`kind` | | `node` | [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md) | - | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | ## Accessors @@ -29,6 +29,10 @@ title: "[I] TemplateParameter" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -43,6 +47,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md index 2ac7bb59d3..aab05bde44 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md @@ -11,14 +11,14 @@ title: "[I] TemplateParameterDeclarationNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `constraint?` | [`Expression`](../type-aliases/Expression.md) | - | - | -| `readonly` | `default?` | [`Expression`](../type-aliases/Expression.md) | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `constraint`? | [`Expression`](../type-aliases/Expression.md) | - | - | +| `readonly` | `default`? | [`Expression`](../type-aliases/Expression.md) | - | - | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `TemplateParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`TemplateableNode`](../type-aliases/TemplateableNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`TemplateableNode`](../type-aliases/TemplateableNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md index 987e48f7a6..3509ad1147 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md @@ -15,6 +15,6 @@ title: "[I] TemplatedTypeBase" | Property | Type | Description | | :------ | :------ | :------ | -| `templateArguments?` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | +| `templateArguments`? | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | +| `templateMapper`? | [`TypeMapper`](TypeMapper.md) | - | +| `templateNode`? | [`Node`](../type-aliases/Node.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md index 3a3f9861be..5cd4e60f6e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md @@ -17,6 +17,10 @@ sub(subarea): Tracer | :------ | :------ | | `subarea` | `string` | +#### Returns + +[`Tracer`](Tracer.md) + *** ### trace() @@ -37,3 +41,7 @@ Trace | `area` | `string` | | | `message` | `string` | | | `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | - | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md index 145b6400fb..3a5e52c544 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md @@ -7,4 +7,4 @@ title: "[I] TracerOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `filter?` | `string`[] | - | +| `filter`? | `string`[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md index 2fceb725ba..8c183385fc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md @@ -11,13 +11,13 @@ title: "[I] Tuple" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"Tuple"` | - | [`BaseType`](BaseType.md).`kind` | | `node` | [`TupleExpressionNode`](TupleExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `values` | [`Type`](../type-aliases/Type.md)[] | - | - | ## Accessors @@ -28,6 +28,10 @@ title: "[I] Tuple" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -42,6 +46,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md index 3a0251e246..8aa0ebc0ff 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md @@ -11,12 +11,12 @@ title: "[I] TupleExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `TupleExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `values` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md index 23d9ed98f8..1b84e154b7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md @@ -19,6 +19,10 @@ get(args): undefined | Type | :------ | :------ | | `args` | readonly [`Type`](../type-aliases/Type.md)[] | +#### Returns + +`undefined` \| [`Type`](../type-aliases/Type.md) + *** ### set() @@ -33,3 +37,7 @@ set(args, type): void | :------ | :------ | | `args` | readonly [`Type`](../type-aliases/Type.md)[] | | `type` | [`Type`](../type-aliases/Type.md) | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md index 974a74ff32..bc3f0a2ed3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md @@ -23,3 +23,7 @@ getMappedType(type): Type | Parameter | Type | | :------ | :------ | | `type` | [`TemplateParameter`](TemplateParameter.md) | + +#### Returns + +[`Type`](../type-aliases/Type.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md index 8b4ff0574e..d59f5238b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md @@ -7,5 +7,5 @@ title: "[I] TypeNameOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `namespaceFilter?` | (`ns`) => `boolean` | - | -| `printable?` | `boolean` | - | +| `namespaceFilter`? | (`ns`) => `boolean` | - | +| `printable`? | `boolean` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md index 85a89e6b07..ec7b1da399 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md @@ -12,12 +12,12 @@ title: "[I] TypeReferenceNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `arguments` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `TypeReference` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md index ac1c10531e..f9600d26ac 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md @@ -7,5 +7,5 @@ title: "[I] TypeSpecCompletionItem" | Property | Type | Description | | :------ | :------ | :------ | -| `label?` | `string` | Optional label if different from the text to complete. | +| `label`? | `string` | Optional label if different from the text to complete. | | `sym` | [`Sym`](Sym.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md index 13585f50c4..7070f91549 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md @@ -21,12 +21,12 @@ Definition of a TypeSpec library | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `diagnostics` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`diagnostics` | -| `readonly` | `emitter?` | `object` | Emitter configuration if library is an emitter. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`emitter` | -| `readonly` | `emitter.options?` | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | - | -| `readonly` | `emitterOptionValidator?` | [`JSONSchemaValidator`](JSONSchemaValidator.md) | JSON Schema validator for emitter options | - | -| `readonly` | `linter?` | [`LinterDefinition`](LinterDefinition.md) | Configuration if library is providing linting rules/rulesets. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`linter` | +| `readonly` | `emitter`? | `object` | Emitter configuration if library is an emitter. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`emitter` | +| `readonly` | `emitter.options`? | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | - | +| `readonly` | `emitterOptionValidator`? | [`JSONSchemaValidator`](JSONSchemaValidator.md) | JSON Schema validator for emitter options | - | +| `readonly` | `linter`? | [`LinterDefinition`](LinterDefinition.md) | Configuration if library is providing linting rules/rulesets. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`linter` | | `readonly` | `name` | `string` | Name of the library. Must match the package.json name. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`name` | -| `public` | `requireImports?` | readonly `string`[] | List of other library that should be imported when this is used as an emitter.
Compiler will emit an error if the libraries are not explicitly imported. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`requireImports` | +| `public` | `requireImports`? | readonly `string`[] | List of other library that should be imported when this is used as an emitter.
Compiler will emit an error if the libraries are not explicitly imported. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`requireImports` | ## Methods @@ -49,6 +49,10 @@ createDiagnostic(diag): Diagnostic | :------ | :------ | | `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | +#### Returns + +[`Diagnostic`](Diagnostic.md) + *** ### createStateSymbol() @@ -65,6 +69,10 @@ Get or create a symbol with the given name unique for that library. | :------ | :------ | :------ | | `name` | `string` | Symbol name scoped with the library name. | +#### Returns + +`symbol` + *** ### getTracer() @@ -82,6 +90,10 @@ All trace area logged via this tracer will be prefixed with the library name. | :------ | :------ | | `program` | [`Program`](Program.md) | +#### Returns + +[`Tracer`](Tracer.md) + *** ### reportDiagnostic() @@ -103,3 +115,7 @@ reportDiagnostic(program, diag): void | :------ | :------ | | `program` | [`Program`](Program.md) | | `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md index f7fae3e4e6..9e31a18c18 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md @@ -21,8 +21,8 @@ Definition of a TypeSpec library | Modifier | Property | Type | Description | | :------ | :------ | :------ | :------ | | `readonly` | `diagnostics` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | -| `readonly` | `emitter?` | `object` | Emitter configuration if library is an emitter. | -| `readonly` | `emitter.options?` | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | -| `readonly` | `linter?` | [`LinterDefinition`](LinterDefinition.md) | Configuration if library is providing linting rules/rulesets. | +| `readonly` | `emitter`? | `object` | Emitter configuration if library is an emitter. | +| `readonly` | `emitter.options`? | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | +| `readonly` | `linter`? | [`LinterDefinition`](LinterDefinition.md) | Configuration if library is providing linting rules/rulesets. | | `readonly` | `name` | `string` | Name of the library. Must match the package.json name. | -| `public` | `requireImports?` | readonly `string`[] | List of other library that should be imported when this is used as an emitter.
Compiler will emit an error if the libraries are not explicitly imported. | +| `public` | `requireImports`? | readonly `string`[] | List of other library that should be imported when this is used as an emitter.
Compiler will emit an error if the libraries are not explicitly imported. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md index 67130a08b8..9b5afeb568 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md @@ -8,5 +8,5 @@ title: "[I] TypeSpecManifest" | Property | Type | Description | | :------ | :------ | :------ | | `commit` | `string` | Full commit sha. | -| `pr?` | `number` | Number of the pull request, if the build was from a pull request. | +| `pr`? | `number` | Number of the pull request, if the build was from a pull request. | | `version` | `string` | Version of the tsp compiler. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md index b3ac438174..940d2ab302 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md @@ -12,8 +12,8 @@ title: "[I] TypeSpecScriptNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `comments` | readonly [`Comment`](../type-aliases/Comment.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `file` | [`SourceFile`](SourceFile.md) | - | - | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | @@ -22,7 +22,7 @@ title: "[I] TypeSpecScriptNode" | `readonly` | `kind` | `TypeSpecScript` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `locals` | `SymbolTable` | - | - | | `readonly` | `namespaces` | [`NamespaceStatementNode`](NamespaceStatementNode.md)[] | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `parseDiagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | - | - | | `readonly` | `parseOptions` | [`ParseOptions`](ParseOptions.md) | - | - | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md index 1bcadb301d..0400fbb2b7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md @@ -13,19 +13,19 @@ title: "[I] Union" | :------ | :------ | :------ | :------ | :------ | | `public` | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | | `public` | `expression` | `boolean` | - | - | -| `public` | `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `public` | `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `public` | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `public` | `kind` | `"Union"` | - | [`BaseType`](BaseType.md).`kind` | -| `public` | `name?` | `string` | - | - | -| `public` | `namespace?` | [`Namespace`](Namespace.md) | - | - | +| `public` | `name`? | `string` | - | - | +| `public` | `namespace`? | [`Namespace`](Namespace.md) | - | - | | `public` | `node` | [`UnionStatementNode`](UnionStatementNode.md) \| [`UnionExpressionNode`](UnionExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | | `readonly` | `options` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use variants | - | -| `public` | `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `public` | `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `public` | `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | -| `public` | `templateArguments?` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `public` | `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `public` | `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | +| `public` | `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `public` | `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `public` | `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `public` | `templateArguments`? | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `public` | `templateMapper`? | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `public` | `templateNode`? | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | | `public` | `variants` | `RekeyableMap`<`string` \| `symbol`, [`UnionVariant`](UnionVariant.md)\> | The variants of the union.

Variants are ordered in order that they appear in source. | - | ## Accessors @@ -36,6 +36,10 @@ title: "[I] Union" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -50,6 +54,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md index 14c5a5e550..0388933c55 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md @@ -11,12 +11,12 @@ title: "[I] UnionExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `UnionExpression` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `options` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md index 1220ada39c..e1c49608ee 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md @@ -12,15 +12,15 @@ title: "[I] UnionStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `readonly` | `kind` | `UnionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `locals?` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `readonly` | `locals`? | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | | `readonly` | `options` | readonly [`UnionVariantNode`](UnionVariantNode.md)[] | - | - | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `templateParameters` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md index 94aba8a4f6..b6d16fbbd7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md @@ -12,14 +12,14 @@ title: "[I] UnionVariant" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `"UnionVariant"` | - | [`BaseType`](BaseType.md).`kind` | | `name` | `string` \| `symbol` | - | - | | `node` | `undefined` \| [`UnionVariantNode`](UnionVariantNode.md) | - | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | | `type` | [`Type`](../type-aliases/Type.md) | - | - | | `union` | [`Union`](Union.md) | - | - | @@ -31,6 +31,10 @@ title: "[I] UnionVariant" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -45,6 +49,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md index e592839947..74577fb8e5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md @@ -12,13 +12,13 @@ title: "[I] UnionVariantNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | | `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | -| `readonly` | `id?` | [`IdentifierNode`](IdentifierNode.md) | - | - | +| `readonly` | `id`? | [`IdentifierNode`](IdentifierNode.md) | - | - | | `readonly` | `kind` | `UnionVariant` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`UnionStatementNode`](UnionStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`UnionStatementNode`](UnionStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `value` | [`Expression`](../type-aliases/Expression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md index 3fa09ba62b..350d09d69c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md @@ -11,14 +11,14 @@ title: "[I] UnknownType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`IntrinsicType`](IntrinsicType.md).`isFinished` | | `kind` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | | `name` | `"unknown"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | +| `node`? | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | ## Accessors @@ -28,6 +28,10 @@ title: "[I] UnknownType" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -42,6 +46,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md index 777ceaa089..4fe97b6882 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md @@ -23,3 +23,7 @@ isUsedAs(type, usage): boolean | :------ | :------ | | `type` | [`TrackableType`](../type-aliases/TrackableType.md) | | `usage` | [`UsageFlags`](../enumerations/UsageFlags.md) | + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md index 644117d12f..88a4587707 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md @@ -11,12 +11,12 @@ title: "[I] UsingStatementNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `UsingStatement` | - | [`BaseNode`](BaseNode.md).`kind` | | `readonly` | `name` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | -| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md index 9c4c98a981..a5fc607ae6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md @@ -11,12 +11,12 @@ title: "[I] ValueOfExpressionNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `ValueOfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | | `readonly` | `target` | [`Expression`](../type-aliases/Expression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md index 6035a0d3b7..a2be42b303 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md @@ -11,11 +11,11 @@ title: "[I] VoidKeywordNode" | Modifier | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | :------ | -| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `directives`? | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs`? | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | | `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | | `readonly` | `kind` | `VoidKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | -| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parent`? | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | | `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | | `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md index 79d22f6062..9bfe03ba17 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md @@ -11,14 +11,14 @@ title: "[I] VoidType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `instantiationParameters`? | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`IntrinsicType`](IntrinsicType.md).`isFinished` | | `kind` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | | `name` | `"void"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | +| `node`? | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase`? | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource`? | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector`? | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | ## Accessors @@ -28,6 +28,10 @@ title: "[I] VoidType" get projections(): ProjectionStatementNode[] ``` +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + ## Methods ### projectionsByName() @@ -42,6 +46,10 @@ projectionsByName(name): ProjectionStatementNode[] | :------ | :------ | | `name` | `string` | +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + #### Inherited from [`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md index a8cda9bcb2..693a7e0aea 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md @@ -4,7 +4,7 @@ title: "[T] DiagnosticFormat" --- ```ts -type DiagnosticFormat: T[C][M] extends CallableMessage ? object : Record; +type DiagnosticFormat: T\[C\]\[M\] extends CallableMessage ? object : Record; ``` ## Type parameters @@ -13,4 +13,4 @@ type DiagnosticFormat: T[C][M] extends CallableMessage ? objec | :------ | :------ | | `T` extends `object` | - | | `C` extends keyof `T` | - | -| `M` extends keyof `T`[`C`] | `"default"` | +| `M` extends keyof `T`\[`C`\] | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticHandler.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticHandler.md index 08aa8b590d..41fc2cbe61 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticHandler.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticHandler.md @@ -12,3 +12,7 @@ type DiagnosticHandler: (diagnostic) => void; | Parameter | Type | | :------ | :------ | | `diagnostic` | [`Diagnostic`](../interfaces/Diagnostic.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReport.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReport.md index 4a3471badc..1c8233fadc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReport.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReport.md @@ -19,4 +19,4 @@ type DiagnosticReport: DiagnosticReportWithoutTarget & object; | :------ | :------ | | `T` extends `object` | - | | `C` extends keyof `T` | - | -| `M` extends keyof `T`[`C`] | `"default"` | +| `M` extends keyof `T`\[`C`\] | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md index 5f28ab15e6..672700431d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md @@ -20,4 +20,4 @@ type DiagnosticReportWithoutTarget: object & DiagnosticFormat; | :------ | :------ | | `T` extends `object` | - | | `C` extends keyof `T` | - | -| `M` extends keyof `T`[`C`] | `"default"` | +| `M` extends keyof `T`\[`C`\] | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitterFunc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitterFunc.md index 1c75463e4e..90afd7f8a9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitterFunc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitterFunc.md @@ -12,3 +12,7 @@ type EmitterFunc: (context) => Promise | void; | Parameter | Type | | :------ | :------ | | `context` | [`EmitContext`](../interfaces/EmitContext.md) | + +## Returns + +`Promise`<`void`\> \| `void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md index 2c6d055a69..900f0ceee2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md @@ -4,7 +4,7 @@ title: "[T] LinterRuleDiagnosticFormat" --- ```ts -type LinterRuleDiagnosticFormat: T[M] extends CallableMessage ? object : Record; +type LinterRuleDiagnosticFormat: T\[M\] extends CallableMessage ? object : Record; ``` ## Type parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NodeCallback.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NodeCallback.md index d3ed4a633a..1f8a2c10d6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NodeCallback.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NodeCallback.md @@ -18,3 +18,7 @@ type NodeCallback: (c) => T; | Parameter | Type | | :------ | :------ | | `c` | [`Node`](Node.md) | + +## Returns + +`T` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeKind.md index 47f3dbd39e..12ff6820f8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeKind.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeKind.md @@ -4,5 +4,5 @@ title: "[T] TypeKind" --- ```ts -type TypeKind: Type["kind"] | "Any"; +type TypeKind: Type\["kind"\] | "Any"; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/WriteLine.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/WriteLine.md index 359c880693..b7ee72c974 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/WriteLine.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/WriteLine.md @@ -12,3 +12,7 @@ type WriteLine: (text?) => void; | Parameter | Type | | :------ | :------ | | `text`? | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$action.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$action.md index b8c79cde6b..2e794ae091 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$action.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$action.md @@ -17,3 +17,7 @@ $action( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `name`? | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSegment.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSegment.md index 608e9a438b..bbd5fc7700 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSegment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSegment.md @@ -17,3 +17,7 @@ $actionSegment( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `name` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSeparator.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSeparator.md index 2a8cb0f621..ae4bfadc13 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSeparator.md @@ -22,3 +22,7 @@ $actionSeparator( | `context` | `DecoratorContext` | | `entity` | `Model` \| `ModelProperty` \| `Operation` | | `separator` | `"/"` \| `":"` \| `"/:"` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$autoRoute.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$autoRoute.md index f379e56a4c..56c6bc5b29 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$autoRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$autoRoute.md @@ -19,3 +19,7 @@ auto-generated routes. | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Interface` \| `Operation` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$collectionAction.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$collectionAction.md index a078bb5423..d76dc86f31 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$collectionAction.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$collectionAction.md @@ -19,3 +19,7 @@ $collectionAction( | `entity` | `Operation` | | `resourceType` | `Model` | | `name`? | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$copyResourceKeyParameters.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$copyResourceKeyParameters.md index 1d28121be9..44fbf81ad7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$copyResourceKeyParameters.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$copyResourceKeyParameters.md @@ -17,3 +17,7 @@ $copyResourceKeyParameters( | `context` | `DecoratorContext` | | `entity` | `Model` | | `filter`? | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrReplacesResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrReplacesResource.md index aa1451cc01..fe8d8b459f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrReplacesResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrReplacesResource.md @@ -17,3 +17,7 @@ $createsOrReplacesResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrUpdatesResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrUpdatesResource.md index 836b143410..a8403a7f8c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrUpdatesResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrUpdatesResource.md @@ -17,3 +17,7 @@ $createsOrUpdatesResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsResource.md index 24c285285c..10f11b1015 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsResource.md @@ -17,3 +17,7 @@ $createsResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$deletesResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$deletesResource.md index ad1a79193d..2fe790c329 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$deletesResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$deletesResource.md @@ -17,3 +17,7 @@ $deletesResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$listsResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$listsResource.md index 27e48d0d07..c44c4c93d5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$listsResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$listsResource.md @@ -17,3 +17,7 @@ $listsResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$onValidate.md index df5dda0051..212e92eb72 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$onValidate.md @@ -12,3 +12,7 @@ $onValidate(program): void | Parameter | Type | | :------ | :------ | | `program` | `Program` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$parentResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$parentResource.md index e57db3d602..fb6ccf19ff 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$parentResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$parentResource.md @@ -25,3 +25,7 @@ the target type to show up in operations of the `Resource*` interfaces define | `context` | `DecoratorContext` | | `entity` | `Type` | | `parentType` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$readsResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$readsResource.md index 670763f28f..3f2f247573 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$readsResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$readsResource.md @@ -17,3 +17,7 @@ $readsResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resource.md index c79bb590b5..728fb6375e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resource.md @@ -25,3 +25,7 @@ name of `widgets`. | `context` | `DecoratorContext` | | `entity` | `Model` | | `collectionName` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceLocation.md index 008d4f2697..86bd604894 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceLocation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceLocation.md @@ -17,3 +17,7 @@ $resourceLocation( | `context` | `DecoratorContext` | | `entity` | `Model` | | `resourceType` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceTypeForKeyParam.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceTypeForKeyParam.md index 8aa67e2a52..2c47b2f263 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceTypeForKeyParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceTypeForKeyParam.md @@ -17,3 +17,7 @@ $resourceTypeForKeyParam( | `context` | `DecoratorContext` | | `entity` | `Type` | | `resourceType` | `Type` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segment.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segment.md index 46b4a3f89c..3f790317cd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segment.md @@ -24,3 +24,7 @@ path parameter's name field. | `context` | `DecoratorContext` | | `entity` | `Model` \| `ModelProperty` \| `Operation` | | `name` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segmentOf.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segmentOf.md index 63972a9f8f..725f4a7ae3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segmentOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segmentOf.md @@ -17,3 +17,7 @@ $segmentOf( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$updatesResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$updatesResource.md index c81d7bd331..22655150ed 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$updatesResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$updatesResource.md @@ -17,3 +17,7 @@ $updatesResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getAction.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getAction.md index 094e46508c..ff9533a06f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getAction.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getAction.md @@ -16,6 +16,8 @@ getAction(program, operation): string | null | undefined ## Returns +`string` \| `null` \| `undefined` + ## Deprecated Use getActionDetails instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionDetails.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionDetails.md index e7514c1146..2061cae006 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionDetails.md @@ -15,3 +15,7 @@ Gets the ActionDetails for the specified operation if it has previously been mar | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | + +## Returns + +[`ActionDetails`](../interfaces/ActionDetails.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSegment.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSegment.md index 697444b0bc..4a67666f95 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSegment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSegment.md @@ -13,3 +13,7 @@ getActionSegment(program, entity): string | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSeparator.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSeparator.md index 696b47f937..ad10e29315 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSeparator.md @@ -16,4 +16,6 @@ getActionSeparator(program, entity): string | undefined ## Returns +`string` \| `undefined` + the action separator string diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionAction.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionAction.md index 875637d6c6..d1641f55e9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionAction.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionAction.md @@ -16,6 +16,8 @@ getCollectionAction(program, operation): string | null | undefined ## Returns +`string` \| `null` \| `undefined` + ## Deprecated Use getCollectionActionDetails instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionActionDetails.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionActionDetails.md index f5ff439bf0..d0d4616f7e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionActionDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionActionDetails.md @@ -15,3 +15,7 @@ Gets the ActionDetails for the specified operation if it has previously been mar | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | + +## Returns + +[`ActionDetails`](../interfaces/ActionDetails.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getParentResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getParentResource.md index 3cec874c50..035bf89e60 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getParentResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getParentResource.md @@ -13,3 +13,7 @@ getParentResource(program, resourceType): Model | undefined | :------ | :------ | | `program` | `Program` | | `resourceType` | `Model` | + +## Returns + +`Model` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceLocationType.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceLocationType.md index 59d4ad5148..ef5607dd0c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceLocationType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceLocationType.md @@ -13,3 +13,7 @@ getResourceLocationType(program, entity): Model | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Scalar` | + +## Returns + +`Model` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceOperation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceOperation.md index cd7f24bd49..38e8f197c3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceOperation.md @@ -13,3 +13,7 @@ getResourceOperation(program, typespecOperation): ResourceOperation | undefined | :------ | :------ | | `program` | `Program` | | `typespecOperation` | `Operation` | + +## Returns + +[`ResourceOperation`](../interfaces/ResourceOperation.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeForKeyParam.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeForKeyParam.md index 2c4ecf6200..916fa74d2a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeForKeyParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeForKeyParam.md @@ -13,3 +13,7 @@ getResourceTypeForKeyParam(program, param): Model | undefined | :------ | :------ | | `program` | `Program` | | `param` | `ModelProperty` | + +## Returns + +`Model` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeKey.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeKey.md index 899bb55b59..6b3ac20de6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeKey.md @@ -13,3 +13,7 @@ getResourceTypeKey(program, resourceType): ResourceKey | undefined | :------ | :------ | | `program` | `Program` | | `resourceType` | `Model` | + +## Returns + +[`ResourceKey`](../interfaces/ResourceKey.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getSegment.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getSegment.md index 53465e3684..4b391cbea4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getSegment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getSegment.md @@ -13,3 +13,7 @@ getSegment(program, entity): string | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isAutoRoute.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isAutoRoute.md index 8805220b75..a2e3f25b11 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isAutoRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isAutoRoute.md @@ -13,3 +13,7 @@ isAutoRoute(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Interface` \| `Operation` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isListOperation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isListOperation.md index 5879329c16..0ace542980 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isListOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isListOperation.md @@ -15,3 +15,7 @@ Returns `true` if the given operation is marked as a list operation. | :------ | :------ | :------ | | `program` | `Program` | the TypeSpec program | | `target` | `Operation` | the target operation | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceOperation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceOperation.md index 35e6b99a80..74831209bc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceOperation.md @@ -19,3 +19,7 @@ setResourceOperation( | `entity` | `Operation` | | `resourceType` | `Model` | | `operation` | [`ResourceOperations`](../type-aliases/ResourceOperations.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceTypeKey.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceTypeKey.md index 455af87b5e..511fa16af9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceTypeKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceTypeKey.md @@ -17,3 +17,7 @@ setResourceTypeKey( | `program` | `Program` | | `resourceType` | `Model` | | `keyProperty` | `ModelProperty` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/AutoRouteOptions.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/AutoRouteOptions.md index b7d977cb6b..204f41b61f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/AutoRouteOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/AutoRouteOptions.md @@ -7,4 +7,4 @@ title: "[I] AutoRouteOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `routeParamFilter?` | (`op`, `param`) => `undefined` \| [`FilteredRouteParam`](FilteredRouteParam.md) | - | +| `routeParamFilter`? | (`op`, `param`) => `undefined` \| [`FilteredRouteParam`](FilteredRouteParam.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/FilteredRouteParam.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/FilteredRouteParam.md index 5fc5a97d34..a7c2b51ad6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/FilteredRouteParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/FilteredRouteParam.md @@ -7,5 +7,5 @@ title: "[I] FilteredRouteParam" | Property | Type | Description | | :------ | :------ | :------ | -| `excludeFromOperationParams?` | `boolean` | - | -| `routeParamString?` | `string` | - | +| `excludeFromOperationParams`? | `boolean` | - | +| `routeParamString`? | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/decorators.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/decorators.md index a9e9040218..1f752c8b5a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/decorators.md @@ -18,7 +18,7 @@ Identifies when the target was added. #### Target -`(intrinsic) unknown` +`union Model | ModelProperty | Operation | Enum | EnumMember | Union | UnionVariant | Scalar | Interface` #### Parameters @@ -53,7 +53,7 @@ Identifies when a target was made optional. #### Target -`(intrinsic) unknown` +`ModelProperty` #### Parameters @@ -82,7 +82,7 @@ Identifies when the target was removed. #### Target -`(intrinsic) unknown` +`union Model | ModelProperty | Operation | Enum | EnumMember | Union | UnionVariant | Scalar | Interface` #### Parameters @@ -117,7 +117,7 @@ Identifies when the target has been renamed. #### Target -`(intrinsic) unknown` +`union Model | ModelProperty | Operation | Enum | EnumMember | Union | UnionVariant | Scalar | Interface` #### Parameters @@ -162,7 +162,7 @@ Identifies when the target type changed. #### Target -`(intrinsic) unknown` +`ModelProperty` #### Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/classes/VersionMap.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/classes/VersionMap.md index b026409955..20e01b5a6a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/classes/VersionMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/classes/VersionMap.md @@ -18,6 +18,10 @@ new VersionMap(namespace, enumType): VersionMap | `namespace` | `Namespace` | | `enumType` | `Enum` | +#### Returns + +[`VersionMap`](VersionMap.md) + ## Properties | Modifier | Property | Type | Description | @@ -32,6 +36,10 @@ new VersionMap(namespace, enumType): VersionMap get size(): number ``` +#### Returns + +`number` + ## Methods ### getVersionForEnumMember() @@ -46,6 +54,10 @@ getVersionForEnumMember(member): undefined | Version | :------ | :------ | | `member` | `EnumMember` | +#### Returns + +`undefined` \| [`Version`](../interfaces/Version.md) + *** ### getVersions() @@ -53,3 +65,7 @@ getVersionForEnumMember(member): undefined | Version ```ts getVersions(): Version[] ``` + +#### Returns + +[`Version`](../interfaces/Version.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$added.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$added.md index 1fdad62384..a377288d6f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$added.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$added.md @@ -15,5 +15,9 @@ $added( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `t` | `Type` | +| `t` | \| `Model` \| `ModelProperty` \| `Scalar` \| `Enum` \| `EnumMember` \| `Operation` \| `Union` \| `UnionVariant` \| `Interface` | | `v` | `EnumMember` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$madeOptional.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$madeOptional.md index 7decbe579a..1a56411398 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$madeOptional.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$madeOptional.md @@ -17,3 +17,7 @@ $madeOptional( | `context` | `DecoratorContext` | | `t` | `ModelProperty` | | `v` | `EnumMember` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$onValidate.md index df5dda0051..212e92eb72 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$onValidate.md @@ -12,3 +12,7 @@ $onValidate(program): void | Parameter | Type | | :------ | :------ | | `program` | `Program` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$removed.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$removed.md index a7a031f468..499f38a97d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$removed.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$removed.md @@ -15,5 +15,9 @@ $removed( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `t` | `Type` | +| `t` | \| `Model` \| `ModelProperty` \| `Scalar` \| `Enum` \| `EnumMember` \| `Operation` \| `Union` \| `UnionVariant` \| `Interface` | | `v` | `EnumMember` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$renamedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$renamedFrom.md index 363443640e..2ad1e5c7bf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$renamedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$renamedFrom.md @@ -16,6 +16,10 @@ $renamedFrom( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `t` | `Type` | +| `t` | \| `Model` \| `ModelProperty` \| `Scalar` \| `Enum` \| `EnumMember` \| `Operation` \| `Union` \| `UnionVariant` \| `Interface` | | `v` | `EnumMember` | | `oldName` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$returnTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$returnTypeChangedFrom.md index ef23d3f31a..ee6148a2f5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$returnTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$returnTypeChangedFrom.md @@ -19,3 +19,7 @@ $returnTypeChangedFrom( | `op` | `Operation` | | `v` | `EnumMember` | | `oldReturnType` | `any` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$typeChangedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$typeChangedFrom.md index 24b4e25952..819a72520e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$typeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$typeChangedFrom.md @@ -19,3 +19,7 @@ $typeChangedFrom( | `prop` | `ModelProperty` | | `v` | `EnumMember` | | `oldType` | `any` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$useDependency.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$useDependency.md index fc0546cc72..b49fdc61e5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$useDependency.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$useDependency.md @@ -17,3 +17,7 @@ $useDependency( | `context` | `DecoratorContext` | | `target` | `EnumMember` \| `Namespace` | | ...`versionRecords` | `EnumMember`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$versioned.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$versioned.md index 1a260ccab4..e5b86d0cf6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$versioned.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$versioned.md @@ -17,3 +17,7 @@ $versioned( | `context` | `DecoratorContext` | | `t` | `Namespace` | | `versions` | `Enum` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/buildVersionProjections.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/buildVersionProjections.md index cd8a640c27..a9d48aba13 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/buildVersionProjections.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/buildVersionProjections.md @@ -13,3 +13,7 @@ buildVersionProjections(program, rootNs): VersionProjections[] | :------ | :------ | | `program` | `Program` | | `rootNs` | `Namespace` | + +## Returns + +`VersionProjections`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/existsAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/existsAtVersion.md index 0e98a7e3a3..0859befce5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/existsAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/existsAtVersion.md @@ -17,3 +17,7 @@ existsAtVersion( | `p` | `Program` | | `type` | `Type` | | `versionKey` | `ObjectType` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/findVersionedNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/findVersionedNamespace.md index fdf0acd7c1..5e282acbda 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/findVersionedNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/findVersionedNamespace.md @@ -13,3 +13,7 @@ findVersionedNamespace(program, namespace): Namespace | undefined | :------ | :------ | | `program` | `Program` | | `namespace` | `Namespace` | + +## Returns + +`Namespace` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAddedOnVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAddedOnVersions.md index 9655c1964b..1850c0e9b1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAddedOnVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAddedOnVersions.md @@ -13,3 +13,7 @@ getAddedOnVersions(p, t): Version[] | undefined | :------ | :------ | | `p` | `Program` | | `t` | `Type` | + +## Returns + +[`Version`](../interfaces/Version.md)[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMap.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMap.md index 7f972bc15f..f39c2e9e39 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMap.md @@ -13,3 +13,7 @@ getAvailabilityMap(program, type): Map | undefined | :------ | :------ | | `program` | `Program` | | `type` | `Type` | + +## Returns + +`Map`<`string`, [`Availability`](../enumerations/Availability.md)\> \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md index 9802f6339c..dfd9932bcc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md @@ -17,3 +17,7 @@ getAvailabilityMapInTimeline( | `program` | `Program` | | `type` | `Type` | | `timeline` | `VersioningTimeline` | + +## Returns + +`Map`<`TimelineMoment`, [`Availability`](../enumerations/Availability.md)\> \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getMadeOptionalOn.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getMadeOptionalOn.md index 24d90d946c..f2f1758a10 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getMadeOptionalOn.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getMadeOptionalOn.md @@ -16,4 +16,6 @@ getMadeOptionalOn(p, t): Version | undefined ## Returns +[`Version`](../interfaces/Version.md) \| `undefined` + version when the given type was made optional if applicable. diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getNameAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getNameAtVersion.md index d170922f5b..7152651a3c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getNameAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getNameAtVersion.md @@ -20,4 +20,6 @@ getNameAtVersion( ## Returns +`string` + get old name if applicable. diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRemovedOnVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRemovedOnVersions.md index 12ed5476db..2710d05daf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRemovedOnVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRemovedOnVersions.md @@ -13,3 +13,7 @@ getRemovedOnVersions(p, t): Version[] | undefined | :------ | :------ | | `p` | `Program` | | `t` | `Type` | + +## Returns + +[`Version`](../interfaces/Version.md)[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFrom.md index 3d53fc7ce9..281d453204 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFrom.md @@ -16,4 +16,6 @@ getRenamedFrom(p, t): RenamedFrom[] | undefined ## Returns +`RenamedFrom`[] \| `undefined` + the array of RenamedFrom metadata if applicable. diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFromVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFromVersions.md index 1da63f3937..7271627b65 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFromVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFromVersions.md @@ -16,4 +16,6 @@ getRenamedFromVersions(p, t): Version[] | undefined ## Returns +[`Version`](../interfaces/Version.md)[] \| `undefined` + the list of versions for which this decorator has been applied diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeBeforeVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeBeforeVersion.md index abfe677663..4dd8f4ac80 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeBeforeVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeBeforeVersion.md @@ -20,4 +20,6 @@ getReturnTypeBeforeVersion( ## Returns +`any` + get old type if applicable. diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md index aca2124e35..fcfe8651a2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md @@ -18,4 +18,6 @@ Returns the mapping of versions to old return type values, if applicable ## Returns +`Map`<[`Version`](../interfaces/Version.md), `Type`\> \| `undefined` + Map of versions to old types, if any diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeBeforeVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeBeforeVersion.md index 2be8a03bba..9577e38be6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeBeforeVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeBeforeVersion.md @@ -20,4 +20,6 @@ getTypeBeforeVersion( ## Returns +`Type` \| `undefined` + get old type if applicable. diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeChangedFrom.md index 7039315ede..cfc7770ff3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeChangedFrom.md @@ -18,4 +18,6 @@ Returns the mapping of versions to old type values, if applicable ## Returns +`Map`<[`Version`](../interfaces/Version.md), `Type`\> \| `undefined` + Map of versions to old types, if any diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getUseDependencies.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getUseDependencies.md index 6fc9813ab1..91e38014de 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getUseDependencies.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getUseDependencies.md @@ -17,3 +17,7 @@ getUseDependencies( | `program` | `Program` | `undefined` | | `target` | `Enum` \| `Namespace` | `undefined` | | `searchEnum` | `boolean` | `true` | + +## Returns + +`Map`<`Namespace`, `Map`<[`Version`](../interfaces/Version.md), [`Version`](../interfaces/Version.md)\> \| [`Version`](../interfaces/Version.md)\> \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersion.md index 7ba5549b34..5e41facaf2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersion.md @@ -15,3 +15,7 @@ Get the version map of the namespace. | :------ | :------ | | `program` | `Program` | | `namespace` | `Namespace` | + +## Returns + +[`VersionMap`](../classes/VersionMap.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionDependencies.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionDependencies.md index 60f81f8d17..d634787c13 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionDependencies.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionDependencies.md @@ -13,3 +13,7 @@ getVersionDependencies(program, namespace): Map | :------ | :------ | | `program` | `Program` | | `namespace` | `Namespace` | + +## Returns + +`Map`<`Namespace`, `Map`<[`Version`](../interfaces/Version.md), [`Version`](../interfaces/Version.md)\> \| [`Version`](../interfaces/Version.md)\> \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionForEnumMember.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionForEnumMember.md index 124598d405..5766333d94 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionForEnumMember.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionForEnumMember.md @@ -13,3 +13,7 @@ getVersionForEnumMember(program, member): Version | undefined | :------ | :------ | | `program` | `Program` | | `member` | `EnumMember` | + +## Returns + +[`Version`](../interfaces/Version.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersions.md index c728ea66a4..16ff101189 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersions.md @@ -13,3 +13,7 @@ getVersions(p, t): [Namespace, VersionMap] | [] | :------ | :------ | | `p` | `Program` | | `t` | `Type` | + +## Returns + +[`Namespace`, [`VersionMap`](../classes/VersionMap.md)] \| [] diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionsForEnum.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionsForEnum.md index f1d43817dd..75d0c4198a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionsForEnum.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionsForEnum.md @@ -13,3 +13,7 @@ getVersionsForEnum(program, en): [Namespace, VersionMap] | [] | :------ | :------ | | `program` | `Program` | | `en` | `Enum` | + +## Returns + +[`Namespace`, [`VersionMap`](../classes/VersionMap.md)] \| [] diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentNameAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentNameAtVersion.md index 8c00bdee96..f10a2a5940 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentNameAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentNameAtVersion.md @@ -17,3 +17,7 @@ hasDifferentNameAtVersion( | `p` | `Program` | | `type` | `Type` | | `version` | `ObjectType` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentReturnTypeAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentReturnTypeAtVersion.md index 5621b96796..9f3c307f8b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentReturnTypeAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentReturnTypeAtVersion.md @@ -17,3 +17,7 @@ hasDifferentReturnTypeAtVersion( | `p` | `Program` | | `type` | `Type` | | `version` | `ObjectType` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentTypeAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentTypeAtVersion.md index 18fcdb6065..56b9d0e896 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentTypeAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentTypeAtVersion.md @@ -17,3 +17,7 @@ hasDifferentTypeAtVersion( | `p` | `Program` | | `type` | `Type` | | `version` | `ObjectType` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/madeOptionalAfter.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/madeOptionalAfter.md index 6d79ee513c..180463b276 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/madeOptionalAfter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/madeOptionalAfter.md @@ -17,3 +17,7 @@ madeOptionalAfter( | `program` | `Program` | | `type` | `Type` | | `versionKey` | `ObjectType` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/resolveVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/resolveVersions.md index 20172beec1..7d2a52fb75 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/resolveVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/resolveVersions.md @@ -15,3 +15,7 @@ Resolve the version to use for all namespace for each of the root namespace vers | :------ | :------ | :------ | | `program` | `Program` | | | `rootNs` | `Namespace` | Root namespace. | + +## Returns + +[`VersionResolution`](../interfaces/VersionResolution.md)[]