diff --git a/common/changes/@typespec/compiler/augment-statement-semicolon_2023-08-30-12-49.json b/common/changes/@typespec/compiler/augment-statement-semicolon_2023-08-30-12-49.json deleted file mode 100644 index 6de1a078c15..00000000000 --- a/common/changes/@typespec/compiler/augment-statement-semicolon_2023-08-30-12-49.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "**Breaking Change** A semicolon is now required after augment decorator statements.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/compiler-ParameterReturnVisibility_2023-08-11-16-42.json b/common/changes/@typespec/compiler/compiler-ParameterReturnVisibility_2023-08-11-16-42.json deleted file mode 100644 index 919557daf4e..00000000000 --- a/common/changes/@typespec/compiler/compiler-ParameterReturnVisibility_2023-08-11-16-42.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Added decorators `@parameterVisibility` and `@returnTypeVisibility`. Added methods `getParameterVisibility` and `getReturnTypeVisibility`. ", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/compiler/configDirectoryFix_2023-08-18-20-14.json b/common/changes/@typespec/compiler/configDirectoryFix_2023-08-18-20-14.json deleted file mode 100644 index 5855d1f6a5c..00000000000 --- a/common/changes/@typespec/compiler/configDirectoryFix_2023-08-18-20-14.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix issue where --config would search the folder hierarchy looking for `tspconfig.yaml`.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/compiler/deprecated-deprecated_2023-08-14-15-51.json b/common/changes/@typespec/compiler/deprecated-deprecated_2023-08-14-15-51.json deleted file mode 100644 index f7132b52247..00000000000 --- a/common/changes/@typespec/compiler/deprecated-deprecated_2023-08-14-15-51.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "**Deprecation** `@deprecated` decorator has been marked as deprecated. Use `#deprecated` directive instead.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/feature-doc-comment-color_2023-08-17-21-42.json b/common/changes/@typespec/compiler/feature-doc-comment-color_2023-08-17-21-42.json deleted file mode 100644 index 755448413f8..00000000000 --- a/common/changes/@typespec/compiler/feature-doc-comment-color_2023-08-17-21-42.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "**IDE** Add coloring for doc comment", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/feature-yaml-ast_2023-08-09-16-14.json b/common/changes/@typespec/compiler/feature-yaml-ast_2023-08-09-16-14.json deleted file mode 100644 index 213a1a3af0f..00000000000 --- a/common/changes/@typespec/compiler/feature-yaml-ast_2023-08-09-16-14.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Changed yaml parser from `js-yaml` to `yaml`", - "type": "none" - }, - { - "packageName": "@typespec/compiler", - "comment": "Parsing and validation of the tspconfig.yaml will not report the error location.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/compiler/fix-circular-prop_2023-09-06-15-32.json b/common/changes/@typespec/compiler/fix-circular-prop_2023-09-06-15-32.json deleted file mode 100644 index 642fba8c088..00000000000 --- a/common/changes/@typespec/compiler/fix-circular-prop_2023-09-06-15-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "**Fix** Stackoverflow when model property reference itself", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-compiler-crash-alias-namespace_2023-09-05-18-03.json b/common/changes/@typespec/compiler/fix-compiler-crash-alias-namespace_2023-09-05-18-03.json deleted file mode 100644 index a2e39296c4f..00000000000 --- a/common/changes/@typespec/compiler/fix-compiler-crash-alias-namespace_2023-09-05-18-03.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "**Fix** Compiler crash when using alias of namespace that has decorators", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-doc-freeze_2023-09-06-22-33.json b/common/changes/@typespec/compiler/fix-doc-freeze_2023-09-06-22-33.json deleted file mode 100644 index aaec925d834..00000000000 --- a/common/changes/@typespec/compiler/fix-doc-freeze_2023-09-06-22-33.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix: Compiler freeze when using invalid token between doc comment and type", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-openapi3-additional-properties_2023-08-09-20-46.json b/common/changes/@typespec/compiler/fix-openapi3-additional-properties_2023-08-09-20-46.json deleted file mode 100644 index 5ea552166e5..00000000000 --- a/common/changes/@typespec/compiler/fix-openapi3-additional-properties_2023-08-09-20-46.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "**Added** validation making sure properties of model are compatible with a base model indexer (using `extends`)", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-relation-recursive-types_2023-09-06-21-08.json b/common/changes/@typespec/compiler/fix-relation-recursive-types_2023-09-06-21-08.json deleted file mode 100644 index be7a54a37c0..00000000000 --- a/common/changes/@typespec/compiler/fix-relation-recursive-types_2023-09-06-21-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix: Crash with when relating recursive types", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/formatter-typo_2023-08-19-05-16.json b/common/changes/@typespec/compiler/formatter-typo_2023-08-19-05-16.json deleted file mode 100644 index aeec4eefdf9..00000000000 --- a/common/changes/@typespec/compiler/formatter-typo_2023-08-19-05-16.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix typo in 'format' error message", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/compiler/playground-linters_2023-09-07-22-00.json b/common/changes/@typespec/compiler/playground-linters_2023-09-07-22-00.json deleted file mode 100644 index d87aadf9490..00000000000 --- a/common/changes/@typespec/compiler/playground-linters_2023-09-07-22-00.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Expose `CompilerOptions` TypeScript type", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/removeWatchForChanges_2023-08-23-22-23.json b/common/changes/@typespec/compiler/removeWatchForChanges_2023-08-23-22-23.json deleted file mode 100644 index 5945164bd23..00000000000 --- a/common/changes/@typespec/compiler/removeWatchForChanges_2023-08-23-22-23.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/report-onvalidate-errors_2023-08-16-18-49.json b/common/changes/@typespec/compiler/report-onvalidate-errors_2023-08-16-18-49.json deleted file mode 100644 index 6aecbaf9f39..00000000000 --- a/common/changes/@typespec/compiler/report-onvalidate-errors_2023-08-16-18-49.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Report library information when crash happen in $onValidate", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/show-node-id-diagnostic_2023-08-14-18-50.json b/common/changes/@typespec/compiler/show-node-id-diagnostic_2023-08-14-18-50.json deleted file mode 100644 index c27025f2ca0..00000000000 --- a/common/changes/@typespec/compiler/show-node-id-diagnostic_2023-08-14-18-50.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Diagnostics reported on nodes with an `id` will see the diagnostic highlight the id instead of the whole node. For example it will show the error on the model name instead of highlighting the entire model.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/http/bodyTDoc_2023-08-25-21-19.json b/common/changes/@typespec/http/bodyTDoc_2023-08-25-21-19.json deleted file mode 100644 index e59b9bb12e2..00000000000 --- a/common/changes/@typespec/http/bodyTDoc_2023-08-25-21-19.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/compiler-ParameterReturnVisibility_2023-08-11-16-42.json b/common/changes/@typespec/http/compiler-ParameterReturnVisibility_2023-08-11-16-42.json deleted file mode 100644 index 6146cb7ce5b..00000000000 --- a/common/changes/@typespec/http/compiler-ParameterReturnVisibility_2023-08-11-16-42.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "Deprecated `getRequestVisibility`. Added methods `getDefaultVisibilityForVerb` and `resolveRequestVisibility`. Use either depending on the situation.", - "type": "none" - } - ], - "packageName": "@typespec/http" -} diff --git a/common/changes/@typespec/http/fix-useauth-link_2023-08-30-11-46.json b/common/changes/@typespec/http/fix-useauth-link_2023-08-30-11-46.json deleted file mode 100644 index e59b9bb12e2..00000000000 --- a/common/changes/@typespec/http/fix-useauth-link_2023-08-30-11-46.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/metadataFix_2023-08-21-21-48.json b/common/changes/@typespec/http/metadataFix_2023-08-21-21-48.json deleted file mode 100644 index e59b9bb12e2..00000000000 --- a/common/changes/@typespec/http/metadataFix_2023-08-21-21-48.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/no-route-containers_2023-08-29-13-37.json b/common/changes/@typespec/http/no-route-containers_2023-08-29-13-37.json deleted file mode 100644 index 4ff225416d4..00000000000 --- a/common/changes/@typespec/http/no-route-containers_2023-08-29-13-37.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "Add validation step to check whether any operation references another operation with a route prefix defined on a parent container. This helps avoid unexpected route changes when using operation references.", - "type": "none" - } - ], - "packageName": "@typespec/http" -} \ No newline at end of file diff --git a/common/changes/@typespec/http/use-auth-error_2023-08-28-14-25.json b/common/changes/@typespec/http/use-auth-error_2023-08-28-14-25.json deleted file mode 100644 index 152cf5de815..00000000000 --- a/common/changes/@typespec/http/use-auth-error_2023-08-28-14-25.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "Avoid runtime errors when `OAuth2Auth` is given invalid `OAuth2Flow` arguments", - "type": "none" - } - ], - "packageName": "@typespec/http" -} \ No newline at end of file diff --git a/common/changes/@typespec/internal-build-utils/feature-pr-artifacts_2023-08-07-17-33.json b/common/changes/@typespec/internal-build-utils/feature-pr-artifacts_2023-08-07-17-33.json deleted file mode 100644 index 24cb1c38e19..00000000000 --- a/common/changes/@typespec/internal-build-utils/feature-pr-artifacts_2023-08-07-17-33.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/internal-build-utils", - "comment": "Add new command to be able to bump version for a PR", - "type": "none" - } - ], - "packageName": "@typespec/internal-build-utils" -} \ No newline at end of file diff --git a/common/changes/@typespec/json-schema/deprecated-deprecated_2023-08-15-18-00.json b/common/changes/@typespec/json-schema/deprecated-deprecated_2023-08-15-18-00.json deleted file mode 100644 index c15d89290ff..00000000000 --- a/common/changes/@typespec/json-schema/deprecated-deprecated_2023-08-15-18-00.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/feature-yaml-ast_2023-08-09-16-14.json b/common/changes/@typespec/json-schema/feature-yaml-ast_2023-08-09-16-14.json deleted file mode 100644 index 45dc5b87f29..00000000000 --- a/common/changes/@typespec/json-schema/feature-yaml-ast_2023-08-09-16-14.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/json-schema", - "comment": "Changed yaml parser from `js-yaml` to `yaml`", - "type": "none" - } - ], - "packageName": "@typespec/json-schema" -} \ No newline at end of file diff --git a/common/changes/@typespec/json-schema/json-schema-decimal_2023-07-20-16-22.json b/common/changes/@typespec/json-schema/json-schema-decimal_2023-07-20-16-22.json deleted file mode 100644 index 155ca8479ec..00000000000 --- a/common/changes/@typespec/json-schema/json-schema-decimal_2023-07-20-16-22.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/json-schema", - "comment": "Support decimal scalar types.", - "type": "none" - } - ], - "packageName": "@typespec/json-schema" -} \ No newline at end of file diff --git a/common/changes/@typespec/lint/report-onvalidate-errors_2023-08-16-18-49.json b/common/changes/@typespec/lint/report-onvalidate-errors_2023-08-16-18-49.json deleted file mode 100644 index 7ca05a5a8df..00000000000 --- a/common/changes/@typespec/lint/report-onvalidate-errors_2023-08-16-18-49.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/lint", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/lint" -} \ No newline at end of file diff --git a/common/changes/@typespec/migrate/feature-yaml-ast_2023-08-09-16-14.json b/common/changes/@typespec/migrate/feature-yaml-ast_2023-08-09-16-14.json deleted file mode 100644 index 0ba5281da7d..00000000000 --- a/common/changes/@typespec/migrate/feature-yaml-ast_2023-08-09-16-14.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/migrate", - "comment": "Changed yaml parser from `js-yaml` to `yaml`", - "type": "none" - } - ], - "packageName": "@typespec/migrate" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/bodyTDoc_2023-08-28-15-54.json b/common/changes/@typespec/openapi3/bodyTDoc_2023-08-28-15-54.json deleted file mode 100644 index d9a70151de5..00000000000 --- a/common/changes/@typespec/openapi3/bodyTDoc_2023-08-28-15-54.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/compiler-ParameterReturnVisibility_2023-08-11-16-42.json b/common/changes/@typespec/openapi3/compiler-ParameterReturnVisibility_2023-08-11-16-42.json deleted file mode 100644 index b6f58e15a42..00000000000 --- a/common/changes/@typespec/openapi3/compiler-ParameterReturnVisibility_2023-08-11-16-42.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Fixed issue where parameters on a PATCH request marked with visibility \"create\" did not appear.", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/feature-yaml-ast_2023-08-09-16-14.json b/common/changes/@typespec/openapi3/feature-yaml-ast_2023-08-09-16-14.json deleted file mode 100644 index 212eec718a3..00000000000 --- a/common/changes/@typespec/openapi3/feature-yaml-ast_2023-08-09-16-14.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Changed yaml parser from `js-yaml` to `yaml`", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/fix-exclusive-min-max_2023-09-05-20-05.json b/common/changes/@typespec/openapi3/fix-exclusive-min-max_2023-09-05-20-05.json deleted file mode 100644 index 270765f8daf..00000000000 --- a/common/changes/@typespec/openapi3/fix-exclusive-min-max_2023-09-05-20-05.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Fix: `exclusiveMinimum` and `exclusiveMaximum` properties are booleans in openapi3", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} diff --git a/common/changes/@typespec/openapi3/fix-oneof_2023-09-05-20-13.json b/common/changes/@typespec/openapi3/fix-oneof_2023-09-05-20-13.json deleted file mode 100644 index 1807bb4acf0..00000000000 --- a/common/changes/@typespec/openapi3/fix-oneof_2023-09-05-20-13.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Use `anyOf` instead of `oneOf` for shared route with different request/response bodies", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/fix-openapi3-additional-properties_2023-08-09-20-46.json b/common/changes/@typespec/openapi3/fix-openapi3-additional-properties_2023-08-09-20-46.json deleted file mode 100644 index d8682ef0d6e..00000000000 --- a/common/changes/@typespec/openapi3/fix-openapi3-additional-properties_2023-08-09-20-46.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Fix handling of `Record` in `model is` and `model extends`", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/prettier-plugin-typespec/feature-yaml-ast_2023-08-09-16-14.json b/common/changes/@typespec/prettier-plugin-typespec/feature-yaml-ast_2023-08-09-16-14.json deleted file mode 100644 index 6c41a3f9663..00000000000 --- a/common/changes/@typespec/prettier-plugin-typespec/feature-yaml-ast_2023-08-09-16-14.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/prettier-plugin-typespec", - "comment": "Changed yaml parser from `js-yaml` to `yaml`", - "type": "none" - } - ], - "packageName": "@typespec/prettier-plugin-typespec" -} \ No newline at end of file diff --git a/common/changes/@typespec/protobuf/protobuf-omit-unreachable-types_2023-08-10-17-22.json b/common/changes/@typespec/protobuf/protobuf-omit-unreachable-types_2023-08-10-17-22.json deleted file mode 100644 index 1a6dcef8665..00000000000 --- a/common/changes/@typespec/protobuf/protobuf-omit-unreachable-types_2023-08-10-17-22.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/protobuf", - "comment": "Added support for the 'omit-unreachable-types' option.", - "type": "none" - } - ], - "packageName": "@typespec/protobuf" -} \ No newline at end of file diff --git a/common/changes/@typespec/protobuf/protobuf-treat-empty-as-wellknown_2023-08-10-17-26.json b/common/changes/@typespec/protobuf/protobuf-treat-empty-as-wellknown_2023-08-10-17-26.json deleted file mode 100644 index 7707f8e0b51..00000000000 --- a/common/changes/@typespec/protobuf/protobuf-treat-empty-as-wellknown_2023-08-10-17-26.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/protobuf", - "comment": "Automatically convert empty operation parameters into a reference to 'google.protobuf.Empty' instead of synthesizing an empty model.", - "type": "none" - } - ], - "packageName": "@typespec/protobuf" -} \ No newline at end of file diff --git a/common/changes/@typespec/protobuf/show-node-id-diagnostic_2023-08-14-19-16.json b/common/changes/@typespec/protobuf/show-node-id-diagnostic_2023-08-14-19-16.json deleted file mode 100644 index 8f48e4e9521..00000000000 --- a/common/changes/@typespec/protobuf/show-node-id-diagnostic_2023-08-14-19-16.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/versioning/fixChangeTypeFrom_2023-09-08-17-28.json b/common/changes/@typespec/versioning/fixChangeTypeFrom_2023-09-08-17-28.json deleted file mode 100644 index 4946aa74b73..00000000000 --- a/common/changes/@typespec/versioning/fixChangeTypeFrom_2023-09-08-17-28.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/versioning", - "comment": "Fixed issue with `@typeChangedFrom` complaining about incorrect versioned references.", - "type": "none" - } - ], - "packageName": "@typespec/versioning" -} \ No newline at end of file diff --git a/common/changes/tmlanguage-generator/upgrade-deps_2023-08-25-01-08.json b/common/changes/tmlanguage-generator/upgrade-deps_2023-08-25-01-08.json deleted file mode 100644 index e9b6a685d7f..00000000000 --- a/common/changes/tmlanguage-generator/upgrade-deps_2023-08-25-01-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "tmlanguage-generator", - "comment": "Upgrade dependency \"plist\" to latest", - "type": "patch" - } - ], - "packageName": "tmlanguage-generator" -} \ No newline at end of file diff --git a/common/changes/typespec-vscode/feature-doc-comment-color_2023-09-07-17-48.json b/common/changes/typespec-vscode/feature-doc-comment-color_2023-09-07-17-48.json deleted file mode 100644 index 61f0dadf97a..00000000000 --- a/common/changes/typespec-vscode/feature-doc-comment-color_2023-09-07-17-48.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "typespec-vscode", - "comment": "Add colors definition for `param`", - "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 7c4445a331a..757b80ae343 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -17,13 +17,13 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-plugin-typespec c8: specifier: ~8.0.0 @@ -68,7 +68,7 @@ importers: specifier: ~3.0.1 version: 3.0.1(rollup@3.24.0) '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler rollup: specifier: ~3.24.0 @@ -81,7 +81,7 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.0 @@ -175,10 +175,10 @@ importers: specifier: ~17.0.24 version: 17.0.24 '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../internal-build-utils c8: specifier: ~8.0.0 @@ -211,7 +211,7 @@ importers: specifier: ~0.5.19 version: 0.5.19 tmlanguage-generator: - specifier: workspace:~0.4.3 + specifier: workspace:~0.4.4 version: link:../tmlanguage-generator typescript: specifier: ~5.1.3 @@ -272,7 +272,7 @@ importers: specifier: ^6.2.1 version: 6.2.1(eslint@8.42.0)(typescript@5.1.3) '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.0 @@ -330,10 +330,10 @@ importers: specifier: ~18.2.4 version: 18.2.4 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.0 @@ -366,16 +366,16 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-plugin-typespec '@typespec/library-linter': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -424,7 +424,7 @@ importers: specifier: ~17.0.24 version: 17.0.24 '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.0 @@ -464,19 +464,19 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-plugin-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../internal-build-utils '@typespec/library-linter': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -518,10 +518,10 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.0 @@ -554,13 +554,13 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-plugin-typespec c8: specifier: ~8.0.0 @@ -587,7 +587,7 @@ importers: ../../packages/migrate: dependencies: '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/compiler-v0.37': specifier: npm:@cadl-lang/compiler@0.37.0 @@ -633,10 +633,10 @@ importers: specifier: ~17.0.24 version: 17.0.24 '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-plugin-typespec c8: specifier: ~8.0.0 @@ -669,22 +669,22 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../http '@typespec/library-linter': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../library-linter '@typespec/rest': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../rest '@typespec/tspd': specifier: workspace:~0.46.0 @@ -724,31 +724,31 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../http '@typespec/library-linter': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../library-linter '@typespec/openapi': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../openapi '@typespec/rest': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../rest '@typespec/tspd': specifier: workspace:~0.46.0 version: link:../tspd '@typespec/versioning': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../versioning c8: specifier: ~8.0.0 @@ -784,28 +784,28 @@ importers: specifier: ~2.0.190 version: 2.0.190(react@18.2.0) '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/html-program-viewer': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../html-program-viewer '@typespec/http': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../http '@typespec/openapi': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../openapi3 '@typespec/protobuf': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../protobuf '@typespec/rest': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../rest '@typespec/versioning': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../versioning debounce: specifier: ~1.2.1 @@ -869,7 +869,7 @@ importers: specifier: workspace:~0.1.0 version: link:../bundler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@vitejs/plugin-react': specifier: ~4.0.0 @@ -911,34 +911,34 @@ importers: specifier: ^11.11.1 version: 11.11.1(@types/react@18.2.9)(react@18.2.0) '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/html-program-viewer': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../html-program-viewer '@typespec/http': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../http '@typespec/json-schema': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../json-schema '@typespec/openapi': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../openapi3 '@typespec/playground': specifier: workspace:~0.44.0 version: link:../playground '@typespec/protobuf': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../protobuf '@typespec/rest': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../rest '@typespec/versioning': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../versioning react: specifier: ~18.2.0 @@ -978,7 +978,7 @@ importers: specifier: workspace:~0.1.0 version: link:../bundler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@vitejs/plugin-react': specifier: ~4.0.0 @@ -1033,10 +1033,10 @@ importers: specifier: ~5.0.2 version: 5.0.2(rollup@3.24.0) '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/internal-build-utils': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../internal-build-utils mocha: specifier: ~10.2.0 @@ -1066,13 +1066,13 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-plugin-typespec '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1105,19 +1105,19 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../http '@typespec/library-linter': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1150,25 +1150,25 @@ importers: specifier: workspace:~0.45.0 version: link:../best-practices '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/html-program-viewer': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../html-program-viewer '@typespec/http': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../http '@typespec/openapi': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../openapi3 '@typespec/rest': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../rest '@typespec/versioning': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../versioning devDependencies: '@types/mocha': @@ -1178,10 +1178,10 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../internal-build-utils autorest: specifier: ~3.3.2 @@ -1208,7 +1208,7 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/internal-build-utils': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../internal-build-utils ecmarkup: specifier: ~12.0.3 @@ -1230,7 +1230,7 @@ importers: specifier: ~3.0.2 version: 3.0.2 '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec eslint: specifier: ^8.42.0 @@ -1245,7 +1245,7 @@ importers: ../../packages/tspd: dependencies: '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler picocolors: specifier: ~1.0.0 @@ -1270,10 +1270,10 @@ importers: specifier: ~17.0.24 version: 17.0.24 '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/prettier-plugin-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../prettier-plugin-typespec c8: specifier: ~8.0.0 @@ -1309,10 +1309,10 @@ importers: ../../packages/typespec-vs: devDependencies: '@typespec/internal-build-utils': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../internal-build-utils typespec-vscode: - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../typespec-vscode ../../packages/typespec-vscode: @@ -1333,13 +1333,13 @@ importers: specifier: ~1.53.0 version: 1.53.0 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../internal-build-utils '@vscode/vsce': specifier: ~2.15.0 @@ -1381,16 +1381,16 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-plugin-typespec '@typespec/library-linter': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1454,28 +1454,28 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.47.1 + specifier: workspace:~0.48.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../eslint-config-typespec '@typespec/http': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../http '@typespec/json-schema': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../json-schema '@typespec/openapi': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../openapi3 '@typespec/protobuf': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../protobuf '@typespec/rest': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../rest '@typespec/spec': specifier: workspace:* @@ -1484,7 +1484,7 @@ importers: specifier: workspace:~0.46.0 version: link:../tspd '@typespec/versioning': - specifier: workspace:~0.47.0 + specifier: workspace:~0.48.0 version: link:../versioning dotenv: specifier: ~16.1.3 diff --git a/common/config/rush/version-policies.json b/common/config/rush/version-policies.json index 3466764d6a3..ec4587a877b 100644 --- a/common/config/rush/version-policies.json +++ b/common/config/rush/version-policies.json @@ -12,7 +12,7 @@ { "definitionName": "lockStepVersion", "policyName": "typespec", - "version": "0.47.0", + "version": "0.48.0", "nextBump": "minor" } // { diff --git a/packages/best-practices/package.json b/packages/best-practices/package.json index b8d76b5e4a3..cd1a75f82bb 100644 --- a/packages/best-practices/package.json +++ b/packages/best-practices/package.json @@ -39,14 +39,14 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.47.1" + "@typespec/compiler": "workspace:~0.48.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", - "@typespec/eslint-plugin": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/eslint-plugin": "workspace:~0.48.0", "eslint": "^8.42.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.0", diff --git a/packages/bundler/package.json b/packages/bundler/package.json index a2119781f5d..61bcf433221 100644 --- a/packages/bundler/package.json +++ b/packages/bundler/package.json @@ -38,7 +38,7 @@ "!dist/test/**" ], "dependencies": { - "@typespec/compiler": "workspace:~0.47.1", + "@typespec/compiler": "workspace:~0.48.0", "@rollup/plugin-virtual": "~3.0.1", "@rollup/plugin-commonjs": "~25.0.0", "@rollup/plugin-json": "~6.0.0", @@ -50,7 +50,7 @@ "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", "eslint": "^8.42.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.0", diff --git a/packages/compiler/CHANGELOG.json b/packages/compiler/CHANGELOG.json index f0a6d14cfd6..c31f78f1ee6 100644 --- a/packages/compiler/CHANGELOG.json +++ b/packages/compiler/CHANGELOG.json @@ -1,6 +1,68 @@ { "name": "@typespec/compiler", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/compiler_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": { + "none": [ + { + "comment": "**Breaking Change** A semicolon is now required after augment decorator statements." + }, + { + "comment": "Added decorators `@parameterVisibility` and `@returnTypeVisibility`. Added methods `getParameterVisibility` and `getReturnTypeVisibility`. " + }, + { + "comment": "Fix issue where --config would search the folder hierarchy looking for `tspconfig.yaml`." + }, + { + "comment": "**Deprecation** `@deprecated` decorator has been marked as deprecated. Use `#deprecated` directive instead." + }, + { + "comment": "**IDE** Add coloring for doc comment" + }, + { + "comment": "Changed yaml parser from `js-yaml` to `yaml`" + }, + { + "comment": "Parsing and validation of the tspconfig.yaml will not report the error location." + }, + { + "comment": "**Fix** Stackoverflow when model property reference itself" + }, + { + "comment": "**Fix** Compiler crash when using alias of namespace that has decorators" + }, + { + "comment": "Fix: Compiler freeze when using invalid token between doc comment and type" + }, + { + "comment": "**Added** validation making sure properties of model are compatible with a base model indexer (using `extends`)" + }, + { + "comment": "Fix: Crash with when relating recursive types" + }, + { + "comment": "Fix typo in 'format' error message" + }, + { + "comment": "Expose `CompilerOptions` TypeScript type" + }, + { + "comment": "Report library information when crash happen in $onValidate" + }, + { + "comment": "Diagnostics reported on nodes with an `id` will see the diagnostic highlight the id instead of the whole node. For example it will show the error on the model name instead of highlighting the entire model." + } + ], + "dependency": [ + { + "comment": "Updating dependency \"tmlanguage-generator\" from `~0.4.3` to `~0.4.4`" + } + ] + } + }, { "version": "0.47.1", "tag": "@typespec/compiler_v0.47.1", diff --git a/packages/compiler/CHANGELOG.md b/packages/compiler/CHANGELOG.md index ecbb8305e0f..13c26402702 100644 --- a/packages/compiler/CHANGELOG.md +++ b/packages/compiler/CHANGELOG.md @@ -1,6 +1,28 @@ # Change Log - @typespec/compiler -This log was last generated on Thu, 10 Aug 2023 20:18:00 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +### Updates + +- **Breaking Change** A semicolon is now required after augment decorator statements. +- Added decorators `@parameterVisibility` and `@returnTypeVisibility`. Added methods `getParameterVisibility` and `getReturnTypeVisibility`. +- Fix issue where --config would search the folder hierarchy looking for `tspconfig.yaml`. +- **Deprecation** `@deprecated` decorator has been marked as deprecated. Use `#deprecated` directive instead. +- **IDE** Add coloring for doc comment +- Changed yaml parser from `js-yaml` to `yaml` +- Parsing and validation of the tspconfig.yaml will not report the error location. +- **Fix** Stackoverflow when model property reference itself +- **Fix** Compiler crash when using alias of namespace that has decorators +- Fix: Compiler freeze when using invalid token between doc comment and type +- **Added** validation making sure properties of model are compatible with a base model indexer (using `extends`) +- Fix: Crash with when relating recursive types +- Fix typo in 'format' error message +- Expose `CompilerOptions` TypeScript type +- Report library information when crash happen in $onValidate +- Diagnostics reported on nodes with an `id` will see the diagnostic highlight the id instead of the whole node. For example it will show the error on the model name instead of highlighting the entire model. ## 0.47.1 Thu, 10 Aug 2023 20:18:00 GMT diff --git a/packages/compiler/package.json b/packages/compiler/package.json index 257afec9f60..dde2f87def5 100644 --- a/packages/compiler/package.json +++ b/packages/compiler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/compiler", - "version": "0.47.1", + "version": "0.48.0", "description": "TypeSpec Compiler Preview", "author": "Microsoft Corporation", "license": "MIT", @@ -95,8 +95,8 @@ "@types/prompts": "~2.4.3", "@types/semver": "^7.3.13", "@types/yargs": "~17.0.24", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", - "@typespec/internal-build-utils": "workspace:~0.47.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/internal-build-utils": "workspace:~0.48.0", "eslint": "^8.42.0", "grammarkdown": "~3.2.0", "mocha": "~10.2.0", @@ -106,7 +106,7 @@ "prettier-plugin-organize-imports": "~3.2.0", "source-map-support": "~0.5.19", "rimraf": "~5.0.1", - "tmlanguage-generator": "workspace:~0.4.3", + "tmlanguage-generator": "workspace:~0.4.4", "typescript": "~5.1.3", "vscode-oniguruma": "~1.7.0", "vscode-textmate": "~9.0.0", diff --git a/packages/eslint-config-typespec/CHANGELOG.json b/packages/eslint-config-typespec/CHANGELOG.json index 759c7d68a3c..b6fbcfe2765 100644 --- a/packages/eslint-config-typespec/CHANGELOG.json +++ b/packages/eslint-config-typespec/CHANGELOG.json @@ -1,6 +1,12 @@ { "name": "@typespec/eslint-config-typespec", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/eslint-config-typespec_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": {} + }, { "version": "0.47.0", "tag": "@typespec/eslint-config-typespec_v0.47.0", diff --git a/packages/eslint-config-typespec/CHANGELOG.md b/packages/eslint-config-typespec/CHANGELOG.md index 820d4ac809b..393f9aa5d63 100644 --- a/packages/eslint-config-typespec/CHANGELOG.md +++ b/packages/eslint-config-typespec/CHANGELOG.md @@ -1,6 +1,11 @@ # Change Log - @typespec/eslint-config-typespec -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +_Version update only_ ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/eslint-config-typespec/package.json b/packages/eslint-config-typespec/package.json index 981170b02d3..5c83ce82e4e 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.47.0", + "version": "0.48.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 a4fc7da5462..8b8ac0650c9 100644 --- a/packages/eslint-plugin-typespec/CHANGELOG.json +++ b/packages/eslint-plugin-typespec/CHANGELOG.json @@ -1,6 +1,12 @@ { "name": "@typespec/eslint-plugin", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/eslint-plugin_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": {} + }, { "version": "0.47.0", "tag": "@typespec/eslint-plugin_v0.47.0", diff --git a/packages/eslint-plugin-typespec/CHANGELOG.md b/packages/eslint-plugin-typespec/CHANGELOG.md index 94e92a93fad..1a620576d42 100644 --- a/packages/eslint-plugin-typespec/CHANGELOG.md +++ b/packages/eslint-plugin-typespec/CHANGELOG.md @@ -1,6 +1,11 @@ # Change Log - @typespec/eslint-plugin -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +_Version update only_ ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/eslint-plugin-typespec/package.json b/packages/eslint-plugin-typespec/package.json index 7a6034a6ac2..0f60225d12f 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.47.0", + "version": "0.48.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.47.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", "@typescript-eslint/parser": "^6.2.1", "eslint": "^8.42.0", "mocha": "~10.2.0", diff --git a/packages/html-program-viewer/CHANGELOG.json b/packages/html-program-viewer/CHANGELOG.json index ff5b5ad2ea2..6a75ffb045f 100644 --- a/packages/html-program-viewer/CHANGELOG.json +++ b/packages/html-program-viewer/CHANGELOG.json @@ -1,6 +1,12 @@ { "name": "@typespec/html-program-viewer", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/html-program-viewer_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": {} + }, { "version": "0.47.0", "tag": "@typespec/html-program-viewer_v0.47.0", diff --git a/packages/html-program-viewer/CHANGELOG.md b/packages/html-program-viewer/CHANGELOG.md index 122e2277ba0..49609894bd2 100644 --- a/packages/html-program-viewer/CHANGELOG.md +++ b/packages/html-program-viewer/CHANGELOG.md @@ -1,6 +1,11 @@ # Change Log - @typespec/html-program-viewer -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +_Version update only_ ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/html-program-viewer/package.json b/packages/html-program-viewer/package.json index ef48f02ff91..a3303b97e7c 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.47.0", + "version": "0.48.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting an html view of the program.", "homepage": "https://microsoft.github.io/typespec", @@ -51,7 +51,7 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.47.1" + "@typespec/compiler": "workspace:~0.48.0" }, "dependencies": { "prettier": "~3.0.1", @@ -65,8 +65,8 @@ "@types/node": "~18.11.9", "@types/react": "~18.2.9", "@types/react-dom": "~18.2.4", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", "@babel/core": "^7.0.0", "eslint": "^8.42.0", "mocha": "~10.2.0", diff --git a/packages/http/CHANGELOG.json b/packages/http/CHANGELOG.json index f5a09df1fac..a2ba38cd4dc 100644 --- a/packages/http/CHANGELOG.json +++ b/packages/http/CHANGELOG.json @@ -1,6 +1,24 @@ { "name": "@typespec/http", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/http_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": { + "none": [ + { + "comment": "Deprecated `getRequestVisibility`. Added methods `getDefaultVisibilityForVerb` and `resolveRequestVisibility`. Use either depending on the situation." + }, + { + "comment": "Add validation step to check whether any operation references another operation with a route prefix defined on a parent container. This helps avoid unexpected route changes when using operation references." + }, + { + "comment": "Avoid runtime errors when `OAuth2Auth` is given invalid `OAuth2Flow` arguments" + } + ] + } + }, { "version": "0.47.0", "tag": "@typespec/http_v0.47.0", diff --git a/packages/http/CHANGELOG.md b/packages/http/CHANGELOG.md index 443049d5052..3f517659f98 100644 --- a/packages/http/CHANGELOG.md +++ b/packages/http/CHANGELOG.md @@ -1,6 +1,15 @@ # Change Log - @typespec/http -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +### Updates + +- Deprecated `getRequestVisibility`. Added methods `getDefaultVisibilityForVerb` and `resolveRequestVisibility`. Use either depending on the situation. +- Add validation step to check whether any operation references another operation with a route prefix defined on a parent container. This helps avoid unexpected route changes when using operation references. +- Avoid runtime errors when `OAuth2Auth` is given invalid `OAuth2Flow` arguments ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/http/package.json b/packages/http/package.json index 934abbfc3f8..9404403793f 100644 --- a/packages/http/package.json +++ b/packages/http/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/http", - "version": "0.47.0", + "version": "0.48.0", "author": "Microsoft Corporation", "description": "TypeSpec HTTP protocol binding", "homepage": "https://github.com/microsoft/typespec", @@ -53,15 +53,15 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.47.1" + "@typespec/compiler": "workspace:~0.48.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", - "@typespec/library-linter": "workspace:~0.47.0", - "@typespec/eslint-plugin": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/library-linter": "workspace:~0.48.0", + "@typespec/eslint-plugin": "workspace:~0.48.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.42.0", "mocha": "~10.2.0", diff --git a/packages/internal-build-utils/CHANGELOG.json b/packages/internal-build-utils/CHANGELOG.json index c953ea00a5e..79bb42d9959 100644 --- a/packages/internal-build-utils/CHANGELOG.json +++ b/packages/internal-build-utils/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/internal-build-utils", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/internal-build-utils_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": { + "none": [ + { + "comment": "Add new command to be able to bump version for a PR" + } + ] + } + }, { "version": "0.47.0", "tag": "@typespec/internal-build-utils_v0.47.0", diff --git a/packages/internal-build-utils/CHANGELOG.md b/packages/internal-build-utils/CHANGELOG.md index 423d0e0d819..031b315cc59 100644 --- a/packages/internal-build-utils/CHANGELOG.md +++ b/packages/internal-build-utils/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/internal-build-utils -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +### Updates + +- Add new command to be able to bump version for a PR ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/internal-build-utils/package.json b/packages/internal-build-utils/package.json index b8ca2b3e5fa..36792cd8778 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.47.0", + "version": "0.48.0", "author": "Microsoft Corporation", "description": "Internal library to TypeSpec providing helpers to build.", "homepage": "https://microsoft.github.io/typespec", @@ -47,7 +47,7 @@ "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", "@types/yargs": "~17.0.24", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", "eslint": "^8.42.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.0", diff --git a/packages/json-schema/CHANGELOG.json b/packages/json-schema/CHANGELOG.json index 7d00a245af8..8aa6c512e90 100644 --- a/packages/json-schema/CHANGELOG.json +++ b/packages/json-schema/CHANGELOG.json @@ -1,6 +1,21 @@ { "name": "@typespec/json-schema", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/json-schema_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": { + "none": [ + { + "comment": "Changed yaml parser from `js-yaml` to `yaml`" + }, + { + "comment": "Support decimal scalar types." + } + ] + } + }, { "version": "0.47.0", "tag": "@typespec/json-schema_v0.47.0", diff --git a/packages/json-schema/CHANGELOG.md b/packages/json-schema/CHANGELOG.md index fa4f629b6f1..fdc1d5f78f6 100644 --- a/packages/json-schema/CHANGELOG.md +++ b/packages/json-schema/CHANGELOG.md @@ -1,6 +1,14 @@ # Change Log - @typespec/json-schema -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +### Updates + +- Changed yaml parser from `js-yaml` to `yaml` +- Support decimal scalar types. ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/json-schema/package.json b/packages/json-schema/package.json index d96e05a74f6..d0a3f70e107 100644 --- a/packages/json-schema/package.json +++ b/packages/json-schema/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/json-schema", - "version": "0.47.0", + "version": "0.48.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.47.1" + "@typespec/compiler": "workspace:~0.48.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/library-linter": "workspace:~0.47.0", - "@typespec/eslint-plugin": "workspace:~0.47.0", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/library-linter": "workspace:~0.48.0", + "@typespec/eslint-plugin": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.42.0", "mocha": "~10.2.0", @@ -61,7 +61,7 @@ "rimraf": "~5.0.1", "typescript": "~5.1.3", "ajv": "~8.12.0", - "@typespec/internal-build-utils": "workspace:~0.47.0", + "@typespec/internal-build-utils": "workspace:~0.48.0", "ajv-formats": "~2.1.1" }, "dependencies": { diff --git a/packages/library-linter/CHANGELOG.json b/packages/library-linter/CHANGELOG.json index 938da807677..a7417cfae13 100644 --- a/packages/library-linter/CHANGELOG.json +++ b/packages/library-linter/CHANGELOG.json @@ -1,6 +1,12 @@ { "name": "@typespec/library-linter", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/library-linter_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": {} + }, { "version": "0.47.0", "tag": "@typespec/library-linter_v0.47.0", diff --git a/packages/library-linter/CHANGELOG.md b/packages/library-linter/CHANGELOG.md index cb73e497edd..f303ef57a8e 100644 --- a/packages/library-linter/CHANGELOG.md +++ b/packages/library-linter/CHANGELOG.md @@ -1,6 +1,11 @@ # Change Log - @typespec/library-linter -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +_Version update only_ ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/library-linter/package.json b/packages/library-linter/package.json index 7fc04caf4d1..dd826e6aa8c 100644 --- a/packages/library-linter/package.json +++ b/packages/library-linter/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/library-linter", - "version": "0.47.0", + "version": "0.48.0", "author": "Microsoft Corporation", "description": "TypeSpec library for linting another library.", "homepage": "https://microsoft.github.io/typespec", @@ -51,13 +51,13 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.47.1" + "@typespec/compiler": "workspace:~0.48.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", "eslint": "^8.42.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.0", diff --git a/packages/lint/CHANGELOG.json b/packages/lint/CHANGELOG.json index 9255a79e653..4afd156bb73 100644 --- a/packages/lint/CHANGELOG.json +++ b/packages/lint/CHANGELOG.json @@ -1,6 +1,12 @@ { "name": "@typespec/lint", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/lint_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": {} + }, { "version": "0.47.0", "tag": "@typespec/lint_v0.47.0", diff --git a/packages/lint/CHANGELOG.md b/packages/lint/CHANGELOG.md index 1fd07db89ef..aec9c7b0bfc 100644 --- a/packages/lint/CHANGELOG.md +++ b/packages/lint/CHANGELOG.md @@ -1,6 +1,11 @@ # Change Log - @typespec/lint -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +_Version update only_ ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/lint/package.json b/packages/lint/package.json index e648f015e2f..6297d872fab 100644 --- a/packages/lint/package.json +++ b/packages/lint/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/lint", - "version": "0.47.0", + "version": "0.48.0", "author": "Microsoft Corporation", "description": "**DEPRECATED** Use typespec built-in linter.", "homepage": "https://microsoft.github.io/typespec", @@ -50,14 +50,14 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.47.1" + "@typespec/compiler": "workspace:~0.48.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", - "@typespec/eslint-plugin": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/eslint-plugin": "workspace:~0.48.0", "eslint": "^8.42.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.0", diff --git a/packages/migrate/CHANGELOG.json b/packages/migrate/CHANGELOG.json index 614b4a8c732..57080fc01c6 100644 --- a/packages/migrate/CHANGELOG.json +++ b/packages/migrate/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/migrate", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/migrate_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": { + "none": [ + { + "comment": "Changed yaml parser from `js-yaml` to `yaml`" + } + ] + } + }, { "version": "0.47.0", "tag": "@typespec/migrate_v0.47.0", diff --git a/packages/migrate/CHANGELOG.md b/packages/migrate/CHANGELOG.md index e9bd5165223..c9e96c6ab0d 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 Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +### Updates + +- Changed yaml parser from `js-yaml` to `yaml` ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/migrate/package.json b/packages/migrate/package.json index ba83f8959df..714c41233b2 100644 --- a/packages/migrate/package.json +++ b/packages/migrate/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/migrate", - "version": "0.47.0", + "version": "0.48.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.47.1", + "@typespec/compiler": "workspace:~0.48.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.3.13", "@types/yargs": "~17.0.24", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", - "@typespec/eslint-plugin": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/eslint-plugin": "workspace:~0.48.0", "c8": "~8.0.0", "eslint": "^8.42.0", "mocha": "~10.2.0", diff --git a/packages/openapi/CHANGELOG.json b/packages/openapi/CHANGELOG.json index 619563d6020..373ebf2fb98 100644 --- a/packages/openapi/CHANGELOG.json +++ b/packages/openapi/CHANGELOG.json @@ -1,6 +1,12 @@ { "name": "@typespec/openapi", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/openapi_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": {} + }, { "version": "0.47.0", "tag": "@typespec/openapi_v0.47.0", diff --git a/packages/openapi/CHANGELOG.md b/packages/openapi/CHANGELOG.md index a8376a5de80..b80c499db40 100644 --- a/packages/openapi/CHANGELOG.md +++ b/packages/openapi/CHANGELOG.md @@ -1,6 +1,11 @@ # Change Log - @typespec/openapi -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +_Version update only_ ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/openapi/package.json b/packages/openapi/package.json index 3578b422081..2eb86f1724f 100644 --- a/packages/openapi/package.json +++ b/packages/openapi/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi", - "version": "0.47.0", + "version": "0.48.0", "author": "Microsoft Corporation", "description": "TypeSpec library providing OpenAPI concepts", "homepage": "https://microsoft.github.io/typespec", @@ -53,19 +53,19 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/http": "workspace:~0.47.0", - "@typespec/rest": "workspace:~0.47.0" + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/http": "workspace:~0.48.0", + "@typespec/rest": "workspace:~0.48.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/http": "workspace:~0.47.0", - "@typespec/rest": "workspace:~0.47.0", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", - "@typespec/library-linter": "workspace:~0.47.0", - "@typespec/eslint-plugin": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/http": "workspace:~0.48.0", + "@typespec/rest": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/library-linter": "workspace:~0.48.0", + "@typespec/eslint-plugin": "workspace:~0.48.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.42.0", "mocha": "~10.2.0", diff --git a/packages/openapi3/CHANGELOG.json b/packages/openapi3/CHANGELOG.json index f336032df06..9b6d24717f8 100644 --- a/packages/openapi3/CHANGELOG.json +++ b/packages/openapi3/CHANGELOG.json @@ -1,6 +1,30 @@ { "name": "@typespec/openapi3", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/openapi3_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": { + "none": [ + { + "comment": "Fixed issue where parameters on a PATCH request marked with visibility \"create\" did not appear." + }, + { + "comment": "Changed yaml parser from `js-yaml` to `yaml`" + }, + { + "comment": "Fix: `exclusiveMinimum` and `exclusiveMaximum` properties are booleans in openapi3" + }, + { + "comment": "Use `anyOf` instead of `oneOf` for shared route with different request/response bodies" + }, + { + "comment": "Fix handling of `Record` in `model is` and `model extends`" + } + ] + } + }, { "version": "0.47.0", "tag": "@typespec/openapi3_v0.47.0", diff --git a/packages/openapi3/CHANGELOG.md b/packages/openapi3/CHANGELOG.md index 6c185d5719f..69426b46b24 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 Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +### Updates + +- Fixed issue where parameters on a PATCH request marked with visibility "create" did not appear. +- Changed yaml parser from `js-yaml` to `yaml` +- Fix: `exclusiveMinimum` and `exclusiveMaximum` properties are booleans in openapi3 +- Use `anyOf` instead of `oneOf` for shared route with different request/response bodies +- Fix handling of `Record` in `model is` and `model extends` ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/openapi3/package.json b/packages/openapi3/package.json index 630da2b910c..4d6662b48ef 100644 --- a/packages/openapi3/package.json +++ b/packages/openapi3/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi3", - "version": "0.47.0", + "version": "0.48.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding", "homepage": "https://microsoft.github.io/typespec", @@ -56,23 +56,23 @@ "yaml": "~2.3.1" }, "peerDependencies": { - "@typespec/versioning": "workspace:~0.47.0", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/http": "workspace:~0.47.0", - "@typespec/rest": "workspace:~0.47.0", - "@typespec/openapi": "workspace:~0.47.0" + "@typespec/versioning": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/http": "workspace:~0.48.0", + "@typespec/rest": "workspace:~0.48.0", + "@typespec/openapi": "workspace:~0.48.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/http": "workspace:~0.47.0", - "@typespec/rest": "workspace:~0.47.0", - "@typespec/openapi": "workspace:~0.47.0", - "@typespec/versioning": "workspace:~0.47.0", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", - "@typespec/library-linter": "workspace:~0.47.0", - "@typespec/eslint-plugin": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/http": "workspace:~0.48.0", + "@typespec/rest": "workspace:~0.48.0", + "@typespec/openapi": "workspace:~0.48.0", + "@typespec/versioning": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/library-linter": "workspace:~0.48.0", + "@typespec/eslint-plugin": "workspace:~0.48.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.42.0", "mocha": "~10.2.0", diff --git a/packages/playground-website/package.json b/packages/playground-website/package.json index 7764f4480e4..aac42681aab 100644 --- a/packages/playground-website/package.json +++ b/packages/playground-website/package.json @@ -42,15 +42,15 @@ ], "dependencies": { "@typespec/playground": "workspace:~0.44.0", - "@typespec/versioning": "workspace:~0.47.0", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/http": "workspace:~0.47.0", - "@typespec/rest": "workspace:~0.47.0", - "@typespec/openapi3": "workspace:~0.47.0", - "@typespec/json-schema": "workspace:~0.47.0", - "@typespec/openapi": "workspace:~0.47.0", - "@typespec/protobuf": "workspace:~0.47.0", - "@typespec/html-program-viewer": "workspace:~0.47.0", + "@typespec/versioning": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/http": "workspace:~0.48.0", + "@typespec/rest": "workspace:~0.48.0", + "@typespec/openapi3": "workspace:~0.48.0", + "@typespec/json-schema": "workspace:~0.48.0", + "@typespec/openapi": "workspace:~0.48.0", + "@typespec/protobuf": "workspace:~0.48.0", + "@typespec/html-program-viewer": "workspace:~0.48.0", "@emotion/react": "^11.11.1", "react-dom": "~18.2.0", "react": "~18.2.0" @@ -66,7 +66,7 @@ "@types/swagger-ui-react": "^4.11.0", "@types/swagger-ui": "~3.52.0", "@typespec/bundler": "workspace:~0.1.0", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", "@vitejs/plugin-react": "~4.0.0", "c8": "~8.0.0", "cross-env": "~7.0.3", diff --git a/packages/playground/package.json b/packages/playground/package.json index 002e35f83ae..c7c83236124 100644 --- a/packages/playground/package.json +++ b/packages/playground/package.json @@ -51,14 +51,14 @@ "@emotion/react": "^11.11.1", "@fluentui/react-components": "~9.21.0", "@fluentui/react-icons": "~2.0.190", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/html-program-viewer": "workspace:~0.47.0", - "@typespec/http": "workspace:~0.47.0", - "@typespec/openapi": "workspace:~0.47.0", - "@typespec/openapi3": "workspace:~0.47.0", - "@typespec/protobuf": "workspace:~0.47.0", - "@typespec/rest": "workspace:~0.47.0", - "@typespec/versioning": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/html-program-viewer": "workspace:~0.48.0", + "@typespec/http": "workspace:~0.48.0", + "@typespec/openapi": "workspace:~0.48.0", + "@typespec/openapi3": "workspace:~0.48.0", + "@typespec/protobuf": "workspace:~0.48.0", + "@typespec/rest": "workspace:~0.48.0", + "@typespec/versioning": "workspace:~0.48.0", "debounce": "~1.2.1", "lzutf8": "0.6.3", "monaco-editor": "~0.39.0", @@ -81,7 +81,7 @@ "@types/swagger-ui-react": "^4.11.0", "@types/swagger-ui": "~3.52.0", "@typespec/bundler": "workspace:~0.1.0", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", "@vitejs/plugin-react": "~4.0.0", "c8": "~8.0.0", "cross-env": "~7.0.3", diff --git a/packages/prettier-plugin-typespec/CHANGELOG.json b/packages/prettier-plugin-typespec/CHANGELOG.json index 042014afc0c..a4fa0dc0d7b 100644 --- a/packages/prettier-plugin-typespec/CHANGELOG.json +++ b/packages/prettier-plugin-typespec/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/prettier-plugin-typespec", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/prettier-plugin-typespec_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": { + "none": [ + { + "comment": "Changed yaml parser from `js-yaml` to `yaml`" + } + ] + } + }, { "version": "0.47.0", "tag": "@typespec/prettier-plugin-typespec_v0.47.0", diff --git a/packages/prettier-plugin-typespec/CHANGELOG.md b/packages/prettier-plugin-typespec/CHANGELOG.md index 0a88c890970..5455ad6fae9 100644 --- a/packages/prettier-plugin-typespec/CHANGELOG.md +++ b/packages/prettier-plugin-typespec/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/prettier-plugin-typespec -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +### Updates + +- Changed yaml parser from `js-yaml` to `yaml` ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/prettier-plugin-typespec/package.json b/packages/prettier-plugin-typespec/package.json index d130b78aedb..c8d6852ff7c 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.47.0", + "version": "0.48.0", "description": "", "main": "dist/index.js", "scripts": { @@ -16,8 +16,8 @@ }, "devDependencies": { "prettier_2": "npm:prettier@2.8.7", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/internal-build-utils": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/internal-build-utils": "workspace:~0.48.0", "@rollup/plugin-commonjs": "~25.0.0", "@rollup/plugin-json": "~6.0.0", "@rollup/plugin-node-resolve": "~15.1.0", diff --git a/packages/protobuf/CHANGELOG.json b/packages/protobuf/CHANGELOG.json index d9d15b50940..d294bc1eb9c 100644 --- a/packages/protobuf/CHANGELOG.json +++ b/packages/protobuf/CHANGELOG.json @@ -1,6 +1,21 @@ { "name": "@typespec/protobuf", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/protobuf_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": { + "none": [ + { + "comment": "Added support for the 'omit-unreachable-types' option." + }, + { + "comment": "Automatically convert empty operation parameters into a reference to 'google.protobuf.Empty' instead of synthesizing an empty model." + } + ] + } + }, { "version": "0.47.0", "tag": "@typespec/protobuf_v0.47.0", diff --git a/packages/protobuf/CHANGELOG.md b/packages/protobuf/CHANGELOG.md index 83c9a9cd0ae..5e0823c4635 100644 --- a/packages/protobuf/CHANGELOG.md +++ b/packages/protobuf/CHANGELOG.md @@ -1,6 +1,14 @@ # Change Log - @typespec/protobuf -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +### Updates + +- Added support for the 'omit-unreachable-types' option. +- Automatically convert empty operation parameters into a reference to 'google.protobuf.Empty' instead of synthesizing an empty model. ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/protobuf/package.json b/packages/protobuf/package.json index 5178d0b5ad1..c23b3329152 100644 --- a/packages/protobuf/package.json +++ b/packages/protobuf/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/protobuf", - "version": "0.47.0", + "version": "0.48.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.47.1" + "@typespec/compiler": "workspace:~0.48.0" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", - "@typespec/eslint-plugin": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/eslint-plugin": "workspace:~0.48.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 e69853e8ced..9a1c5b3a280 100644 --- a/packages/rest/CHANGELOG.json +++ b/packages/rest/CHANGELOG.json @@ -1,6 +1,12 @@ { "name": "@typespec/rest", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/rest_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": {} + }, { "version": "0.47.0", "tag": "@typespec/rest_v0.47.0", diff --git a/packages/rest/CHANGELOG.md b/packages/rest/CHANGELOG.md index d5f67ad197d..abdc515cade 100644 --- a/packages/rest/CHANGELOG.md +++ b/packages/rest/CHANGELOG.md @@ -1,6 +1,11 @@ # Change Log - @typespec/rest -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +_Version update only_ ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/rest/package.json b/packages/rest/package.json index 43911325497..ffc27bedeb4 100644 --- a/packages/rest/package.json +++ b/packages/rest/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/rest", - "version": "0.47.0", + "version": "0.48.0", "author": "Microsoft Corporation", "description": "TypeSpec REST protocol binding", "homepage": "https://microsoft.github.io/typespec", @@ -53,16 +53,16 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.47.1" + "@typespec/compiler": "workspace:~0.48.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/http": "workspace:~0.47.0", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", - "@typespec/library-linter": "workspace:~0.47.0", - "@typespec/eslint-plugin": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/http": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/library-linter": "workspace:~0.48.0", + "@typespec/eslint-plugin": "workspace:~0.48.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.42.0", "mocha": "~10.2.0", diff --git a/packages/samples/package.json b/packages/samples/package.json index 858da3d62fb..a759e47442b 100644 --- a/packages/samples/package.json +++ b/packages/samples/package.json @@ -43,18 +43,18 @@ "!dist/test/**" ], "dependencies": { - "@typespec/versioning": "workspace:~0.47.0", + "@typespec/versioning": "workspace:~0.48.0", "@typespec/best-practices": "workspace:~0.45.0", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/http": "workspace:~0.47.0", - "@typespec/rest": "workspace:~0.47.0", - "@typespec/openapi": "workspace:~0.47.0", - "@typespec/openapi3": "workspace:~0.47.0", - "@typespec/html-program-viewer": "workspace:~0.47.0" + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/http": "workspace:~0.48.0", + "@typespec/rest": "workspace:~0.48.0", + "@typespec/openapi": "workspace:~0.48.0", + "@typespec/openapi3": "workspace:~0.48.0", + "@typespec/html-program-viewer": "workspace:~0.48.0" }, "devDependencies": { - "@typespec/internal-build-utils": "workspace:~0.47.0", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", + "@typespec/internal-build-utils": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", "cross-env": "~7.0.3", diff --git a/packages/spec/package.json b/packages/spec/package.json index c663529ce40..b63a69591ce 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.47.0" + "@typespec/internal-build-utils": "workspace:~0.48.0" } } diff --git a/packages/tmlanguage-generator/CHANGELOG.json b/packages/tmlanguage-generator/CHANGELOG.json index 5eb2683828a..acc83811fb7 100644 --- a/packages/tmlanguage-generator/CHANGELOG.json +++ b/packages/tmlanguage-generator/CHANGELOG.json @@ -1,6 +1,23 @@ { "name": "tmlanguage-generator", "entries": [ + { + "version": "0.4.4", + "tag": "tmlanguage-generator_v0.4.4", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": { + "dependency": [ + { + "comment": "Dependency @typespec/eslint-config-typespec version bump from workspace:~0.47.0 to workspace:~0.48.0." + } + ], + "patch": [ + { + "comment": "Upgrade dependency \"plist\" to latest" + } + ] + } + }, { "version": "0.4.3", "tag": "tmlanguage-generator_v0.4.3", diff --git a/packages/tmlanguage-generator/CHANGELOG.md b/packages/tmlanguage-generator/CHANGELOG.md index 8aa83c49722..5cf0c1e1c97 100644 --- a/packages/tmlanguage-generator/CHANGELOG.md +++ b/packages/tmlanguage-generator/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - tmlanguage-generator -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.4.4 +Tue, 12 Sep 2023 21:47:11 GMT + +### Patches + +- Upgrade dependency "plist" to latest ## 0.4.3 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/tmlanguage-generator/package.json b/packages/tmlanguage-generator/package.json index 2393cbb2817..5bb36591360 100644 --- a/packages/tmlanguage-generator/package.json +++ b/packages/tmlanguage-generator/package.json @@ -1,6 +1,6 @@ { "name": "tmlanguage-generator", - "version": "0.4.3", + "version": "0.4.4", "author": "Microsoft Corporation", "description": "Helper library to generate TextMate syntax highlighting tmLanguage files.", "homepage": "https://github.com/microsoft/typespec/tree/master/packages/tmlanguage-generator", @@ -39,7 +39,7 @@ "devDependencies": { "@types/node": "~18.11.9", "@types/plist": "~3.0.2", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", "eslint": "^8.42.0", "rimraf": "~5.0.1", "typescript": "~5.1.3" diff --git a/packages/tspd/package.json b/packages/tspd/package.json index 0dd68984015..ff0fec0c8ab 100644 --- a/packages/tspd/package.json +++ b/packages/tspd/package.json @@ -53,16 +53,16 @@ "!dist/test/**" ], "dependencies": { - "@typespec/compiler": "workspace:~0.47.1", + "@typespec/compiler": "workspace:~0.48.0", "yaml": "~2.3.1", "prettier": "~3.0.1", "picocolors": "~1.0.0", "yargs": "~17.7.1" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", - "@typespec/prettier-plugin-typespec": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/prettier-plugin-typespec": "workspace:~0.48.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 55c82faf5cc..2fa2271cf04 100644 --- a/packages/typespec-vs/CHANGELOG.json +++ b/packages/typespec-vs/CHANGELOG.json @@ -1,6 +1,12 @@ { "name": "typespec-vs", "entries": [ + { + "version": "0.48.0", + "tag": "typespec-vs_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": {} + }, { "version": "0.47.0", "tag": "typespec-vs_v0.47.0", diff --git a/packages/typespec-vs/CHANGELOG.md b/packages/typespec-vs/CHANGELOG.md index b9df2dee688..f3b59208168 100644 --- a/packages/typespec-vs/CHANGELOG.md +++ b/packages/typespec-vs/CHANGELOG.md @@ -1,6 +1,11 @@ # Change Log - typespec-vs -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +_Version update only_ ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/typespec-vs/package.json b/packages/typespec-vs/package.json index 4e5ee6b4ef8..656f3f16855 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.47.0", + "version": "0.48.0", "description": "TypeSpec Language Support for Visual Studio", "homepage": "https://microsoft.github.io/typespec", "readme": "https://github.com/microsoft/typespec/blob/master/README.md", @@ -27,7 +27,7 @@ "build": "node scripts/build.js" }, "devDependencies": { - "typespec-vscode": "workspace:~0.47.0", - "@typespec/internal-build-utils": "workspace:~0.47.0" + "typespec-vscode": "workspace:~0.48.0", + "@typespec/internal-build-utils": "workspace:~0.48.0" } } diff --git a/packages/typespec-vscode/CHANGELOG.json b/packages/typespec-vscode/CHANGELOG.json index 4fb00904897..0a212277e6b 100644 --- a/packages/typespec-vscode/CHANGELOG.json +++ b/packages/typespec-vscode/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "typespec-vscode", "entries": [ + { + "version": "0.48.0", + "tag": "typespec-vscode_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": { + "none": [ + { + "comment": "Add colors definition for `param`" + } + ] + } + }, { "version": "0.47.0", "tag": "typespec-vscode_v0.47.0", diff --git a/packages/typespec-vscode/CHANGELOG.md b/packages/typespec-vscode/CHANGELOG.md index 50d06655b43..5e1bf6426aa 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 Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +### Updates + +- Add colors definition for `param` ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/typespec-vscode/package.json b/packages/typespec-vscode/package.json index b9c026db76b..0182c7ad2cc 100644 --- a/packages/typespec-vscode/package.json +++ b/packages/typespec-vscode/package.json @@ -1,6 +1,6 @@ { "name": "typespec-vscode", - "version": "0.47.0", + "version": "0.48.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.53.0", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", - "@typespec/internal-build-utils": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/internal-build-utils": "workspace:~0.48.0", "eslint": "^8.42.0", "c8": "~8.0.0", "mocha": "~10.2.0", diff --git a/packages/versioning/CHANGELOG.json b/packages/versioning/CHANGELOG.json index 6ad6fce7442..3adc79810dd 100644 --- a/packages/versioning/CHANGELOG.json +++ b/packages/versioning/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/versioning", "entries": [ + { + "version": "0.48.0", + "tag": "@typespec/versioning_v0.48.0", + "date": "Tue, 12 Sep 2023 21:47:11 GMT", + "comments": { + "none": [ + { + "comment": "Fixed issue with `@typeChangedFrom` complaining about incorrect versioned references." + } + ] + } + }, { "version": "0.47.0", "tag": "@typespec/versioning_v0.47.0", diff --git a/packages/versioning/CHANGELOG.md b/packages/versioning/CHANGELOG.md index 99522482d0f..17361671d42 100644 --- a/packages/versioning/CHANGELOG.md +++ b/packages/versioning/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/versioning -This log was last generated on Tue, 08 Aug 2023 22:32:10 GMT and should not be manually modified. +This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. + +## 0.48.0 +Tue, 12 Sep 2023 21:47:11 GMT + +### Updates + +- Fixed issue with `@typeChangedFrom` complaining about incorrect versioned references. ## 0.47.0 Tue, 08 Aug 2023 22:32:10 GMT diff --git a/packages/versioning/package.json b/packages/versioning/package.json index 18fb8ca9a6b..7ee7cd0dda3 100644 --- a/packages/versioning/package.json +++ b/packages/versioning/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/versioning", - "version": "0.47.0", + "version": "0.48.0", "author": "Microsoft Corporation", "description": "TypeSpec library for declaring and emitting versioned APIs", "homepage": "https://microsoft.github.io/typespec", @@ -53,15 +53,15 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.47.1" + "@typespec/compiler": "workspace:~0.48.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.47.1", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", - "@typespec/library-linter": "workspace:~0.47.0", - "@typespec/eslint-plugin": "workspace:~0.47.0", + "@typespec/compiler": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/library-linter": "workspace:~0.48.0", + "@typespec/eslint-plugin": "workspace:~0.48.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.42.0", "mocha": "~10.2.0", diff --git a/packages/website/package.json b/packages/website/package.json index 63f7776c9cf..bd8c07f6d5b 100644 --- a/packages/website/package.json +++ b/packages/website/package.json @@ -32,16 +32,16 @@ "react-dom": "^17.0.2" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.47.1", + "@typespec/compiler": "workspace:~0.48.0", "@typespec/tspd": "workspace:~0.46.0", "@typespec/spec": "workspace:*", - "@typespec/http": "workspace:~0.47.0", - "@typespec/rest": "workspace:~0.47.0", - "@typespec/openapi": "workspace:~0.47.0", - "@typespec/openapi3": "workspace:~0.47.0", - "@typespec/protobuf": "workspace:~0.47.0", - "@typespec/versioning": "workspace:~0.47.0", - "@typespec/json-schema": "workspace:~0.47.0", + "@typespec/http": "workspace:~0.48.0", + "@typespec/rest": "workspace:~0.48.0", + "@typespec/openapi": "workspace:~0.48.0", + "@typespec/openapi3": "workspace:~0.48.0", + "@typespec/protobuf": "workspace:~0.48.0", + "@typespec/versioning": "workspace:~0.48.0", + "@typespec/json-schema": "workspace:~0.48.0", "@docusaurus/module-type-aliases": "^2.2.0", "@docusaurus/types": "^2.2.0", "@tsconfig/docusaurus": "^1.0.5", @@ -51,7 +51,7 @@ "playwright": "~1.32.2", "mermaid": "~9.1.6", "mdx-mermaid": "1.3.2", - "@typespec/eslint-config-typespec": "workspace:~0.47.0", + "@typespec/eslint-config-typespec": "workspace:~0.48.0", "eslint": "^8.42.0", "rimraf": "~5.0.1", "dotenv": "~16.1.3" 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 c2a04c7487a..36ce99e4887 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/basics.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/basics.md @@ -150,7 +150,7 @@ TypeSpec libraries are defined using `peerDependencies` so we don't end-up with ```jsonc { "dependencies": { - "js-yaml": "~4.1.0" // This is a regular package this library/emitter will use + "yaml": "~2.3.1" // This is a regular package this library/emitter will use }, "peerDependencies": { // Those are all TypeSpec libraries this library/emitter depend on diff --git a/packages/website/versioned_docs/version-latest/language-basics/built-in-types.md b/packages/website/versioned_docs/version-latest/language-basics/built-in-types.md index 8da181be28f..a3d9e1d7135 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/built-in-types.md +++ b/packages/website/versioned_docs/version-latest/language-basics/built-in-types.md @@ -42,18 +42,17 @@ Built in types are related to each other according to the rules described in [ty ## Other core types -| Type | Description | -| ----------- | ------------------------------------------------------------------------------------------ | -| `bytes` | A sequence of bytes | -| `string` | A sequence of textual characters | -| `boolean` | Boolean with `true` and `false` values | -| `null` | Null value | -| `object` | Represent any structured model.(With properties) | -| `Array` | Array model type, equivalent to `T[]` | -| `Record` | Model with string properties where all the properties have type `T` | -| `unknown` | A top type in TypeSpec that all types can be assigned to. | -| `void` | A function/operation return type indicating the function/operation doesn't return a value. | -| `never` | The never type indicates the values that will never occur. | +| Type | Description | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `bytes` | A sequence of bytes | +| `string` | A sequence of textual characters | +| `boolean` | Boolean with `true` and `false` values | +| `null` | Null value | +| `Array` | Array model type, equivalent to `T[]` | +| `Record` | Model with string keys where all the values have type `T` (similar to `Map` in TypeScript or `Dictionary` in .Net) | +| `unknown` | A top type in TypeSpec that all types can be assigned to. Values that can have any type should be assigned this value (similar to `any` in JavaScript) | +| `void` | A function/operation return type indicating the function/operation doesn't return a value. | +| `never` | The never type indicates the values that will never occur. | ## String types diff --git a/packages/website/versioned_docs/version-latest/language-basics/decorators.md b/packages/website/versioned_docs/version-latest/language-basics/decorators.md index 2cc5d79dd8e..929cbe5dc89 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/decorators.md +++ b/packages/website/versioned_docs/version-latest/language-basics/decorators.md @@ -34,7 +34,7 @@ model Dog {} ## Augment decorators -Decorators can also be used from a different location by referring to the type being decorated. For this you can declare an augment decorator using the `@@` prefix. The first argument of an augment decorator is the type reference that should be decorated. +Decorators can also be used from a different location by referring to the type being decorated. For this you can declare an augment decorator using the `@@` prefix. The first argument of an augment decorator is the type reference that should be decorated. As the augment decorator is a statement, it must end with a semicolon (`;`). ```typespec model Dog {} diff --git a/packages/website/versioned_docs/version-latest/language-basics/documentation.md b/packages/website/versioned_docs/version-latest/language-basics/documentation.md new file mode 100644 index 00000000000..d8ce3e78067 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/language-basics/documentation.md @@ -0,0 +1,74 @@ +--- +id: documentation +title: Documentation +--- + +# Documentation + +Documentation is crucial to any API. TypeSpec provides a number of ways to document your API using TSDoc doc comments and decorators. + +# Documenting APIs + +## `@doc` Decorator + +The `@doc` decorator can be used to attach documentation to most TypeSpec declarations. It most-commonly accepts a string argument that will be used as the documentation for the declaration. + +```typespec +@doc("This is a sample model") +model Dog { + @doc("This is a sample property") + name: string; +} +``` + +The `@doc` decorator can also accept a source object which can be used, for example, to provide templated documentation for a generic type. + +```typespec +@doc("Templated {name}", T) +model Template { +} + +// doc will read "Templated A" +model A is Template +``` + +## TSDoc Doc Comments + +TSDoc doc comments are a standard way to document TypeScript code. They are supported by many IDEs and can be used to generate external documentation using tools like [TypeDoc](https://typedoc.org/). + +You can annotate objects in your TypeSpec spec with TSDoc doc comments. These comments will be considered the same as if they were attached using the `@doc` decorator and can be used to generate external documentation. + +```typespec +/** + * Get a widget. + * @param widgetId The ID of the widget to retrieve. + * / +op @get create(@path widgetId: string): Widget | Error; +``` + +This is functionally equivalent to: + +```typespec +@doc("Get a widget.") +op @get create( + @doc("The ID of the widget to retrieve.") + @path + widgetId: string): Widget | Error; +``` + +The benefit to using TSDoc doc comment syntax is that it keeps all of the documentation for a declaration in one place, making it easier to read and maintain. Additionally, it allows the generation of documentation using tools like TypeDoc without having to write a custom emitter to examine the `@doc` metadata. + +# Comments + +TypeSpec supports both single-line and multi-line comments. Single-line comments start with `//` and continue until the end of the line. Multi-line comments start with `/*` and continue until the closing `*/` is encountered. + +```typespec +// This is a single-line comment +model Dog { + /* This is a multi-line comment + that spans multiple lines */ + name: string; +} +``` + +Comments are ignored by the compiler and are not included in the generated output. They are intended to be used to document your spec internally and are not suitable for generating external documentation. diff --git a/packages/website/versioned_docs/version-latest/language-basics/overview.md b/packages/website/versioned_docs/version-latest/language-basics/overview.md index 68d5cf5f496..9d615fa0e2b 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/overview.md +++ b/packages/website/versioned_docs/version-latest/language-basics/overview.md @@ -47,7 +47,7 @@ _Details: [Decorators](./decorators.md)_ | Use decorator with arguments | `@tag("abc")` | | Declare a decorator in JS | `export function $tag(context: DecoratorContext, target: Type, name: string) {...}` | | Save state in decorator | `context.program.stateMap(key).set(target, )` | -| Augment decorator | `@@tag(MyType, "abc")` | +| Augment decorator | `@@tag(MyType, "abc");` | ## Scalars diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-09-12.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-09-12.md new file mode 100644 index 00000000000..ba0bf667445 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-09-12.md @@ -0,0 +1,87 @@ +--- +title: September 2023 +--- + +# Release Notes September 2023 (2023-09-12) + +:::danger +This release contains **breaking changes** +::: + +## New Features + +### `@typespec/compiler` New Features + +- Allow library authors to precisely define the visibility of operation templates with new decorators `@parameterVisibility` and `@returnTypeVisibility`, paired with corresponding accessor methods `getParameterVisibility` and `getReturnTypeVisibility`. +- Add coloring for documentation comments in Visual Studio and Visual Studio Code language extensions. +- Change yaml parser from `js-yaml` to `yaml`, enabling more precise validation and error reporting in `tspconfig.yaml` +- Added validation to ensure that properties of a derived model (using `extends`) are compatible with the base model indexer. +- Export `CompilerOptions` TypeScript type. +- Report library information when library code crashes during `$onValidate` execution. +- Diagnostics reported on a node with an `id` property will highlight the id instead of the entire node. For example, if a diagnostic is reported on a `model` type, the model name will be highlighted, instead of the entire model definition. + +### `@typespec/http` New Features + +- Add new helper method `resolveRequestVisibility` which incorporates settings from new core decorators `@parameterVisibility` and `@returnTypeVisibility`. This replaces the deprecated `getRequestVisibility` helper. +- Add new helper method `getDefaultVisibilityForVerb` which returns the default visibility for Http verbs. +- Add validation step to issue a warning when an `operation is` statement does not include route information from the original operation container (`interface` or `namespace`). This helps to prevent unexpected route changes when using operation references. +- Add validation to prevent runtime errors when `OAuth2Auth` is given invalid `OAuth2Flow` arguments. + +### `@typespec/json-schema` New Features + +- Support decimal scalar types. + +### `@typespec/openapi3` New Features + +- Allow library authors to override default Http verb visibility in operation declarations. + +### `@typespec/protobuf` New features + +- Support `omit-unreachable-types` option. +- Automatically convert empty operation parameters into a reference to `google.protobuf.Empty` instead of synthesizing an empty model. + +### `typespec-vscode` New features + +- Add color definition for `@param` tag in documentation comments + +## Bug Fixes + +### `@typespec/compiler` Bug Fixes + +- Fix issue where specifying a directory using the `--config` command line option would search the parent folder hierarchy looking for `tspconfig.yaml`. +- Fix Stack overflow when a model property references itself. +- Fix compiler crash when using the alias of a namespace that has decorators. +- Fix compiler freeze when an invalid token appears between doc comment and type. +- Fix compiler crash when relating recursive types. +- Fix typo in format error diagnostic. + +### `@typespec/openapi3` Bug Fixes + +- Fixed issue where parameters marked with visibility \"create\" did not appear in a `PATCH` request body. +- Fixed incorrect usage of `exclusiveMinimum` and `exclusiveMaximum` boolean properties. +- Use `anyOf` instead of `oneOf` for operations with shared routes and different request or response bodies. +- Fix handling of `Record` in `model is` and `model extends` statements. + +### `@typespec/versioning` Bug Fixes + +- Fixed validation in `@typeChangedFrom` for incorrect versioned references. + +## Deprecations + +### `@typespec/compiler` Deprecations + +- The `@deprecated` decorator has been marked as deprecated. Use `#deprecated` directive instead. + +### `@typespec/http` Deprecations + +- The `getRequestVisibility` helper function is now deprecated. Use `resolveRequestVisibility` or `getDefaultVisibilityForVerb` instead. + +## Breaking Changes + +### `@typespec/compiler` Breaking Changes + +- A semicolon is now required at the end of augment decorator statements. The formatter was already inserting the semicolon, if omitted. For example: + + ```tsp + @@doc(MyType.myProperty, "Documentation for myProperty"); + ``` 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 new file mode 100644 index 00000000000..6e0a469f9db --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/built-in-data-types.md @@ -0,0 +1,7 @@ +--- +title: "Built-in Data types" +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +See [Language Basics: Built-in types](../language-basics/built-in-types) diff --git a/packages/website/versioned_docs/version-latest/standard-library/built-in-decorators.md b/packages/website/versioned_docs/version-latest/standard-library/built-in-decorators.md index 0fce90f9a50..7fe661ff2bf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/built-in-decorators.md +++ b/packages/website/versioned_docs/version-latest/standard-library/built-in-decorators.md @@ -557,6 +557,25 @@ op uploadBytes(data: bytes, @header contentType: "application/octet-stream"): vo ``` +### `@parameterVisibility` {#@parameterVisibility} + +Sets which visibilities apply to parameters for the given operation. + +```typespec +@parameterVisibility(...visibilities: valueof string[]) +``` + +#### Target + +`Operation` + +#### Parameters +| Name | Type | Description | +|------|------|-------------| +| visibilities | `valueof model string[]` | List of visibility strings which apply to this operation. | + + + ### `@pattern` {#@pattern} Specify the the pattern this string should respect using simple regular expression syntax. @@ -612,6 +631,25 @@ expireAt: int32; ``` +### `@returnTypeVisibility` {#@returnTypeVisibility} + +Sets which visibilities apply to the return type for the given operation. + +```typespec +@returnTypeVisibility(...visibilities: valueof string[]) +``` + +#### Target + +`Operation` + +#### Parameters +| Name | Type | Description | +|------|------|-------------| +| visibilities | `valueof model string[]` | List of visibility strings which apply to this operation. | + + + ### `@secret` {#@secret} Mark this string as a secret value that should be treated carefully to avoid exposure diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/encoding.md b/packages/website/versioned_docs/version-latest/standard-library/http/encoding.md index 432690c13e3..f7cbb1dec5e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/encoding.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/encoding.md @@ -9,6 +9,10 @@ This document describe how the http library interpret TypeSpec built-in types an - `bytes` are serialized as `base64` when used inside a model serialized as JSON - In request or response body it represent a binary payload. +:::note +This behavior is only a specification and MUST be respected by the emitter. The http library DOES NOT automatically apply the `@encode("base64")` when used inside a JSON model. +::: + Use `@encode` to configure ```tsp @@ -31,6 +35,10 @@ op upload(@body data: bytes): void; // Accept application/octet-stream - Encoded as `rfc7231` when used in a header - Encoded as `rfc3339` otherwise. +:::note +This behavior is only a specification and MUST be respected by the emitter. The http library DOES NOT automatically apply the `@encode("rfc7231")` on `utcDatetime` and `offsetDateTime` when used in a header. +::: + Use `@encode` to configure. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/decorators.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/decorators.md index 623e0f09354..71892dba54a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/decorators.md @@ -402,7 +402,7 @@ op create(): {@statusCode: 201 | 202} ### `@useAuth` {#@TypeSpec.Http.useAuth} -Specify this service authentication. See the [documentation in the Http library][https://microsoft.github.io/typespec/standard-library/rest/authentication] for full details. +Specify this service authentication. See the [documentation in the Http library](https://microsoft.github.io/typespec/standard-library/http/authentication) for full details. ```typespec @TypeSpec.Http.useAuth(auth: {} | Union | {}[]) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Enumeration.Visibility.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Enumeration.Visibility.md index baec341ef5b..91610301d34 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Enumeration.Visibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Enumeration.Visibility.md @@ -1,20 +1,21 @@ --- jsApi: true title: "[E] Visibility" ---- +--- Flags enum representation of well-known visibilities that are used in REST API. ## Enumeration Members -| Member | Value | Description | -| :------- | :-------- | :----------------------------------------------------------------------------------------------------------------- | -| `All` | `31` | - | -| `Create` | `2` | - | -| `Delete` | `8` | - | -| `Item` | `1048576` | Additional flag to indicate when something is nested in a collection
and therefore no metadata is applicable. | -| `None` | `0` | - | -| `Query` | `16` | - | -| `Read` | `1` | - | -| `Update` | `4` | - | +| Member | Value | Description | +| :------ | :------ | :------ | +| `All` | ``31`` | - | +| `Create` | ``2`` | - | +| `Delete` | ``8`` | - | +| `Item` | ``1048576`` | Additional flag to indicate when something is nested in a collection
and therefore no metadata is applicable. | +| `None` | ``0`` | - | +| `Patch` | ``2097152`` | Additional flag to indicate when the verb is path and therefore
will have fields made optional if request visibility includes update. | +| `Query` | ``16`` | - | +| `Read` | ``1`` | - | +| `Update` | ``4`` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$body.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$body.md index e48fdf920ca..74c51eca4ae 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$body.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$body.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $body" ---- +--- ```ts $body(context, entity): void ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `ModelProperty` | +| `entity` | `ModelProperty` | ## Returns `void` - -## Source - -[decorators.ts:169](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L169) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$delete.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$delete.md index 4b81176219f..a97fdb5e370 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$delete.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$delete.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $delete" ---- +--- ```ts $delete(context, entity): void ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `entity` | `Operation` | ## Returns `void` - -## Source - -[decorators.ts:336](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L336) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$get.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$get.md index 58a80edbadb..0815e4bbf29 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$get.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$get.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $get" ---- +--- ```ts $get(context, entity): void ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `entity` | `Operation` | ## Returns `void` - -## Source - -[decorators.ts:320](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L320) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$head.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$head.md index 0ed002064c6..63c0520514c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$head.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$head.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $head" ---- +--- ```ts $head(context, entity): void ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `entity` | `Operation` | ## Returns `void` - -## Source - -[decorators.ts:340](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L340) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$header.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$header.md index 3cb012e7ee6..73340df6fd9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$header.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$header.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $header" ---- +--- ```ts $header( context, @@ -12,16 +12,12 @@ $header( ## Parameters -| Parameter | Type | -| :--------------------- | :------------------------- | -| `context` | `DecoratorContext` | -| `entity` | `ModelProperty` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `ModelProperty` | | `headerNameOrOptions`? | `StringLiteral` \| `Model` | ## Returns `void` - -## Source - -[decorators.ts:39](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L39) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$includeInapplicableMetadataInPayload.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$includeInapplicableMetadataInPayload.md index 73ac665f0bf..0b205fd19c0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$includeInapplicableMetadataInPayload.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$includeInapplicableMetadataInPayload.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $includeInapplicableMetadataInPayload" ---- +--- ```ts $includeInapplicableMetadataInPayload( context, @@ -14,22 +14,18 @@ Specifies if inapplicable metadata should be included in the payload for the given entity. This is true by default unless changed by this decorator. -## See - -isApplicableMetadata - ## Parameters -| Parameter | Type | Description | -| :-------- | :----------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context` | `DecoratorContext` | - | -| `entity` | `Type` | Target model, namespace, or model property. If applied to a
model or namespace, applies recursively to child models,
namespaces, and model properties unless overridden by
applying this decorator to a child. | -| `value` | `boolean` | `true` to include inapplicable metadata in payload, false to
exclude it. | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | `DecoratorContext` | - | +| `entity` | `Type` | Target model, namespace, or model property. If applied to a
model or namespace, applies recursively to child models,
namespaces, and model properties unless overridden by
applying this decorator to a child. | +| `value` | `boolean` | `true` to include inapplicable metadata in payload, false to
exclude it. | ## Returns `void` -## Source +## See -[decorators.ts:637](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L637) +isApplicableMetadata diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$onValidate.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$onValidate.md index c50ac53b156..212e92eb72e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$onValidate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$onValidate.md @@ -1,22 +1,18 @@ --- jsApi: true title: "[F] $onValidate" ---- +--- ```ts $onValidate(program): void ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | ## Returns `void` - -## Source - -[validate.ts:6](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/validate.ts#L6) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$patch.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$patch.md index 55731102d34..32efa20c4d7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$patch.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$patch.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $patch" ---- +--- ```ts $patch(context, entity): void ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `entity` | `Operation` | ## Returns `void` - -## Source - -[decorators.ts:332](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L332) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$path.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$path.md index 0cb8db099fa..4e0192e5b6d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$path.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$path.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $path" ---- +--- ```ts $path( context, @@ -12,16 +12,12 @@ $path( ## Parameters -| Parameter | Type | -| :----------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `ModelProperty` | -| `paramName`? | `string` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `ModelProperty` | +| `paramName`? | `string` | ## Returns `void` - -## Source - -[decorators.ts:148](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L148) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$plainData.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$plainData.md index 6ab8b53afad..d61d12c6bbc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$plainData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$plainData.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $plainData" ---- +--- ```ts $plainData(context, entity): void ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Model` | +| `entity` | `Model` | ## Returns `void` - -## Source - -[decorators.ts:395](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L395) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$post.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$post.md index dad079da090..61ab855910a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$post.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$post.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $post" ---- +--- ```ts $post(context, entity): void ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `entity` | `Operation` | ## Returns `void` - -## Source - -[decorators.ts:328](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L328) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$put.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$put.md index d5a5b8f3c21..0c991e4bbef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$put.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$put.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $put" ---- +--- ```ts $put(context, entity): void ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `entity` | `Operation` | ## Returns `void` - -## Source - -[decorators.ts:324](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L324) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$query.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$query.md index b91781ac718..3d08e36c5b0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$query.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$query.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $query" ---- +--- ```ts $query( context, @@ -12,16 +12,12 @@ $query( ## Parameters -| Parameter | Type | -| :-------------------- | :------------------------- | -| `context` | `DecoratorContext` | -| `entity` | `ModelProperty` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `ModelProperty` | | `queryNameOrOptions`? | `StringLiteral` \| `Model` | ## Returns `void` - -## Source - -[decorators.ts:99](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L99) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$route.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$route.md index 4989fef2726..c3a85655571 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$route.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$route.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $route" ---- +--- ```ts $route( context, @@ -21,17 +21,13 @@ it will be used as a prefix to the route URI of the operation. ## Parameters -| Parameter | Type | -| :------------ | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Type` | -| `path` | `string` | -| `parameters`? | `Model` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Type` | +| `path` | `string` | +| `parameters`? | `Model` | ## Returns `void` - -## Source - -[decorators.ts:581](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L581) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$server.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$server.md index 5a7aa9fde0f..12a350714c2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$server.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$server.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $server" ---- +--- ```ts $server( context, @@ -14,24 +14,20 @@ $server( Configure the server url for the service. -## Optional - -Parameters to interpolate in the server url. - ## Parameters -| Parameter | Type | Description | -| :------------ | :----------------- | :------------------------------------ | -| `context` | `DecoratorContext` | Decorator context | -| `target` | `Namespace` | Decorator target(Must be a namespace) | -| `url` | `string` | - | -| `description` | `string` | Description for this server. | -| `parameters`? | `Model` | | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | `DecoratorContext` | Decorator context | +| `target` | `Namespace` | Decorator target(Must be a namespace) | +| `url` | `string` | - | +| `description` | `string` | Description for this server. | +| `parameters`? | `Model` | | ## Returns `void` -## Source +## Optional -[decorators.ts:358](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L358) +Parameters to interpolate in the server url. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$sharedRoute.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$sharedRoute.md index cb95d0ca85e..85f083c5887 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$sharedRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$sharedRoute.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $sharedRoute" ---- +--- ```ts $sharedRoute(context, entity): void ``` @@ -16,15 +16,11 @@ route path as long as those operations are also marked with `@sharedRoute`. ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `entity` | `Operation` | ## Returns `void` - -## Source - -[decorators.ts:614](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L614) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$statusCode.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$statusCode.md index 171c7a5f40c..6fa9dcb7374 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$statusCode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$statusCode.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $statusCode" ---- +--- ```ts $statusCode(context, entity): void ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `ModelProperty` | +| `entity` | `ModelProperty` | ## Returns `void` - -## Source - -[decorators.ts:178](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L178) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$useAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$useAuth.md index 504937551c7..df37baa99a3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$useAuth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$useAuth.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $useAuth" ---- +--- ```ts $useAuth( context, @@ -12,16 +12,12 @@ $useAuth( ## Parameters -| Parameter | Type | -| :----------------- | :---------------------------- | -| `context` | `DecoratorContext` | -| `serviceNamespace` | `Namespace` | -| `authConfig` | `Model` \| `Tuple` \| `Union` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `serviceNamespace` | `Namespace` | +| `authConfig` | `Model` \| `Tuple` \| `Union` | ## Returns `void` - -## Source - -[decorators.ts:426](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L426) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.DefaultRouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.DefaultRouteProducer.md index b638c83484e..ee95561469f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.DefaultRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.DefaultRouteProducer.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] DefaultRouteProducer" ---- +--- ```ts DefaultRouteProducer( program, @@ -14,18 +14,14 @@ DefaultRouteProducer( ## Parameters -| Parameter | Type | -| :--------------- | :----------------------------------------------------------- | -| `program` | `Program` | -| `operation` | `Operation` | -| `parentSegments` | `string`[] | -| `overloadBase` | `undefined` \| [`HttpOperation`](Interface.HttpOperation.md) | -| `options` | [`RouteOptions`](Interface.RouteOptions.md) | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `operation` | `Operation` | +| `parentSegments` | `string`[] | +| `overloadBase` | `undefined` \| [`HttpOperation`](Interface.HttpOperation.md) | +| `options` | [`RouteOptions`](Interface.RouteOptions.md) | ## Returns `DiagnosticResult`< [`RouteProducerResult`](Interface.RouteProducerResult.md) \> - -## Source - -[route.ts:155](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/route.ts#L155) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.createMetadataInfo.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.createMetadataInfo.md index bf0d613f9ed..4041c77635b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.createMetadataInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.createMetadataInfo.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] createMetadataInfo" ---- +--- ```ts createMetadataInfo(program, options?): MetadataInfo ``` ## Parameters -| Parameter | Type | -| :--------- | :-------------------------------------------------------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `options`? | [`MetadataInfoOptions`](Interface.MetadataInfoOptions.md) | ## Returns [`MetadataInfo`](Interface.MetadataInfo.md) - -## Source - -[metadata.ts:350](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L350) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.gatherMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.gatherMetadata.md index f7dd784f6c5..ae5c7eb97dc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.gatherMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.gatherMetadata.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] gatherMetadata" ---- +--- ```ts gatherMetadata( program, @@ -18,19 +18,15 @@ properties recursively. ## Parameters -| Parameter | Type | Default value | Description | -| :------------------- | :----------------------------------------- | :------------ | :------------------------------------------------------------------------------------------------------- | -| `program` | `Program` | `undefined` | - | -| `diagnostics` | `DiagnosticCollector` | `undefined` | - | -| `type` | `Type` | `undefined` | - | -| `visibility` | [`Visibility`](Enumeration.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. | +| Parameter | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `program` | `Program` | `undefined` | - | +| `diagnostics` | `DiagnosticCollector` | `undefined` | - | +| `type` | `Type` | `undefined` | - | +| `visibility` | [`Visibility`](Enumeration.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` \> - -## Source - -[metadata.ts:145](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L145) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllHttpServices.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllHttpServices.md index fed6af4c9d5..2e8bb3d67e8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllHttpServices.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllHttpServices.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getAllHttpServices" ---- +--- ```ts getAllHttpServices(program, options?): [HttpService[], readonly Diagnostic[]] ``` @@ -11,15 +11,11 @@ Returns all the services defined. ## Parameters -| Parameter | Type | -| :--------- | :-------------------------------------------------------------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | ## Returns [[`HttpService`](Interface.HttpService.md)[], *readonly* `Diagnostic`[]] - -## Source - -[operations.ts:66](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/operations.ts#L66) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllRoutes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllRoutes.md index fbd54f6a3bf..f83f9629fbb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllRoutes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllRoutes.md @@ -1,27 +1,23 @@ --- jsApi: true title: "[F] getAllRoutes" ---- +--- ```ts getAllRoutes(program, options?): [HttpOperation[], readonly Diagnostic[]] ``` -## Deprecated - -use `getAllHttpServices` or `resolveHttpOperations` manually - ## Parameters -| Parameter | Type | -| :--------- | :-------------------------------------------------------------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | ## Returns [[`HttpOperation`](Interface.HttpOperation.md)[], *readonly* `Diagnostic`[]] -## Source +## Deprecated -[operations.ts:112](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/operations.ts#L112) +use `getAllHttpServices` instead diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAuthentication.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAuthentication.md index a3291de175a..9cccaa81242 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAuthentication.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAuthentication.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getAuthentication" ---- +--- ```ts getAuthentication(program, namespace): ServiceAuthentication | undefined ``` ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `namespace` | `Namespace` | ## Returns [`ServiceAuthentication`](Interface.ServiceAuthentication.md) \| `undefined` - -## Source - -[decorators.ts:565](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L565) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getContentTypes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getContentTypes.md index 561100f2695..51d55ff2821 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getContentTypes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getContentTypes.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getContentTypes" ---- +--- ```ts getContentTypes(property): [string[], readonly Diagnostic[]] ``` @@ -11,16 +11,12 @@ Resolve the content types from a model property by looking at the value. ## Parameters -| Parameter | Type | Description | -| :--------- | :-------------- | :------------- | +| Parameter | Type | Description | +| :------ | :------ | :------ | | `property` | `ModelProperty` | Model property | ## Returns -[`string`[], _readonly_ `Diagnostic`[]] +[`string`[], *readonly* `Diagnostic`[]] List of contnet types and any diagnostics if there was an issue. - -## Source - -[content-types.ts:21](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/content-types.ts#L21) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldName.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldName.md index 040696fba77..5096ca42e67 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldName.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getHeaderFieldName" ---- +--- ```ts getHeaderFieldName(program, entity): string ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `string` - -## Source - -[decorators.ts:90](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L90) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldOptions.md index 2332c108a4f..4ac36c8e5a8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldOptions.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getHeaderFieldOptions" ---- +--- ```ts getHeaderFieldOptions(program, entity): HeaderFieldOptions ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns [`HeaderFieldOptions`](Interface.HeaderFieldOptions.md) - -## Source - -[decorators.ts:86](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L86) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpOperation.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpOperation.md index 5aef51497c7..fad628d1157 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpOperation.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getHttpOperation" ---- +--- ```ts getHttpOperation( program, @@ -14,16 +14,12 @@ Return the Http Operation details for a given TypeSpec operation. ## Parameters -| Parameter | Type | Description | -| :---------- | :-------------------------------------------------------------- | :-------------------------------------------------- | -| `program` | `Program` | - | -| `operation` | `Operation` | Operation | -| `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | Optional option on how to resolve the http details. | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | `Program` | - | +| `operation` | `Operation` | Operation | +| `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | Optional option on how to resolve the http details. | ## Returns [[`HttpOperation`](Interface.HttpOperation.md), *readonly* `Diagnostic`[]] - -## Source - -[operations.ts:34](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/operations.ts#L34) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpService.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpService.md index 183d3e672a4..55cfd502ab6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpService.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getHttpService" ---- +--- ```ts getHttpService( program, @@ -12,16 +12,12 @@ getHttpService( ## Parameters -| Parameter | Type | -| :----------------- | :-------------------------------------------------------------- | -| `program` | `Program` | -| `serviceNamespace` | `Namespace` | -| `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `serviceNamespace` | `Namespace` | +| `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | ## Returns [[`HttpService`](Interface.HttpService.md), *readonly* `Diagnostic`[]] - -## Source - -[operations.ts:84](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/operations.ts#L84) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationParameters.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationParameters.md index ae28525428b..e1b11c540a0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationParameters.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationParameters.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getOperationParameters" ---- +--- ```ts getOperationParameters( program, @@ -14,18 +14,14 @@ getOperationParameters( ## Parameters -| Parameter | Type | Default value | -| :--------------------- | :-------------------------------------------------------------------- | :------------ | -| `program` | `Program` | `undefined` | -| `operation` | `Operation` | `undefined` | -| `overloadBase`? | [`HttpOperation`](Interface.HttpOperation.md) | `undefined` | -| `knownPathParamNames`? | `string`[] | `[]` | -| `options`? | [`OperationParameterOptions`](Interface.OperationParameterOptions.md) | `{}` | +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `program` | `Program` | `undefined` | +| `operation` | `Operation` | `undefined` | +| `overloadBase`? | [`HttpOperation`](Interface.HttpOperation.md) | `undefined` | +| `knownPathParamNames`? | `string`[] | `[]` | +| `options`? | [`OperationParameterOptions`](Interface.OperationParameterOptions.md) | `{}` | ## Returns [[`HttpOperationParameters`](Interface.HttpOperationParameters.md), *readonly* `Diagnostic`[]] - -## Source - -[parameters.ts:29](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/parameters.ts#L29) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationVerb.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationVerb.md index f1082ef2de5..b7498434214 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationVerb.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationVerb.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getOperationVerb" ---- +--- ```ts getOperationVerb(program, entity): HttpVerb | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns [`HttpVerb`](Type.HttpVerb.md) \| `undefined` - -## Source - -[decorators.ts:316](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L316) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamName.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamName.md index 2b37ce00846..947c88dedfa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamName.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getPathParamName" ---- +--- ```ts getPathParamName(program, entity): string ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `string` - -## Source - -[decorators.ts:160](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L160) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamOptions.md index 5a60863066d..87008abe9ea 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamOptions.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getPathParamOptions" ---- +--- ```ts getPathParamOptions(program, entity): PathParameterOptions ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns [`PathParameterOptions`](Interface.PathParameterOptions.md) - -## Source - -[decorators.ts:156](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L156) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamName.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamName.md index 53b6d5cdfb8..da9c1758b24 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamName.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getQueryParamName" ---- +--- ```ts getQueryParamName(program, entity): string ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `string` - -## Source - -[decorators.ts:139](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L139) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamOptions.md index 110d206ff14..a1535812dfb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamOptions.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getQueryParamOptions" ---- +--- ```ts getQueryParamOptions(program, entity): QueryParameterOptions ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns [`QueryParameterOptions`](Interface.QueryParameterOptions.md) - -## Source - -[decorators.ts:135](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L135) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRequestVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRequestVisibility.md index ef0fbe066ad..42e003f7682 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRequestVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRequestVisibility.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getRequestVisibility" ---- +--- ```ts getRequestVisibility(verb): Visibility ``` @@ -10,20 +10,23 @@ getRequestVisibility(verb): Visibility Determines the visibility to use for a request with the given verb. - GET | HEAD => Visibility.Query -- POST => Visibility.Update +- POST => Visibility.Create +- PATCH => Visibility.Update - PUT => Visibility.Create | Update - DELETE => Visibility.Delete ## Parameters -| Parameter | Type | -| :-------- | :----------------------------- | -| `verb` | [`HttpVerb`](Type.HttpVerb.md) | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `verb` | [`HttpVerb`](Type.HttpVerb.md) | The HTTP verb for the operation. | ## Returns [`Visibility`](Enumeration.Visibility.md) -## Source +The applicable parameter visibility or visibilities for the request. + +## Deprecated -[metadata.ts:119](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L119) +Use `resolveRequestVisibility` instead, or if you only want the default visibility for a verb, `getDefaultVisibilityForVerb`. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getResponsesForOperation.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getResponsesForOperation.md index af4c07b5e8b..68da7f5af0d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getResponsesForOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getResponsesForOperation.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getResponsesForOperation" ---- +--- ```ts getResponsesForOperation(program, operation): [HttpOperationResponse[], readonly Diagnostic[]] ``` @@ -11,15 +11,11 @@ Get the responses for a given operation. ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `operation` | `Operation` | ## Returns [[`HttpOperationResponse`](Interface.HttpOperationResponse.md)[], *readonly* `Diagnostic`[]] - -## Source - -[responses.ts:33](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/responses.ts#L33) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteOptionsForNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteOptionsForNamespace.md index b1a8d8a5df3..e7f2f4dd254 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteOptionsForNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteOptionsForNamespace.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getRouteOptionsForNamespace" ---- +--- ```ts getRouteOptionsForNamespace(program, namespace): RouteOptions | undefined ``` ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `namespace` | `Namespace` | ## Returns [`RouteOptions`](Interface.RouteOptions.md) \| `undefined` - -## Source - -[route.ts:268](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/route.ts#L268) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRoutePath.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRoutePath.md index a9710bdfc77..67f28cb7f6b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRoutePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRoutePath.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getRoutePath" ---- +--- ```ts getRoutePath(program, entity): RoutePath | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :---------------------------------------- | -| `program` | `Program` | -| `entity` | `Interface` \| `Namespace` \| `Operation` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `entity` | `Interface` \| `Namespace` \| `Operation` | ## Returns [`RoutePath`](Interface.RoutePath.md) \| `undefined` - -## Source - -[route.ts:245](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/route.ts#L245) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteProducer.md index 70996986f1e..2d6d3d7fbe9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteProducer.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getRouteProducer" ---- +--- ```ts getRouteProducer(program, operation): RouteProducer ``` ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `operation` | `Operation` | ## Returns [`RouteProducer`](Type.RouteProducer.md) - -## Source - -[route.ts:203](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/route.ts#L203) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getServers.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getServers.md index 8f3314508af..5ca51b72c9a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getServers.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getServers.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getServers" ---- +--- ```ts getServers(program, type): HttpServer[] | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :---------- | -| `program` | `Program` | -| `type` | `Namespace` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `type` | `Namespace` | ## Returns [`HttpServer`](Interface.HttpServer.md)[] \| `undefined` - -## Source - -[decorators.ts:391](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L391) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodeDescription.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodeDescription.md index a0fd34c6c0d..d98eb575a0f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodeDescription.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodeDescription.md @@ -1,22 +1,18 @@ --- jsApi: true title: "[F] getStatusCodeDescription" ---- +--- ```ts getStatusCodeDescription(statusCode): undefined | "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." | "Informational" | "Successful" | "Redirection" | "Client Error" | "Server Error" ``` ## Parameters -| Parameter | Type | -| :----------- | :------- | +| Parameter | Type | +| :------ | :------ | | `statusCode` | `string` | ## Returns `undefined` \| `"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."` \| `"Informational"` \| `"Successful"` \| `"Redirection"` \| `"Client Error"` \| `"Server Error"` - -## Source - -[decorators.ts:247](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L247) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodes.md index f7fb6fc21d3..5f10358c8ca 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodes.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getStatusCodes" ---- +--- ```ts getStatusCodes(program, entity): string[] ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `string`[] - -## Source - -[decorators.ts:242](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L242) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getVisibilitySuffix.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getVisibilitySuffix.md index 05a303b622b..af621fa04e4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getVisibilitySuffix.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getVisibilitySuffix.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getVisibilitySuffix" ---- +--- ```ts getVisibilitySuffix(visibility, canonicalVisibility = Visibility.None): string ``` @@ -15,24 +15,19 @@ otherwise visibilities are joined in pascal-case with `Or`. And `Item` is if `Visibility.Item` is produced. Examples (with canonicalVisibility = Visibility.Read): - -- Visibility.Read => "" -- Visibility.Update => "Update" -- Visibility.Create | Visibility.Update => "CreateOrUpdate" -- Visibility.Create | Visibility.Item => "CreateItem" -- Visibility.Create | Visibility.Update | Visibility.Item => "CreateOrUpdateItem" + - Visibility.Read => "" + - Visibility.Update => "Update" + - Visibility.Create | Visibility.Update => "CreateOrUpdate" + - Visibility.Create | Visibility.Item => "CreateItem" + - Visibility.Create | Visibility.Update | Visibility.Item => "CreateOrUpdateItem" ## Parameters -| Parameter | Type | Default value | -| :-------------------- | :------------------------------------------------------- | :---------------- | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | `undefined` | +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `visibility` | [`Visibility`](Enumeration.Visibility.md) | `undefined` | | `canonicalVisibility` | `undefined` \| [`Visibility`](Enumeration.Visibility.md) | `Visibility.None` | ## Returns `string` - -## Source - -[metadata.ts:93](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L93) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInapplicableMetadataInPayload.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInapplicableMetadataInPayload.md index 318662457f5..293ee6ea1e0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInapplicableMetadataInPayload.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInapplicableMetadataInPayload.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] includeInapplicableMetadataInPayload" ---- +--- ```ts includeInapplicableMetadataInPayload(program, property): boolean ``` @@ -10,22 +10,18 @@ includeInapplicableMetadataInPayload(program, property): boolean Determines if the given model property should be included in the payload if it is inapplicable metadata. -## See - -- isApplicableMetadata -- $includeInapplicableMetadataInPayload - ## Parameters -| Parameter | Type | -| :--------- | :-------------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `property` | `ModelProperty` | ## Returns `boolean` -## Source +## See -[decorators.ts:662](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L662) + - isApplicableMetadata + - $includeInapplicableMetadataInPayload diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInterfaceRoutesInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInterfaceRoutesInNamespace.md index e922dcc6000..81e88b7153e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInterfaceRoutesInNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInterfaceRoutesInNamespace.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] includeInterfaceRoutesInNamespace" ---- +--- ```ts includeInterfaceRoutesInNamespace( program, @@ -10,22 +10,18 @@ includeInterfaceRoutesInNamespace( sourceInterface): void ``` -## Deprecated - -DO NOT USE. For internal use only as a workaround. - ## Parameters -| Parameter | Type | Description | -| :---------------- | :---------- | :---------------------------------------------- | -| `program` | `Program` | Program | -| `target` | `Namespace` | Target namespace | -| `sourceInterface` | `string` | Interface that should be included in namespace. | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | `Program` | Program | +| `target` | `Namespace` | Target namespace | +| `sourceInterface` | `string` | Interface that should be included in namespace. | ## Returns `void` -## Source +## Deprecated -[route.ts:139](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/route.ts#L139) +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/Function.isApplicableMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadata.md index 7348b1c56a8..74cf604799b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadata.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] isApplicableMetadata" ---- +--- ```ts isApplicableMetadata( program, @@ -22,17 +22,13 @@ given visibility. ## Parameters -| Parameter | Type | Default value | -| :------------------- | :---------------------------------------- | :------------ | -| `program` | `Program` | `undefined` | -| `property` | `ModelProperty` | `undefined` | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | `undefined` | -| `isMetadataCallback` | (`program`, `property`) => `boolean` | `isMetadata` | +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `program` | `Program` | `undefined` | +| `property` | `ModelProperty` | `undefined` | +| `visibility` | [`Visibility`](Enumeration.Visibility.md) | `undefined` | +| `isMetadataCallback` | (`program`, `property`) => `boolean` | `isMetadata` | ## Returns `boolean` - -## Source - -[metadata.ts:231](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L231) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadataOrBody.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadataOrBody.md index 7a2146051f6..2bc45458596 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadataOrBody.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadataOrBody.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] isApplicableMetadataOrBody" ---- +--- ```ts isApplicableMetadataOrBody( program, @@ -16,17 +16,13 @@ applicable with the given visibility. ## Parameters -| Parameter | Type | Default value | -| :------------------- | :---------------------------------------- | :------------ | -| `program` | `Program` | `undefined` | -| `property` | `ModelProperty` | `undefined` | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | `undefined` | -| `isMetadataCallback` | (`program`, `property`) => `boolean` | `isMetadata` | +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `program` | `Program` | `undefined` | +| `property` | `ModelProperty` | `undefined` | +| `visibility` | [`Visibility`](Enumeration.Visibility.md) | `undefined` | +| `isMetadataCallback` | (`program`, `property`) => `boolean` | `isMetadata` | ## Returns `boolean` - -## Source - -[metadata.ts:244](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L244) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isBody.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isBody.md index b93d6370c51..5507e46ac08 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isBody.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isBody.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] isBody" ---- +--- ```ts isBody(program, entity): boolean ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `boolean` - -## Source - -[decorators.ts:173](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L173) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isContentTypeHeader.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isContentTypeHeader.md index 20562f6a31c..9eb585e9b34 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isContentTypeHeader.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isContentTypeHeader.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] isContentTypeHeader" ---- +--- ```ts isContentTypeHeader(program, property): boolean ``` @@ -11,9 +11,9 @@ Check if the given model property is the content type header. ## Parameters -| Parameter | Type | Description | -| :--------- | :-------------- | :-------------- | -| `program` | `Program` | Program | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | `Program` | Program | | `property` | `ModelProperty` | Model property. | ## Returns @@ -21,7 +21,3 @@ Check if the given model property is the content type header. `boolean` True if the model property is marked as a header and has the name `content-type`(case insensitive.) - -## Source - -[content-types.ts:11](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/content-types.ts#L11) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isHeader.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isHeader.md index 197e7b11562..12866ccacae 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isHeader.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isHeader.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] isHeader" ---- +--- ```ts isHeader(program, entity): boolean ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `boolean` - -## Source - -[decorators.ts:94](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L94) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isMetadata.md index c49779aa3de..ee8b7f79528 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isMetadata.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] isMetadata" ---- +--- ```ts isMetadata(program, property): boolean ``` @@ -12,15 +12,11 @@ metadata if it is marked `@header`, `@query`, `@path`, or `@statusCode`. ## Parameters -| Parameter | Type | -| :--------- | :-------------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `property` | `ModelProperty` | ## Returns `boolean` - -## Source - -[metadata.ts:205](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L205) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isOverloadSameEndpoint.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isOverloadSameEndpoint.md index e181d44c297..523e6f072dd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isOverloadSameEndpoint.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isOverloadSameEndpoint.md @@ -1,22 +1,18 @@ --- jsApi: true title: "[F] isOverloadSameEndpoint" ---- +--- ```ts isOverloadSameEndpoint(overload): boolean ``` ## Parameters -| Parameter | Type | -| :--------- | :--------------------------------------------------------------------------------------------------------------- | +| Parameter | Type | +| :------ | :------ | | `overload` | [`HttpOperation`](Interface.HttpOperation.md) & \{`overloading`: [`HttpOperation`](Interface.HttpOperation.md);} | ## Returns `boolean` - -## Source - -[operations.ts:177](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/operations.ts#L177) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isPathParam.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isPathParam.md index 28a0c4c663a..234c9d49c17 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isPathParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isPathParam.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] isPathParam" ---- +--- ```ts isPathParam(program, entity): boolean ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `boolean` - -## Source - -[decorators.ts:164](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L164) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isQueryParam.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isQueryParam.md index af3300e690c..ce13bfe40f9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isQueryParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isQueryParam.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] isQueryParam" ---- +--- ```ts isQueryParam(program, entity): boolean ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `boolean` - -## Source - -[decorators.ts:143](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L143) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isSharedRoute.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isSharedRoute.md index d12931eef37..20dcc9fea46 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isSharedRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isSharedRoute.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] isSharedRoute" ---- +--- ```ts isSharedRoute(program, operation): boolean ``` ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `operation` | `Operation` | ## Returns `boolean` - -## Source - -[route.ts:241](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/route.ts#L241) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isStatusCode.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isStatusCode.md index 17009859b0d..82423465113 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isStatusCode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isStatusCode.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] isStatusCode" ---- +--- ```ts isStatusCode(program, entity): boolean ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `boolean` - -## Source - -[decorators.ts:238](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L238) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isVisible.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isVisible.md index 59517aed771..c1b7035b9c7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isVisible.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isVisible.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] isVisible" ---- +--- ```ts isVisible( program, @@ -14,16 +14,12 @@ Determines if the given property is visible with the given visibility. ## Parameters -| Parameter | Type | -| :----------- | :---------------------------------------- | -| `program` | `Program` | -| `property` | `ModelProperty` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `property` | `ModelProperty` | | `visibility` | [`Visibility`](Enumeration.Visibility.md) | ## Returns `boolean` - -## Source - -[metadata.ts:217](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L217) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.listHttpOperationsIn.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.listHttpOperationsIn.md index b425cdf0f07..caa7e82c0f1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.listHttpOperationsIn.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.listHttpOperationsIn.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] listHttpOperationsIn" ---- +--- ```ts listHttpOperationsIn( program, @@ -14,16 +14,12 @@ Get all the Http Operation in the given container. ## Parameters -| Parameter | Type | Description | -| :---------- | :-------------------------------------------------------------- | :------------------------------------------- | -| `program` | `Program` | Program | -| `container` | [`OperationContainer`](Type.OperationContainer.md) | Namespace or interface containing operations | -| `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | Resolution options | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | `Program` | Program | +| `container` | [`OperationContainer`](Type.OperationContainer.md) | Namespace or interface containing operations | +| `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | Resolution options | ## Returns [[`HttpOperation`](Interface.HttpOperation.md)[], *readonly* `Diagnostic`[]] - -## Source - -[operations.ts:49](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/operations.ts#L49) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.reportIfNoRoutes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.reportIfNoRoutes.md index 58dd445d4df..55102c45fc8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.reportIfNoRoutes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.reportIfNoRoutes.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] reportIfNoRoutes" ---- +--- ```ts reportIfNoRoutes(program, routes): void ``` ## Parameters -| Parameter | Type | -| :-------- | :---------------------------------------------- | -| `program` | `Program` | -| `routes` | [`HttpOperation`](Interface.HttpOperation.md)[] | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `routes` | [`HttpOperation`](Interface.HttpOperation.md)[] | ## Returns `void` - -## Source - -[operations.ts:120](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/operations.ts#L120) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolvePathAndParameters.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolvePathAndParameters.md index 95ebbce4b44..e5c09d78b56 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolvePathAndParameters.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolvePathAndParameters.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] resolvePathAndParameters" ---- +--- ```ts resolvePathAndParameters( program, @@ -13,17 +13,13 @@ resolvePathAndParameters( ## Parameters -| Parameter | Type | -| :------------- | :-------------------------------------------------------------- | -| `program` | `Program` | -| `operation` | `Operation` | -| `overloadBase` | `undefined` \| [`HttpOperation`](Interface.HttpOperation.md) | -| `options` | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `operation` | `Operation` | +| `overloadBase` | `undefined` \| [`HttpOperation`](Interface.HttpOperation.md) | +| `options` | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | ## Returns `DiagnosticResult`< \{`parameters`: [`HttpOperationParameters`](Interface.HttpOperationParameters.md); `path`: `string`; `pathSegments`: `string`[];} \> - -## Source - -[route.ts:52](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/route.ts#L52) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolveRequestVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolveRequestVisibility.md new file mode 100644 index 00000000000..cbf03c3ba44 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolveRequestVisibility.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] resolveRequestVisibility" + +--- +```ts +resolveRequestVisibility( + program, + operation, + verb): Visibility +``` + +Returns the applicable parameter visibility or visibilities for the request if `@requestVisibility` was used. +Otherwise, returns the default visibility based on the HTTP verb for the operation. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | `Program` | - | +| `operation` | `Operation` | The TypeSpec Operation for the request. | +| `verb` | [`HttpVerb`](Type.HttpVerb.md) | The HTTP verb for the operation. | + +## Returns + +[`Visibility`](Enumeration.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/Function.setAuthentication.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setAuthentication.md index 124926e1e4c..cb6312ada39 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setAuthentication.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setAuthentication.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] setAuthentication" ---- +--- ```ts setAuthentication( program, @@ -12,16 +12,12 @@ setAuthentication( ## Parameters -| Parameter | Type | -| :----------------- | :------------------------------------------------------------ | -| `program` | `Program` | -| `serviceNamespace` | `Namespace` | -| `auth` | [`ServiceAuthentication`](Interface.ServiceAuthentication.md) | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `serviceNamespace` | `Namespace` | +| `auth` | [`ServiceAuthentication`](Interface.ServiceAuthentication.md) | ## Returns `void` - -## Source - -[decorators.ts:438](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L438) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRoute.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRoute.md index b84eafde9f9..10f84400140 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRoute.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] setRoute" ---- +--- ```ts setRoute( context, @@ -12,16 +12,12 @@ setRoute( ## Parameters -| Parameter | Type | -| :-------- | :------------------------------------ | -| `context` | `DecoratorContext` | -| `entity` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Type` | | `details` | [`RoutePath`](Interface.RoutePath.md) | ## Returns `void` - -## Source - -[route.ts:209](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/route.ts#L209) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteOptionsForNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteOptionsForNamespace.md index 8900278236a..fab2adb2536 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteOptionsForNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteOptionsForNamespace.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] setRouteOptionsForNamespace" ---- +--- ```ts setRouteOptionsForNamespace( program, @@ -12,16 +12,12 @@ setRouteOptionsForNamespace( ## Parameters -| Parameter | Type | -| :---------- | :------------------------------------------ | -| `program` | `Program` | -| `namespace` | `Namespace` | -| `options` | [`RouteOptions`](Interface.RouteOptions.md) | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `namespace` | `Namespace` | +| `options` | [`RouteOptions`](Interface.RouteOptions.md) | ## Returns `void` - -## Source - -[route.ts:260](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/route.ts#L260) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteProducer.md index 82f59f1b657..f854833a461 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteProducer.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] setRouteProducer" ---- +--- ```ts setRouteProducer( program, @@ -12,16 +12,12 @@ setRouteProducer( ## Parameters -| Parameter | Type | -| :-------------- | :--------------------------------------- | -| `program` | `Program` | -| `operation` | `Operation` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `operation` | `Operation` | | `routeProducer` | [`RouteProducer`](Type.RouteProducer.md) | ## Returns `void` - -## Source - -[route.ts:195](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/route.ts#L195) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setSharedRoute.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setSharedRoute.md index b6e87b2449b..5a17f9bf5e6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setSharedRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setSharedRoute.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] setSharedRoute" ---- +--- ```ts setSharedRoute(program, operation): void ``` ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `operation` | `Operation` | ## Returns `void` - -## Source - -[route.ts:237](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/route.ts#L237) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setStatusCode.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setStatusCode.md index bcd455d8fb5..e622d2a1c81 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setStatusCode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setStatusCode.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] setStatusCode" ---- +--- ```ts setStatusCode( program, @@ -12,16 +12,12 @@ setStatusCode( ## Parameters -| Parameter | Type | -| :-------- | :------------------------- | -| `program` | `Program` | -| `entity` | `Model` \| `ModelProperty` | -| `codes` | `string`[] | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `entity` | `Model` \| `ModelProperty` | +| `codes` | `string`[] | ## Returns `void` - -## Source - -[decorators.ts:219](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/decorators.ts#L219) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.validateRouteUnique.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.validateRouteUnique.md index a4e2b9486b1..99be23d27f5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.validateRouteUnique.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.validateRouteUnique.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] validateRouteUnique" ---- +--- ```ts validateRouteUnique( program, @@ -12,16 +12,12 @@ validateRouteUnique( ## Parameters -| Parameter | Type | -| :------------ | :---------------------------------------------- | -| `program` | `Program` | -| `diagnostics` | `DiagnosticCollector` | -| `operations` | [`HttpOperation`](Interface.HttpOperation.md)[] | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `diagnostics` | `DiagnosticCollector` | +| `operations` | [`HttpOperation`](Interface.HttpOperation.md)[] | ## Returns `void` - -## Source - -[operations.ts:129](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/operations.ts#L129) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ApiKeyAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ApiKeyAuth.md index 51ec0d9a90b..a1345c324ee 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ApiKeyAuth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ApiKeyAuth.md @@ -1,10 +1,9 @@ --- jsApi: true title: "[I] ApiKeyAuth" ---- +--- An API key is a token that a client provides when making API calls. The key can be sent in the query string: - ``` GET /something?api_key=abcdef12345 ``` @@ -29,17 +28,17 @@ Cookie: X-API-KEY=abcdef12345 ## Type parameters -| Parameter | -| :------------------------------------- | -| `TLocation` _extends_ `ApiKeyLocation` | -| `TName` _extends_ `string` | +| Parameter | +| :------ | +| `TLocation` *extends* `ApiKeyLocation` | +| `TName` *extends* `string` | ## Properties -| Property | Type | Description | -| :------------- | :---------- | :------------------------------- | -| `description`? | `string` | Optional description. | -| `id` | `string` | Id of the authentication scheme. | -| `in` | `TLocation` | - | -| `name` | `TName` | - | -| `type` | `"apiKey"` | - | +| Property | Type | Description | +| :------ | :------ | :------ | +| `description`? | `string` | Optional description. | +| `id` | `string` | Id of the authentication scheme. | +| `in` | `TLocation` | - | +| `name` | `TName` | - | +| `type` | `"apiKey"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthenticationOption.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthenticationOption.md index 051030588d0..99ad2de87b7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthenticationOption.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthenticationOption.md @@ -1,10 +1,10 @@ --- jsApi: true title: "[I] AuthenticationOption" ---- +--- ## Properties -| Property | Type | Description | -| :-------- | :------------------------------- | :-------------------------------------------------------------------------- | +| Property | Type | Description | +| :------ | :------ | :------ | | `schemes` | [`HttpAuth`](Type.HttpAuth.md)[] | For this authentication option all the given auth have to be used together. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthorizationCodeFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthorizationCodeFlow.md index 189b8a92934..bcf7feb4dd3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthorizationCodeFlow.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthorizationCodeFlow.md @@ -1,16 +1,16 @@ --- jsApi: true title: "[I] AuthorizationCodeFlow" ---- +--- Authorization Code flow ## Properties -| Property | Type | -| :----------------- | :------------------------------------------ | -| `authorizationUrl` | `string` | -| `refreshUrl`? | `string` | -| `scopes` | [`OAuth2Scope`](Interface.OAuth2Scope.md)[] | -| `tokenUrl` | `string` | -| `type` | `"authorizationCode"` | +| Property | Type | +| :------ | :------ | +| `authorizationUrl` | `string` | +| `refreshUrl`? | `string` | +| `scopes` | [`OAuth2Scope`](Interface.OAuth2Scope.md)[] | +| `tokenUrl` | `string` | +| `type` | `"authorizationCode"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BasicAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BasicAuth.md index d271fc5344b..6a02c3a473b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BasicAuth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BasicAuth.md @@ -1,12 +1,11 @@ --- jsApi: true title: "[I] BasicAuth" ---- +--- Basic authentication is a simple authentication scheme built into the HTTP protocol. The client sends HTTP requests with the Authorization header that contains the word Basic word followed by a space and a base64-encoded string username:password. For example, to authorize as demo / p@55w0rd the client would send - ``` Authorization: Basic ZGVtbzpwQDU1dzByZA== ``` @@ -17,9 +16,9 @@ For example, to authorize as demo / p@55w0rd the client would send ## Properties -| Property | Type | Description | -| :------------- | :-------- | :------------------------------- | -| `description`? | `string` | Optional description. | -| `id` | `string` | Id of the authentication scheme. | -| `scheme` | `"basic"` | - | -| `type` | `"http"` | - | +| Property | Type | Description | +| :------ | :------ | :------ | +| `description`? | `string` | Optional description. | +| `id` | `string` | Id of the authentication scheme. | +| `scheme` | `"basic"` | - | +| `type` | `"http"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BearerAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BearerAuth.md index 3acc31c4ff5..bd21824e29a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BearerAuth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BearerAuth.md @@ -1,12 +1,11 @@ --- jsApi: true title: "[I] BearerAuth" ---- +--- Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The name “Bearer authentication” can be understood as “give access to the bearer of this token.” The bearer token is a cryptic string, usually generated by the server in response to a login request. The client must send this token in the Authorization header when making requests to protected resources: - ``` Authorization: Bearer ``` @@ -17,9 +16,9 @@ The client must send this token in the Authorization header when making requests ## Properties -| Property | Type | Description | -| :------------- | :--------- | :------------------------------- | -| `description`? | `string` | Optional description. | -| `id` | `string` | Id of the authentication scheme. | -| `scheme` | `"bearer"` | - | -| `type` | `"http"` | - | +| Property | Type | Description | +| :------ | :------ | :------ | +| `description`? | `string` | Optional description. | +| `id` | `string` | Id of the authentication scheme. | +| `scheme` | `"bearer"` | - | +| `type` | `"http"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ClientCredentialsFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ClientCredentialsFlow.md index eea8b43bce6..483411e271b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ClientCredentialsFlow.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ClientCredentialsFlow.md @@ -1,15 +1,15 @@ --- jsApi: true title: "[I] ClientCredentialsFlow" ---- +--- Client credentials flow ## Properties -| Property | Type | -| :------------ | :------------------------------------------ | -| `refreshUrl`? | `string` | -| `scopes` | [`OAuth2Scope`](Interface.OAuth2Scope.md)[] | -| `tokenUrl` | `string` | -| `type` | `"clientCredentials"` | +| Property | Type | +| :------ | :------ | +| `refreshUrl`? | `string` | +| `scopes` | [`OAuth2Scope`](Interface.OAuth2Scope.md)[] | +| `tokenUrl` | `string` | +| `type` | `"clientCredentials"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HeaderFieldOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HeaderFieldOptions.md index 18dde24f5cf..963137286ee 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HeaderFieldOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HeaderFieldOptions.md @@ -1,12 +1,12 @@ --- jsApi: true title: "[I] HeaderFieldOptions" ---- +--- ## Properties -| Property | Type | Description | -| :-------- | :-------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------- | +| 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". | -| `name` | `string` | - | -| `type` | `"header"` | - | +| `name` | `string` | - | +| `type` | `"header"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpAuthBase.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpAuthBase.md index 38656084ae0..b9fdbd2aa22 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpAuthBase.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpAuthBase.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[I] HttpAuthBase" ---- +--- ## Extended By - [`BasicAuth`](Interface.BasicAuth.md) @@ -12,7 +12,7 @@ title: "[I] HttpAuthBase" ## Properties -| Property | Type | Description | -| :------------- | :------- | :------------------------------- | -| `description`? | `string` | Optional description. | -| `id` | `string` | Id of the authentication scheme. | +| Property | Type | 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/Interface.HttpOperation.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperation.md index c6574e1ef22..12343783b63 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperation.md @@ -1,18 +1,18 @@ --- jsApi: true title: "[I] HttpOperation" ---- +--- ## Properties -| Property | Type | Description | -| :------------- | :---------------------------------------------------------------- | :-------------------------------------------------------------- | -| `container` | [`OperationContainer`](Type.OperationContainer.md) | Parent type being the interface, namespace or global namespace. | -| `operation` | `Operation` | Operation type reference. | -| `overloading`? | [`HttpOperation`](Interface.HttpOperation.md) | Overload this operation | -| `overloads`? | [`HttpOperation`](Interface.HttpOperation.md)[] | List of operations that overloads this one. | -| `parameters` | [`HttpOperationParameters`](Interface.HttpOperationParameters.md) | Parameters. | -| `path` | `string` | Route path | -| `pathSegments` | `string`[] | Path segments | -| `responses` | [`HttpOperationResponse`](Interface.HttpOperationResponse.md)[] | Responses. | -| `verb` | [`HttpVerb`](Type.HttpVerb.md) | Route verb. | +| Property | Type | Description | +| :------ | :------ | :------ | +| `container` | [`OperationContainer`](Type.OperationContainer.md) | Parent type being the interface, namespace or global namespace. | +| `operation` | `Operation` | Operation type reference. | +| `overloading`? | [`HttpOperation`](Interface.HttpOperation.md) | Overload this operation | +| `overloads`? | [`HttpOperation`](Interface.HttpOperation.md)[] | List of operations that overloads this one. | +| `parameters` | [`HttpOperationParameters`](Interface.HttpOperationParameters.md) | Parameters. | +| `path` | `string` | Route path | +| `pathSegments` | `string`[] | Path segments | +| `responses` | [`HttpOperationResponse`](Interface.HttpOperationResponse.md)[] | Responses. | +| `verb` | [`HttpVerb`](Type.HttpVerb.md) | Route verb. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationBody.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationBody.md index d7674830664..382f56b9a38 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationBody.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationBody.md @@ -1,15 +1,15 @@ --- jsApi: true title: "[I] HttpOperationBody" ---- +--- ## Extended By - [`HttpOperationRequestBody`](Interface.HttpOperationRequestBody.md) ## Properties -| Property | Type | Description | -| :------------- | :--------- | :-------------------------- | -| `contentTypes` | `string`[] | Content types. | -| `type` | `Type` | Type of the operation body. | +| Property | Type | Description | +| :------ | :------ | :------ | +| `contentTypes` | `string`[] | Content types. | +| `type` | `Type` | Type of the operation body. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationParameters.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationParameters.md index c89eca7060d..65804ab169d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationParameters.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationParameters.md @@ -1,14 +1,14 @@ --- jsApi: true title: "[I] HttpOperationParameters" ---- +--- ## Properties -| Property | Type | Description | -| :--------------- | :------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `body`? | [`HttpOperationRequestBody`](Interface.HttpOperationRequestBody.md) | - | -| `bodyParameter`? | `ModelProperty` | **Deprecated**

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

use body.type | -| `parameters` | [`HttpOperationParameter`](Type.HttpOperationParameter.md)[] | - | -| `verb` | [`HttpVerb`](Type.HttpVerb.md) | NOTE: The verb is determined when processing parameters as it can
depend on whether there is a request body if not explicitly specified.
Marked internal to keep from polluting the public API with the verb at
two levels. | +| Property | Type | Description | +| :------ | :------ | :------ | +| `body`? | [`HttpOperationRequestBody`](Interface.HttpOperationRequestBody.md) | - | +| `bodyParameter`? | `ModelProperty` | **Deprecated**

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

use body.type | +| `parameters` | [`HttpOperationParameter`](Type.HttpOperationParameter.md)[] | - | +| `verb` | [`HttpVerb`](Type.HttpVerb.md) | NOTE: The verb is determined when processing parameters as it can
depend on whether there is a request body if not explicitly specified.
Marked internal to keep from polluting the public API with the verb at
two levels. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationRequestBody.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationRequestBody.md index a4adf1d9557..73ce748a9b7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationRequestBody.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationRequestBody.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[I] HttpOperationRequestBody" ---- +--- Represent the body information for an http request. ## Note @@ -15,8 +15,8 @@ the `type` must be a `Model` if the content type is multipart. ## Properties -| Property | Type | Description | -| :------------- | :-------------- | :------------------------------------------------------------------------------------ | -| `contentTypes` | `string`[] | Content types. | -| `parameter`? | `ModelProperty` | If the body was explicitly set as a property. Correspond to the property with `@body` | -| `type` | `Type` | Type of the operation body. | +| Property | Type | Description | +| :------ | :------ | :------ | +| `contentTypes` | `string`[] | Content types. | +| `parameter`? | `ModelProperty` | If the body was explicitly set as a property. Correspond to the property with `@body` | +| `type` | `Type` | Type of the operation body. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponse.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponse.md index 85cd2089ab4..3cc2c128f5a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponse.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponse.md @@ -1,13 +1,13 @@ --- jsApi: true title: "[I] HttpOperationResponse" ---- +--- ## Properties -| Property | Type | -| :------------- | :---------------------------------------------------------------------------- | -| `description`? | `string` | -| `responses` | [`HttpOperationResponseContent`](Interface.HttpOperationResponseContent.md)[] | -| `statusCode` | [`StatusCode`](Type.StatusCode.md) | -| `type` | `Type` | +| Property | Type | +| :------ | :------ | +| `description`? | `string` | +| `responses` | [`HttpOperationResponseContent`](Interface.HttpOperationResponseContent.md)[] | +| `statusCode` | [`StatusCode`](Type.StatusCode.md) | +| `type` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponseContent.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponseContent.md index 1d02a685c6c..1fbc763c1d3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponseContent.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponseContent.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] HttpOperationResponseContent" ---- +--- ## Properties -| Property | Type | -| :--------- | :---------------------------------------------------- | -| `body`? | [`HttpOperationBody`](Interface.HttpOperationBody.md) | -| `headers`? | `Record`< `string`, `ModelProperty` \> | +| Property | Type | +| :------ | :------ | +| `body`? | [`HttpOperationBody`](Interface.HttpOperationBody.md) | +| `headers`? | `Record`< `string`, `ModelProperty` \> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpServer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpServer.md index ac5d9ac7bcc..830b9f97ab1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpServer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpServer.md @@ -1,12 +1,12 @@ --- jsApi: true title: "[I] HttpServer" ---- +--- ## Properties -| Property | Type | -| :------------ | :---------------------------------- | -| `description` | `string` | -| `parameters` | `Map`< `string`, `ModelProperty` \> | -| `url` | `string` | +| Property | Type | +| :------ | :------ | +| `description` | `string` | +| `parameters` | `Map`< `string`, `ModelProperty` \> | +| `url` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpService.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpService.md index 11f039c1184..43eddde92b9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpService.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] HttpService" ---- +--- ## Properties -| Property | Type | -| :----------- | :---------------------------------------------- | -| `namespace` | `Namespace` | +| Property | Type | +| :------ | :------ | +| `namespace` | `Namespace` | | `operations` | [`HttpOperation`](Interface.HttpOperation.md)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ImplicitFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ImplicitFlow.md index 341b45d82ee..f35a7866637 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ImplicitFlow.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ImplicitFlow.md @@ -1,15 +1,15 @@ --- jsApi: true title: "[I] ImplicitFlow" ---- +--- Implicit flow ## Properties -| Property | Type | -| :----------------- | :------------------------------------------ | -| `authorizationUrl` | `string` | -| `refreshUrl`? | `string` | -| `scopes` | [`OAuth2Scope`](Interface.OAuth2Scope.md)[] | -| `type` | `"implicit"` | +| Property | Type | +| :------ | :------ | +| `authorizationUrl` | `string` | +| `refreshUrl`? | `string` | +| `scopes` | [`OAuth2Scope`](Interface.OAuth2Scope.md)[] | +| `type` | `"implicit"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfo.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfo.md index 4c500d4ed40..32ae18d23d3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfo.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[I] MetadataInfo" ---- +--- Provides information about changes that happen to a data type's payload when inapplicable metadata is added or invisible properties are removed. @@ -10,7 +10,7 @@ Results are computed on demand and expensive computations are memoized. ## Methods -### getEffectivePayloadType() +### getEffectivePayloadType ```ts getEffectivePayloadType(type, visibility): Type @@ -21,22 +21,18 @@ same set of properties when non-payload properties are excluded. #### Parameters -| Parameter | Type | -| :----------- | :---------------------------------------- | -| `type` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `type` | `Type` | | `visibility` | [`Visibility`](Enumeration.Visibility.md) | #### Returns `Type` -#### Source - -[metadata.ts:326](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L326) - ---- +*** -### isEmptied() +### isEmptied ```ts isEmptied(type, visibility): boolean @@ -53,22 +49,18 @@ itself is also removed. #### Parameters -| Parameter | Type | -| :----------- | :---------------------------------------- | -| `type` | `undefined` \| `Type` | +| Parameter | Type | +| :------ | :------ | +| `type` | `undefined` \| `Type` | | `visibility` | [`Visibility`](Enumeration.Visibility.md) | #### Returns `boolean` -#### Source - -[metadata.ts:300](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L300) - ---- +*** -### isOptional() +### isOptional ```ts isOptional(property, visibility): boolean @@ -79,22 +71,18 @@ response payload for the given visibility. #### Parameters -| Parameter | Type | -| :----------- | :---------------------------------------- | -| `property` | `ModelProperty` | +| Parameter | Type | +| :------ | :------ | +| `property` | `ModelProperty` | | `visibility` | [`Visibility`](Enumeration.Visibility.md) | #### Returns `boolean` -#### Source +*** -[metadata.ts:320](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L320) - ---- - -### isPayloadProperty() +### isPayloadProperty ```ts isPayloadProperty(property, visibility): boolean @@ -106,22 +94,18 @@ filtered out by the given visibility. #### Parameters -| Parameter | Type | -| :----------- | :---------------------------------------- | -| `property` | `ModelProperty` | +| Parameter | Type | +| :------ | :------ | +| `property` | `ModelProperty` | | `visibility` | [`Visibility`](Enumeration.Visibility.md) | #### Returns `boolean` -#### Source - -[metadata.ts:314](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L314) +*** ---- - -### isTransformed() +### isTransformed ```ts isTransformed(type, visibility): boolean @@ -133,15 +117,11 @@ metadata properties. #### Parameters -| Parameter | Type | -| :----------- | :---------------------------------------- | -| `type` | `undefined` \| `Type` | +| Parameter | Type | +| :------ | :------ | +| `type` | `undefined` \| `Type` | | `visibility` | [`Visibility`](Enumeration.Visibility.md) | #### Returns `boolean` - -#### Source - -[metadata.ts:307](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L307) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfoOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfoOptions.md index 302dbc7b245..02cc394bcf7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfoOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfoOptions.md @@ -1,17 +1,17 @@ --- jsApi: true title: "[I] MetadataInfoOptions" ---- +--- ## Properties -| Property | Type | Description | -| :--------------------- | :---------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Property | Type | Description | +| :------ | :------ | :------ | | `canonicalVisibility`? | [`Visibility`](Enumeration.Visibility.md) | The visibility to be used as the baseline against which
[isEmptied](Interface.MetadataInfo.md#isemptied) and [isTransformed](Interface.MetadataInfo.md#istransformed)
are computed. If not specified, [None](Enumeration.Visibility.md#none) is used, which
will consider that any model that has fields that are only visible to
some visibilities as transformed. | ## Methods -### canShareProperty() +### canShareProperty ```ts optional canShareProperty(property): boolean @@ -26,14 +26,10 @@ creating a separate schema schema for [Read](Enumeration.Visibility.md#read). #### Parameters -| Parameter | Type | -| :--------- | :-------------- | +| Parameter | Type | +| :------ | :------ | | `property` | `ModelProperty` | #### Returns `boolean` - -#### Source - -[metadata.ts:347](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/metadata.ts#L347) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OAuth2Scope.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OAuth2Scope.md index 884af66d652..ba74099dbb0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OAuth2Scope.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OAuth2Scope.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] OAuth2Scope" ---- +--- ## Properties -| Property | Type | -| :------------- | :------- | +| Property | Type | +| :------ | :------ | | `description`? | `string` | -| `value` | `string` | +| `value` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.Oauth2Auth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.Oauth2Auth.md index af42f6f33eb..e37ae61d24b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.Oauth2Auth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.Oauth2Auth.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[I] Oauth2Auth" ---- +--- OAuth 2.0 is an authorization protocol that gives an API client limited access to user data on a web server. OAuth relies on authentication scenarios called flows, which allow the resource owner (user) to share the protected content from the resource server without sharing their credentials. For that purpose, an OAuth 2.0 server issues access tokens that the client applications can use to access protected resources on behalf of the resource owner. @@ -14,15 +14,15 @@ For more information about OAuth 2.0, see oauth.net and RFC 6749. ## Type parameters -| Parameter | -| :------------------------------------------------------ | -| `TFlows` _extends_ [`OAuth2Flow`](Type.OAuth2Flow.md)[] | +| Parameter | +| :------ | +| `TFlows` *extends* [`OAuth2Flow`](Type.OAuth2Flow.md)[] | ## Properties -| Property | Type | Description | -| :------------- | :--------- | :------------------------------- | -| `description`? | `string` | Optional description. | -| `flows` | `TFlows` | - | -| `id` | `string` | Id of the authentication scheme. | -| `type` | `"oauth2"` | - | +| Property | Type | Description | +| :------ | :------ | :------ | +| `description`? | `string` | Optional description. | +| `flows` | `TFlows` | - | +| `id` | `string` | Id of the authentication scheme. | +| `type` | `"oauth2"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OperationParameterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OperationParameterOptions.md index 57fc66347d3..8c2f5e9acc3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OperationParameterOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OperationParameterOptions.md @@ -1,10 +1,10 @@ --- jsApi: true title: "[I] OperationParameterOptions" ---- +--- ## Properties -| Property | Type | -| :-------------- | :------------------------------------------------------- | +| Property | Type | +| :------ | :------ | | `verbSelector`? | [`OperationVerbSelector`](Type.OperationVerbSelector.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PasswordFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PasswordFlow.md index 593897a3176..e5398bb7086 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PasswordFlow.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PasswordFlow.md @@ -1,15 +1,15 @@ --- jsApi: true title: "[I] PasswordFlow" ---- +--- Resource Owner Password flow ## Properties -| Property | Type | -| :----------------- | :------------------------------------------ | -| `authorizationUrl` | `string` | -| `refreshUrl`? | `string` | -| `scopes` | [`OAuth2Scope`](Interface.OAuth2Scope.md)[] | -| `type` | `"password"` | +| Property | Type | +| :------ | :------ | +| `authorizationUrl` | `string` | +| `refreshUrl`? | `string` | +| `scopes` | [`OAuth2Scope`](Interface.OAuth2Scope.md)[] | +| `type` | `"password"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PathParameterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PathParameterOptions.md index 69656c1f1a5..e1ff10adacf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PathParameterOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PathParameterOptions.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] PathParameterOptions" ---- +--- ## Properties -| Property | Type | -| :------- | :------- | -| `name` | `string` | -| `type` | `"path"` | +| Property | Type | +| :------ | :------ | +| `name` | `string` | +| `type` | `"path"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.QueryParameterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.QueryParameterOptions.md index 0d736c377bc..8447f32e64b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.QueryParameterOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.QueryParameterOptions.md @@ -1,12 +1,12 @@ --- jsApi: true title: "[I] QueryParameterOptions" ---- +--- ## Properties -| Property | Type | Description | -| :-------- | :-------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------- | +| 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". | -| `name` | `string` | - | -| `type` | `"query"` | - | +| `name` | `string` | - | +| `type` | `"query"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteOptions.md index b4bda03ec45..4d24a9c3d8c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteOptions.md @@ -1,18 +1,18 @@ --- jsApi: true title: "[I] RouteOptions" ---- +--- ## Extended By - [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) ## Indexable -\[`prop`: `string`\]: `any` + \[`prop`: `string`\]: `any` ## Properties -| Property | Type | -| :-------------- | :-------------------------------------------------------------------- | +| Property | Type | +| :------ | :------ | | `paramOptions`? | [`OperationParameterOptions`](Interface.OperationParameterOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RoutePath.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RoutePath.md index 4121827eccd..9dab4e018a6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RoutePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RoutePath.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] RoutePath" ---- +--- ## Properties -| Property | Type | -| :------- | :-------- | -| `path` | `string` | +| Property | Type | +| :------ | :------ | +| `path` | `string` | | `shared` | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteProducerResult.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteProducerResult.md index c81c8d36e06..9e578d50c4c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteProducerResult.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteProducerResult.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] RouteProducerResult" ---- +--- ## Properties -| Property | Type | -| :----------- | :---------------------------------------------------------------- | +| Property | Type | +| :------ | :------ | | `parameters` | [`HttpOperationParameters`](Interface.HttpOperationParameters.md) | -| `segments` | `string`[] | +| `segments` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteResolutionOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteResolutionOptions.md index db88afbbf03..e852623d71f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteResolutionOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteResolutionOptions.md @@ -1,15 +1,15 @@ --- jsApi: true title: "[I] RouteResolutionOptions" ---- +--- ## Extends - [`RouteOptions`](Interface.RouteOptions.md) ## Properties -| Property | Type | -| :-------------- | :-------------------------------------------------------------------- | -| `listOptions`? | `ListOperationOptions` | +| Property | Type | +| :------ | :------ | +| `listOptions`? | `ListOperationOptions` | | `paramOptions`? | [`OperationParameterOptions`](Interface.OperationParameterOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ServiceAuthentication.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ServiceAuthentication.md index 553dcf614d7..409ce5e3cd4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ServiceAuthentication.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ServiceAuthentication.md @@ -1,10 +1,10 @@ --- jsApi: true title: "[I] ServiceAuthentication" ---- +--- ## Properties -| Property | Type | Description | -| :-------- | :------------------------------------------------------------ | :--------------------------------------------------------------------- | +| Property | Type | Description | +| :------ | :------ | :------ | | `options` | [`AuthenticationOption`](Interface.AuthenticationOption.md)[] | Either one of those options can be used independently to authenticate. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpAuth.md index 626b19679b7..5d71a8b772e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpAuth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpAuth.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[T] HttpAuth" ---- +--- ```ts -HttpAuth: BasicAuth | BearerAuth | ApiKeyAuth | Oauth2Auth; +HttpAuth: BasicAuth | BearerAuth | ApiKeyAuth< ApiKeyLocation, string > | Oauth2Auth< OAuth2Flow[] > ``` - -## Source - -[types.ts:33](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/types.ts#L33) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpOperationParameter.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpOperationParameter.md index aeae510d94c..da6f6c422e8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpOperationParameter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpOperationParameter.md @@ -1,16 +1,12 @@ --- jsApi: true title: "[T] HttpOperationParameter" ---- +--- ```ts HttpOperationParameter: HeaderFieldOptions | QueryParameterOptions | PathParameterOptions & {param: ModelProperty;} ``` -| Member | Type | -| :------ | :-------------- | +| Member | Type | +| :------ | :------ | | `param` | `ModelProperty` | - -## Source - -[types.ts:231](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/types.ts#L231) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpVerb.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpVerb.md index 6e0c310658a..134813fa30c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpVerb.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpVerb.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[T] HttpVerb" ---- +--- ```ts -HttpVerb: "get" | "put" | "post" | "patch" | "delete" | "head"; +HttpVerb: "get" | "put" | "post" | "patch" | "delete" | "head" ``` - -## Source - -[types.ts:17](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/types.ts#L17) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2Flow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2Flow.md index a3d83470d39..cea2bd210ad 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2Flow.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2Flow.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[T] OAuth2Flow" ---- +--- ```ts -OAuth2Flow: AuthorizationCodeFlow | ImplicitFlow | PasswordFlow | ClientCredentialsFlow; +OAuth2Flow: AuthorizationCodeFlow | ImplicitFlow | PasswordFlow | ClientCredentialsFlow ``` - -## Source - -[types.ts:117](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/types.ts#L117) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2FlowType.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2FlowType.md index 7ccb04ab00f..510f5f40542 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2FlowType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2FlowType.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[T] OAuth2FlowType" ---- +--- ```ts -OAuth2FlowType: OAuth2Flow["type"]; +OAuth2FlowType: OAuth2Flow["type"] ``` - -## Source - -[types.ts:123](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/types.ts#L123) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationContainer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationContainer.md index cbf3c44f121..9b2f3cd3649 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationContainer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationContainer.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[T] OperationContainer" ---- +--- ```ts -OperationContainer: Namespace | Interface; +OperationContainer: Namespace | Interface ``` - -## Source - -[types.ts:171](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/types.ts#L171) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationDetails.md index 1b9b5642c8d..c7da2af5d4e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationDetails.md @@ -1,16 +1,12 @@ --- jsApi: true title: "[T] OperationDetails" ---- +--- ```ts -OperationDetails: HttpOperation; +OperationDetails: HttpOperation ``` ## Deprecated use `HttpOperation`. To remove in November 2022 release. - -## Source - -[types.ts:15](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/types.ts#L15) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationVerbSelector.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationVerbSelector.md index 7200f5a1516..85be67f16d8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationVerbSelector.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationVerbSelector.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[T] OperationVerbSelector" ---- +--- ```ts -OperationVerbSelector: (program, operation) => HttpVerb | undefined; +OperationVerbSelector: (program, operation) => HttpVerb | undefined ``` ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `operation` | `Operation` | ## Returns [`HttpVerb`](Type.HttpVerb.md) \| `undefined` - -## Source - -[types.ts:173](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/types.ts#L173) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.RouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.RouteProducer.md index f337d300894..d31bc6614d8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.RouteProducer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.RouteProducer.md @@ -1,27 +1,22 @@ --- jsApi: true title: "[T] RouteProducer" ---- +--- ```ts -RouteProducer: (program, operation, parentSegments, overloadBase, options) => - DiagnosticResult; +RouteProducer: (program, operation, parentSegments, overloadBase, options) => DiagnosticResult< RouteProducerResult > ``` ## Parameters -| Parameter | Type | -| :--------------- | :----------------------------------------------------------- | -| `program` | `Program` | -| `operation` | `Operation` | -| `parentSegments` | `string`[] | -| `overloadBase` | [`HttpOperation`](Interface.HttpOperation.md) \| `undefined` | -| `options` | [`RouteOptions`](Interface.RouteOptions.md) | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `operation` | `Operation` | +| `parentSegments` | `string`[] | +| `overloadBase` | [`HttpOperation`](Interface.HttpOperation.md) \| `undefined` | +| `options` | [`RouteOptions`](Interface.RouteOptions.md) | ## Returns `DiagnosticResult`< [`RouteProducerResult`](Interface.RouteProducerResult.md) \> - -## Source - -[types.ts:198](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/types.ts#L198) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.StatusCode.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.StatusCode.md index 0d20eec298c..3cd9f5c6fb5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.StatusCode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.StatusCode.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[T] StatusCode" ---- +--- ```ts StatusCode: \${number}\ | "" ``` - -## Source - -[types.ts:328](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/types.ts#L328) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.$lib.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.$lib.md new file mode 100644 index 00000000000..d11cee9bf58 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.$lib.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] $lib" + +--- +```ts +const $lib: TypeSpecLibrary< Object, Record< string, any > > +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.namespace.md index 3f8ecc6968e..f486edc38fa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.namespace.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[V] namespace" ---- +--- ```ts -const namespace: "TypeSpec.Http" = "TypeSpec.Http"; +const namespace: "TypeSpec.Http" = "TypeSpec.Http" ``` - -## Source - -[index.ts:1](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/http/src/index.ts#L1) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/index.md index 713d7ac593d..78edbdc1803 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/index.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[P] JS Api" ---- +--- ## Index ### Enumerations @@ -57,6 +57,7 @@ title: "[P] JS Api" ### Variables +- [$lib](Variable.$lib.md) - [namespace](Variable.namespace.md) ### Functions @@ -122,6 +123,7 @@ title: "[P] JS Api" - [listHttpOperationsIn](Function.listHttpOperationsIn.md) - [reportIfNoRoutes](Function.reportIfNoRoutes.md) - [resolvePathAndParameters](Function.resolvePathAndParameters.md) +- [resolveRequestVisibility](Function.resolveRequestVisibility.md) - [setAuthentication](Function.setAuthentication.md) - [setRoute](Function.setRoute.md) - [setRouteOptionsForNamespace](Function.setRouteOptionsForNamespace.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Class.JsonSchemaEmitter.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Class.JsonSchemaEmitter.md index 47525d5ddbc..787ecb13fc5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Class.JsonSchemaEmitter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Class.JsonSchemaEmitter.md @@ -1,15 +1,15 @@ --- jsApi: true title: "[C] JsonSchemaEmitter" ---- +--- ## Extends - `TypeEmitter`< `Record`< `string`, `any` \>, [`JSONSchemaEmitterOptions`](Interface.JSONSchemaEmitterOptions.md) \> ## Constructors -### constructor() +### new JsonSchemaEmitter ```ts new JsonSchemaEmitter(emitter): JsonSchemaEmitter @@ -20,8 +20,8 @@ call `createAssetEmitter` on the emitter context object. #### Parameters -| Parameter | Type | Description | -| :-------- | :------------------------------------------------------------------------------------------------------------------- | :---------------- | +| Parameter | Type | Description | +| :------ | :------ | :------ | | `emitter` | `AssetEmitter`< `Record`< `string`, `any` \>, [`JSONSchemaEmitterOptions`](Interface.JSONSchemaEmitterOptions.md) \> | The asset emitter | #### Returns @@ -32,22 +32,18 @@ call `createAssetEmitter` on the emitter context object. TypeEmitter, JSONSchemaEmitterOptions\>.constructor -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:124 - ## Properties -| Property | Type | -| :----------------------------- | :------------------------------------------------------------------------------------------------------------------- | -| `private` `#refToDecl` | `Map`< `string`, `Declaration`< `Record`< `string`, `unknown` \> \> \> | -| `private` `#seenIds` | `Set`< `unknown` \> | -| `private` `#typeForSourceFile` | `Map`< `SourceFile`< `any` \>, [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) \> | -| `protected` `emitter` | `AssetEmitter`< `Record`< `string`, `any` \>, [`JSONSchemaEmitterOptions`](Interface.JSONSchemaEmitterOptions.md) \> | +| Property | Type | +| :------ | :------ | +| `private` `#refToDecl` | `Map`< `string`, `Declaration`< `Record`< `string`, `unknown` \> \> \> | +| `private` `#seenIds` | `Set`< `unknown` \> | +| `private` `#typeForSourceFile` | `Map`< `SourceFile`< `any` \>, [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) \> | +| `protected` `emitter` | `AssetEmitter`< `Record`< `string`, `any` \>, [`JSONSchemaEmitterOptions`](Interface.JSONSchemaEmitterOptions.md) \> | ## Methods -### #applyConstraints() +### #applyConstraints ```ts private #applyConstraints(type, schema): void @@ -55,22 +51,18 @@ private #applyConstraints(type, schema): void #### Parameters -| Parameter | Type | -| :-------- | :---------------------------------------------------------- | -| `type` | `Model` \| `ModelProperty` \| `Scalar` \| `Enum` \| `Union` | -| `schema` | `ObjectBuilder`< `unknown` \> | +| Parameter | Type | +| :------ | :------ | +| `type` | `Model` \| `ModelProperty` \| `Scalar` \| `Enum` \| `Union` | +| `schema` | `ObjectBuilder`< `unknown` \> | #### Returns `void` -#### Source - -[json-schema/src/json-schema-emitter.ts:407](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L407) +*** ---- - -### #checkForDuplicateId() +### #checkForDuplicateId ```ts private #checkForDuplicateId(id): string @@ -78,21 +70,17 @@ private #checkForDuplicateId(id): string #### Parameters -| Parameter | Type | -| :-------- | :------- | -| `id` | `string` | +| Parameter | Type | +| :------ | :------ | +| `id` | `string` | #### Returns `string` -#### Source - -[json-schema/src/json-schema-emitter.ts:652](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L652) - ---- +*** -### #createDeclaration() +### #createDeclaration ```ts private #createDeclaration( @@ -103,23 +91,19 @@ private #createDeclaration( #### Parameters -| Parameter | Type | -| :-------- | :------------------------------------------------------- | -| `type` | [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | -| `name` | `string` | -| `schema` | `ObjectBuilder`< `unknown` \> | +| Parameter | Type | +| :------ | :------ | +| `type` | [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | +| `name` | `string` | +| `schema` | `ObjectBuilder`< `unknown` \> | #### Returns `Declaration`< `Record`< `string`, `any` \> \> -#### Source +*** -[json-schema/src/json-schema-emitter.ts:503](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L503) - ---- - -### #fileExtension() +### #fileExtension ```ts private #fileExtension(): "json" | "yaml" @@ -129,13 +113,9 @@ private #fileExtension(): "json" | "yaml" `"json"` \| `"yaml"` -#### Source +*** -[json-schema/src/json-schema-emitter.ts:741](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L741) - ---- - -### #getCurrentSourceFile() +### #getCurrentSourceFile ```ts private #getCurrentSourceFile(): SourceFile< object > @@ -145,13 +125,9 @@ private #getCurrentSourceFile(): SourceFile< object > `SourceFile`< `object` \> -#### Source - -[json-schema/src/json-schema-emitter.ts:604](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L604) - ---- +*** -### #getDeclId() +### #getDeclId ```ts private #getDeclId(type, name): string @@ -159,22 +135,18 @@ private #getDeclId(type, name): string #### Parameters -| Parameter | Type | -| :-------- | :------------------------------------------------------- | -| `type` | [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `type` | [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | +| `name` | `string` | #### Returns `string` -#### Source +*** -[json-schema/src/json-schema-emitter.ts:617](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L617) - ---- - -### #isStdType() +### #isStdType ```ts private #isStdType(type): boolean @@ -182,21 +154,17 @@ private #isStdType(type): boolean #### Parameters -| Parameter | Type | -| :-------- | :----- | -| `type` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `type` | `Type` | #### Returns `boolean` -#### Source - -[json-schema/src/json-schema-emitter.ts:513](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L513) - ---- +*** -### #newFileScope() +### #newFileScope ```ts private #newFileScope(type): object @@ -204,23 +172,19 @@ private #newFileScope(type): object #### Parameters -| Parameter | Type | -| :-------- | :------------------------------------------------------- | -| `type` | [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | +| Parameter | Type | +| :------ | :------ | +| `type` | [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | #### Returns -| Member | Type | -| :------ | :--------------------------------------- | +| Member | Type | +| :------ | :------ | | `scope` | `Scope`< `Record`< `string`, `any` \> \> | -#### Source - -[json-schema/src/json-schema-emitter.ts:727](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L727) +*** ---- - -### #requiredModelProperties() +### #requiredModelProperties ```ts private #requiredModelProperties(model): undefined | string[] @@ -228,21 +192,17 @@ private #requiredModelProperties(model): undefined | string[] #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `model` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `model` | `Model` | #### Returns `undefined` \| `string`[] -#### Source +*** -[json-schema/src/json-schema-emitter.ts:138](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L138) - ---- - -### #scalarBuiltinBaseType() +### #scalarBuiltinBaseType ```ts private #scalarBuiltinBaseType(scalar): null | Scalar @@ -250,21 +210,17 @@ private #scalarBuiltinBaseType(scalar): null | Scalar #### Parameters -| Parameter | Type | -| :-------- | :------- | -| `scalar` | `Scalar` | +| Parameter | Type | +| :------ | :------ | +| `scalar` | `Scalar` | #### Returns `null` \| `Scalar` -#### Source - -[json-schema/src/json-schema-emitter.ts:490](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L490) - ---- +*** -### arrayDeclaration() +### arrayDeclaration ```ts arrayDeclaration( @@ -275,11 +231,11 @@ arrayDeclaration( #### Parameters -| Parameter | Type | -| :------------ | :------- | -| `array` | `Model` | -| `name` | `string` | -| `elementType` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `array` | `Model` | +| `name` | `string` | +| `elementType` | `Type` | #### Returns @@ -289,13 +245,9 @@ arrayDeclaration( TypeEmitter.arrayDeclaration -#### Source +*** -[json-schema/src/json-schema-emitter.ts:118](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L118) - ---- - -### arrayDeclarationContext() +### arrayDeclarationContext ```ts arrayDeclarationContext(array): Context @@ -303,9 +255,9 @@ arrayDeclarationContext(array): Context #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `array` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `array` | `Model` | #### Returns @@ -315,13 +267,9 @@ arrayDeclarationContext(array): Context TypeEmitter.arrayDeclarationContext -#### Source +*** -[json-schema/src/json-schema-emitter.ts:693](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L693) - ---- - -### arrayDeclarationReferenceContext() +### arrayDeclarationReferenceContext ```ts arrayDeclarationReferenceContext( @@ -332,11 +280,11 @@ arrayDeclarationReferenceContext( #### Parameters -| Parameter | Type | -| :------------ | :------- | -| `array` | `Model` | -| `name` | `string` | -| `elementType` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `array` | `Model` | +| `name` | `string` | +| `elementType` | `Type` | #### Returns @@ -346,13 +294,9 @@ arrayDeclarationReferenceContext( TypeEmitter.arrayDeclarationReferenceContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:254 - ---- +*** -### arrayLiteral() +### arrayLiteral ```ts arrayLiteral(array, elementType): EmitterOutput< object > @@ -360,10 +304,10 @@ arrayLiteral(array, elementType): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :------------ | :------ | -| `array` | `Model` | -| `elementType` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `array` | `Model` | +| `elementType` | `Type` | #### Returns @@ -373,13 +317,9 @@ arrayLiteral(array, elementType): EmitterOutput< object > TypeEmitter.arrayLiteral -#### Source +*** -[json-schema/src/json-schema-emitter.ts:131](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L131) - ---- - -### arrayLiteralContext() +### arrayLiteralContext ```ts arrayLiteralContext(array, elementType): Context @@ -387,10 +327,10 @@ arrayLiteralContext(array, elementType): Context #### Parameters -| Parameter | Type | -| :------------ | :------ | -| `array` | `Model` | -| `elementType` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `array` | `Model` | +| `elementType` | `Type` | #### Returns @@ -400,13 +340,9 @@ arrayLiteralContext(array, elementType): Context TypeEmitter.arrayLiteralContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:256 - ---- - -### arrayLiteralReferenceContext() +### arrayLiteralReferenceContext ```ts arrayLiteralReferenceContext(array, elementType): Context @@ -414,10 +350,10 @@ arrayLiteralReferenceContext(array, elementType): Context #### Parameters -| Parameter | Type | -| :------------ | :------ | -| `array` | `Model` | -| `elementType` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `array` | `Model` | +| `elementType` | `Type` | #### Returns @@ -427,13 +363,9 @@ arrayLiteralReferenceContext(array, elementType): Context TypeEmitter.arrayLiteralReferenceContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:257 +*** ---- - -### booleanLiteral() +### booleanLiteral ```ts booleanLiteral(boolean): EmitterOutput< object > @@ -441,8 +373,8 @@ booleanLiteral(boolean): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :-------- | :--------------- | +| Parameter | Type | +| :------ | :------ | | `boolean` | `BooleanLiteral` | #### Returns @@ -453,13 +385,9 @@ booleanLiteral(boolean): EmitterOutput< object > TypeEmitter.booleanLiteral -#### Source +*** -[json-schema/src/json-schema-emitter.ts:174](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L174) - ---- - -### booleanLiteralContext() +### booleanLiteralContext ```ts booleanLiteralContext(boolean): Context @@ -467,8 +395,8 @@ booleanLiteralContext(boolean): Context #### Parameters -| Parameter | Type | -| :-------- | :--------------- | +| Parameter | Type | +| :------ | :------ | | `boolean` | `BooleanLiteral` | #### Returns @@ -479,13 +407,9 @@ booleanLiteralContext(boolean): Context TypeEmitter.booleanLiteralContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:264 - ---- - -### declarationName() +### declarationName ```ts declarationName(declarationType): undefined | string @@ -493,8 +417,8 @@ declarationName(declarationType): undefined | string #### Parameters -| Parameter | Type | -| :---------------- | :-------------------- | +| Parameter | Type | +| :------ | :------ | | `declarationType` | `TypeSpecDeclaration` | #### Returns @@ -505,13 +429,9 @@ declarationName(declarationType): undefined | string TypeEmitter.declarationName -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:316 +*** ---- - -### enumDeclaration() +### enumDeclaration ```ts enumDeclaration(en, name): EmitterOutput< object > @@ -519,10 +439,10 @@ enumDeclaration(en, name): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :-------- | :------- | -| `en` | `Enum` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `en` | `Enum` | +| `name` | `string` | #### Returns @@ -532,13 +452,9 @@ enumDeclaration(en, name): EmitterOutput< object > TypeEmitter.enumDeclaration -#### Source +*** -[json-schema/src/json-schema-emitter.ts:186](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L186) - ---- - -### enumDeclarationContext() +### enumDeclarationContext ```ts enumDeclarationContext(en): Context @@ -546,9 +462,9 @@ enumDeclarationContext(en): Context #### Parameters -| Parameter | Type | -| :-------- | :----- | -| `en` | `Enum` | +| Parameter | Type | +| :------ | :------ | +| `en` | `Enum` | #### Returns @@ -558,13 +474,9 @@ enumDeclarationContext(en): Context TypeEmitter.enumDeclarationContext -#### Source - -[json-schema/src/json-schema-emitter.ts:701](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L701) - ---- +*** -### enumMember() +### enumMember ```ts enumMember(member): EmitterOutput< Record< string, any > > @@ -572,9 +484,9 @@ enumMember(member): EmitterOutput< Record< string, any > > #### Parameters -| Parameter | Type | -| :-------- | :----------- | -| `member` | `EnumMember` | +| Parameter | Type | +| :------ | :------ | +| `member` | `EnumMember` | #### Returns @@ -584,13 +496,9 @@ enumMember(member): EmitterOutput< Record< string, any > > TypeEmitter.enumMember -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:292 +*** ---- - -### enumMemberContext() +### enumMemberContext ```ts enumMemberContext(member): object @@ -598,9 +506,9 @@ enumMemberContext(member): object #### Parameters -| Parameter | Type | -| :-------- | :----------- | -| `member` | `EnumMember` | +| Parameter | Type | +| :------ | :------ | +| `member` | `EnumMember` | #### Returns @@ -610,13 +518,9 @@ enumMemberContext(member): object TypeEmitter.enumMemberContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:293 - ---- - -### enumMemberReference() +### enumMemberReference ```ts enumMemberReference(member): EmitterOutput< Record< string, any > > @@ -624,9 +528,9 @@ enumMemberReference(member): EmitterOutput< Record< string, any > > #### Parameters -| Parameter | Type | -| :-------- | :----------- | -| `member` | `EnumMember` | +| Parameter | Type | +| :------ | :------ | +| `member` | `EnumMember` | #### Returns @@ -636,13 +540,9 @@ enumMemberReference(member): EmitterOutput< Record< string, any > > TypeEmitter.enumMemberReference -#### Source +*** -[json-schema/src/json-schema-emitter.ts:207](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L207) - ---- - -### enumMembers() +### enumMembers ```ts enumMembers(en): EmitterOutput< Record< string, any > > @@ -650,9 +550,9 @@ enumMembers(en): EmitterOutput< Record< string, any > > #### Parameters -| Parameter | Type | -| :-------- | :----- | -| `en` | `Enum` | +| Parameter | Type | +| :------ | :------ | +| `en` | `Enum` | #### Returns @@ -662,13 +562,9 @@ enumMembers(en): EmitterOutput< Record< string, any > > TypeEmitter.enumMembers -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:290 +*** ---- - -### enumMembersContext() +### enumMembersContext ```ts enumMembersContext(en): Context @@ -676,9 +572,9 @@ enumMembersContext(en): Context #### Parameters -| Parameter | Type | -| :-------- | :----- | -| `en` | `Enum` | +| Parameter | Type | +| :------ | :------ | +| `en` | `Enum` | #### Returns @@ -688,13 +584,9 @@ enumMembersContext(en): Context TypeEmitter.enumMembersContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:291 +*** ---- - -### interfaceDeclaration() +### interfaceDeclaration ```ts interfaceDeclaration(iface, name): EmitterOutput< Record< string, any > > @@ -702,10 +594,10 @@ interfaceDeclaration(iface, name): EmitterOutput< Record< string, any > > #### Parameters -| Parameter | Type | -| :-------- | :---------- | -| `iface` | `Interface` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `iface` | `Interface` | +| `name` | `string` | #### Returns @@ -715,13 +607,9 @@ interfaceDeclaration(iface, name): EmitterOutput< Record< string, any > > TypeEmitter.interfaceDeclaration -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:283 - ---- +*** -### interfaceDeclarationContext() +### interfaceDeclarationContext ```ts interfaceDeclarationContext(iface, name): Context @@ -729,10 +617,10 @@ interfaceDeclarationContext(iface, name): Context #### Parameters -| Parameter | Type | -| :-------- | :---------- | -| `iface` | `Interface` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `iface` | `Interface` | +| `name` | `string` | #### Returns @@ -742,13 +630,9 @@ interfaceDeclarationContext(iface, name): Context TypeEmitter.interfaceDeclarationContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:284 - ---- - -### interfaceDeclarationOperations() +### interfaceDeclarationOperations ```ts interfaceDeclarationOperations(iface): EmitterOutput< Record< string, any > > @@ -756,9 +640,9 @@ interfaceDeclarationOperations(iface): EmitterOutput< Record< string, any > > #### Parameters -| Parameter | Type | -| :-------- | :---------- | -| `iface` | `Interface` | +| Parameter | Type | +| :------ | :------ | +| `iface` | `Interface` | #### Returns @@ -768,13 +652,9 @@ interfaceDeclarationOperations(iface): EmitterOutput< Record< string, any > > TypeEmitter.interfaceDeclarationOperations -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:286 - ---- - -### interfaceDeclarationOperationsContext() +### interfaceDeclarationOperationsContext ```ts interfaceDeclarationOperationsContext(iface): Context @@ -782,9 +662,9 @@ interfaceDeclarationOperationsContext(iface): Context #### Parameters -| Parameter | Type | -| :-------- | :---------- | -| `iface` | `Interface` | +| Parameter | Type | +| :------ | :------ | +| `iface` | `Interface` | #### Returns @@ -794,13 +674,9 @@ interfaceDeclarationOperationsContext(iface): Context TypeEmitter.interfaceDeclarationOperationsContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:273 - ---- +*** -### interfaceDeclarationOperationsReferenceContext() +### interfaceDeclarationOperationsReferenceContext ```ts interfaceDeclarationOperationsReferenceContext(iface): Context @@ -808,9 +684,9 @@ interfaceDeclarationOperationsReferenceContext(iface): Context #### Parameters -| Parameter | Type | -| :-------- | :---------- | -| `iface` | `Interface` | +| Parameter | Type | +| :------ | :------ | +| `iface` | `Interface` | #### Returns @@ -820,13 +696,9 @@ interfaceDeclarationOperationsReferenceContext(iface): Context TypeEmitter.interfaceDeclarationOperationsReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:274 - ---- - -### interfaceDeclarationReferenceContext() +### interfaceDeclarationReferenceContext ```ts interfaceDeclarationReferenceContext(iface, name): Context @@ -834,10 +706,10 @@ interfaceDeclarationReferenceContext(iface, name): Context #### Parameters -| Parameter | Type | -| :-------- | :---------- | -| `iface` | `Interface` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `iface` | `Interface` | +| `name` | `string` | #### Returns @@ -847,13 +719,9 @@ interfaceDeclarationReferenceContext(iface, name): Context TypeEmitter.interfaceDeclarationReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:285 - ---- - -### interfaceOperationDeclaration() +### interfaceOperationDeclaration ```ts interfaceOperationDeclaration(operation, name): EmitterOutput< Record< string, any > > @@ -861,10 +729,10 @@ interfaceOperationDeclaration(operation, name): EmitterOutput< Record< string, a #### Parameters -| Parameter | Type | -| :---------- | :---------- | +| Parameter | Type | +| :------ | :------ | | `operation` | `Operation` | -| `name` | `string` | +| `name` | `string` | #### Returns @@ -874,13 +742,9 @@ interfaceOperationDeclaration(operation, name): EmitterOutput< Record< string, a TypeEmitter.interfaceOperationDeclaration -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:287 - ---- +*** -### interfaceOperationDeclarationContext() +### interfaceOperationDeclarationContext ```ts interfaceOperationDeclarationContext(operation, name): Context @@ -888,10 +752,10 @@ interfaceOperationDeclarationContext(operation, name): Context #### Parameters -| Parameter | Type | -| :---------- | :---------- | +| Parameter | Type | +| :------ | :------ | | `operation` | `Operation` | -| `name` | `string` | +| `name` | `string` | #### Returns @@ -901,13 +765,9 @@ interfaceOperationDeclarationContext(operation, name): Context TypeEmitter.interfaceOperationDeclarationContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:275 - ---- - -### interfaceOperationDeclarationReferenceContext() +### interfaceOperationDeclarationReferenceContext ```ts interfaceOperationDeclarationReferenceContext(operation, name): Context @@ -915,10 +775,10 @@ interfaceOperationDeclarationReferenceContext(operation, name): Context #### Parameters -| Parameter | Type | -| :---------- | :---------- | +| Parameter | Type | +| :------ | :------ | | `operation` | `Operation` | -| `name` | `string` | +| `name` | `string` | #### Returns @@ -928,13 +788,9 @@ interfaceOperationDeclarationReferenceContext(operation, name): Context TypeEmitter.interfaceOperationDeclarationReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:276 - ---- - -### intrinsic() +### intrinsic ```ts intrinsic(intrinsic, name): EmitterOutput< object > @@ -942,10 +798,10 @@ intrinsic(intrinsic, name): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :---------- | :-------------- | +| Parameter | Type | +| :------ | :------ | | `intrinsic` | `IntrinsicType` | -| `name` | `string` | +| `name` | `string` | #### Returns @@ -955,13 +811,9 @@ intrinsic(intrinsic, name): EmitterOutput< object > TypeEmitter.intrinsic -#### Source - -[json-schema/src/json-schema-emitter.ts:517](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L517) - ---- +*** -### intrinsicContext() +### intrinsicContext ```ts intrinsicContext(intrinsic, name): Context @@ -969,10 +821,10 @@ intrinsicContext(intrinsic, name): Context #### Parameters -| Parameter | Type | -| :---------- | :-------------- | +| Parameter | Type | +| :------ | :------ | | `intrinsic` | `IntrinsicType` | -| `name` | `string` | +| `name` | `string` | #### Returns @@ -982,13 +834,9 @@ intrinsicContext(intrinsic, name): Context TypeEmitter.intrinsicContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:263 - ---- - -### modelDeclaration() +### modelDeclaration ```ts modelDeclaration(model, name): EmitterOutput< object > @@ -996,10 +844,10 @@ modelDeclaration(model, name): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :-------- | :------- | -| `model` | `Model` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `model` | `Model` | +| `name` | `string` | #### Returns @@ -1009,13 +857,9 @@ modelDeclaration(model, name): EmitterOutput< object > TypeEmitter.modelDeclaration -#### Source - -[json-schema/src/json-schema-emitter.ts:72](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L72) - ---- +*** -### modelDeclarationContext() +### modelDeclarationContext ```ts modelDeclarationContext(model, name): Context @@ -1023,10 +867,10 @@ modelDeclarationContext(model, name): Context #### Parameters -| Parameter | Type | -| :-------- | :------- | -| `model` | `Model` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `model` | `Model` | +| `name` | `string` | #### Returns @@ -1036,13 +880,9 @@ modelDeclarationContext(model, name): Context TypeEmitter.modelDeclarationContext -#### Source - -[json-schema/src/json-schema-emitter.ts:671](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L671) +*** ---- - -### modelDeclarationReferenceContext() +### modelDeclarationReferenceContext ```ts modelDeclarationReferenceContext(model, name): Context @@ -1052,10 +892,10 @@ Set reference context for a model declaration. #### Parameters -| Parameter | Type | Description | -| :-------- | :------- | :---------- | -| `model` | `Model` | | -| `name` | `string` | - | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `model` | `Model` | | +| `name` | `string` | - | #### Returns @@ -1065,13 +905,9 @@ Set reference context for a model declaration. TypeEmitter.modelDeclarationReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:187 - ---- - -### modelInstantiation() +### modelInstantiation ```ts modelInstantiation(model, name): EmitterOutput< Record< string, any > > @@ -1079,10 +915,10 @@ modelInstantiation(model, name): EmitterOutput< Record< string, any > > #### Parameters -| Parameter | Type | -| :-------- | :---------------------- | -| `model` | `Model` | -| `name` | `undefined` \| `string` | +| Parameter | Type | +| :------ | :------ | +| `model` | `Model` | +| `name` | `undefined` \| `string` | #### Returns @@ -1092,13 +928,9 @@ modelInstantiation(model, name): EmitterOutput< Record< string, any > > TypeEmitter.modelInstantiation -#### Source - -[json-schema/src/json-schema-emitter.ts:110](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L110) - ---- +*** -### modelInstantiationContext() +### modelInstantiationContext ```ts modelInstantiationContext(model, name): Context @@ -1106,10 +938,10 @@ modelInstantiationContext(model, name): Context #### Parameters -| Parameter | Type | -| :-------- | :---------------------- | -| `model` | `Model` | -| `name` | `undefined` \| `string` | +| Parameter | Type | +| :------ | :------ | +| `model` | `Model` | +| `name` | `undefined` \| `string` | #### Returns @@ -1119,13 +951,9 @@ modelInstantiationContext(model, name): Context TypeEmitter.modelInstantiationContext -#### Source +*** -[json-schema/src/json-schema-emitter.ts:683](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L683) - ---- - -### modelInstantiationReferenceContext() +### modelInstantiationReferenceContext ```ts modelInstantiationReferenceContext(model, name): Context @@ -1135,10 +963,10 @@ Set reference context for a model declaration. #### Parameters -| Parameter | Type | Description | -| :-------- | :---------------------- | :---------- | -| `model` | `Model` | | -| `name` | `undefined` \| `string` | - | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `model` | `Model` | | +| `name` | `undefined` \| `string` | - | #### Returns @@ -1148,13 +976,9 @@ Set reference context for a model declaration. TypeEmitter.modelInstantiationReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:208 - ---- - -### modelLiteral() +### modelLiteral ```ts modelLiteral(model): EmitterOutput< object > @@ -1162,9 +986,9 @@ modelLiteral(model): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `model` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `model` | `Model` | #### Returns @@ -1174,13 +998,9 @@ modelLiteral(model): EmitterOutput< object > TypeEmitter.modelLiteral -#### Source - -[json-schema/src/json-schema-emitter.ts:96](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L96) - ---- +*** -### modelLiteralContext() +### modelLiteralContext ```ts modelLiteralContext(model): Context @@ -1190,9 +1010,9 @@ Set lexical context for a model literal. #### Parameters -| Parameter | Type | Description | -| :-------- | :------ | :---------- | -| `model` | `Model` | | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `model` | `Model` | | #### Returns @@ -1202,13 +1022,9 @@ Set lexical context for a model literal. TypeEmitter.modelLiteralContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:162 - ---- - -### modelLiteralReferenceContext() +### modelLiteralReferenceContext ```ts modelLiteralReferenceContext(model): Context @@ -1218,9 +1034,9 @@ Set reference context for a model literal. #### Parameters -| Parameter | Type | Description | -| :-------- | :------ | :---------- | -| `model` | `Model` | | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `model` | `Model` | | #### Returns @@ -1230,13 +1046,9 @@ Set reference context for a model literal. TypeEmitter.modelLiteralReferenceContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:167 +*** ---- - -### modelProperties() +### modelProperties ```ts modelProperties(model): EmitterOutput< object > @@ -1244,9 +1056,9 @@ modelProperties(model): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `model` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `model` | `Model` | #### Returns @@ -1256,13 +1068,9 @@ modelProperties(model): EmitterOutput< object > TypeEmitter.modelProperties -#### Source - -[json-schema/src/json-schema-emitter.ts:150](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L150) - ---- +*** -### modelPropertiesContext() +### modelPropertiesContext ```ts modelPropertiesContext(model): Context @@ -1270,9 +1078,9 @@ modelPropertiesContext(model): Context #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `model` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `model` | `Model` | #### Returns @@ -1282,13 +1090,9 @@ modelPropertiesContext(model): Context TypeEmitter.modelPropertiesContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:216 - ---- - -### modelPropertiesReferenceContext() +### modelPropertiesReferenceContext ```ts modelPropertiesReferenceContext(model): Context @@ -1296,9 +1100,9 @@ modelPropertiesReferenceContext(model): Context #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `model` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `model` | `Model` | #### Returns @@ -1308,13 +1112,9 @@ modelPropertiesReferenceContext(model): Context TypeEmitter.modelPropertiesReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:217 - ---- - -### modelPropertyLiteral() +### modelPropertyLiteral ```ts modelPropertyLiteral(property): EmitterOutput< object > @@ -1322,8 +1122,8 @@ modelPropertyLiteral(property): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :--------- | :-------------- | +| Parameter | Type | +| :------ | :------ | | `property` | `ModelProperty` | #### Returns @@ -1334,13 +1134,9 @@ modelPropertyLiteral(property): EmitterOutput< object > TypeEmitter.modelPropertyLiteral -#### Source - -[json-schema/src/json-schema-emitter.ts:161](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L161) - ---- +*** -### modelPropertyLiteralContext() +### modelPropertyLiteralContext ```ts modelPropertyLiteralContext(property): Context @@ -1350,9 +1146,9 @@ Set lexical context for a property of a model. #### Parameters -| Parameter | Type | Description | -| :--------- | :-------------- | :---------- | -| `property` | `ModelProperty` | | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `property` | `ModelProperty` | | #### Returns @@ -1362,13 +1158,9 @@ Set lexical context for a property of a model. TypeEmitter.modelPropertyLiteralContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:229 - ---- - -### modelPropertyLiteralReferenceContext() +### modelPropertyLiteralReferenceContext ```ts modelPropertyLiteralReferenceContext(property): Context @@ -1378,9 +1170,9 @@ Set reference context for a property of a model. #### Parameters -| Parameter | Type | Description | -| :--------- | :-------------- | :---------- | -| `property` | `ModelProperty` | | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `property` | `ModelProperty` | | #### Returns @@ -1390,13 +1182,9 @@ Set reference context for a property of a model. TypeEmitter.modelPropertyLiteralReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:235 - ---- - -### modelPropertyReference() +### modelPropertyReference ```ts modelPropertyReference(property): EmitterOutput< object > @@ -1404,8 +1192,8 @@ modelPropertyReference(property): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :--------- | :-------------- | +| Parameter | Type | +| :------ | :------ | | `property` | `ModelProperty` | #### Returns @@ -1416,13 +1204,9 @@ modelPropertyReference(property): EmitterOutput< object > TypeEmitter.modelPropertyReference -#### Source - -[json-schema/src/json-schema-emitter.ts:249](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L249) +*** ---- - -### namespace() +### namespace ```ts namespace(namespace): EmitterOutput< Record< string, any > > @@ -1432,9 +1216,9 @@ Emit a namespace #### Parameters -| Parameter | Type | Description | -| :---------- | :---------- | :---------- | -| `namespace` | `Namespace` | | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `namespace` | `Namespace` | | #### Returns @@ -1446,13 +1230,9 @@ Emitter output TypeEmitter.namespace -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:139 - ---- - -### namespaceContext() +### namespaceContext ```ts namespaceContext(namespace): Context @@ -1462,9 +1242,9 @@ Set lexical context for a namespace #### Parameters -| Parameter | Type | Description | -| :---------- | :---------- | :---------- | -| `namespace` | `Namespace` | | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `namespace` | `Namespace` | | #### Returns @@ -1474,13 +1254,9 @@ Set lexical context for a namespace TypeEmitter.namespaceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:145 - ---- - -### namespaceReferenceContext() +### namespaceReferenceContext ```ts namespaceReferenceContext(namespace): Context @@ -1490,9 +1266,9 @@ Set reference context for a namespace. #### Parameters -| Parameter | Type | Description | -| :---------- | :---------- | :---------- | -| `namespace` | `Namespace` | | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `namespace` | `Namespace` | | #### Returns @@ -1502,13 +1278,9 @@ Set reference context for a namespace. TypeEmitter.namespaceReferenceContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:151 +*** ---- - -### numericLiteral() +### numericLiteral ```ts numericLiteral(number): EmitterOutput< object > @@ -1516,9 +1288,9 @@ numericLiteral(number): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :-------- | :--------------- | -| `number` | `NumericLiteral` | +| Parameter | Type | +| :------ | :------ | +| `number` | `NumericLiteral` | #### Returns @@ -1528,13 +1300,9 @@ numericLiteral(number): EmitterOutput< object > TypeEmitter.numericLiteral -#### Source +*** -[json-schema/src/json-schema-emitter.ts:182](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L182) - ---- - -### numericLiteralContext() +### numericLiteralContext ```ts numericLiteralContext(number): Context @@ -1542,9 +1310,9 @@ numericLiteralContext(number): Context #### Parameters -| Parameter | Type | -| :-------- | :--------------- | -| `number` | `NumericLiteral` | +| Parameter | Type | +| :------ | :------ | +| `number` | `NumericLiteral` | #### Returns @@ -1554,13 +1322,9 @@ numericLiteralContext(number): Context TypeEmitter.numericLiteralContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:268 - ---- +*** -### operationDeclaration() +### operationDeclaration ```ts operationDeclaration(operation, name): EmitterOutput< Record< string, any > > @@ -1568,10 +1332,10 @@ operationDeclaration(operation, name): EmitterOutput< Record< string, any > > #### Parameters -| Parameter | Type | -| :---------- | :---------- | +| Parameter | Type | +| :------ | :------ | | `operation` | `Operation` | -| `name` | `string` | +| `name` | `string` | #### Returns @@ -1581,13 +1345,9 @@ operationDeclaration(operation, name): EmitterOutput< Record< string, any > > TypeEmitter.operationDeclaration -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:270 +*** ---- - -### operationDeclarationContext() +### operationDeclarationContext ```ts operationDeclarationContext(operation, name): Context @@ -1595,10 +1355,10 @@ operationDeclarationContext(operation, name): Context #### Parameters -| Parameter | Type | -| :---------- | :---------- | +| Parameter | Type | +| :------ | :------ | | `operation` | `Operation` | -| `name` | `string` | +| `name` | `string` | #### Returns @@ -1608,13 +1368,9 @@ operationDeclarationContext(operation, name): Context TypeEmitter.operationDeclarationContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:271 - ---- - -### operationDeclarationReferenceContext() +### operationDeclarationReferenceContext ```ts operationDeclarationReferenceContext(operation, name): Context @@ -1622,10 +1378,10 @@ operationDeclarationReferenceContext(operation, name): Context #### Parameters -| Parameter | Type | -| :---------- | :---------- | +| Parameter | Type | +| :------ | :------ | | `operation` | `Operation` | -| `name` | `string` | +| `name` | `string` | #### Returns @@ -1635,13 +1391,9 @@ operationDeclarationReferenceContext(operation, name): Context TypeEmitter.operationDeclarationReferenceContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:272 - ---- +*** -### operationParameters() +### operationParameters ```ts operationParameters(operation, parameters): EmitterOutput< Record< string, any > > @@ -1649,10 +1401,10 @@ operationParameters(operation, parameters): EmitterOutput< Record< string, any > #### Parameters -| Parameter | Type | -| :----------- | :---------- | -| `operation` | `Operation` | -| `parameters` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `operation` | `Operation` | +| `parameters` | `Model` | #### Returns @@ -1662,13 +1414,9 @@ operationParameters(operation, parameters): EmitterOutput< Record< string, any > TypeEmitter.operationParameters -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:277 - ---- +*** -### operationParametersContext() +### operationParametersContext ```ts operationParametersContext(operation, parameters): Context @@ -1676,10 +1424,10 @@ operationParametersContext(operation, parameters): Context #### Parameters -| Parameter | Type | -| :----------- | :---------- | -| `operation` | `Operation` | -| `parameters` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `operation` | `Operation` | +| `parameters` | `Model` | #### Returns @@ -1689,13 +1437,9 @@ operationParametersContext(operation, parameters): Context TypeEmitter.operationParametersContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:278 +*** ---- - -### operationParametersReferenceContext() +### operationParametersReferenceContext ```ts operationParametersReferenceContext(operation, parameters): Context @@ -1703,10 +1447,10 @@ operationParametersReferenceContext(operation, parameters): Context #### Parameters -| Parameter | Type | -| :----------- | :---------- | -| `operation` | `Operation` | -| `parameters` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `operation` | `Operation` | +| `parameters` | `Model` | #### Returns @@ -1716,13 +1460,9 @@ operationParametersReferenceContext(operation, parameters): Context TypeEmitter.operationParametersReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:279 - ---- - -### operationReturnType() +### operationReturnType ```ts operationReturnType(operation, returnType): EmitterOutput< Record< string, any > > @@ -1730,10 +1470,10 @@ operationReturnType(operation, returnType): EmitterOutput< Record< string, any > #### Parameters -| Parameter | Type | -| :----------- | :---------- | -| `operation` | `Operation` | -| `returnType` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `operation` | `Operation` | +| `returnType` | `Type` | #### Returns @@ -1743,13 +1483,9 @@ operationReturnType(operation, returnType): EmitterOutput< Record< string, any > TypeEmitter.operationReturnType -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:280 - ---- - -### operationReturnTypeContext() +### operationReturnTypeContext ```ts operationReturnTypeContext(operation, returnType): Context @@ -1757,10 +1493,10 @@ operationReturnTypeContext(operation, returnType): Context #### Parameters -| Parameter | Type | -| :----------- | :---------- | -| `operation` | `Operation` | -| `returnType` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `operation` | `Operation` | +| `returnType` | `Type` | #### Returns @@ -1770,13 +1506,9 @@ operationReturnTypeContext(operation, returnType): Context TypeEmitter.operationReturnTypeContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:281 - ---- - -### operationReturnTypeReferenceContext() +### operationReturnTypeReferenceContext ```ts operationReturnTypeReferenceContext(operation, returnType): Context @@ -1784,10 +1516,10 @@ operationReturnTypeReferenceContext(operation, returnType): Context #### Parameters -| Parameter | Type | -| :----------- | :---------- | -| `operation` | `Operation` | -| `returnType` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `operation` | `Operation` | +| `returnType` | `Type` | #### Returns @@ -1797,13 +1529,9 @@ operationReturnTypeReferenceContext(operation, returnType): Context TypeEmitter.operationReturnTypeReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:282 - ---- - -### programContext() +### programContext ```ts programContext(program): Context @@ -1811,8 +1539,8 @@ programContext(program): Context #### Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | #### Returns @@ -1823,13 +1551,9 @@ programContext(program): Context TypeEmitter.programContext -#### Source - -[json-schema/src/json-schema-emitter.ts:662](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L662) - ---- +*** -### reference() +### reference ```ts reference( @@ -1841,12 +1565,12 @@ reference( #### Parameters -| Parameter | Type | -| :------------------ | :----------------------------------------------------- | -| `targetDeclaration` | `Declaration`< `Record`< `string`, `unknown` \> \> | -| `pathUp` | `Scope`< `Record`< `string`, `unknown` \> \>[] | -| `pathDown` | `Scope`< `Record`< `string`, `unknown` \> \>[] | -| `commonScope` | `null` \| `Scope`< `Record`< `string`, `unknown` \> \> | +| Parameter | Type | +| :------ | :------ | +| `targetDeclaration` | `Declaration`< `Record`< `string`, `unknown` \> \> | +| `pathUp` | `Scope`< `Record`< `string`, `unknown` \> \>[] | +| `pathDown` | `Scope`< `Record`< `string`, `unknown` \> \>[] | +| `commonScope` | `null` \| `Scope`< `Record`< `string`, `unknown` \> \> | #### Returns @@ -1856,13 +1580,9 @@ reference( TypeEmitter.reference -#### Source +*** -[json-schema/src/json-schema-emitter.ts:263](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L263) - ---- - -### scalarDeclaration() +### scalarDeclaration ```ts scalarDeclaration(scalar, name): EmitterOutput< object > @@ -1870,10 +1590,10 @@ scalarDeclaration(scalar, name): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :-------- | :------- | -| `scalar` | `Scalar` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `scalar` | `Scalar` | +| `name` | `string` | #### Returns @@ -1883,13 +1603,9 @@ scalarDeclaration(scalar, name): EmitterOutput< object > TypeEmitter.scalarDeclaration -#### Source +*** -[json-schema/src/json-schema-emitter.ts:300](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L300) - ---- - -### scalarDeclarationContext() +### scalarDeclarationContext ```ts scalarDeclarationContext(scalar): Context @@ -1897,9 +1613,9 @@ scalarDeclarationContext(scalar): Context #### Parameters -| Parameter | Type | -| :-------- | :------- | -| `scalar` | `Scalar` | +| Parameter | Type | +| :------ | :------ | +| `scalar` | `Scalar` | #### Returns @@ -1909,13 +1625,9 @@ scalarDeclarationContext(scalar): Context TypeEmitter.scalarDeclarationContext -#### Source - -[json-schema/src/json-schema-emitter.ts:717](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L717) - ---- +*** -### scalarInstantiation() +### scalarInstantiation ```ts scalarInstantiation(scalar, name): EmitterOutput< Record< string, any > > @@ -1923,10 +1635,10 @@ scalarInstantiation(scalar, name): EmitterOutput< Record< string, any > > #### Parameters -| Parameter | Type | -| :-------- | :---------------------- | -| `scalar` | `Scalar` | -| `name` | `undefined` \| `string` | +| Parameter | Type | +| :------ | :------ | +| `scalar` | `Scalar` | +| `name` | `undefined` \| `string` | #### Returns @@ -1936,13 +1648,9 @@ scalarInstantiation(scalar, name): EmitterOutput< Record< string, any > > TypeEmitter.scalarInstantiation -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:260 - ---- - -### scalarInstantiationContext() +### scalarInstantiationContext ```ts scalarInstantiationContext(scalar, name): Context @@ -1950,10 +1658,10 @@ scalarInstantiationContext(scalar, name): Context #### Parameters -| Parameter | Type | -| :-------- | :---------------------- | -| `scalar` | `Scalar` | -| `name` | `undefined` \| `string` | +| Parameter | Type | +| :------ | :------ | +| `scalar` | `Scalar` | +| `name` | `undefined` \| `string` | #### Returns @@ -1963,13 +1671,9 @@ scalarInstantiationContext(scalar, name): Context TypeEmitter.scalarInstantiationContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:261 - ---- +*** -### sourceFile() +### sourceFile ```ts sourceFile(sourceFile): EmittedSourceFile @@ -1977,8 +1681,8 @@ sourceFile(sourceFile): EmittedSourceFile #### Parameters -| Parameter | Type | -| :----------- | :------------------------ | +| Parameter | Type | +| :------ | :------ | | `sourceFile` | `SourceFile`< `object` \> | #### Returns @@ -1989,13 +1693,9 @@ sourceFile(sourceFile): EmittedSourceFile TypeEmitter.sourceFile -#### Source - -[json-schema/src/json-schema-emitter.ts:550](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L550) +*** ---- - -### stringLiteral() +### stringLiteral ```ts stringLiteral(string): EmitterOutput< object > @@ -2003,9 +1703,9 @@ stringLiteral(string): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :-------- | :-------------- | -| `string` | `StringLiteral` | +| Parameter | Type | +| :------ | :------ | +| `string` | `StringLiteral` | #### Returns @@ -2015,13 +1715,9 @@ stringLiteral(string): EmitterOutput< object > TypeEmitter.stringLiteral -#### Source +*** -[json-schema/src/json-schema-emitter.ts:178](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L178) - ---- - -### stringLiteralContext() +### stringLiteralContext ```ts stringLiteralContext(string): Context @@ -2029,9 +1725,9 @@ stringLiteralContext(string): Context #### Parameters -| Parameter | Type | -| :-------- | :-------------- | -| `string` | `StringLiteral` | +| Parameter | Type | +| :------ | :------ | +| `string` | `StringLiteral` | #### Returns @@ -2041,13 +1737,9 @@ stringLiteralContext(string): Context TypeEmitter.stringLiteralContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:266 - ---- +*** -### tupleLiteral() +### tupleLiteral ```ts tupleLiteral(tuple): EmitterOutput< Record< string, any > > @@ -2055,9 +1747,9 @@ tupleLiteral(tuple): EmitterOutput< Record< string, any > > #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `tuple` | `Tuple` | +| Parameter | Type | +| :------ | :------ | +| `tuple` | `Tuple` | #### Returns @@ -2067,13 +1759,9 @@ tupleLiteral(tuple): EmitterOutput< Record< string, any > > TypeEmitter.tupleLiteral -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:309 - ---- - -### tupleLiteralContext() +### tupleLiteralContext ```ts tupleLiteralContext(tuple): Context @@ -2081,9 +1769,9 @@ tupleLiteralContext(tuple): Context #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `tuple` | `Tuple` | +| Parameter | Type | +| :------ | :------ | +| `tuple` | `Tuple` | #### Returns @@ -2093,13 +1781,9 @@ tupleLiteralContext(tuple): Context TypeEmitter.tupleLiteralContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:310 - ---- - -### tupleLiteralReferenceContext() +### tupleLiteralReferenceContext ```ts tupleLiteralReferenceContext(tuple): Context @@ -2107,9 +1791,9 @@ tupleLiteralReferenceContext(tuple): Context #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `tuple` | `Tuple` | +| Parameter | Type | +| :------ | :------ | +| `tuple` | `Tuple` | #### Returns @@ -2119,13 +1803,9 @@ tupleLiteralReferenceContext(tuple): Context TypeEmitter.tupleLiteralReferenceContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:312 - ---- +*** -### tupleLiteralValues() +### tupleLiteralValues ```ts tupleLiteralValues(tuple): EmitterOutput< Record< string, any > > @@ -2133,9 +1813,9 @@ tupleLiteralValues(tuple): EmitterOutput< Record< string, any > > #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `tuple` | `Tuple` | +| Parameter | Type | +| :------ | :------ | +| `tuple` | `Tuple` | #### Returns @@ -2145,13 +1825,9 @@ tupleLiteralValues(tuple): EmitterOutput< Record< string, any > > TypeEmitter.tupleLiteralValues -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:311 - ---- - -### unionDeclaration() +### unionDeclaration ```ts unionDeclaration(union, name): EmitterOutput< object > @@ -2159,10 +1835,10 @@ unionDeclaration(union, name): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :-------- | :------- | -| `union` | `Union` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `union` | `Union` | +| `name` | `string` | #### Returns @@ -2172,13 +1848,9 @@ unionDeclaration(union, name): EmitterOutput< object > TypeEmitter.unionDeclaration -#### Source - -[json-schema/src/json-schema-emitter.ts:219](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L219) +*** ---- - -### unionDeclarationContext() +### unionDeclarationContext ```ts unionDeclarationContext(union): Context @@ -2186,9 +1858,9 @@ unionDeclarationContext(union): Context #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `union` | `Union` | +| Parameter | Type | +| :------ | :------ | +| `union` | `Union` | #### Returns @@ -2198,13 +1870,9 @@ unionDeclarationContext(union): Context TypeEmitter.unionDeclarationContext -#### Source - -[json-schema/src/json-schema-emitter.ts:709](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L709) - ---- +*** -### unionDeclarationReferenceContext() +### unionDeclarationReferenceContext ```ts unionDeclarationReferenceContext(union): Context @@ -2212,9 +1880,9 @@ unionDeclarationReferenceContext(union): Context #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `union` | `Union` | +| Parameter | Type | +| :------ | :------ | +| `union` | `Union` | #### Returns @@ -2224,13 +1892,9 @@ unionDeclarationReferenceContext(union): Context TypeEmitter.unionDeclarationReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:296 - ---- - -### unionInstantiation() +### unionInstantiation ```ts unionInstantiation(union, name): EmitterOutput< Record< string, any > > @@ -2238,10 +1902,10 @@ unionInstantiation(union, name): EmitterOutput< Record< string, any > > #### Parameters -| Parameter | Type | -| :-------- | :------- | -| `union` | `Union` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `union` | `Union` | +| `name` | `string` | #### Returns @@ -2251,13 +1915,9 @@ unionInstantiation(union, name): EmitterOutput< Record< string, any > > TypeEmitter.unionInstantiation -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:297 +*** ---- - -### unionInstantiationContext() +### unionInstantiationContext ```ts unionInstantiationContext(union, name): Context @@ -2265,10 +1925,10 @@ unionInstantiationContext(union, name): Context #### Parameters -| Parameter | Type | -| :-------- | :------- | -| `union` | `Union` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `union` | `Union` | +| `name` | `string` | #### Returns @@ -2278,13 +1938,9 @@ unionInstantiationContext(union, name): Context TypeEmitter.unionInstantiationContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:298 - ---- +*** -### unionInstantiationReferenceContext() +### unionInstantiationReferenceContext ```ts unionInstantiationReferenceContext(union, name): Context @@ -2292,10 +1948,10 @@ unionInstantiationReferenceContext(union, name): Context #### Parameters -| Parameter | Type | -| :-------- | :------- | -| `union` | `Union` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `union` | `Union` | +| `name` | `string` | #### Returns @@ -2305,13 +1961,9 @@ unionInstantiationReferenceContext(union, name): Context TypeEmitter.unionInstantiationReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:299 - ---- - -### unionLiteral() +### unionLiteral ```ts unionLiteral(union): EmitterOutput< object > @@ -2319,9 +1971,9 @@ unionLiteral(union): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `union` | `Union` | +| Parameter | Type | +| :------ | :------ | +| `union` | `Union` | #### Returns @@ -2331,13 +1983,9 @@ unionLiteral(union): EmitterOutput< object > TypeEmitter.unionLiteral -#### Source +*** -[json-schema/src/json-schema-emitter.ts:230](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L230) - ---- - -### unionLiteralContext() +### unionLiteralContext ```ts unionLiteralContext(union): Context @@ -2345,9 +1993,9 @@ unionLiteralContext(union): Context #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `union` | `Union` | +| Parameter | Type | +| :------ | :------ | +| `union` | `Union` | #### Returns @@ -2357,13 +2005,9 @@ unionLiteralContext(union): Context TypeEmitter.unionLiteralContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:301 +*** ---- - -### unionLiteralReferenceContext() +### unionLiteralReferenceContext ```ts unionLiteralReferenceContext(union): Context @@ -2371,9 +2015,9 @@ unionLiteralReferenceContext(union): Context #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `union` | `Union` | +| Parameter | Type | +| :------ | :------ | +| `union` | `Union` | #### Returns @@ -2383,13 +2027,9 @@ unionLiteralReferenceContext(union): Context TypeEmitter.unionLiteralReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:302 - ---- - -### unionVariant() +### unionVariant ```ts unionVariant(variant): EmitterOutput< object > @@ -2397,8 +2037,8 @@ unionVariant(variant): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :-------- | :------------- | +| Parameter | Type | +| :------ | :------ | | `variant` | `UnionVariant` | #### Returns @@ -2409,13 +2049,9 @@ unionVariant(variant): EmitterOutput< object > TypeEmitter.unionVariant -#### Source +*** -[json-schema/src/json-schema-emitter.ts:245](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L245) - ---- - -### unionVariantContext() +### unionVariantContext ```ts unionVariantContext(union): Context @@ -2423,9 +2059,9 @@ unionVariantContext(union): Context #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `union` | `Union` | +| Parameter | Type | +| :------ | :------ | +| `union` | `Union` | #### Returns @@ -2435,13 +2071,9 @@ unionVariantContext(union): Context TypeEmitter.unionVariantContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:307 +*** ---- - -### unionVariantReferenceContext() +### unionVariantReferenceContext ```ts unionVariantReferenceContext(union): Context @@ -2449,9 +2081,9 @@ unionVariantReferenceContext(union): Context #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `union` | `Union` | +| Parameter | Type | +| :------ | :------ | +| `union` | `Union` | #### Returns @@ -2461,13 +2093,9 @@ unionVariantReferenceContext(union): Context TypeEmitter.unionVariantReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:308 - ---- - -### unionVariants() +### unionVariants ```ts unionVariants(union): EmitterOutput< object > @@ -2475,9 +2103,9 @@ unionVariants(union): EmitterOutput< object > #### Parameters -| Parameter | Type | -| :-------- | :------ | -| `union` | `Union` | +| Parameter | Type | +| :------ | :------ | +| `union` | `Union` | #### Returns @@ -2487,13 +2115,9 @@ unionVariants(union): EmitterOutput< object > TypeEmitter.unionVariants -#### Source - -[json-schema/src/json-schema-emitter.ts:237](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L237) - ---- +*** -### unionVariantsContext() +### unionVariantsContext ```ts unionVariantsContext(): Context @@ -2507,13 +2131,9 @@ unionVariantsContext(): Context TypeEmitter.unionVariantsContext -#### Source - -compiler/dist/src/emitter-framework/type-emitter.d.ts:304 +*** ---- - -### unionVariantsReferenceContext() +### unionVariantsReferenceContext ```ts unionVariantsReferenceContext(): Context @@ -2527,13 +2147,9 @@ unionVariantsReferenceContext(): Context TypeEmitter.unionVariantsReferenceContext -#### Source +*** -compiler/dist/src/emitter-framework/type-emitter.d.ts:305 - ---- - -### writeOutput() +### writeOutput ```ts writeOutput(sourceFiles): Promise< void > @@ -2541,8 +2157,8 @@ writeOutput(sourceFiles): Promise< void > #### Parameters -| Parameter | Type | -| :------------ | :---------------------------------------------- | +| Parameter | Type | +| :------ | :------ | | `sourceFiles` | `SourceFile`< `Record`< `string`, `any` \> \>[] | #### Returns @@ -2552,7 +2168,3 @@ writeOutput(sourceFiles): Promise< void > #### Overrides TypeEmitter.writeOutput - -#### Source - -[json-schema/src/json-schema-emitter.ts:531](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/json-schema-emitter.ts#L531) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$baseUri.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$baseUri.md index d46ea1973ea..d8c44a25433 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$baseUri.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$baseUri.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $baseUri" ---- +--- ```ts $baseUri( context, @@ -12,16 +12,12 @@ $baseUri( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Namespace` | -| `baseUri` | `string` | +| `target` | `Namespace` | +| `baseUri` | `string` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:57](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L57) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contains.md index d2b21f7c075..92ac56d6e88 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contains.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $contains" ---- +--- ```ts $contains( context, @@ -12,16 +12,12 @@ $contains( ## Parameters -| Parameter | Type | -| :-------- | :------------------------- | -| `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | -| `value` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Model` \| `ModelProperty` | +| `value` | `Type` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:123](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L123) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentEncoding.md index d8d18576def..de78004bf49 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentEncoding.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentEncoding.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $contentEncoding" ---- +--- ```ts $contentEncoding( context, @@ -12,16 +12,12 @@ $contentEncoding( ## Parameters -| Parameter | Type | -| :-------- | :--------------------------------- | -| `context` | `DecoratorContext` | -| `target` | `StringLiteral` \| `ModelProperty` | -| `value` | `string` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `StringLiteral` \| `ModelProperty` | +| `value` | `string` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:193](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L193) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentMediaType.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentMediaType.md index a7682e280a4..773d7935c7a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentMediaType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentMediaType.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $contentMediaType" ---- +--- ```ts $contentMediaType( context, @@ -12,16 +12,12 @@ $contentMediaType( ## Parameters -| Parameter | Type | -| :-------- | :--------------------------------- | -| `context` | `DecoratorContext` | -| `target` | `StringLiteral` \| `ModelProperty` | -| `value` | `string` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `StringLiteral` \| `ModelProperty` | +| `value` | `string` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:206](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L206) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentSchema.md index 8833d90a192..c96d8354ca8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentSchema.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $contentSchema" ---- +--- ```ts $contentSchema( context, @@ -12,16 +12,12 @@ $contentSchema( ## Parameters -| Parameter | Type | -| :-------- | :--------------------------------- | -| `context` | `DecoratorContext` | -| `target` | `StringLiteral` \| `ModelProperty` | -| `value` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `StringLiteral` \| `ModelProperty` | +| `value` | `Type` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:219](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L219) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$extension.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$extension.md index 2d994d3e9bc..3d1a9ea67ba 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$extension.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$extension.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $extension" ---- +--- ```ts $extension( context, @@ -13,17 +13,13 @@ $extension( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Type` | -| `key` | `string` | -| `value` | `Type` | +| `target` | `Type` | +| `key` | `string` | +| `value` | `Type` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:250](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L250) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$id.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$id.md index e91ef8e16d0..72612867c9c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$id.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$id.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $id" ---- +--- ```ts $id( context, @@ -12,16 +12,12 @@ $id( ## Parameters -| Parameter | Type | -| :-------- | :--------------------------------------- | -| `context` | `DecoratorContext` | -| `target` | `Model` \| `Scalar` \| `Enum` \| `Union` | -| `value` | `string` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Model` \| `Scalar` \| `Enum` \| `Union` | +| `value` | `string` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:110](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L110) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$jsonSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$jsonSchema.md index 1dafa549595..b63c53b10fa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$jsonSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$jsonSchema.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $jsonSchema" ---- +--- ```ts $jsonSchema( context, @@ -12,16 +12,12 @@ $jsonSchema( ## Parameters -| Parameter | Type | -| :------------- | :---------------------------------------------------------------------- | -| `context` | `DecoratorContext` | -| `target` | `Namespace` \| [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | -| `baseUriOrId`? | `string` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Namespace` \| [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | +| `baseUriOrId`? | `string` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:41](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L41) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxContains.md index 0b7791d0970..b096e943b17 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxContains.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $maxContains" ---- +--- ```ts $maxContains( context, @@ -12,16 +12,12 @@ $maxContains( ## Parameters -| Parameter | Type | -| :-------- | :------------------------- | -| `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | -| `value` | `number` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Model` \| `ModelProperty` | +| `value` | `number` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:145](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L145) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxProperties.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxProperties.md index 61728e0e628..349ef621297 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxProperties.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $maxProperties" ---- +--- ```ts $maxProperties( context, @@ -12,16 +12,12 @@ $maxProperties( ## Parameters -| Parameter | Type | -| :-------- | :------------------------- | -| `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | -| `value` | `number` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Model` \| `ModelProperty` | +| `value` | `number` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:180](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L180) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minContains.md index 990b02cf8f9..1889672b178 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minContains.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $minContains" ---- +--- ```ts $minContains( context, @@ -12,16 +12,12 @@ $minContains( ## Parameters -| Parameter | Type | -| :-------- | :------------------------- | -| `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | -| `value` | `number` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Model` \| `ModelProperty` | +| `value` | `number` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:132](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L132) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minProperties.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minProperties.md index f4a8a4cac01..ea42687c284 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minProperties.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $minProperties" ---- +--- ```ts $minProperties( context, @@ -12,16 +12,12 @@ $minProperties( ## Parameters -| Parameter | Type | -| :-------- | :------------------------- | -| `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | -| `value` | `number` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Model` \| `ModelProperty` | +| `value` | `number` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:167](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L167) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$multipleOf.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$multipleOf.md index 70a6ed89466..f1eb1cc59cf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$multipleOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$multipleOf.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $multipleOf" ---- +--- ```ts $multipleOf( context, @@ -12,16 +12,12 @@ $multipleOf( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` | -| `value` | `number` | +| `target` | `Model` | +| `value` | `number` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:101](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L101) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$onEmit.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$onEmit.md index 79fd78fdd3c..760ef203418 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$onEmit.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$onEmit.md @@ -1,22 +1,18 @@ --- jsApi: true title: "[F] $onEmit" ---- +--- ```ts $onEmit(context): Promise< void > ``` ## Parameters -| Parameter | Type | -| :-------- | :------------------------------------------------------------------------------------ | +| Parameter | Type | +| :------ | :------ | | `context` | `EmitContext`< [`JSONSchemaEmitterOptions`](Interface.JSONSchemaEmitterOptions.md) \> | ## Returns `Promise`< `void` \> - -## Source - -[json-schema/src/index.ts:27](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L27) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$prefixItems.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$prefixItems.md index 4503b9ad836..dc825cef20a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$prefixItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$prefixItems.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $prefixItems" ---- +--- ```ts $prefixItems( context, @@ -12,16 +12,12 @@ $prefixItems( ## Parameters -| Parameter | Type | -| :-------- | :------------------------- | -| `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | -| `value` | `Tuple` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Model` \| `ModelProperty` | +| `value` | `Tuple` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:232](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L232) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$uniqueItems.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$uniqueItems.md index 388904f3ede..cd02cd49caf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$uniqueItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$uniqueItems.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $uniqueItems" ---- +--- ```ts $uniqueItems(context, target): void ``` ## Parameters -| Parameter | Type | -| :-------- | :------------------------- | -| `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Model` \| `ModelProperty` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:158](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L158) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$validatesRawJson.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$validatesRawJson.md index f3890afe7f6..8ba5269b155 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$validatesRawJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$validatesRawJson.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $validatesRawJson" ---- +--- ```ts $validatesRawJson( context, @@ -12,16 +12,12 @@ $validatesRawJson( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` | -| `value` | `Type` | +| `target` | `Model` | +| `value` | `Type` | ## Returns `void` - -## Source - -[json-schema/src/index.ts:263](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L263) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.findBaseUri.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.findBaseUri.md index cd13f7554ef..0e69c3675da 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.findBaseUri.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.findBaseUri.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] findBaseUri" ---- +--- ```ts findBaseUri(program, target): string | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :---------------------------------------------------------------------- | -| `program` | `Program` | -| `target` | `Namespace` \| [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Namespace` \| [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | ## Returns `string` \| `undefined` - -## Source - -[json-schema/src/index.ts:65](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L65) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getBaseUri.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getBaseUri.md index 91e3358ed0d..c94f6620057 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getBaseUri.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getBaseUri.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getBaseUri" ---- +--- ```ts getBaseUri(program, target): any ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `any` - -## Source - -[json-schema/src/index.ts:61](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L61) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContains.md index 1b7aa683275..b0da5ad87f0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContains.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getContains" ---- +--- ```ts getContains(program, target): any ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `any` - -## Source - -[json-schema/src/index.ts:127](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L127) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentEncoding.md index cf033ce3738..daaac1ade3e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentEncoding.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentEncoding.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getContentEncoding" ---- +--- ```ts getContentEncoding(program, target): string ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `string` - -## Source - -[json-schema/src/index.ts:201](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L201) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentMediaType.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentMediaType.md index 77d02e9d251..a3e3c8a6c04 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentMediaType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentMediaType.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getContentMediaType" ---- +--- ```ts getContentMediaType(program, target): string ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `string` - -## Source - -[json-schema/src/index.ts:214](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L214) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentSchema.md index 899ade90c61..52c63e3751c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentSchema.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getContentSchema" ---- +--- ```ts getContentSchema(program, target): any ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `any` - -## Source - -[json-schema/src/index.ts:227](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L227) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getExtensions.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getExtensions.md index 2b3d260f40f..5e6cf89ee26 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getExtensions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getExtensions.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getExtensions" ---- +--- ```ts getExtensions(program, target): ExtensionRecord[] ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns [`ExtensionRecord`](Interface.ExtensionRecord.md)[] - -## Source - -[json-schema/src/index.ts:259](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L259) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getId.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getId.md index cfdd81df506..c1a7a41f977 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getId.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getId.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getId" ---- +--- ```ts getId(program, target): any ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `any` - -## Source - -[json-schema/src/index.ts:118](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L118) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchema.md index f3ebf2cd0ed..d08e1edf471 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchema.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getJsonSchema" ---- +--- ```ts getJsonSchema(program, target): boolean ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `boolean` - -## Source - -[json-schema/src/index.ts:96](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L96) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchemaTypes.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchemaTypes.md index 6d33708f170..1d0453f6163 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchemaTypes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchemaTypes.md @@ -1,22 +1,18 @@ --- jsApi: true title: "[F] getJsonSchemaTypes" ---- +--- ```ts getJsonSchemaTypes(program): (Namespace | Model)[] ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | ## Returns (`Namespace` \| `Model`)[] - -## Source - -[json-schema/src/index.ts:92](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L92) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxContains.md index ec678aa362a..1444d483123 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxContains.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getMaxContains" ---- +--- ```ts getMaxContains(program, target): any ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `any` - -## Source - -[json-schema/src/index.ts:153](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L153) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxProperties.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxProperties.md index 88b51119425..d00b87352ec 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxProperties.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getMaxProperties" ---- +--- ```ts getMaxProperties(program, target): any ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `any` - -## Source - -[json-schema/src/index.ts:188](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L188) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinContains.md index bd9df423ad5..84ee972bfde 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinContains.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getMinContains" ---- +--- ```ts getMinContains(program, target): any ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `any` - -## Source - -[json-schema/src/index.ts:140](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L140) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinProperties.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinProperties.md index 2eb6b04d042..6c748548e22 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinProperties.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getMinProperties" ---- +--- ```ts getMinProperties(program, target): any ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `any` - -## Source - -[json-schema/src/index.ts:175](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L175) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMultipleOf.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMultipleOf.md index 8d8041e20a7..1c0a704b15c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMultipleOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMultipleOf.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getMultipleOf" ---- +--- ```ts getMultipleOf(program, target): any ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `any` - -## Source - -[json-schema/src/index.ts:105](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L105) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getPrefixItems.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getPrefixItems.md index 78079c43eba..0e6407ad2f7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getPrefixItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getPrefixItems.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getPrefixItems" ---- +--- ```ts getPrefixItems(program, target): Tuple | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `Tuple` \| `undefined` - -## Source - -[json-schema/src/index.ts:240](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L240) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getUniqueItems.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getUniqueItems.md index aeb98947608..1de081729cc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getUniqueItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getUniqueItems.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getUniqueItems" ---- +--- ```ts getUniqueItems(program, target): any ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `target` | `Type` | +| `target` | `Type` | ## Returns `any` - -## Source - -[json-schema/src/index.ts:162](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L162) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.isJsonSchemaDeclaration.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.isJsonSchemaDeclaration.md index 6f4a2c6b29d..0909d925586 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.isJsonSchemaDeclaration.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.isJsonSchemaDeclaration.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] isJsonSchemaDeclaration" ---- +--- ```ts isJsonSchemaDeclaration(program, target): boolean ``` ## Parameters -| Parameter | Type | -| :-------- | :------------------------------------------------------- | -| `program` | `Program` | -| `target` | [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | ## Returns `boolean` - -## Source - -[json-schema/src/index.ts:79](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L79) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.ExtensionRecord.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.ExtensionRecord.md index 0d714df74a0..cad8f6a4736 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.ExtensionRecord.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.ExtensionRecord.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] ExtensionRecord" ---- +--- ## Properties -| Property | Type | -| :------- | :------- | -| `key` | `string` | -| `value` | `Type` | +| Property | Type | +| :------ | :------ | +| `key` | `string` | +| `value` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.JSONSchemaEmitterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.JSONSchemaEmitterOptions.md index 8d2d27d3ffc..d0e8671a3e4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.JSONSchemaEmitterOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.JSONSchemaEmitterOptions.md @@ -1,14 +1,14 @@ --- jsApi: true title: "[I] JSONSchemaEmitterOptions" ---- +--- ## Properties -| 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) | +| 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) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.Variable.namespace.md index 7f16ab5360b..326ad2a476a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.Variable.namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.Variable.namespace.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[V] namespace" ---- +--- ```ts -let namespace: string; +let namespace: string ``` - -## Source - -[json-schema/src/index.ts:269](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L269) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.md index 4520014ce78..f9111632736 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[N] $validatesRawJson" ---- +--- ## Index ### Variables diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Type.JsonSchemaDeclaration.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Type.JsonSchemaDeclaration.md index aeb813cb7db..172ba48cf8c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Type.JsonSchemaDeclaration.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Type.JsonSchemaDeclaration.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[T] JsonSchemaDeclaration" ---- +--- ```ts -JsonSchemaDeclaration: Model | Union | Enum | Scalar; +JsonSchemaDeclaration: Model | Union | Enum | Scalar ``` - -## Source - -[json-schema/src/index.ts:23](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L23) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.$lib.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.$lib.md index fbe99c2a2b6..297b2b284cd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.$lib.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.$lib.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[V] $lib" ---- +--- ```ts -const $lib: TypeSpecLibrary<{}, JSONSchemaEmitterOptions>; +const $lib: TypeSpecLibrary< {}, JSONSchemaEmitterOptions > ``` - -## Source - -[json-schema/src/lib.ts:91](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/lib.ts#L91) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.EmitterOptionsSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.EmitterOptionsSchema.md index 97d0e70e421..ba94990b7e8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.EmitterOptionsSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.EmitterOptionsSchema.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[V] EmitterOptionsSchema" ---- +--- ```ts -const EmitterOptionsSchema: JSONSchemaType; +const EmitterOptionsSchema: JSONSchemaType< JSONSchemaEmitterOptions > ``` - -## Source - -[json-schema/src/lib.ts:42](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/lib.ts#L42) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.namespace.md index 72b6689aa60..4e9054404cf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.namespace.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[V] namespace" ---- +--- ```ts -const namespace: "TypeSpec.JsonSchema" = "TypeSpec.JsonSchema"; +const namespace: "TypeSpec.JsonSchema" = "TypeSpec.JsonSchema" ``` - -## Source - -[json-schema/src/index.ts:22](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/json-schema/src/index.ts#L22) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/index.md index 5373efac6d2..457dd4e42c7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/index.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[P] JS Api" ---- +--- ## Index ### Namespaces diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$defaultResponse.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$defaultResponse.md index 3772c2da65a..d22dfd043e7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$defaultResponse.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$defaultResponse.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $defaultResponse" ---- +--- ```ts $defaultResponse(context, entity): void ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Model` | +| `entity` | `Model` | ## Returns `void` - -## Source - -[decorators.ts:85](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/decorators.ts#L85) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$extension.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$extension.md index 2f1493bebef..38407efdc73 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$extension.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$extension.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $extension" ---- +--- ```ts $extension( context, @@ -13,17 +13,13 @@ $extension( ## Parameters -| Parameter | Type | -| :-------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Type` | -| `extensionName` | `string` | -| `value` | `TypeSpecValue` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Type` | +| `extensionName` | `string` | +| `value` | `TypeSpecValue` | ## Returns `void` - -## Source - -[decorators.ts:37](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/decorators.ts#L37) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$externalDocs.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$externalDocs.md index a1ea29ea9e8..0d11dded05e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$externalDocs.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$externalDocs.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $externalDocs" ---- +--- ```ts $externalDocs( context, @@ -13,23 +13,19 @@ $externalDocs( Allows referencing an external resource for extended documentation. -## Optional - -description A short description of the target documentation. - ## Parameters -| Parameter | Type | Description | -| :------------- | :----------------- | :-------------------------------------------------------------------------- | -| `context` | `DecoratorContext` | - | -| `target` | `Type` | - | -| `url` | `string` | The URL for the target documentation. Value MUST be in the format of a URL. | -| `description`? | `string` | - | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | `DecoratorContext` | - | +| `target` | `Type` | - | +| `url` | `string` | The URL for the target documentation. Value MUST be in the format of a URL. | +| `description`? | `string` | - | ## Returns `void` -## Source +## Optional -[decorators.ts:111](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/decorators.ts#L111) +description A short description of the target documentation. diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$info.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$info.md index 3edcf77d278..ca81a88cad0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$info.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$info.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $info" ---- +--- ```ts $info( context, @@ -12,16 +12,12 @@ $info( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Namespace` | -| `model` | `Model` | +| `entity` | `Namespace` | +| `model` | `Model` | ## Returns `void` - -## Source - -[decorators.ts:129](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/decorators.ts#L129) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$operationId.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$operationId.md index 3606551e9c0..0e202b6092c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$operationId.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$operationId.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $operationId" ---- +--- ```ts $operationId( context, @@ -14,16 +14,12 @@ Set a specific operation ID. ## Parameters -| Parameter | Type | Description | -| :-------- | :----------------- | :---------------- | +| Parameter | Type | Description | +| :------ | :------ | :------ | | `context` | `DecoratorContext` | Decorator Context | -| `entity` | `Operation` | Decorator target | -| `opId` | `string` | Operation ID. | +| `entity` | `Operation` | Decorator target | +| `opId` | `string` | Operation ID. | ## Returns `void` - -## Source - -[decorators.ts:24](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/decorators.ts#L24) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.checkDuplicateTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.checkDuplicateTypeName.md index 42603be23f2..34ad11796d5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.checkDuplicateTypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.checkDuplicateTypeName.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] checkDuplicateTypeName" ---- +--- ```ts checkDuplicateTypeName( program, @@ -13,17 +13,13 @@ checkDuplicateTypeName( ## Parameters -| Parameter | Type | -| :--------- | :---------------------------------------------- | -| `program` | `Program` | -| `type` | `Type` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `type` | `Type` | +| `name` | `string` | | `existing` | `undefined` \| `Record`< `string`, `unknown` \> | ## Returns `void` - -## Source - -[helpers.ts:67](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/helpers.ts#L67) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExtensions.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExtensions.md index 4c0f79ca2fa..49f558fb582 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExtensions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExtensions.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getExtensions" ---- +--- ```ts getExtensions(program, entity): ReadonlyMap< ExtensionKey, any > ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `ReadonlyMap`< [`ExtensionKey`](Type.ExtensionKey.md), `any` \> - -## Source - -[decorators.ts:71](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/decorators.ts#L71) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExternalDocs.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExternalDocs.md index a07b10534e0..cf1f8cfd853 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExternalDocs.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExternalDocs.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getExternalDocs" ---- +--- ```ts getExternalDocs(program, entity): ExternalDocs | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns [`ExternalDocs`](Interface.ExternalDocs.md) \| `undefined` - -## Source - -[decorators.ts:124](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/decorators.ts#L124) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getInfo.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getInfo.md index f9b02a5a0a9..f4520131dce 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getInfo.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getInfo" ---- +--- ```ts getInfo(program, entity): AdditionalInfo | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :---------- | -| `program` | `Program` | -| `entity` | `Namespace` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `entity` | `Namespace` | ## Returns [`AdditionalInfo`](Interface.AdditionalInfo.md) \| `undefined` - -## Source - -[decorators.ts:135](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/decorators.ts#L135) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOpenAPITypeName.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOpenAPITypeName.md index ed55a81c4b0..026fd11016e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOpenAPITypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOpenAPITypeName.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getOpenAPITypeName" ---- +--- ```ts getOpenAPITypeName( program, @@ -22,17 +22,13 @@ namespace using the provided `TypeNameOptions`. ## Parameters -| Parameter | Type | -| :---------- | :--------------------------- | -| `program` | `Program` | -| `type` | `Type` | -| `options` | `TypeNameOptions` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `type` | `Type` | +| `options` | `TypeNameOptions` | | `existing`? | `Record`< `string`, `any` \> | ## Returns `string` - -## Source - -[helpers.ts:55](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/helpers.ts#L55) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOperationId.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOperationId.md index 6b6d3dcbc31..f6150de6c4b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOperationId.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOperationId.md @@ -1,22 +1,18 @@ --- jsApi: true title: "[F] getOperationId" ---- +--- ```ts getOperationId(program, entity): string | undefined ``` -## Operation Id - -decorator or `undefined` - ## Parameters -| Parameter | Type | -| :-------- | :---------- | -| `program` | `Program` | -| `entity` | `Operation` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `entity` | `Operation` | ## Returns @@ -24,6 +20,6 @@ decorator or `undefined` operationId set via the -## Source +## Operation Id -[decorators.ts:31](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/decorators.ts#L31) +decorator or `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getParameterKey.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getParameterKey.md index 9546d65f7f8..1f3d1f367ac 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getParameterKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getParameterKey.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getParameterKey" ---- +--- ```ts getParameterKey( program, @@ -16,18 +16,14 @@ Gets the key that is used to define a parameter in OpenAPI. ## Parameters -| Parameter | Type | -| :--------------- | :------------------------------- | -| `program` | `Program` | -| `property` | `ModelProperty` | -| `newParam` | `unknown` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `property` | `ModelProperty` | +| `newParam` | `unknown` | | `existingParams` | `Record`< `string`, `unknown` \> | -| `options` | `TypeNameOptions` | +| `options` | `TypeNameOptions` | ## Returns `string` - -## Source - -[helpers.ts:87](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/helpers.ts#L87) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isDefaultResponse.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isDefaultResponse.md index ec36f66bf77..0e1a024b769 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isDefaultResponse.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isDefaultResponse.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] isDefaultResponse" ---- +--- ```ts isDefaultResponse(program, entity): boolean ``` @@ -11,17 +11,13 @@ Check if the given model has been mark as a default response. ## Parameters -| Parameter | Type | Description | -| :-------- | :-------- | :--------------- | +| Parameter | Type | Description | +| :------ | :------ | :------ | | `program` | `Program` | TypeSpec Program | -| `entity` | `Type` | Model to check. | +| `entity` | `Type` | Model to check. | ## Returns `boolean` boolean. - -## Source - -[decorators.ts:96](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/decorators.ts#L96) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isReadonlyProperty.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isReadonlyProperty.md index 440e59626e0..6594fe94901 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isReadonlyProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isReadonlyProperty.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] isReadonlyProperty" ---- +--- ```ts isReadonlyProperty(program, property): boolean ``` @@ -16,15 +16,11 @@ designate a read-only property. ## Parameters -| Parameter | Type | -| :--------- | :-------------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `property` | `ModelProperty` | ## Returns `boolean` - -## Source - -[helpers.ts:154](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/helpers.ts#L154) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.resolveOperationId.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.resolveOperationId.md index 1da81774e8d..7c61cc81012 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.resolveOperationId.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.resolveOperationId.md @@ -1,29 +1,21 @@ --- jsApi: true title: "[F] resolveOperationId" ---- +--- ```ts resolveOperationId(program, operation): string ``` Resolve the OpenAPI operation ID for the given operation using the following logic: - - If -## Operation Id - -was specified use that value - -- If operation is defined at the root or under the service namespace return `` -- Otherwise(operation is under another namespace or interface) return `_` - ## Parameters -| Parameter | Type | Description | -| :---------- | :---------- | :--------------- | -| `program` | `Program` | TypeSpec Program | -| `operation` | `Operation` | Operation | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | `Program` | TypeSpec Program | +| `operation` | `Operation` | Operation | ## Returns @@ -31,6 +23,8 @@ was specified use that value Operation ID in this format `` or `_` -## Source +## Operation Id -[helpers.ts:125](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/helpers.ts#L125) +was specified use that value +- If operation is defined at the root or under the service namespace return `` +- Otherwise(operation is under another namespace or interface) return `_` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.setExtension.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.setExtension.md index 91a7c02967e..b544a1c5e37 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.setExtension.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.setExtension.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] setExtension" ---- +--- ```ts setExtension( program, @@ -13,17 +13,13 @@ setExtension( ## Parameters -| Parameter | Type | -| :-------------- | :--------------- | -| `program` | `Program` | -| `entity` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `entity` | `Type` | | `extensionName` | \`x-$\{string}\` | -| `data` | `unknown` | +| `data` | `unknown` | ## Returns `void` - -## Source - -[decorators.ts:58](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/decorators.ts#L58) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.shouldInline.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.shouldInline.md index 14a842c0c80..539e51977b6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.shouldInline.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.shouldInline.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] shouldInline" ---- +--- ```ts shouldInline(program, type): boolean ``` @@ -19,15 +19,11 @@ decorator, or chosen by default in simple cases. ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `type` | `Type` | +| `type` | `Type` | ## Returns `boolean` - -## Source - -[helpers.ts:28](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/helpers.ts#L28) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.AdditionalInfo.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.AdditionalInfo.md index 453cca960d8..5947ef994b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.AdditionalInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.AdditionalInfo.md @@ -1,14 +1,14 @@ --- jsApi: true title: "[I] AdditionalInfo" ---- +--- OpenAPI additional information ## Properties -| Property | Type | Description | -| :---------------- | :-------------------------------- | :------------------------------------------------------------------------- | -| `contact`? | [`Contact`](Interface.Contact.md) | The contact information for the exposed API. | -| `license`? | [`License`](Interface.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. | +| Property | Type | Description | +| :------ | :------ | :------ | +| `contact`? | [`Contact`](Interface.Contact.md) | The contact information for the exposed API. | +| `license`? | [`License`](Interface.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/Interface.Contact.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.Contact.md index 10dfbc6d77b..b4f33643203 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.Contact.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.Contact.md @@ -1,12 +1,12 @@ --- jsApi: true title: "[I] Contact" ---- +--- ## Properties -| Property | Type | Description | -| :------- | :------- | :----------------------------------------------------------------------------------------------- | +| 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. | +| `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/Interface.ExternalDocs.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.ExternalDocs.md index b4c817b40bd..8c671d062d5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.ExternalDocs.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.ExternalDocs.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] ExternalDocs" ---- +--- ## Properties -| Property | Type | -| :------------- | :------- | +| Property | Type | +| :------ | :------ | | `description`? | `string` | -| `url` | `string` | +| `url` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.License.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.License.md index c91c644c09f..e4880abc500 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.License.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.License.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] License" ---- +--- ## Properties -| 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. | +| 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. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Type.ExtensionKey.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Type.ExtensionKey.md index b46566bbadf..4a2123ae002 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Type.ExtensionKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Type.ExtensionKey.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[T] ExtensionKey" ---- +--- ```ts ExtensionKey: \x-${string}\ ``` - -## Source - -[types.ts:1](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/types.ts#L1) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Variable.namespace.md index d01f85bb454..47635e306f5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Variable.namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Variable.namespace.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[V] namespace" ---- +--- ```ts -const namespace: "OpenAPI" = "OpenAPI"; +const namespace: "OpenAPI" = "OpenAPI" ``` - -## Source - -[decorators.ts:15](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi/src/decorators.ts#L15) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/index.md index edd746fd9eb..c7afe41ec9a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/index.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[P] JS Api" ---- +--- ## Index ### Interfaces diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$onEmit.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$onEmit.md index 5b0e33c6847..cbb2709ca2b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$onEmit.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$onEmit.md @@ -1,22 +1,18 @@ --- jsApi: true title: "[F] $onEmit" ---- +--- ```ts $onEmit(context): Promise< void > ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------------------------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `EmitContext`< `OpenAPI3EmitterOptions` \> | ## Returns `Promise`< `void` \> - -## Source - -[openapi.ts:125](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi3/src/openapi.ts#L125) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$oneOf.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$oneOf.md index 5fd08a7e9e6..18f2c875225 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$oneOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$oneOf.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $oneOf" ---- +--- ```ts $oneOf(context, entity): void ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Union` | +| `entity` | `Union` | ## Returns `void` - -## Source - -[decorators.ts:18](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi3/src/decorators.ts#L18) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$useRef.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$useRef.md index 1f94aa4af93..817f6186842 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$useRef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$useRef.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $useRef" ---- +--- ```ts $useRef( context, @@ -12,16 +12,12 @@ $useRef( ## Parameters -| Parameter | Type | -| :-------- | :------------------------- | -| `context` | `DecoratorContext` | -| `entity` | `Model` \| `ModelProperty` | -| `refUrl` | `string` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Model` \| `ModelProperty` | +| `refUrl` | `string` | ## Returns `void` - -## Source - -[decorators.ts:5](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi3/src/decorators.ts#L5) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getOneOf.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getOneOf.md index ddd37fb4108..3f4d7270426 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getOneOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getOneOf.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getOneOf" ---- +--- ```ts getOneOf(program, entity): boolean ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `boolean` - -## Source - -[decorators.ts:22](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi3/src/decorators.ts#L22) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getRef.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getRef.md index 020dc8c5d06..20ad7ec6488 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getRef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getRef.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getRef" ---- +--- ```ts getRef(program, entity): string | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `string` \| `undefined` - -## Source - -[decorators.ts:13](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi3/src/decorators.ts#L13) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.resolveOptions.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.resolveOptions.md index d33e8ccac06..415323ec6fc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.resolveOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.resolveOptions.md @@ -1,22 +1,18 @@ --- jsApi: true title: "[F] resolveOptions" ---- +--- ```ts resolveOptions(context): ResolvedOpenAPI3EmitterOptions ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------------------------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `EmitContext`< `OpenAPI3EmitterOptions` \> | ## Returns [`ResolvedOpenAPI3EmitterOptions`](Interface.ResolvedOpenAPI3EmitterOptions.md) - -## Source - -[openapi.ts:145](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi3/src/openapi.ts#L145) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Interface.ResolvedOpenAPI3EmitterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Interface.ResolvedOpenAPI3EmitterOptions.md index 138bf887131..767582100da 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Interface.ResolvedOpenAPI3EmitterOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Interface.ResolvedOpenAPI3EmitterOptions.md @@ -1,14 +1,14 @@ --- jsApi: true title: "[I] ResolvedOpenAPI3EmitterOptions" ---- +--- ## Properties -| Property | Type | -| :--------------------- | :--------------------------- | -| `fileType` | `FileType` | +| Property | Type | +| :------ | :------ | +| `fileType` | `FileType` | | `includeXTypeSpecName` | `"never"` \| `"inline-only"` | -| `newLine` | `NewLine` | -| `omitUnreachableTypes` | `boolean` | -| `outputFile` | `string` | +| `newLine` | `NewLine` | +| `omitUnreachableTypes` | `boolean` | +| `outputFile` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.$lib.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.$lib.md index 426d64cc15c..5429b6e4430 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.$lib.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.$lib.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[V] $lib" ---- +--- ```ts -const $lib: TypeSpecLibrary; +const $lib: TypeSpecLibrary< Object, OpenAPI3EmitterOptions > ``` - -## Source - -[lib.ts:220](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi3/src/lib.ts#L220) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.namespace.md index 5f443224618..47635e306f5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.namespace.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[V] namespace" ---- +--- ```ts -const namespace: "OpenAPI" = "OpenAPI"; +const namespace: "OpenAPI" = "OpenAPI" ``` - -## Source - -[index.ts:1](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/openapi3/src/index.ts#L1) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/index.md index 73de2065c4c..c814985a013 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/index.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[P] JS Api" ---- +--- ## Index ### Interfaces diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/guide.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/guide.md index e0723a3e9fc..daf6e4eda70 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/guide.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/guide.md @@ -167,34 +167,6 @@ The Protobuf emitter supports declaring the streaming mode of an operation using Example: `rpc Example(stream In) returns (stream Out);` -## Emitter options - -Emitter options can be provided to the CLI with - -```bash ---option "@typespec/protobuf.=" - -# For example ---option "@typespec/protobuf.noEmit=true" -``` - -or configured through the `typespec-project.yaml` project configuration: - -```yaml -emitters: - '@typespec/protobuf': - : - -# For example -emitters: - '@typespec/protobuf': - noEmit: true -``` - -#### `noEmit` - -If set to `true`, this emitter will not write any files. It will still validate the TypeSpec sources to ensure they are compatible with Protobuf, but the files will simply not be written to the output directory. - [native-service]: ../built-in-decorators#service [protobuf-service]: reference/decorators#@TypeSpec.Protobuf.service [protobuf-package]: reference/decorators#@TypeSpec.Protobuf.package diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/emitter.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/emitter.md index d8a8b42f20a..22e256a81b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/emitter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/emitter.md @@ -26,3 +26,11 @@ emit: ### `noEmit` **Type:** `boolean` + +If set to `true`, this emitter will not write any files. It will still validate the TypeSpec sources to ensure they are compatible with Protobuf, but the files will simply not be written to the output directory. + +### `omit-unreachable-types` + +**Type:** `boolean` + +By default, the emitter will create `message` declarations for any models in a namespace decorated with `@package` that have an `@field` decorator on every property. If this option is set to true, this behavior will be disabled, and only messages that are explicitly decorated with `@message` or that are reachable from a service operation will be emitted. diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$_map.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$_map.md index 53fc3a971d0..afe55c58640 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$_map.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$_map.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $_map" ---- +--- ```ts $_map(ctx, target): void ``` @@ -11,15 +11,11 @@ Binds the internal representation of a Protobuf map. ## Parameters -| Parameter | Type | Description | -| :-------- | :----------------- | :---------- | -| `ctx` | `DecoratorContext` | | -| `target` | `Model` | | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `ctx` | `DecoratorContext` | | +| `target` | `Model` | | ## Returns `void` - -## Source - -[proto.ts:91](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L91) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$externRef.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$externRef.md index 4f1e1daf6c0..30e67c0b360 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$externRef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$externRef.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $externRef" ---- +--- ```ts $externRef( ctx, @@ -13,17 +13,13 @@ $externRef( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | -| `ctx` | `DecoratorContext` | -| `target` | `Model` | -| `path` | `StringLiteral` | -| `name` | `StringLiteral` | +| Parameter | Type | +| :------ | :------ | +| `ctx` | `DecoratorContext` | +| `target` | `Model` | +| `path` | `StringLiteral` | +| `name` | `StringLiteral` | ## Returns `void` - -## Source - -[proto.ts:95](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L95) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$field.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$field.md index 96a006cf018..570560f61d2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$field.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$field.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $field" ---- +--- ```ts $field( ctx, @@ -14,16 +14,12 @@ Decorate a model property with a field index. Field indices are required for all ## Parameters -| Parameter | Type | Description | -| :----------- | :----------------- | :---------- | -| `ctx` | `DecoratorContext` | - | -| `target` | `ModelProperty` | | -| `fieldIndex` | `number` | | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `ctx` | `DecoratorContext` | - | +| `target` | `ModelProperty` | | +| `fieldIndex` | `number` | | ## Returns `void` - -## Source - -[proto.ts:159](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L159) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$message.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$message.md index 441c1bc0372..a20a75e3812 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$message.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$message.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] $message" ---- +--- ```ts $message(ctx, target): void ``` ## Parameters -| Parameter | Type | -| :-------- | :----------------- | -| `ctx` | `DecoratorContext` | -| `target` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `ctx` | `DecoratorContext` | +| `target` | `Model` | ## Returns `void` - -## Source - -[proto.ts:147](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L147) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onEmit.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onEmit.md index df409588534..54b96792533 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onEmit.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onEmit.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $onEmit" ---- +--- ```ts $onEmit(ctx): Promise< void > ``` @@ -11,14 +11,10 @@ Emitter main function. ## Parameters -| Parameter | Type | -| :-------- | :----------------------------------------- | -| `ctx` | `EmitContext`< `ProtobufEmitterOptions` \> | +| Parameter | Type | +| :------ | :------ | +| `ctx` | `EmitContext`< `ProtobufEmitterOptions` \> | ## Returns `Promise`< `void` \> - -## Source - -[proto.ts:203](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L203) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onValidate.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onValidate.md index 6588a479415..43874617fb4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onValidate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onValidate.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $onValidate" ---- +--- ```ts $onValidate(program): Promise< void > ``` @@ -11,14 +11,10 @@ Validation function ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | ## Returns `Promise`< `void` \> - -## Source - -[proto.ts:212](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L212) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$package.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$package.md index 92bfd530036..dfc505b38f5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$package.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$package.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $package" ---- +--- ```ts $package( ctx, @@ -14,16 +14,12 @@ Declare a Protobuf package. ## Parameters -| Parameter | Type | Description | -| :--------- | :----------------- | :------------------------- | -| `ctx` | `DecoratorContext` | decorator context | -| `target` | `Namespace` | target decorator namespace | -| `details`? | `Model` | - | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `ctx` | `DecoratorContext` | decorator context | +| `target` | `Namespace` | target decorator namespace | +| `details`? | `Model` | - | ## Returns `void` - -## Source - -[proto.ts:70](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L70) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$reserve.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$reserve.md index 015f7bd62e5..2eceea00f7a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$reserve.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$reserve.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $reserve" ---- +--- ```ts $reserve( ctx, @@ -12,16 +12,12 @@ $reserve( ## Parameters -| Parameter | Type | -| :---------------- | :-------------------------------------------- | -| `ctx` | `DecoratorContext` | -| `target` | `Model` | -| ...`reservations` | _readonly_ (`string` \| `number` \| `Type`)[] | +| Parameter | Type | +| :------ | :------ | +| `ctx` | `DecoratorContext` | +| `target` | `Model` | +| ...`reservations` | *readonly* (`string` \| `number` \| `Type`)[] | ## Returns `void` - -## Source - -[proto.ts:133](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L133) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$service.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$service.md index fad2cfe2645..3f35f2324f9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$service.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$service.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $service" ---- +--- ```ts $service(ctx, target): void ``` @@ -11,15 +11,11 @@ Decorate an interface as a service, indicating that it represents a Protobuf `se ## Parameters -| Parameter | Type | Description | -| :-------- | :----------------- | :---------------------- | -| `ctx` | `DecoratorContext` | decorator context | -| `target` | `Interface` | the decorated interface | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `ctx` | `DecoratorContext` | decorator context | +| `target` | `Interface` | the decorated interface | ## Returns `void` - -## Source - -[proto.ts:56](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L56) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$stream.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$stream.md index d3b1188a0f8..6ff322eb03f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$stream.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$stream.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $stream" ---- +--- ```ts $stream( ctx, @@ -12,16 +12,12 @@ $stream( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | -| `ctx` | `DecoratorContext` | -| `target` | `Operation` | -| `mode` | `EnumMember` | +| Parameter | Type | +| :------ | :------ | +| `ctx` | `DecoratorContext` | +| `target` | `Operation` | +| `mode` | `EnumMember` | ## Returns `void` - -## Source - -[proto.ts:104](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L104) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.isMap.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.isMap.md index d8250f215d0..6708926d078 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.isMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.isMap.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] isMap" ---- +--- ```ts isMap(program, m): boolean ``` @@ -11,17 +11,13 @@ Determines whether a type represents a Protobuf map. ## Parameters -| Parameter | Type | Description | -| :-------- | :-------- | :------------------ | +| Parameter | Type | Description | +| :------ | :------ | :------ | | `program` | `Program` | the program context | -| `m` | `Type` | the type to test | +| `m` | `Type` | the type to test | ## Returns `boolean` true if the internal representation of a Protobuf map is bound to this type. - -## Source - -[proto.ts:81](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L81) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Interface.PackageDetails.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Interface.PackageDetails.md index f52d5568224..bbaf2aa3974 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Interface.PackageDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Interface.PackageDetails.md @@ -1,10 +1,10 @@ --- jsApi: true title: "[I] PackageDetails" ---- +--- ## Properties -| Property | Type | -| :------- | :------- | -| `name`? | `string` | +| Property | Type | +| :------ | :------ | +| `name`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Type.Reservation.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Type.Reservation.md index 5ec8bc8ddf1..afe66d7dae0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Type.Reservation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Type.Reservation.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[T] Reservation" ---- +--- ```ts Reservation: string | number | [number, number] & {type: Type;} ``` - -## Source - -[proto.ts:131](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L131) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.$lib.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.$lib.md index 34d2d534a77..283584fea37 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.$lib.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.$lib.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[V] $lib" ---- +--- ```ts -const $lib: TypeSpecLibrary = TypeSpecProtobufLibrary; +const $lib: TypeSpecLibrary< Object, ProtobufEmitterOptions > = TypeSpecProtobufLibrary ``` - -## Source - -[index.ts:7](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/index.ts#L7) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.PROTO_FULL_IDENT.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.PROTO_FULL_IDENT.md index 97dbcb0f010..5d1d8b4f614 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.PROTO_FULL_IDENT.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.PROTO_FULL_IDENT.md @@ -1,17 +1,13 @@ --- jsApi: true title: "[V] PROTO_FULL_IDENT" ---- +--- ```ts -const PROTO_FULL_IDENT: RegExp; +const PROTO_FULL_IDENT: RegExp ``` Defined in the [ProtoBuf Language Spec](https://developers.google.com/protocol-buffers/docs/reference/proto3-spec#identifiers). -ident = letter { letter | decimalDigit | "\_" } +ident = letter { letter | decimalDigit | "_" } fullIdent = ident { "." ident } - -## Source - -[proto.ts:48](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/proto.ts#L48) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.namespace.md index 8100daed214..2530651317c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.namespace.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[V] namespace" ---- +--- ```ts -const namespace: "TypeSpec.Protobuf" = "TypeSpec.Protobuf"; +const namespace: "TypeSpec.Protobuf" = "TypeSpec.Protobuf" ``` - -## Source - -[index.ts:3](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/protobuf/src/index.ts#L3) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/index.md index 1dc1c549fb7..b7bc0b4c4b7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/index.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[P] JS Api" ---- +--- ## Index ### Interfaces @@ -16,7 +16,7 @@ title: "[P] JS Api" ### Variables - [$lib](Variable.$lib.md) -- [PROTO_FULL_IDENT](Variable.PROTO_FULL_IDENT.md) +- [PROTO\_FULL\_IDENT](Variable.PROTO_FULL_IDENT.md) - [namespace](Variable.namespace.md) ### Functions diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.DuplicateTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.DuplicateTracker.md new file mode 100644 index 00000000000..dd58558caf5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.DuplicateTracker.md @@ -0,0 +1,66 @@ +--- +jsApi: true +title: "[C] DuplicateTracker" + +--- +Helper class to track duplicate instance + +## Constructors + +### new DuplicateTracker + +```ts +new DuplicateTracker(): DuplicateTracker< K, V > +``` + +#### Type parameters + +| Parameter | +| :------ | +| `K` | +| `V` | + +#### Returns + +[`DuplicateTracker`](Class.DuplicateTracker.md)< `K`, `V` \> + +## Properties + +| Property | Type | +| :------ | :------ | +| `private` `#entries` | `Map`< `K`, `V`[] \> | + +## Methods + +### entries + +```ts +entries(): Iterable< [K, V[]] > +``` + +Return iterator of all the duplicate entries. + +#### Returns + +`Iterable`< [`K`, `V`[]] \> + +*** + +### track + +```ts +track(k, v): void +``` + +Track usage of K. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `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/Class.EventEmitter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.EventEmitter.md new file mode 100644 index 00000000000..3e1fb3632ee --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.EventEmitter.md @@ -0,0 +1,78 @@ +--- +jsApi: true +title: "[C] EventEmitter" + +--- +## Constructors + +### new EventEmitter + +```ts +new EventEmitter(): EventEmitter< T > +``` + +#### Type parameters + +| Parameter | +| :------ | +| `T` *extends* \{} | + +#### Returns + +[`EventEmitter`](Class.EventEmitter.md)< `T` \> + +## Properties + +| Property | Type | +| :------ | :------ | +| `private` `listeners` | `Map`< *keyof* `T`, (...`args`) => `any`[] \> | + +## Methods + +### emit + +```ts +emit(name, ...args): void +``` + +#### Type parameters + +| Parameter | +| :------ | +| `K` *extends* `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `K` | +| ...`args` | `Parameters`< `T`[`K`] \> | + +#### Returns + +`void` + +*** + +### on + +```ts +on(name, listener): void +``` + +#### Type parameters + +| Parameter | +| :------ | +| `K` *extends* `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `K` | +| `listener` | (...`args`) => `any` | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.InvalidEncodingError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.InvalidEncodingError.md new file mode 100644 index 00000000000..83953f3eab5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.InvalidEncodingError.md @@ -0,0 +1,65 @@ +--- +jsApi: true +title: "[C] InvalidEncodingError" + +--- +## Extends + +- `Error` + +## Constructors + +### new InvalidEncodingError + +```ts +new InvalidEncodingError(encoding): InvalidEncodingError +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `encoding` | `string` | + +#### Returns + +[`InvalidEncodingError`](Class.InvalidEncodingError.md) + +#### Overrides + +Error.constructor + +## Properties + +| Property | Type | +| :------ | :------ | +| `message` | `string` | +| `name` | `string` | +| `stack`? | `string` | +| `prepareStackTrace`? | (`err`, `stackTraces`) => `any` | +| `static` `stackTraceLimit` | `number` | + +## Methods + +### captureStackTrace + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.ProjectionError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.ProjectionError.md new file mode 100644 index 00000000000..5a0f59940eb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.ProjectionError.md @@ -0,0 +1,67 @@ +--- +jsApi: true +title: "[C] ProjectionError" + +--- +Represents a failure while interpreting a projection. + +## Extends + +- `Error` + +## Constructors + +### new ProjectionError + +```ts +new ProjectionError(message): ProjectionError +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `message` | `string` | + +#### Returns + +[`ProjectionError`](Class.ProjectionError.md) + +#### Overrides + +Error.constructor + +## Properties + +| Property | Type | +| :------ | :------ | +| `message` | `string` | +| `name` | `string` | +| `stack`? | `string` | +| `prepareStackTrace`? | (`err`, `stackTraces`) => `any` | +| `static` `stackTraceLimit` | `number` | + +## Methods + +### captureStackTrace + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.Queue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.Queue.md new file mode 100644 index 00000000000..caf95126fb4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.Queue.md @@ -0,0 +1,77 @@ +--- +jsApi: true +title: "[C] Queue" + +--- +## Constructors + +### new Queue + +```ts +new Queue(elements?): Queue< T > +``` + +#### Type parameters + +| Parameter | +| :------ | +| `T` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `elements`? | `T`[] | + +#### Returns + +[`Queue`](Class.Queue.md)< `T` \> + +## Properties + +| Property | Type | +| :------ | :------ | +| `private` `#elements` | `T`[] | +| `private` `#headIndex` | `number` | + +## Methods + +### dequeue + +```ts +dequeue(): T +``` + +#### Returns + +`T` + +*** + +### enqueue + +```ts +enqueue(...items): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| ...`items` | `T`[] | + +#### Returns + +`void` + +*** + +### isEmpty + +```ts +isEmpty(): boolean +``` + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.ResolveModuleError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.ResolveModuleError.md new file mode 100644 index 00000000000..ac672157543 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.ResolveModuleError.md @@ -0,0 +1,67 @@ +--- +jsApi: true +title: "[C] ResolveModuleError" + +--- +## Extends + +- `Error` + +## Constructors + +### new ResolveModuleError + +```ts +new ResolveModuleError(code, message): ResolveModuleError +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `code` | `ResolveModuleErrorCode` | +| `message` | `string` | + +#### Returns + +[`ResolveModuleError`](Class.ResolveModuleError.md) + +#### Overrides + +Error.constructor + +## Properties + +| Property | Type | +| :------ | :------ | +| `code` | `ResolveModuleErrorCode` | +| `message` | `string` | +| `name` | `string` | +| `stack`? | `string` | +| `prepareStackTrace`? | (`err`, `stackTraces`) => `any` | +| `static` `stackTraceLimit` | `number` | + +## Methods + +### captureStackTrace + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.IdentifierKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.IdentifierKind.md new file mode 100644 index 00000000000..aa43c10f1ba --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.IdentifierKind.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[E] IdentifierKind" + +--- +## Enumeration Members + +| Member | Value | +| :------ | :------ | +| `Declaration` | ``4`` | +| `Decorator` | ``1`` | +| `Function` | ``2`` | +| `Other` | ``5`` | +| `TypeReference` | ``0`` | +| `Using` | ``3`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.KeywordLimit.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.KeywordLimit.md new file mode 100644 index 00000000000..3284e72767e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.KeywordLimit.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[E] KeywordLimit" + +--- + +## Enumeration Members + +| Member | Value | +| :------ | :------ | +| `MaxLength` | ``10`` | +| `MinLength` | ``2`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.ListenerFlow.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.ListenerFlow.md new file mode 100644 index 00000000000..3f64466436f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.ListenerFlow.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[E] ListenerFlow" + +--- +## Enumeration Members + +| Member | Value | Description | +| :------ | :------ | :------ | +| `NoRecursion` | ``1`` | Do not navigate any containing or referenced type. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.ModifierFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.ModifierFlags.md new file mode 100644 index 00000000000..7e592bfb927 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.ModifierFlags.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[E] ModifierFlags" + +--- +## Enumeration Members + +| Member | Value | +| :------ | :------ | +| `Extern` | ``2`` | +| `None` | ``0`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.NodeFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.NodeFlags.md new file mode 100644 index 00000000000..91c97762898 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.NodeFlags.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[E] NodeFlags" + +--- +## Enumeration Members + +| Member | Value | Description | +| :------ | :------ | :------ | +| `DescendantErrorsExamined` | ``1`` | If this is set, the DescendantHasError bit can be trusted. If this not set,
children need to be visited still to see if DescendantHasError should be
set.

Use the parser's `hasParseError` API instead of using this flag directly. | +| `DescendantHasError` | ``4`` | Indicates that a child of this node (or one of its children,
transitively) has a parse error.

Use the parser's `hasParseError` API instead of using this flag directly. | +| `None` | ``0`` | - | +| `Synthetic` | ``8`` | Indicates that a node was created synthetically and therefore may not be parented. | +| `ThisNodeHasError` | ``2`` | Indicates that a parse error was associated with this specific node.

Use the parser's `hasParseError` API instead of using this flag directly. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.SemanticTokenKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.SemanticTokenKind.md new file mode 100644 index 00000000000..32dcd828863 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.SemanticTokenKind.md @@ -0,0 +1,31 @@ +--- +jsApi: true +title: "[E] SemanticTokenKind" + +--- +## Enumeration Members + +| Member | Value | +| :------ | :------ | +| `Class` | ``2`` | +| `Comment` | ``16`` | +| `DocCommentTag` | ``21`` | +| `Enum` | ``3`` | +| `EnumMember` | ``10`` | +| `Event` | ``11`` | +| `Function` | ``12`` | +| `Interface` | ``4`` | +| `Keyword` | ``15`` | +| `Macro` | ``14`` | +| `Method` | ``13`` | +| `Namespace` | ``0`` | +| `Number` | ``18`` | +| `Operator` | ``20`` | +| `Parameter` | ``7`` | +| `Property` | ``9`` | +| `Regexp` | ``19`` | +| `String` | ``17`` | +| `Struct` | ``5`` | +| `Type` | ``1`` | +| `TypeParameter` | ``6`` | +| `Variable` | ``8`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.SymbolFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.SymbolFlags.md new file mode 100644 index 00000000000..d88e3490acc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.SymbolFlags.md @@ -0,0 +1,37 @@ +--- +jsApi: true +title: "[E] SymbolFlags" + +--- +## Enumeration Members + +| Member | Value | Description | +| :------ | :------ | :------ | +| `Alias` | ``2048`` | - | +| `Declaration` | ``4194304`` | - | +| `Decorator` | ``16384`` | - | +| `DuplicateUsing` | ``1048576`` | - | +| `Enum` | ``32`` | - | +| `EnumMember` | ``64`` | - | +| `ExportContainer` | ``2101248`` | - | +| `Function` | ``131072`` | - | +| `FunctionParameter` | ``262144`` | - | +| `Implementation` | ``8388608`` | - | +| `Interface` | ``128`` | - | +| `InterfaceMember` | ``256`` | - | +| `LateBound` | ``16777216`` | A symbol which was late-bound, in which case, the type referred to
by this symbol is stored directly in the symbol. | +| `Member` | ``1348`` | - | +| `MemberContainer` | ``674`` | Symbols whose members will be late bound (and stored on the type) | +| `Model` | ``2`` | - | +| `ModelProperty` | ``4`` | - | +| `Namespace` | ``4096`` | - | +| `None` | ``0`` | - | +| `Operation` | ``16`` | - | +| `Projection` | ``8192`` | - | +| `ProjectionParameter` | ``65536`` | - | +| `Scalar` | ``8`` | - | +| `SourceFile` | ``2097152`` | - | +| `TemplateParameter` | ``32768`` | - | +| `Union` | ``512`` | - | +| `UnionVariant` | ``1024`` | - | +| `Using` | ``524288`` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.SyntaxKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.SyntaxKind.md new file mode 100644 index 00000000000..50d7ebb64d6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.SyntaxKind.md @@ -0,0 +1,96 @@ +--- +jsApi: true +title: "[E] SyntaxKind" + +--- +AST types + +## Enumeration Members + +| Member | Value | Description | +| :------ | :------ | :------ | +| `AliasStatement` | ``24`` | - | +| `ArrayExpression` | ``31`` | - | +| `AugmentDecoratorStatement` | ``4`` | - | +| `BlockComment` | ``46`` | - | +| `BooleanLiteral` | ``34`` | - | +| `CadlScript` | ``0`` | **Deprecated**

Use TypeSpecScript | +| `DecoratorDeclarationStatement` | ``25`` | - | +| `DecoratorExpression` | ``5`` | - | +| `DirectiveExpression` | ``6`` | - | +| `Doc` | ``47`` | - | +| `DocParamTag` | ``49`` | - | +| `DocReturnsTag` | ``50`` | - | +| `DocTemplateTag` | ``51`` | - | +| `DocText` | ``48`` | - | +| `DocUnknownTag` | ``52`` | - | +| `EmptyStatement` | ``43`` | - | +| `EnumMember` | ``22`` | - | +| `EnumSpreadMember` | ``23`` | - | +| `EnumStatement` | ``21`` | - | +| `ExternKeyword` | ``35`` | - | +| `FunctionDeclarationStatement` | ``26`` | - | +| `FunctionParameter` | ``27`` | - | +| `Identifier` | ``3`` | - | +| `ImportStatement` | ``2`` | - | +| `InterfaceStatement` | ``18`` | - | +| `IntersectionExpression` | ``29`` | - | +| `InvalidStatement` | ``44`` | - | +| `JsNamespaceDeclaration` | ``83`` | - | +| `JsSourceFile` | ``1`` | - | +| `LineComment` | ``45`` | - | +| `MemberExpression` | ``7`` | - | +| `ModelExpression` | ``14`` | - | +| `ModelProperty` | ``15`` | - | +| `ModelSpreadProperty` | ``16`` | - | +| `ModelStatement` | ``13`` | - | +| `NamespaceStatement` | ``8`` | - | +| `NeverKeyword` | ``37`` | - | +| `NumericLiteral` | ``33`` | - | +| `OperationSignatureDeclaration` | ``11`` | - | +| `OperationSignatureReference` | ``12`` | - | +| `OperationStatement` | ``10`` | - | +| `Projection` | ``53`` | - | +| `ProjectionArithmeticExpression` | ``71`` | - | +| `ProjectionBlockExpression` | ``65`` | - | +| `ProjectionCallExpression` | ``72`` | - | +| `ProjectionDecoratorReferenceExpression` | ``81`` | - | +| `ProjectionEnumMemberSelector` | ``62`` | - | +| `ProjectionEnumSelector` | ``61`` | - | +| `ProjectionEqualityExpression` | ``68`` | - | +| `ProjectionExpressionStatement` | ``63`` | - | +| `ProjectionIfExpression` | ``64`` | - | +| `ProjectionInterfaceSelector` | ``60`` | - | +| `ProjectionLambdaExpression` | ``73`` | - | +| `ProjectionLambdaParameterDeclaration` | ``74`` | - | +| `ProjectionLogicalExpression` | ``67`` | - | +| `ProjectionMemberExpression` | ``66`` | - | +| `ProjectionModelExpression` | ``75`` | - | +| `ProjectionModelProperty` | ``76`` | - | +| `ProjectionModelPropertySelector` | ``56`` | - | +| `ProjectionModelSelector` | ``55`` | - | +| `ProjectionModelSpreadProperty` | ``77`` | - | +| `ProjectionOperationSelector` | ``57`` | - | +| `ProjectionParameterDeclaration` | ``54`` | - | +| `ProjectionReference` | ``41`` | - | +| `ProjectionRelationalExpression` | ``70`` | - | +| `ProjectionSpreadProperty` | ``78`` | - | +| `ProjectionStatement` | ``80`` | - | +| `ProjectionTupleExpression` | ``79`` | - | +| `ProjectionUnaryExpression` | ``69`` | - | +| `ProjectionUnionSelector` | ``58`` | - | +| `ProjectionUnionVariantSelector` | ``59`` | - | +| `Return` | ``82`` | - | +| `ScalarStatement` | ``17`` | - | +| `StringLiteral` | ``32`` | - | +| `TemplateParameterDeclaration` | ``42`` | - | +| `TupleExpression` | ``30`` | - | +| `TypeReference` | ``40`` | - | +| `TypeSpecScript` | ``0`` | - | +| `UnionExpression` | ``28`` | - | +| `UnionStatement` | ``19`` | - | +| `UnionVariant` | ``20`` | - | +| `UnknownKeyword` | ``38`` | - | +| `UsingStatement` | ``9`` | - | +| `ValueOfExpression` | ``39`` | - | +| `VoidKeyword` | ``36`` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.Token.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.Token.md new file mode 100644 index 00000000000..92c3bae72fe --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.Token.md @@ -0,0 +1,94 @@ +--- +jsApi: true +title: "[E] Token" + +--- +## Enumeration Members + +| Member | Value | +| :------ | :------ | +| `AliasKeyword` | ``54`` | +| `Ampersand` | ``27`` | +| `AmpsersandAmpersand` | ``42`` | +| `At` | ``32`` | +| `AtAt` | ``33`` | +| `Bar` | ``28`` | +| `BarBar` | ``43`` | +| `CloseBrace` | ``15`` | +| `CloseBracket` | ``19`` | +| `CloseParen` | ``17`` | +| `Colon` | ``30`` | +| `ColonColon` | ``31`` | +| `Comma` | ``23`` | +| `ConflictMarker` | ``10`` | +| `DecKeyword` | ``61`` | +| `DocCodeFenceDelimiter` | ``13`` | +| `DocCodeSpan` | ``12`` | +| `DocText` | ``11`` | +| `Dot` | ``20`` | +| `Ellipsis` | ``21`` | +| `ElseKeyword` | ``59`` | +| `EndOfFile` | ``2`` | +| `EnumKeyword` | ``53`` | +| `Equals` | ``26`` | +| `EqualsEquals` | ``44`` | +| `EqualsGreaterThan` | ``46`` | +| `Exclamation` | ``39`` | +| `ExclamationEquals` | ``45`` | +| `ExtendsKeyword` | ``65`` | +| `ExternKeyword` | ``64`` | +| `FalseKeyword` | ``67`` | +| `FnKeyword` | ``62`` | +| `ForwardSlash` | ``36`` | +| `GreaterThan` | ``25`` | +| `GreaterThanEquals` | ``41`` | +| `Hash` | ``34`` | +| `Hyphen` | ``38`` | +| `Identifier` | ``3`` | +| `IfKeyword` | ``60`` | +| `ImportKeyword` | ``47`` | +| `InterfaceKeyword` | ``56`` | +| `Invalid` | ``1`` | +| `IsKeyword` | ``55`` | +| `LessThan` | ``24`` | +| `LessThanEquals` | ``40`` | +| `ModelKeyword` | ``48`` | +| `MultiLineComment` | ``7`` | +| `NamespaceKeyword` | ``50`` | +| `NeverKeyword` | ``70`` | +| `NewLine` | ``8`` | +| `None` | ``0`` | +| `NumericLiteral` | ``4`` | +| `OpKeyword` | ``52`` | +| `OpenBrace` | ``14`` | +| `OpenBracket` | ``18`` | +| `OpenParen` | ``16`` | +| `Plus` | ``37`` | +| `ProjectionKeyword` | ``58`` | +| `Question` | ``29`` | +| `ReturnKeyword` | ``68`` | +| `ScalarKeyword` | ``49`` | +| `Semicolon` | ``22`` | +| `SingleLineComment` | ``6`` | +| `Star` | ``35`` | +| `StringLiteral` | ``5`` | +| `TrueKeyword` | ``66`` | +| `UnionKeyword` | ``57`` | +| `UnknownKeyword` | ``71`` | +| `UsingKeyword` | ``51`` | +| `ValueOfKeyword` | ``63`` | +| `VoidKeyword` | ``69`` | +| `Whitespace` | ``9`` | +| `__Count` | ``72`` | +| `__EndDocComment` | ``14`` | +| `__EndKeyword` | ``72`` | +| `__EndModifierKeyword` | ``65`` | +| `__EndPunctuation` | ``47`` | +| `__EndStatementKeyword` | ``64`` | +| `__EndTrivia` | ``11`` | +| `__StartDocComment` | ``11`` | +| `__StartKeyword` | ``47`` | +| `__StartModifierKeyword` | ``64`` | +| `__StartPunctuation` | ``14`` | +| `__StartStatementKeyword` | ``47`` | +| `__StartTrivia` | ``6`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.TokenFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.TokenFlags.md new file mode 100644 index 00000000000..52037df6221 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.TokenFlags.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[E] TokenFlags" + +--- +## Enumeration Members + +| Member | Value | +| :------ | :------ | +| `Backticked` | ``32`` | +| `DocComment` | ``16`` | +| `Escaped` | ``1`` | +| `NonAscii` | ``8`` | +| `None` | ``0`` | +| `TripleQuoted` | ``2`` | +| `Unterminated` | ``4`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.UsageFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.UsageFlags.md new file mode 100644 index 00000000000..e29c763762c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.UsageFlags.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[E] UsageFlags" + +--- +## Enumeration Members + +| Member | Value | +| :------ | :------ | +| `Input` | ``2`` | +| `None` | ``0`` | +| `Output` | ``4`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.assertType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.assertType.md new file mode 100644 index 00000000000..c1e989b1281 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.assertType.md @@ -0,0 +1,31 @@ +--- +jsApi: true +title: "[F] assertType" + +--- +```ts +assertType( + typeDescription, + t, + ...kinds): asserts t is Object +``` + +Assert that the input type has one of the kinds provided + +## Type parameters + +| Parameter | +| :------ | +| `TKind` *extends* (`"Model"` \| `"ModelProperty"` \| `"Scalar"` \| `"Interface"` \| `"Enum"` \| `"EnumMember"` \| `"TemplateParameter"` \| `"Namespace"` \| `"Operation"` \| `"String"` \| `"Number"` \| `"Boolean"` \| `"Tuple"` \| `"Union"` \| `"UnionVariant"` \| `"Intrinsic"` \| `"Function"` \| `"Decorator"` \| `"FunctionParameter"` \| `"Object"` \| `"Projection"`)[] | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeDescription` | `string` | +| `t` | [`Type`](Type.Type.md) | +| ...`kinds` | `TKind` | + +## Returns + +`asserts t is Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.cadlTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.cadlTypeToJson.md new file mode 100644 index 00000000000..eb21757230c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.cadlTypeToJson.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[F] cadlTypeToJson" + +--- +```ts +cadlTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `typespecType` | [`TypeSpecValue`](Type.TypeSpecValue.md) | +| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | + +## Returns + +[`T` \| `undefined`, [`Diagnostic`](Interface.Diagnostic.md)[]] + +## Deprecated + +use typespecTypeToJson diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.checkFormatCadl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.checkFormatCadl.md new file mode 100644 index 00000000000..616efef8181 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.checkFormatCadl.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] checkFormatCadl" + +--- +```ts +checkFormatCadl(code, prettierConfig?): Promise< boolean > +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `code` | `string` | +| `prettierConfig`? | `Options` | + +## Returns + +`Promise`< `boolean` \> + +## Deprecated + +use checkFormatTypeSpec diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.checkFormatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.checkFormatTypeSpec.md new file mode 100644 index 00000000000..97e661516b7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.checkFormatTypeSpec.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] checkFormatTypeSpec" + +--- +```ts +checkFormatTypeSpec(code, prettierConfig?): Promise< boolean > +``` + +Check the given is correctly formatted. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `code` | `string` | +| `prettierConfig`? | `Options` | + +## Returns + +`Promise`< `boolean` \> + +true if code is formatted correctly. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compile.md new file mode 100644 index 00000000000..ba90b5c93cf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compile.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] compile" + +--- +```ts +compile( + host, + mainFile, + options = {}, + oldProgram?): Promise< Program > +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `host` | [`CompilerHost`](Interface.CompilerHost.md) | +| `mainFile` | `string` | +| `options` | [`CompilerOptions`](Interface.CompilerOptions.md) | +| `oldProgram`? | [`Program`](Interface.Program.md) | + +## Returns + +`Promise`< [`Program`](Interface.Program.md) \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compilerAssert.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compilerAssert.md new file mode 100644 index 00000000000..6b83a39a919 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compilerAssert.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[F] compilerAssert" + +--- +```ts +compilerAssert( + condition, + message, + target?): asserts condition +``` + +Use this to report bugs in the compiler, and not errors in the source code +being compiled. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `condition` | `any` | Throw if this is not true. | +| `message` | `string` | Error message. | +| `target`? | [`DiagnosticTarget`](Type.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/Function.createCadlLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createCadlLibrary.md new file mode 100644 index 00000000000..5bab3040e75 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createCadlLibrary.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[F] createCadlLibrary" + +--- +```ts +createCadlLibrary(lib): TypeSpecLibrary< T, E > +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` *extends* \{} | +| `E` *extends* `Record`< `string`, `any` \> | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `lib` | `Readonly`< [`TypeSpecLibraryDef`](Interface.TypeSpecLibraryDef.md)< `T`, `E` \> \> | + +## Returns + +[`TypeSpecLibrary`](Interface.TypeSpecLibrary.md)< `T`, `E` \> + +## Deprecated + +use createTypeSpecLibrary diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createChecker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createChecker.md new file mode 100644 index 00000000000..3210bda9698 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createChecker.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] createChecker" + +--- +```ts +createChecker(program): Checker +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | + +## Returns + +[`Checker`](Interface.Checker.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDecoratorDefinition.md new file mode 100644 index 00000000000..8f86e81d53d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDecoratorDefinition.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[F] createDecoratorDefinition" + +--- +```ts +createDecoratorDefinition(definition): DecoratorValidator< T, P, S > +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` *extends* [`TypeKind`](Type.TypeKind.md) | +| `P` *extends* *readonly* [`DecoratorParamDefinition`](Interface.DecoratorParamDefinition.md)< [`TypeKind`](Type.TypeKind.md) \>[] | +| `S` *extends* `undefined` \| [`DecoratorParamDefinition`](Interface.DecoratorParamDefinition.md)< [`TypeKind`](Type.TypeKind.md) \> | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `definition` | [`DecoratorDefinition`](Interface.DecoratorDefinition.md)< `T`, `P`, `S` \> | + +## Returns + +[`DecoratorValidator`](Interface.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/Function.createDiagnosticCollector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDiagnosticCollector.md new file mode 100644 index 00000000000..c933f17748e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDiagnosticCollector.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] createDiagnosticCollector" + +--- +```ts +createDiagnosticCollector(): DiagnosticCollector +``` + +Create a new instance of the + +## Returns + +[`DiagnosticCollector`](Interface.DiagnosticCollector.md) + +## See + +DiagnosticCollector. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDiagnosticCreator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDiagnosticCreator.md new file mode 100644 index 00000000000..965c011b8f9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDiagnosticCreator.md @@ -0,0 +1,31 @@ +--- +jsApi: true +title: "[F] createDiagnosticCreator" + +--- +```ts +createDiagnosticCreator(diagnostics, libraryName?): DiagnosticCreator< T > +``` + +Create a new diagnostics creator. + +## Type parameters + +| Parameter | +| :------ | +| `T` *extends* \{} | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `diagnostics` | [`DiagnosticMap`](Type.DiagnosticMap.md)< `T` \> | Map of the potential diagnostics. | +| `libraryName`? | `string` | Optional name of the library if in the scope of a library. | + +## Returns + +[`DiagnosticCreator`](Interface.DiagnosticCreator.md)< `T` \> + +## See + +DiagnosticCreator diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createProjectedNameProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createProjectedNameProgram.md new file mode 100644 index 00000000000..7f46e7288ce --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createProjectedNameProgram.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] createProjectedNameProgram" + +--- +```ts +createProjectedNameProgram(program, target): ProjectedNameView +``` + +Create an helper to manager project names. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `target` | `string` | Name of the projected name target(e.g. json, csharp, etc.) | + +## Returns + +[`ProjectedNameView`](Interface.ProjectedNameView.md) + +ProjectedNameView diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRekeyableMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRekeyableMap.md new file mode 100644 index 00000000000..c88363e637e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRekeyableMap.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] createRekeyableMap" + +--- +```ts +createRekeyableMap(entries?): RekeyableMap< K, V > +``` + +## Type parameters + +| Parameter | +| :------ | +| `K` | +| `V` | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `entries`? | [`K`, `V`][] | + +## Returns + +`RekeyableMap`< `K`, `V` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRule.md new file mode 100644 index 00000000000..fb2f0beaf59 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRule.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] createRule" + +--- +```ts +createRule(definition): LinterRuleDefinition< N, T > +``` + +Create a new linter rule. + +## Type parameters + +| Parameter | +| :------ | +| `N` *extends* `string` | +| `T` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `definition` | [`LinterRuleDefinition`](Interface.LinterRuleDefinition.md)< `N`, `T` \> | + +## Returns + +[`LinterRuleDefinition`](Interface.LinterRuleDefinition.md)< `N`, `T` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createScanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createScanner.md new file mode 100644 index 00000000000..2a3ed5b3e0c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createScanner.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] createScanner" + +--- +```ts +createScanner(source, diagnosticHandler): Scanner +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `source` | `string` \| [`SourceFile`](Interface.SourceFile.md) | +| `diagnosticHandler` | [`DiagnosticHandler`](Type.DiagnosticHandler.md) | + +## Returns + +[`Scanner`](Interface.Scanner.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createServer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createServer.md new file mode 100644 index 00000000000..cd4d7ac87b5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createServer.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] createServer" + +--- +```ts +createServer(host): Server +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `host` | [`ServerHost`](Interface.ServerHost.md) | + +## Returns + +[`Server`](Interface.Server.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createSourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createSourceFile.md new file mode 100644 index 00000000000..3ba5c62dc7f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createSourceFile.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] createSourceFile" + +--- +```ts +createSourceFile(text, path): SourceFile +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `text` | `string` | +| `path` | `string` | + +## Returns + +[`SourceFile`](Interface.SourceFile.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createStateAccessors.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createStateAccessors.md new file mode 100644 index 00000000000..fcb4e64b5d5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createStateAccessors.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[F] createStateAccessors" + +--- +```ts +createStateAccessors( + stateMaps, + stateSets, + projector?): object +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `stateMaps` | `Map`< `symbol`, `StateMap` \> | +| `stateSets` | `Map`< `symbol`, `StateSet` \> | +| `projector`? | [`Projector`](Interface.Projector.md) | + +## Returns + +| Member | Type | +| :------ | :------ | +| `stateMap` | <`T`>(`key`) => `StateMapView`< `T` \> | +| `stateSet` | (`key`) => `StateSetView` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createTypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createTypeSpecLibrary.md new file mode 100644 index 00000000000..fcf9f3855f5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createTypeSpecLibrary.md @@ -0,0 +1,46 @@ +--- +jsApi: true +title: "[F] createTypeSpecLibrary" + +--- +```ts +createTypeSpecLibrary(lib): TypeSpecLibrary< T, E > +``` + +Create a new TypeSpec library definition. + +## Type parameters + +| Parameter | +| :------ | +| `T` *extends* \{} | +| `E` *extends* `Record`< `string`, `any` \> | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `lib` | `Readonly`< [`TypeSpecLibraryDef`](Interface.TypeSpecLibraryDef.md)< `T`, `E` \> \> | Library definition. | + +## Returns + +[`TypeSpecLibrary`](Interface.TypeSpecLibrary.md)< `T`, `E` \> + +Library with utility functions. + +## Tutorial + +Create the lib object with `as const` to get the full typing. + +## Example + +```ts +const libDef = { + name: "myLib", + diagnostics: { + "my-code": {serverity: "error", messages: {default: "Foo bar"}} + }, +} as const; + +const lib = createTypeSpecLibrary(libDef); +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.emitFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.emitFile.md new file mode 100644 index 00000000000..379e9ca824f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.emitFile.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] emitFile" + +--- +```ts +emitFile(program, options): Promise< void > +``` + +Helper to emit a file. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | TypeSpec Program | +| `options` | [`EmitFileOptions`](Interface.EmitFileOptions.md) | File Emitter options | + +## Returns + +`Promise`< `void` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ensurePathIsNonModuleName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ensurePathIsNonModuleName.md new file mode 100644 index 00000000000..6ea91a4cc32 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ensurePathIsNonModuleName.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] ensurePathIsNonModuleName" + +--- +```ts +ensurePathIsNonModuleName(path): string +``` + +Ensures a path is either absolute (prefixed with `/` or `c:`) or dot-relative (prefixed +with `./` or `../`) so as not to be confused with an unprefixed module name. + +```ts +ensurePathIsNonModuleName("/path/to/file.ext") === "/path/to/file.ext" +ensurePathIsNonModuleName("./path/to/file.ext") === "./path/to/file.ext" +ensurePathIsNonModuleName("../path/to/file.ext") === "../path/to/file.ext" +ensurePathIsNonModuleName("path/to/file.ext") === "./path/to/file.ext" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ensureTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ensureTrailingDirectorySeparator.md new file mode 100644 index 00000000000..12e9afcd7cd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ensureTrailingDirectorySeparator.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] ensureTrailingDirectorySeparator" + +--- +```ts +ensureTrailingDirectorySeparator(path): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.filterModelProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.filterModelProperties.md new file mode 100644 index 00000000000..e481d5c69e4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.filterModelProperties.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] filterModelProperties" + +--- +```ts +filterModelProperties( + program, + model, + filter): Model +``` + +Applies a filter to the properties of a given type. If no properties +are filtered out, then return the input unchanged. Otherwise, return +a new anonymous model with only the filtered properties. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) \| [`ProjectedProgram`](Interface.ProjectedProgram.md) | - | +| `model` | [`Model`](Interface.Model.md) | The input model to filter. | +| `filter` | (`property`) => `boolean` | The filter to apply. Properties are kept when this returns true. | + +## Returns + +[`Model`](Interface.Model.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.finishTypeForProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.finishTypeForProgram.md new file mode 100644 index 00000000000..a0986d9f25b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.finishTypeForProgram.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] finishTypeForProgram" + +--- +```ts +finishTypeForProgram(program, typeDef): T +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` *extends* [`Type`](Type.Type.md) | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `typeDef` | `T` | + +## Returns + +`T` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatDiagnostic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatDiagnostic.md new file mode 100644 index 00000000000..cf8eb54094f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatDiagnostic.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] formatDiagnostic" + +--- +```ts +formatDiagnostic(diagnostic): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostic` | [`Diagnostic`](Interface.Diagnostic.md) | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatIdentifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatIdentifier.md new file mode 100644 index 00000000000..484f24d9bef --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatIdentifier.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] formatIdentifier" + +--- +```ts +formatIdentifier(sv): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `sv` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatTypeSpec.md new file mode 100644 index 00000000000..4448ae18d61 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatTypeSpec.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] formatTypeSpec" + +--- +```ts +formatTypeSpec(code, prettierConfig?): Promise< string > +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `code` | `string` | +| `prettierConfig`? | `Options` | + +## Returns + +`Promise`< `string` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getAnyExtensionFromPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getAnyExtensionFromPath.md new file mode 100644 index 00000000000..47d49049a08 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getAnyExtensionFromPath.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] getAnyExtensionFromPath" + +--- +```ts +getAnyExtensionFromPath(path): string +``` + +Gets the file extension for a path. +Normalizes it to lower case. + +```ts +getAnyExtensionFromPath("/path/to/file.ext") === ".ext" +getAnyExtensionFromPath("/path/to/file.ext/") === ".ext" +getAnyExtensionFromPath("/path/to/file") === "" +getAnyExtensionFromPath("/path/to.ext/file") === "" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getBaseFileName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getBaseFileName.md new file mode 100644 index 00000000000..aa73d5729ec --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getBaseFileName.md @@ -0,0 +1,46 @@ +--- +jsApi: true +title: "[F] getBaseFileName" + +--- +```ts +getBaseFileName(path): string +``` + +Returns the path except for its containing directory name. +Semantics align with NodeJS's `path.basename` except that we support URL's as well. + +```ts +// POSIX +getBaseFileName("/path/to/file.ext") === "file.ext" +getBaseFileName("/path/to/") === "to" +getBaseFileName("/") === "" +// DOS +getBaseFileName("c:/path/to/file.ext") === "file.ext" +getBaseFileName("c:/path/to/") === "to" +getBaseFileName("c:/") === "" +getBaseFileName("c:") === "" +// URL +getBaseFileName("http://typescriptlang.org/path/to/file.ext") === "file.ext" +getBaseFileName("http://typescriptlang.org/path/to/") === "to" +getBaseFileName("http://typescriptlang.org/") === "" +getBaseFileName("http://typescriptlang.org") === "" +getBaseFileName("file://server/path/to/file.ext") === "file.ext" +getBaseFileName("file://server/path/to/") === "to" +getBaseFileName("file://server/") === "" +getBaseFileName("file://server") === "" +getBaseFileName("file:///path/to/file.ext") === "file.ext" +getBaseFileName("file:///path/to/") === "to" +getBaseFileName("file:///") === "" +getBaseFileName("file://") === "" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getCompletionNodeAtPosition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getCompletionNodeAtPosition.md new file mode 100644 index 00000000000..364014c888e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getCompletionNodeAtPosition.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[F] getCompletionNodeAtPosition" + +--- +```ts +getCompletionNodeAtPosition( + script, + position, + filter = ...): Node | undefined +``` + +Resolve the node that should be auto completed at the given position. +It will try to guess what node it could be as during auto complete the ast might not be complete. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `script` | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | +| `position` | `number` | +| `filter` | (`node`) => `boolean` | + +## Returns + +[`Node`](Type.Node.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDeprecationDetails.md new file mode 100644 index 00000000000..a9a9efbcc04 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDeprecationDetails.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getDeprecationDetails" + +--- +```ts +getDeprecationDetails(program, typeOrNode): DeprecationDetails | undefined +``` + +Returns complete deprecation details for the given type or node + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `typeOrNode` | [`Node`](Type.Node.md) \| [`Type`](Type.Type.md) | A Type or Node to check for deprecation | + +## Returns + +[`DeprecationDetails`](Interface.DeprecationDetails.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDirectoryPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDirectoryPath.md new file mode 100644 index 00000000000..07d5e1a5a98 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDirectoryPath.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] getDirectoryPath" + +--- +```ts +getDirectoryPath(path): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDiscriminatedUnion.md new file mode 100644 index 00000000000..7c4731a11bb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDiscriminatedUnion.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getDiscriminatedUnion" + +--- +```ts +getDiscriminatedUnion(type, discriminator): [DiscriminatedUnion, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Model`](Interface.Model.md) \| [`Union`](Interface.Union.md) | +| `discriminator` | [`Discriminator`](Namespace.decorators.Interface.Discriminator.md) | + +## Returns + +[[`DiscriminatedUnion`](Interface.DiscriminatedUnion.md), *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getEffectiveModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getEffectiveModelType.md new file mode 100644 index 00000000000..cf27613ea00 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getEffectiveModelType.md @@ -0,0 +1,34 @@ +--- +jsApi: true +title: "[F] getEffectiveModelType" + +--- +```ts +getEffectiveModelType( + program, + model, + filter?): Model +``` + +If the input is anonymous (or the provided filter removes properties) +and there exists a named model with the same set of properties +(ignoring filtered properties), then return that named model. +Otherwise, return the input unchanged. + +This can be used by emitters to find a better name for a set of +properties after filtering. For example, given `{ @metadata prop: +string} & SomeName`, and an emitter that wishes to discard properties +marked with `@metadata`, the emitter can use this to recover that the +best name for the remaining properties is `SomeName`. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | - | +| `model` | [`Model`](Interface.Model.md) | The input model | +| `filter`? | (`property`) => `boolean` | An optional filter to apply to the input model's
properties. | + +## Returns + +[`Model`](Interface.Model.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getFirstAncestor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getFirstAncestor.md new file mode 100644 index 00000000000..67477122951 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getFirstAncestor.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getFirstAncestor" + +--- +```ts +getFirstAncestor(node, test): Node | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`Node`](Type.Node.md) | +| `test` | [`NodeCallback`](Type.NodeCallback.md)< `boolean` \> | + +## Returns + +[`Node`](Type.Node.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getFullyQualifiedSymbolName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getFullyQualifiedSymbolName.md new file mode 100644 index 00000000000..c909a6b6a79 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getFullyQualifiedSymbolName.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] getFullyQualifiedSymbolName" + +--- +```ts +getFullyQualifiedSymbolName(sym, options?): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `sym` | `undefined` \| [`Sym`](Interface.Sym.md) | +| `options`? | `object` | +| `options.useGlobalPrefixAtTopLevel`? | `boolean` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getIdentifierContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getIdentifierContext.md new file mode 100644 index 00000000000..98912a8d24c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getIdentifierContext.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] getIdentifierContext" + +--- +```ts +getIdentifierContext(id): IdentifierContext +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | + +## Returns + +[`IdentifierContext`](Interface.IdentifierContext.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getLocationContext.md new file mode 100644 index 00000000000..0a11bb34882 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getLocationContext.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getLocationContext" + +--- +```ts +getLocationContext(program, type): LocationContext +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `type` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | + +## Returns + +[`LocationContext`](Type.LocationContext.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNamespaceFullName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNamespaceFullName.md new file mode 100644 index 00000000000..59a3232f20b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNamespaceFullName.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getNamespaceFullName" + +--- +```ts +getNamespaceFullName(type, options?): string +``` + +Return the full name of the namespace(e.g. "Foo.Bar") + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `type` | [`Namespace`](Interface.Namespace.md) | namespace type | +| `options`? | [`TypeNameOptions`](Interface.TypeNameOptions.md) | | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNodeAtPosition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNodeAtPosition.md new file mode 100644 index 00000000000..ad9349f97c1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNodeAtPosition.md @@ -0,0 +1,50 @@ +--- +jsApi: true +title: "[F] getNodeAtPosition" + +--- +```ts +getNodeAtPosition( + script, + position, + filter?): Node | undefined +``` + +Resolve the node in the syntax tree that that is at the given position. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `script` | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | TypeSpec Script node | +| `position` | `number` | Position | +| `filter`? | (`node`) => `boolean` | Filter if wanting to return a parent containing node early. | + +## Returns + +[`Node`](Type.Node.md) \| `undefined` + +```ts +getNodeAtPosition( + script, + position, + filter): T | undefined +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` *extends* [`Node`](Type.Node.md) | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `script` | [`TypeSpecScriptNode`](Interface.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/Function.getNormalizedAbsolutePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedAbsolutePath.md new file mode 100644 index 00000000000..d3bc953a888 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedAbsolutePath.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getNormalizedAbsolutePath" + +--- +```ts +getNormalizedAbsolutePath(fileName, currentDirectory): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `fileName` | `string` | +| `currentDirectory` | `undefined` \| `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedAbsolutePathWithoutRoot.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedAbsolutePathWithoutRoot.md new file mode 100644 index 00000000000..7c149fe73e1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedAbsolutePathWithoutRoot.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getNormalizedAbsolutePathWithoutRoot" + +--- +```ts +getNormalizedAbsolutePathWithoutRoot(fileName, currentDirectory): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `fileName` | `string` | +| `currentDirectory` | `undefined` \| `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedPathComponents.md new file mode 100644 index 00000000000..24d43d93f9d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedPathComponents.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] getNormalizedPathComponents" + +--- +```ts +getNormalizedPathComponents(path, currentDirectory): string[] +``` + +Parse a path into an array containing a root component (at index 0) and zero or more path +components (at indices > 0). The result is normalized. +If the path is relative, the root component is `""`. +If the path is absolute, the root component includes the first path separator (`/`). + +```ts +getNormalizedPathComponents("to/dir/../file.ext", "/path/") === ["/", "path", "to", "file.ext"] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | +| `currentDirectory` | `undefined` \| `string` | + +## Returns + +`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getOverriddenProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getOverriddenProperty.md new file mode 100644 index 00000000000..7a59d556981 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getOverriddenProperty.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getOverriddenProperty" + +--- +```ts +getOverriddenProperty(property): ModelProperty | undefined +``` + +Gets the property from the nearest base type that is overridden by the +given property, if any. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `property` | [`ModelProperty`](Interface.ModelProperty.md) | + +## Returns + +[`ModelProperty`](Interface.ModelProperty.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getParentTemplateNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getParentTemplateNode.md new file mode 100644 index 00000000000..38206d1e438 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getParentTemplateNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[F] getParentTemplateNode" + +--- +```ts +getParentTemplateNode(node): Node & TemplateDeclarationNode | undefined +``` + +Lookup and find the node + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `node` | [`Node`](Type.Node.md) | Node | + +## Returns + +[`Node`](Type.Node.md) & [`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) \| `undefined` + +Template Parent node if applicable diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getPathComponents.md new file mode 100644 index 00000000000..8a47e958d3a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getPathComponents.md @@ -0,0 +1,49 @@ +--- +jsApi: true +title: "[F] getPathComponents" + +--- +```ts +getPathComponents(path, currentDirectory = ""): string[] +``` + +Parse a path into an array containing a root component (at index 0) and zero or more path +components (at indices > 0). The result is not normalized. +If the path is relative, the root component is `""`. +If the path is absolute, the root component includes the first path separator (`/`). + +```ts +// POSIX +getPathComponents("/path/to/file.ext") === ["/", "path", "to", "file.ext"] +getPathComponents("/path/to/") === ["/", "path", "to"] +getPathComponents("/") === ["/"] +// DOS +getPathComponents("c:/path/to/file.ext") === ["c:/", "path", "to", "file.ext"] +getPathComponents("c:/path/to/") === ["c:/", "path", "to"] +getPathComponents("c:/") === ["c:/"] +getPathComponents("c:") === ["c:"] +// URL +getPathComponents("http://typescriptlang.org/path/to/file.ext") === ["http://typescriptlang.org/", "path", "to", "file.ext"] +getPathComponents("http://typescriptlang.org/path/to/") === ["http://typescriptlang.org/", "path", "to"] +getPathComponents("http://typescriptlang.org/") === ["http://typescriptlang.org/"] +getPathComponents("http://typescriptlang.org") === ["http://typescriptlang.org"] +getPathComponents("file://server/path/to/file.ext") === ["file://server/", "path", "to", "file.ext"] +getPathComponents("file://server/path/to/") === ["file://server/", "path", "to"] +getPathComponents("file://server/") === ["file://server/"] +getPathComponents("file://server") === ["file://server"] +getPathComponents("file:///path/to/file.ext") === ["file:///", "path", "to", "file.ext"] +getPathComponents("file:///path/to/") === ["file:///", "path", "to"] +getPathComponents("file:///") === ["file:///"] +getPathComponents("file://") === ["file://"] +``` + +## Parameters + +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `path` | `string` | `undefined` | +| `currentDirectory` | `string` | `""` | + +## Returns + +`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getPathFromPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getPathFromPathComponents.md new file mode 100644 index 00000000000..a4deec30ede --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getPathFromPathComponents.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] getPathFromPathComponents" + +--- +```ts +getPathFromPathComponents(pathComponents): string +``` + +Formats a parsed path consisting of a root component (at index 0) and zero or more path +segments (at indices > 0). + +```ts +getPathFromPathComponents(["/", "path", "to", "file.ext"]) === "/path/to/file.ext" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `pathComponents` | *readonly* `string`[] | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getProperty.md new file mode 100644 index 00000000000..cbfd42c2fb1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getProperty.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getProperty" + +--- +```ts +getProperty(type, propertyName): ModelProperty | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Model`](Interface.Model.md) | +| `propertyName` | `string` | + +## Returns + +[`ModelProperty`](Interface.ModelProperty.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getRelativePathFromDirectory.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getRelativePathFromDirectory.md new file mode 100644 index 00000000000..94249fba31c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getRelativePathFromDirectory.md @@ -0,0 +1,46 @@ +--- +jsApi: true +title: "[F] getRelativePathFromDirectory" + +--- +```ts +getRelativePathFromDirectory( + from, + to, + ignoreCase): string +``` + +Gets a relative path that can be used to traverse between `from` and `to`. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `from` | `string` | +| `to` | `string` | +| `ignoreCase` | `boolean` | + +## Returns + +`string` + +```ts +getRelativePathFromDirectory( + fromDirectory, + to, + getCanonicalFileName): string +``` + +Gets a relative path that can be used to traverse between `from` and `to`. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `fromDirectory` | `string` | +| `to` | `string` | +| `getCanonicalFileName` | `GetCanonicalFileName` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getRootLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getRootLength.md new file mode 100644 index 00000000000..de62b4b5abb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getRootLength.md @@ -0,0 +1,42 @@ +--- +jsApi: true +title: "[F] getRootLength" + +--- +```ts +getRootLength(path): number +``` + +Returns length of the root part of a path or URL (i.e. length of "/", "x:/", "//server/share/, file:///user/files"). + +For example: +```ts +getRootLength("a") === 0 // "" +getRootLength("/") === 1 // "/" +getRootLength("c:") === 2 // "c:" +getRootLength("c:d") === 0 // "" +getRootLength("c:/") === 3 // "c:/" +getRootLength("c:\\") === 3 // "c:\\" +getRootLength("//server") === 7 // "//server" +getRootLength("//server/share") === 8 // "//server/" +getRootLength("\\\\server") === 7 // "\\\\server" +getRootLength("\\\\server\\share") === 8 // "\\\\server\\" +getRootLength("file:///path") === 8 // "file:///" +getRootLength("file:///c:") === 10 // "file:///c:" +getRootLength("file:///c:d") === 8 // "file:///" +getRootLength("file:///c:/path") === 11 // "file:///c:/" +getRootLength("file://server") === 13 // "file://server" +getRootLength("file://server/path") === 14 // "file://server/" +getRootLength("http://server") === 13 // "http://server" +getRootLength("http://server/path") === 14 // "http://server/" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceFileKindFromExt.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceFileKindFromExt.md new file mode 100644 index 00000000000..9a0a0edeef2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceFileKindFromExt.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] getSourceFileKindFromExt" + +--- +```ts +getSourceFileKindFromExt(path): SourceFileKind | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +[`SourceFileKind`](Type.SourceFileKind.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceLocation.md new file mode 100644 index 00000000000..66191254582 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceLocation.md @@ -0,0 +1,49 @@ +--- +jsApi: true +title: "[F] getSourceLocation" + +--- +```ts +getSourceLocation(target, options?): SourceLocation +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | +| `options`? | [`SourceLocationOptions`](Interface.SourceLocationOptions.md) | + +## Returns + +[`SourceLocation`](Interface.SourceLocation.md) + +```ts +getSourceLocation(target, options?): undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | `undefined` \| *typeof* [`NoTarget`](Variable.NoTarget.md) | +| `options`? | [`SourceLocationOptions`](Interface.SourceLocationOptions.md) | + +## Returns + +`undefined` + +```ts +getSourceLocation(target, options?): SourceLocation | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | `undefined` \| [`DiagnosticTarget`](Type.DiagnosticTarget.md) \| *typeof* [`NoTarget`](Variable.NoTarget.md) | +| `options`? | [`SourceLocationOptions`](Interface.SourceLocationOptions.md) | + +## Returns + +[`SourceLocation`](Interface.SourceLocation.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getTypeName.md new file mode 100644 index 00000000000..63b57826624 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getTypeName.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getTypeName" + +--- +```ts +getTypeName(type, options?): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](Type.Type.md) \| [`ValueType`](Interface.ValueType.md) | +| `options`? | [`TypeNameOptions`](Interface.TypeNameOptions.md) | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.hasParseError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.hasParseError.md new file mode 100644 index 00000000000..84b05293e36 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.hasParseError.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] hasParseError" + +--- +```ts +hasParseError(node): number | true +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`Node`](Type.Node.md) | + +## Returns + +`number` \| `true` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.hasTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.hasTrailingDirectorySeparator.md new file mode 100644 index 00000000000..58c9568e47b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.hasTrailingDirectorySeparator.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] hasTrailingDirectorySeparator" + +--- +```ts +hasTrailingDirectorySeparator(path): boolean +``` + +Determines whether a path has a trailing separator (`/` or `\\`). + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ignoreDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ignoreDiagnostics.md new file mode 100644 index 00000000000..ab8e47c7f5f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ignoreDiagnostics.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] ignoreDiagnostics" + +--- +```ts +ignoreDiagnostics(result): T +``` + +Ignore the diagnostics emitted by the diagnostic accessor pattern and just return the actual result. + +## Type parameters + +| Parameter | +| :------ | +| `T` | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `result` | [`DiagnosticResult`](Type.DiagnosticResult.md)< `T` \> | + +## Returns + +`T` + +Actual result. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.interpolatePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.interpolatePath.md new file mode 100644 index 00000000000..dd81676052f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.interpolatePath.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] interpolatePath" + +--- +```ts +interpolatePath(pathTemplate, predefinedVariables): string +``` + +Interpolate a path template + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `pathTemplate` | `string` | 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/Function.isAnyDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isAnyDirectorySeparator.md new file mode 100644 index 00000000000..abee4537ebb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isAnyDirectorySeparator.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] isAnyDirectorySeparator" + +--- +```ts +isAnyDirectorySeparator(charCode): boolean +``` + +Determines whether a charCode corresponds to `/` or ``. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `charCode` | `number` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isCadlValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isCadlValueTypeOf.md new file mode 100644 index 00000000000..1db32bb1167 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isCadlValueTypeOf.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[F] isCadlValueTypeOf" + +--- +```ts +isCadlValueTypeOf(target, expectedType): target is InferredTypeSpecValue +``` + +## Type parameters + +| Parameter | +| :------ | +| `K` *extends* [`TypeKind`](Type.TypeKind.md) | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | [`TypeSpecValue`](Type.TypeSpecValue.md) | +| `expectedType` | `K` \| *readonly* `K`[] | + +## Returns + +`target is InferredTypeSpecValue` + +## Deprecated + +use isTypeSpecValueTypeOf diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isComment.md new file mode 100644 index 00000000000..ab7cb04c4da --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isComment.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isComment" + +--- +```ts +isComment(token): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `token` | [`Token`](Enumeration.Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeclaredInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeclaredInNamespace.md new file mode 100644 index 00000000000..fded18d7be9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeclaredInNamespace.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[F] isDeclaredInNamespace" + +--- +```ts +isDeclaredInNamespace( + type, + namespace, + options = ...): boolean +``` + +Check if the given type is declared in the specified namespace or, optionally, its child namespaces. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `type` | [`Model`](Interface.Model.md) \| [`Interface`](Interface.Interface.md) \| [`Enum`](Interface.Enum.md) \| [`Namespace`](Interface.Namespace.md) \| [`Operation`](Interface.Operation.md) | Type | +| `namespace` | [`Namespace`](Interface.Namespace.md) | Namespace | +| `options` | `object` | - | +| `options.recursive`? | `boolean` | - | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeclaredType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeclaredType.md new file mode 100644 index 00000000000..611446b4d00 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeclaredType.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[F] isDeclaredType" + +--- +```ts +isDeclaredType(type): boolean +``` + +Check if the type is a declared type. This include: +- non templated type +- template declaration + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](Type.Type.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeprecated.md new file mode 100644 index 00000000000..8d5e4a38e58 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeprecated.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] isDeprecated" + +--- +```ts +isDeprecated(program, type): boolean +``` + +Check if the given type is deprecated + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `type` | [`Type`](Type.Type.md) | Type | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isErrorType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isErrorType.md new file mode 100644 index 00000000000..22727a9ca77 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isErrorType.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isErrorType" + +--- +```ts +isErrorType(type): type is ErrorType +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](Type.Type.md) | + +## Returns + +`type is ErrorType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isGlobalNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isGlobalNamespace.md new file mode 100644 index 00000000000..996e5bb6b74 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isGlobalNamespace.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] isGlobalNamespace" + +--- +```ts +isGlobalNamespace(program, namespace): namespace is Namespace & Object +``` + +Check if the given namespace is the global namespace + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `namespace` | [`Namespace`](Interface.Namespace.md) | Namespace | + +## Returns + +`namespace is Namespace & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isImportStatement.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isImportStatement.md new file mode 100644 index 00000000000..1319d23d0b5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isImportStatement.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isImportStatement" + +--- +```ts +isImportStatement(node): node is ImportStatementNode +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`Node`](Type.Node.md) | + +## Returns + +`node is ImportStatementNode` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isIntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isIntrinsicType.md new file mode 100644 index 00000000000..d4173bc2544 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isIntrinsicType.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] isIntrinsicType" + +--- +```ts +isIntrinsicType( + program, + type, + kind): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `type` | [`Scalar`](Interface.Scalar.md) | +| `kind` | [`IntrinsicScalarName`](Type.IntrinsicScalarName.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isKeyword.md new file mode 100644 index 00000000000..3094bd22345 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isKeyword.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isKeyword" + +--- +```ts +isKeyword(token): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `token` | [`Token`](Enumeration.Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isModifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isModifier.md new file mode 100644 index 00000000000..f9f9ec8b16d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isModifier.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isModifier" + +--- +```ts +isModifier(token): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `token` | [`Token`](Enumeration.Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isNeverType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isNeverType.md new file mode 100644 index 00000000000..3756b179805 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isNeverType.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isNeverType" + +--- +```ts +isNeverType(type): type is NeverType +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](Type.Type.md) | + +## Returns + +`type is NeverType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isNullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isNullType.md new file mode 100644 index 00000000000..1d3a246a34d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isNullType.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isNullType" + +--- +```ts +isNullType(type): type is NullType +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](Type.Type.md) | + +## Returns + +`type is NullType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isPathAbsolute.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isPathAbsolute.md new file mode 100644 index 00000000000..21e4b9b286f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isPathAbsolute.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isPathAbsolute" + +--- +```ts +isPathAbsolute(path): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isProjectedProgram.md new file mode 100644 index 00000000000..647ffda5422 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isProjectedProgram.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isProjectedProgram" + +--- +```ts +isProjectedProgram(program): program is ProjectedProgram +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) \| [`ProjectedProgram`](Interface.ProjectedProgram.md) | + +## Returns + +`program is ProjectedProgram` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isPunctuation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isPunctuation.md new file mode 100644 index 00000000000..b50014e830d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isPunctuation.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isPunctuation" + +--- +```ts +isPunctuation(token): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `token` | [`Token`](Enumeration.Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isStatementKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isStatementKeyword.md new file mode 100644 index 00000000000..83027ef030d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isStatementKeyword.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isStatementKeyword" + +--- +```ts +isStatementKeyword(token): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `token` | [`Token`](Enumeration.Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isStdNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isStdNamespace.md new file mode 100644 index 00000000000..a5b6c35885f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isStdNamespace.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isStdNamespace" + +--- +```ts +isStdNamespace(namespace): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `namespace` | [`Namespace`](Interface.Namespace.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateDeclaration.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateDeclaration.md new file mode 100644 index 00000000000..a67ca5cd171 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateDeclaration.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] isTemplateDeclaration" + +--- +```ts +isTemplateDeclaration(type): type is Object +``` + +Resolve if the type is a template type declaration(Non initialized template type). + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`TemplatedType`](Type.TemplatedType.md) | + +## Returns + +`type is Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateDeclarationOrInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateDeclarationOrInstance.md new file mode 100644 index 00000000000..b7626dd0c94 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateDeclarationOrInstance.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] isTemplateDeclarationOrInstance" + +--- +```ts +isTemplateDeclarationOrInstance(type): boolean +``` + +Resolve if the type was created from a template type or is a template type declaration. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`TemplatedType`](Type.TemplatedType.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateInstance.md new file mode 100644 index 00000000000..ab321766430 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateInstance.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] isTemplateInstance" + +--- +```ts +isTemplateInstance(type): type is Object +``` + +Check the given type is a finished template instance. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](Type.Type.md) | + +## Returns + +`type is Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTrivia.md new file mode 100644 index 00000000000..24d2cbed7f5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTrivia.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isTrivia" + +--- +```ts +isTrivia(token): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `token` | [`Token`](Enumeration.Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTypeSpecValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTypeSpecValueTypeOf.md new file mode 100644 index 00000000000..84d5d6b6528 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTypeSpecValueTypeOf.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[F] isTypeSpecValueTypeOf" + +--- +```ts +isTypeSpecValueTypeOf(target, expectedType): target is InferredTypeSpecValue +``` + +Check if the given target is of any of the typespec types. + +## Type parameters + +| Parameter | +| :------ | +| `K` *extends* [`TypeKind`](Type.TypeKind.md) | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `target` | [`TypeSpecValue`](Type.TypeSpecValue.md) | Target to validate. | +| `expectedType` | `K` \| *readonly* `K`[] | One or multiple allowed 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/Function.isUnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isUnknownType.md new file mode 100644 index 00000000000..ca5bfc65d2e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isUnknownType.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isUnknownType" + +--- +```ts +isUnknownType(type): type is UnknownType +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](Type.Type.md) | + +## Returns + +`type is UnknownType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isUrl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isUrl.md new file mode 100644 index 00000000000..fac8b27849d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isUrl.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] isUrl" + +--- +```ts +isUrl(path): boolean +``` + +Determines whether a path starts with a URL scheme (e.g. starts with `http://`, `ftp://`, `file://`, etc.). + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isVoidType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isVoidType.md new file mode 100644 index 00000000000..5eeead89494 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isVoidType.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isVoidType" + +--- +```ts +isVoidType(type): type is VoidType +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](Type.Type.md) | + +## Returns + +`type is VoidType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.joinPaths.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.joinPaths.md new file mode 100644 index 00000000000..e78d9eea750 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.joinPaths.md @@ -0,0 +1,36 @@ +--- +jsApi: true +title: "[F] joinPaths" + +--- +```ts +joinPaths(path, ...paths): string +``` + +Combines paths. If a path is absolute, it replaces any previous path. Relative paths are not simplified. + +```ts +// Non-rooted +joinPaths("path", "to", "file.ext") === "path/to/file.ext" +joinPaths("path", "dir", "..", "to", "file.ext") === "path/dir/../to/file.ext" +// POSIX +joinPaths("/path", "to", "file.ext") === "/path/to/file.ext" +joinPaths("/path", "/to", "file.ext") === "/to/file.ext" +// DOS +joinPaths("c:/path", "to", "file.ext") === "c:/path/to/file.ext" +joinPaths("c:/path", "c:/to", "file.ext") === "c:/to/file.ext" +// URL +joinPaths("file:///path", "to", "file.ext") === "file:///path/to/file.ext" +joinPaths("file:///path", "file:///to", "file.ext") === "file:///to/file.ext" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | +| ...`paths` | (`undefined` \| `string`)[] | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.listOperationsIn.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.listOperationsIn.md new file mode 100644 index 00000000000..bde92a9d279 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.listOperationsIn.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] listOperationsIn" + +--- +```ts +listOperationsIn(container, options = {}): Operation[] +``` + +List operations in the given container. Will list operation recursively by default(Check subnamespaces.) + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `container` | [`Interface`](Interface.Interface.md) \| [`Namespace`](Interface.Namespace.md) | Container. | +| `options` | [`ListOperationOptions`](Interface.ListOperationOptions.md) | Options. | + +## Returns + +[`Operation`](Interface.Operation.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.logDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.logDiagnostics.md new file mode 100644 index 00000000000..5dbd22a6458 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.logDiagnostics.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] logDiagnostics" + +--- +```ts +logDiagnostics(diagnostics, logger): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | +| `logger` | [`LogSink`](Interface.LogSink.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.logVerboseTestOutput.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.logVerboseTestOutput.md new file mode 100644 index 00000000000..cd6d715306a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.logVerboseTestOutput.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[F] logVerboseTestOutput" + +--- +```ts +logVerboseTestOutput(messageOrCallback): void +``` + +Verbose output is enabled by default for runs in mocha explorer in VS Code, +where the output is nicely associated with the individual test, and disabled +by default for command line runs where we don't want to spam the console. + +If the steps taken to produce the message are expensive, pass a callback +instead of producing the message then passing it here only to be dropped +when verbose output is disabled. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `messageOrCallback` | `string` \| (`log`) => `void` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.mapEventEmitterToNodeListener.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.mapEventEmitterToNodeListener.md new file mode 100644 index 00000000000..bd244a405c0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.mapEventEmitterToNodeListener.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[F] mapEventEmitterToNodeListener" + +--- +```ts +mapEventEmitterToNodeListener(eventEmitter): SemanticNodeListener +``` + +Create a Semantic node listener from an event emitter. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `eventEmitter` | [`EventEmitter`](Class.EventEmitter.md)< [`SemanticNodeListener`](Type.SemanticNodeListener.md) \> | Event emitter. | + +## Returns + +[`SemanticNodeListener`](Type.SemanticNodeListener.md) + +Semantic node listener. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.markDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.markDeprecated.md new file mode 100644 index 00000000000..1187ed03661 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.markDeprecated.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] markDeprecated" + +--- +```ts +markDeprecated( + program, + type, + details): void +``` + +Mark the given type as deprecated with the provided details. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `type` | [`Type`](Type.Type.md) | Type | +| `details` | [`DeprecationDetails`](Interface.DeprecationDetails.md) | Details of the deprecation | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateProgram.md new file mode 100644 index 00000000000..c9d166c1e5e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateProgram.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] navigateProgram" + +--- +```ts +navigateProgram( + program, + listeners, + options = {}): void +``` + +Navigate all types in the program. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program to navigate. | +| `listeners` | [`SemanticNodeListener`](Type.SemanticNodeListener.md) | Listener called when visiting types. | +| `options` | [`NavigationOptions`](Interface.NavigationOptions.md) | Navigation options. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateType.md new file mode 100644 index 00000000000..a8323ae924c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateType.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] navigateType" + +--- +```ts +navigateType( + type, + listeners, + options): void +``` + +Navigate the given type and all the types that are used in it. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `type` | [`Type`](Type.Type.md) | Type to navigate. | +| `listeners` | [`SemanticNodeListener`](Type.SemanticNodeListener.md) | Listener for the types found. | +| `options` | [`NavigationOptions`](Interface.NavigationOptions.md) | Navigation options | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateTypesInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateTypesInNamespace.md new file mode 100644 index 00000000000..6a45efe1aa1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateTypesInNamespace.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] navigateTypesInNamespace" + +--- +```ts +navigateTypesInNamespace( + namespace, + listeners, + options = {}): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `namespace` | [`Namespace`](Interface.Namespace.md) | +| `listeners` | \{`exitModel`: `undefined` \| `TypeListener`< [`Model`](Interface.Model.md) \>; `model`: `undefined` \| `TypeListener`< [`Model`](Interface.Model.md) \>;} & \{`exitModelProperty`: `undefined` \| `TypeListener`< [`ModelProperty`](Interface.ModelProperty.md) \>; `modelProperty`: `undefined` \| `TypeListener`< [`ModelProperty`](Interface.ModelProperty.md) \>;} & \{`exitScalar`: `undefined` \| `TypeListener`< [`Scalar`](Interface.Scalar.md) \>; `scalar`: `undefined` \| `TypeListener`< [`Scalar`](Interface.Scalar.md) \>;} & \{`exitInterface`: `undefined` \| `TypeListener`< [`Interface`](Interface.Interface.md) \>; `interface`: `undefined` \| `TypeListener`< [`Interface`](Interface.Interface.md) \>;} & \{`enum`: `undefined` \| `TypeListener`< [`Enum`](Interface.Enum.md) \>; `exitEnum`: `undefined` \| `TypeListener`< [`Enum`](Interface.Enum.md) \>;} & \{`enumMember`: `undefined` \| `TypeListener`< [`EnumMember`](Interface.EnumMember.md) \>; `exitEnumMember`: `undefined` \| `TypeListener`< [`EnumMember`](Interface.EnumMember.md) \>;} & \{`exitTemplateParameter`: `undefined` \| `TypeListener`< [`TemplateParameter`](Interface.TemplateParameter.md) \>; `templateParameter`: `undefined` \| `TypeListener`< [`TemplateParameter`](Interface.TemplateParameter.md) \>;} & \{`exitNamespace`: `undefined` \| `TypeListener`< [`Namespace`](Interface.Namespace.md) \>; `namespace`: `undefined` \| `TypeListener`< [`Namespace`](Interface.Namespace.md) \>;} & \{`exitOperation`: `undefined` \| `TypeListener`< [`Operation`](Interface.Operation.md) \>; `operation`: `undefined` \| `TypeListener`< [`Operation`](Interface.Operation.md) \>;} & \{`exitString`: `undefined` \| `TypeListener`< [`StringLiteral`](Interface.StringLiteral.md) \>; `string`: `undefined` \| `TypeListener`< [`StringLiteral`](Interface.StringLiteral.md) \>;} & \{`exitNumber`: `undefined` \| `TypeListener`< [`NumericLiteral`](Interface.NumericLiteral.md) \>; `number`: `undefined` \| `TypeListener`< [`NumericLiteral`](Interface.NumericLiteral.md) \>;} & \{`boolean`: `undefined` \| `TypeListener`< [`BooleanLiteral`](Interface.BooleanLiteral.md) \>; `exitBoolean`: `undefined` \| `TypeListener`< [`BooleanLiteral`](Interface.BooleanLiteral.md) \>;} & \{`exitTuple`: `undefined` \| `TypeListener`< [`Tuple`](Interface.Tuple.md) \>; `tuple`: `undefined` \| `TypeListener`< [`Tuple`](Interface.Tuple.md) \>;} & \{`exitUnion`: `undefined` \| `TypeListener`< [`Union`](Interface.Union.md) \>; `union`: `undefined` \| `TypeListener`< [`Union`](Interface.Union.md) \>;} & \{`exitUnionVariant`: `undefined` \| `TypeListener`< [`UnionVariant`](Interface.UnionVariant.md) \>; `unionVariant`: `undefined` \| `TypeListener`< [`UnionVariant`](Interface.UnionVariant.md) \>;} & \{`exitIntrinsic`: `undefined` \| `TypeListener`< [`IntrinsicType`](Interface.IntrinsicType.md) \>; `intrinsic`: `undefined` \| `TypeListener`< [`IntrinsicType`](Interface.IntrinsicType.md) \>;} & \{`exitFunction`: `undefined` \| `TypeListener`< [`FunctionType`](Interface.FunctionType.md) \>; `function`: `undefined` \| `TypeListener`< [`FunctionType`](Interface.FunctionType.md) \>;} & \{`decorator`: `undefined` \| `TypeListener`< [`Decorator`](Interface.Decorator.md) \>; `exitDecorator`: `undefined` \| `TypeListener`< [`Decorator`](Interface.Decorator.md) \>;} & \{`exitFunctionParameter`: `undefined` \| `TypeListener`< [`FunctionParameter`](Interface.FunctionParameter.md) \>; `functionParameter`: `undefined` \| `TypeListener`< [`FunctionParameter`](Interface.FunctionParameter.md) \>;} & \{`exitObject`: `undefined` \| `TypeListener`< [`ObjectType`](Interface.ObjectType.md) \>; `object`: `undefined` \| `TypeListener`< [`ObjectType`](Interface.ObjectType.md) \>;} & \{`exitProjection`: `undefined` \| `TypeListener`< [`Projection`](Interface.Projection.md) \>; `projection`: `undefined` \| `TypeListener`< [`Projection`](Interface.Projection.md) \>;} | +| `options` | [`NamespaceNavigationOptions`](Interface.NamespaceNavigationOptions.md) & [`NavigationOptions`](Interface.NavigationOptions.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.normalizePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.normalizePath.md new file mode 100644 index 00000000000..5f3c85b47a0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.normalizePath.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] normalizePath" + +--- +```ts +normalizePath(path): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.normalizeSlashes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.normalizeSlashes.md new file mode 100644 index 00000000000..f57cabe09d3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.normalizeSlashes.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] normalizeSlashes" + +--- +```ts +normalizeSlashes(path): string +``` + +Normalize path separators, converting `\` into `/`. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.paramMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.paramMessage.md new file mode 100644 index 00000000000..b8527ddd5fb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.paramMessage.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] paramMessage" + +--- +```ts +paramMessage(strings, ...keys): CallableMessage< T > +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` *extends* `string`[] | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `strings` | *readonly* `string`[] | +| ...`keys` | `T` | + +## Returns + +[`CallableMessage`](Interface.CallableMessage.md)< `T` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.parse.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.parse.md new file mode 100644 index 00000000000..42dc4744c78 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.parse.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] parse" + +--- +```ts +parse(code, options = {}): TypeSpecScriptNode +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `code` | `string` \| [`SourceFile`](Interface.SourceFile.md) | +| `options` | [`ParseOptions`](Interface.ParseOptions.md) | + +## Returns + +[`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.parseStandaloneTypeReference.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.parseStandaloneTypeReference.md new file mode 100644 index 00000000000..fe64e531615 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.parseStandaloneTypeReference.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] parseStandaloneTypeReference" + +--- +```ts +parseStandaloneTypeReference(code): [TypeReferenceNode, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `code` | `string` \| [`SourceFile`](Interface.SourceFile.md) | + +## Returns + +[[`TypeReferenceNode`](Interface.TypeReferenceNode.md), *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.projectProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.projectProgram.md new file mode 100644 index 00000000000..bc3287bc7ab --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.projectProgram.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] projectProgram" + +--- +```ts +projectProgram( + program, + projections, + startNode?): ProjectedProgram +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `projections` | [`ProjectionApplication`](Interface.ProjectionApplication.md)[] | +| `startNode`? | [`Type`](Type.Type.md) | + +## Returns + +[`ProjectedProgram`](Interface.ProjectedProgram.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.reducePathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.reducePathComponents.md new file mode 100644 index 00000000000..1580ff3e535 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.reducePathComponents.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] reducePathComponents" + +--- +```ts +reducePathComponents(components): string[] +``` + +Reduce an array of path components to a more simplified path by navigating any +`"."` or `".."` entries in the path. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `components` | *readonly* `string`[] | + +## Returns + +`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.removeTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.removeTrailingDirectorySeparator.md new file mode 100644 index 00000000000..277ef723b72 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.removeTrailingDirectorySeparator.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] removeTrailingDirectorySeparator" + +--- +```ts +removeTrailingDirectorySeparator(path): string +``` + +Removes a trailing directory separator from a path, if it does not already have one. + +```ts +removeTrailingDirectorySeparator("/path/to/file.ext") === "/path/to/file.ext" +removeTrailingDirectorySeparator("/path/to/file.ext/") === "/path/to/file.ext" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.reportDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.reportDeprecated.md new file mode 100644 index 00000000000..5106a534fbb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.reportDeprecated.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] reportDeprecated" + +--- +```ts +reportDeprecated( + program, + message, + target): void +``` + +Report a deprecated diagnostic. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | TypeSpec Program. | +| `message` | `string` | Message describing the deprecation. | +| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) \| *typeof* [`NoTarget`](Variable.NoTarget.md) | Target of the deprecation. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveCompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveCompilerOptions.md new file mode 100644 index 00000000000..3f0397939b5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveCompilerOptions.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] resolveCompilerOptions" + +--- +```ts +resolveCompilerOptions(host, options): Promise< [CompilerOptions, readonly Diagnostic[]] > +``` + +Resolve the compiler options for the given entrypoint by resolving the tspconfig.yaml. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `host` | [`CompilerHost`](Interface.CompilerHost.md) | Compiler host | +| `options` | [`ResolveCompilerOptionsOptions`](Interface.ResolveCompilerOptionsOptions.md) | - | + +## Returns + +`Promise`< [[`CompilerOptions`](Interface.CompilerOptions.md), *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveModule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveModule.md new file mode 100644 index 00000000000..286df7354e7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveModule.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] resolveModule" + +--- +```ts +resolveModule( + host, + name, + options): Promise< ModuleResolutionResult > +``` + +Resolve a module + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `host` | [`ResolveModuleHost`](Interface.ResolveModuleHost.md) | | +| `name` | `string` | | +| `options` | [`ResolveModuleOptions`](Interface.ResolveModuleOptions.md) | | + +## Returns + +`Promise`< [`ModuleResolutionResult`](Type.ModuleResolutionResult.md) \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolvePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolvePath.md new file mode 100644 index 00000000000..cb260f4ffdd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolvePath.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] resolvePath" + +--- +```ts +resolvePath(path, ...paths): string +``` + +Combines and resolves paths. If a path is absolute, it replaces any previous path. Any +`.` and `..` path components are resolved. Trailing directory separators are preserved. + +```ts +resolvePath("/path", "to", "file.ext") === "path/to/file.ext" +resolvePath("/path", "to", "file.ext/") === "path/to/file.ext/" +resolvePath("/path", "dir", "..", "to", "file.ext") === "path/to/file.ext" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | +| ...`paths` | (`undefined` \| `string`)[] | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveUsages.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveUsages.md new file mode 100644 index 00000000000..0c8bf1e0933 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveUsages.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] resolveUsages" + +--- +```ts +resolveUsages(types): UsageTracker +``` + +Resolve usage(input, output or both) of various types in the given namespace. +Will recursively scan all namespace, interfaces and operations contained inside the namespace. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `types` | [`OperationContainer`](Type.OperationContainer.md) \| [`OperationContainer`](Type.OperationContainer.md)[] | Entrypoint(s) namespace, interface or operations to get usage from. | + +## Returns + +[`UsageTracker`](Interface.UsageTracker.md) + +Map of types to usage. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.scopeNavigationToNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.scopeNavigationToNamespace.md new file mode 100644 index 00000000000..7c161b35024 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.scopeNavigationToNamespace.md @@ -0,0 +1,33 @@ +--- +jsApi: true +title: "[F] scopeNavigationToNamespace" + +--- +```ts +scopeNavigationToNamespace( + namespace, + listeners, + options = {}): T +``` + +Scope the current navigation to the given namespace. + +## Type parameters + +| Parameter | +| :------ | +| `T` *extends* \{`exitModel`: `undefined` \| `TypeListener`< [`Model`](Interface.Model.md) \>; `model`: `undefined` \| `TypeListener`< [`Model`](Interface.Model.md) \>;} & \{`exitModelProperty`: `undefined` \| `TypeListener`< [`ModelProperty`](Interface.ModelProperty.md) \>; `modelProperty`: `undefined` \| `TypeListener`< [`ModelProperty`](Interface.ModelProperty.md) \>;} & \{`exitScalar`: `undefined` \| `TypeListener`< [`Scalar`](Interface.Scalar.md) \>; `scalar`: `undefined` \| `TypeListener`< [`Scalar`](Interface.Scalar.md) \>;} & \{`exitInterface`: `undefined` \| `TypeListener`< [`Interface`](Interface.Interface.md) \>; `interface`: `undefined` \| `TypeListener`< [`Interface`](Interface.Interface.md) \>;} & \{`enum`: `undefined` \| `TypeListener`< [`Enum`](Interface.Enum.md) \>; `exitEnum`: `undefined` \| `TypeListener`< [`Enum`](Interface.Enum.md) \>;} & \{`enumMember`: `undefined` \| `TypeListener`< [`EnumMember`](Interface.EnumMember.md) \>; `exitEnumMember`: `undefined` \| `TypeListener`< [`EnumMember`](Interface.EnumMember.md) \>;} & \{`exitTemplateParameter`: `undefined` \| `TypeListener`< [`TemplateParameter`](Interface.TemplateParameter.md) \>; `templateParameter`: `undefined` \| `TypeListener`< [`TemplateParameter`](Interface.TemplateParameter.md) \>;} & \{`exitNamespace`: `undefined` \| `TypeListener`< [`Namespace`](Interface.Namespace.md) \>; `namespace`: `undefined` \| `TypeListener`< [`Namespace`](Interface.Namespace.md) \>;} & \{`exitOperation`: `undefined` \| `TypeListener`< [`Operation`](Interface.Operation.md) \>; `operation`: `undefined` \| `TypeListener`< [`Operation`](Interface.Operation.md) \>;} & \{`exitString`: `undefined` \| `TypeListener`< [`StringLiteral`](Interface.StringLiteral.md) \>; `string`: `undefined` \| `TypeListener`< [`StringLiteral`](Interface.StringLiteral.md) \>;} & \{`exitNumber`: `undefined` \| `TypeListener`< [`NumericLiteral`](Interface.NumericLiteral.md) \>; `number`: `undefined` \| `TypeListener`< [`NumericLiteral`](Interface.NumericLiteral.md) \>;} & \{`boolean`: `undefined` \| `TypeListener`< [`BooleanLiteral`](Interface.BooleanLiteral.md) \>; `exitBoolean`: `undefined` \| `TypeListener`< [`BooleanLiteral`](Interface.BooleanLiteral.md) \>;} & \{`exitTuple`: `undefined` \| `TypeListener`< [`Tuple`](Interface.Tuple.md) \>; `tuple`: `undefined` \| `TypeListener`< [`Tuple`](Interface.Tuple.md) \>;} & \{`exitUnion`: `undefined` \| `TypeListener`< [`Union`](Interface.Union.md) \>; `union`: `undefined` \| `TypeListener`< [`Union`](Interface.Union.md) \>;} & \{`exitUnionVariant`: `undefined` \| `TypeListener`< [`UnionVariant`](Interface.UnionVariant.md) \>; `unionVariant`: `undefined` \| `TypeListener`< [`UnionVariant`](Interface.UnionVariant.md) \>;} & \{`exitIntrinsic`: `undefined` \| `TypeListener`< [`IntrinsicType`](Interface.IntrinsicType.md) \>; `intrinsic`: `undefined` \| `TypeListener`< [`IntrinsicType`](Interface.IntrinsicType.md) \>;} & \{`exitFunction`: `undefined` \| `TypeListener`< [`FunctionType`](Interface.FunctionType.md) \>; `function`: `undefined` \| `TypeListener`< [`FunctionType`](Interface.FunctionType.md) \>;} & \{`decorator`: `undefined` \| `TypeListener`< [`Decorator`](Interface.Decorator.md) \>; `exitDecorator`: `undefined` \| `TypeListener`< [`Decorator`](Interface.Decorator.md) \>;} & \{`exitFunctionParameter`: `undefined` \| `TypeListener`< [`FunctionParameter`](Interface.FunctionParameter.md) \>; `functionParameter`: `undefined` \| `TypeListener`< [`FunctionParameter`](Interface.FunctionParameter.md) \>;} & \{`exitObject`: `undefined` \| `TypeListener`< [`ObjectType`](Interface.ObjectType.md) \>; `object`: `undefined` \| `TypeListener`< [`ObjectType`](Interface.ObjectType.md) \>;} & \{`exitProjection`: `undefined` \| `TypeListener`< [`Projection`](Interface.Projection.md) \>; `projection`: `undefined` \| `TypeListener`< [`Projection`](Interface.Projection.md) \>;} | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `namespace` | [`Namespace`](Interface.Namespace.md) | Namespace the traversal shouldn't leave. | +| `listeners` | `T` | Type listeners. | +| `options` | [`NamespaceNavigationOptions`](Interface.NamespaceNavigationOptions.md) | Scope options | + +## 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/Function.setCadlNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.setCadlNamespace.md new file mode 100644 index 00000000000..db6837821f3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.setCadlNamespace.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] setCadlNamespace" + +--- +```ts +setCadlNamespace(namespace, ...functions): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `namespace` | `string` | +| ...`functions` | (...`args`) => `any`[] | + +## Returns + +`void` + +## Deprecated + +use setTypeSpecNamespace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.setTypeSpecNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.setTypeSpecNamespace.md new file mode 100644 index 00000000000..2d54e87e462 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.setTypeSpecNamespace.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] setTypeSpecNamespace" + +--- +```ts +setTypeSpecNamespace(namespace, ...functions): void +``` + +Set the TypeSpec namespace for that function. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `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/Function.skipTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.skipTrivia.md new file mode 100644 index 00000000000..787eac72adb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.skipTrivia.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] skipTrivia" + +--- +```ts +skipTrivia( + input, + position, + endPosition = input.length): number +``` + +## Parameters + +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `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/Function.skipWhiteSpace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.skipWhiteSpace.md new file mode 100644 index 00000000000..89e0a843a85 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.skipWhiteSpace.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] skipWhiteSpace" + +--- +```ts +skipWhiteSpace( + input, + position, + endPosition = input.length): number +``` + +## Parameters + +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `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/Function.typespecTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.typespecTypeToJson.md new file mode 100644 index 00000000000..40cb0b65410 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.typespecTypeToJson.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] typespecTypeToJson" + +--- +```ts +typespecTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] +``` + +Convert a typespec type to a serializable Json object. +Emits diagnostics if the given type is invalid + +## Type parameters + +| Parameter | +| :------ | +| `T` | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `typespecType` | [`TypeSpecValue`](Type.TypeSpecValue.md) | The type to convert to Json data | +| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | The diagnostic target in case of errors. | + +## Returns + +[`T` \| `undefined`, [`Diagnostic`](Interface.Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorNotOnType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorNotOnType.md new file mode 100644 index 00000000000..43c4bf791d8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorNotOnType.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[F] validateDecoratorNotOnType" + +--- +```ts +validateDecoratorNotOnType( + context, + type, + badDecorator, + givenDecorator): boolean +``` + +Validate that a given decorator is not on a type or any of its base types. +Useful to check for decorator usage that conflicts with another decorator. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | Decorator context | +| `type` | [`Type`](Type.Type.md) | The type to check | +| `badDecorator` | [`DecoratorFunction`](Interface.DecoratorFunction.md) | The decorator we don't want present | +| `givenDecorator` | [`DecoratorFunction`](Interface.DecoratorFunction.md) | The decorator that is the reason why we don't want the bad decorator present | + +## Returns + +`boolean` + +Whether the decorator application is valid diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamCount.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamCount.md new file mode 100644 index 00000000000..c755597bdea --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamCount.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] validateDecoratorParamCount" + +--- +```ts +validateDecoratorParamCount( + context, + min, + max, + parameters): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `min` | `number` | +| `max` | `undefined` \| `number` | +| `parameters` | `unknown`[] | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamType.md new file mode 100644 index 00000000000..35596187b72 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamType.md @@ -0,0 +1,43 @@ +--- +jsApi: true +title: "[F] validateDecoratorParamType" + +--- +```ts +validateDecoratorParamType( + program, + target, + value, + expectedType): value is InferredTypeSpecValue +``` + +Validate a decorator parameter has the correct type. + +## Type parameters + +| Parameter | +| :------ | +| `K` *extends* `"Model"` \| `"ModelProperty"` \| `"Scalar"` \| `"Interface"` \| `"Enum"` \| `"EnumMember"` \| `"TemplateParameter"` \| `"Namespace"` \| `"Operation"` \| `"String"` \| `"Number"` \| `"Boolean"` \| `"Tuple"` \| `"Union"` \| `"UnionVariant"` \| `"Intrinsic"` \| `"Function"` \| `"Decorator"` \| `"FunctionParameter"` \| `"Object"` \| `"Projection"` | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `target` | [`Type`](Type.Type.md) | Decorator target | +| `value` | [`TypeSpecValue`](Type.TypeSpecValue.md) | Value of the parameter. | +| `expectedType` | `K` \| `K`[] | Expected type or list of expected 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 + +use + +## See + +createDecoratorDefinition#validate instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTarget.md new file mode 100644 index 00000000000..94209a4691a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTarget.md @@ -0,0 +1,33 @@ +--- +jsApi: true +title: "[F] validateDecoratorTarget" + +--- +```ts +validateDecoratorTarget( + context, + target, + decoratorName, + expectedType): target is K extends "Any" ? Type : Object +``` + +Validate the decorator target is matching the expected value. + +## Type parameters + +| Parameter | +| :------ | +| `K` *extends* [`TypeKind`](Type.TypeKind.md) | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | - | +| `target` | [`Type`](Type.Type.md) | | +| `decoratorName` | `string` | | +| `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/Function.validateDecoratorTargetIntrinsic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTargetIntrinsic.md new file mode 100644 index 00000000000..b71c9fed1fe --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTargetIntrinsic.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] validateDecoratorTargetIntrinsic" + +--- +```ts +validateDecoratorTargetIntrinsic( + context, + target, + decoratorName, + expectedType): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | +| `decoratorName` | `string` | +| `expectedType` | [`IntrinsicScalarName`](Type.IntrinsicScalarName.md) \| [`IntrinsicScalarName`](Type.IntrinsicScalarName.md)[] | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorUniqueOnNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorUniqueOnNode.md new file mode 100644 index 00000000000..281a3f964b2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorUniqueOnNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] validateDecoratorUniqueOnNode" + +--- +```ts +validateDecoratorUniqueOnNode( + context, + type, + decorator): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `type` | [`Type`](Type.Type.md) | +| `decorator` | [`DecoratorFunction`](Interface.DecoratorFunction.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.visitChildren.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.visitChildren.md new file mode 100644 index 00000000000..7ffc5c77b5f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.visitChildren.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] visitChildren" + +--- +```ts +visitChildren(node, cb): T | undefined +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`Node`](Type.Node.md) | +| `cb` | [`NodeCallback`](Type.NodeCallback.md)< `T` \> | + +## Returns + +`T` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.walkPropertiesInherited.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.walkPropertiesInherited.md new file mode 100644 index 00000000000..e2dd546af2f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.walkPropertiesInherited.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] walkPropertiesInherited" + +--- +```ts +walkPropertiesInherited(model): Generator< ModelProperty, void, unknown > +``` + +Enumerates the properties declared by model or inherited from its base. + +Properties declared by more derived types are enumerated before properties +of less derived types. + +Properties that are overridden are not enumerated. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `model` | [`Model`](Interface.Model.md) | + +## Returns + +`Generator`< [`ModelProperty`](Interface.ModelProperty.md), `void`, `unknown` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AliasStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AliasStatementNode.md new file mode 100644 index 00000000000..54e2e2ba0a6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AliasStatementNode.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[I] AliasStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md).[`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`AliasStatement`](Enumeration.SyntaxKind.md#aliasstatement) | - | +| `locals`? | `SymbolTable` | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | - | +| `readonly` `value` | [`Expression`](Type.Expression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AnyKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AnyKeywordNode.md new file mode 100644 index 00000000000..4ef7454c115 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AnyKeywordNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] AnyKeywordNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`UnknownKeyword`](Enumeration.SyntaxKind.md#unknownkeyword) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ArrayExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ArrayExpressionNode.md new file mode 100644 index 00000000000..59c89887a16 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ArrayExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ArrayExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `elementType` | [`Expression`](Type.Expression.md) | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ArrayExpression`](Enumeration.SyntaxKind.md#arrayexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ArrayModelType.md new file mode 100644 index 00000000000..9d7910c0bb1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ArrayModelType.md @@ -0,0 +1,68 @@ +--- +jsApi: true +title: "[I] ArrayModelType" + +--- +## Extends + +- [`Model`](Interface.Model.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `baseModel`? | [`Model`](Interface.Model.md) | Model this model extends. This represent inheritance. | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | +| `derivedModels` | [`Model`](Interface.Model.md)[] | Direct children. This is the reverse relation of [baseModel](Interface.ArrayModelType.md#basemodel) | +| `indexer` | `object` | - | +| `indexer.key` | [`Scalar`](Interface.Scalar.md) | - | +| `indexer.value` | [`Type`](Type.Type.md) | - | +| `instantiationParameters`? | [`Type`](Type.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` | `"Model"` | - | +| `name` | `string` | - | +| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | +| `node`? | [`ModelStatementNode`](Interface.ModelStatementNode.md) \| [`ModelExpressionNode`](Interface.ModelExpressionNode.md) \| [`IntersectionExpressionNode`](Interface.IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](Interface.ProjectionModelExpressionNode.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `properties` | `RekeyableMap`< `string`, [`ModelProperty`](Interface.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](Function.walkPropertiesInherited.md) to enumerate all properties in the
inheritance hierarchy. | +| `sourceModel`? | [`Model`](Interface.Model.md) | The model that is referenced via `model is`. | +| `symbol`? | [`Sym`](Interface.Sym.md) | Late-bound symbol of this model type. | +| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

use templateMapper instead. | +| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | +| `templateNode`? | [`Node`](Type.Node.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`Model`](Interface.Model.md).[`projections`](Interface.Model.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`Model`](Interface.Model.md).[`projectionsByName`](Interface.Model.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AugmentDecoratorStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AugmentDecoratorStatementNode.md new file mode 100644 index 00000000000..cd4a2a35ec3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AugmentDecoratorStatementNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] AugmentDecoratorStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `arguments` | *readonly* [`Expression`](Type.Expression.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`AugmentDecoratorStatement`](Enumeration.SyntaxKind.md#augmentdecoratorstatement) | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `targetType` | [`TypeReferenceNode`](Interface.TypeReferenceNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseNode.md new file mode 100644 index 00000000000..e1c4ee786d3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] BaseNode" + +--- +## Extends + +- [`TextRange`](Interface.TextRange.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`SyntaxKind`](Enumeration.SyntaxKind.md) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.BaseType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseType.md new file mode 100644 index 00000000000..ea9874bc10a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseType.md @@ -0,0 +1,66 @@ +--- +jsApi: true +title: "[I] BaseType" + +--- +## Extended By + +- [`ObjectType`](Interface.ObjectType.md) +- [`Projection`](Interface.Projection.md) +- [`IntrinsicType`](Interface.IntrinsicType.md) +- [`Model`](Interface.Model.md) +- [`ModelProperty`](Interface.ModelProperty.md) +- [`Scalar`](Interface.Scalar.md) +- [`Interface`](Interface.Interface.md) +- [`Enum`](Interface.Enum.md) +- [`EnumMember`](Interface.EnumMember.md) +- [`Operation`](Interface.Operation.md) +- [`Namespace`](Interface.Namespace.md) +- [`StringLiteral`](Interface.StringLiteral.md) +- [`NumericLiteral`](Interface.NumericLiteral.md) +- [`BooleanLiteral`](Interface.BooleanLiteral.md) +- [`Tuple`](Interface.Tuple.md) +- [`Union`](Interface.Union.md) +- [`UnionVariant`](Interface.UnionVariant.md) +- [`TemplateParameter`](Interface.TemplateParameter.md) +- [`Decorator`](Interface.Decorator.md) +- [`FunctionType`](Interface.FunctionType.md) +- [`FunctionParameter`](Interface.FunctionParameter.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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.Node.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BlockComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BlockComment.md new file mode 100644 index 00000000000..46565dc46dd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BlockComment.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] BlockComment" + +--- +## Extends + +- [`TextRange`](Interface.TextRange.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `kind` | [`BlockComment`](Enumeration.SyntaxKind.md#blockcomment) | - | +| `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. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteral.md new file mode 100644 index 00000000000..f5f3511c0c2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteral.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[I] BooleanLiteral" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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` | `"Boolean"` | - | +| `node`? | [`BooleanLiteralNode`](Interface.BooleanLiteralNode.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `value` | `boolean` | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteralNode.md new file mode 100644 index 00000000000..b1b8c3133ea --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteralNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] BooleanLiteralNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`BooleanLiteral`](Enumeration.SyntaxKind.md#booleanliteral) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `value` | `boolean` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CallableMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CallableMessage.md new file mode 100644 index 00000000000..7e6ebcb3ada --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CallableMessage.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[I] CallableMessage" + +--- +## Type parameters + +| Parameter | +| :------ | +| `T` *extends* `string`[] | + +```ts +CallableMessage(dict): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `dict` | `Record`< `T`[`number`], `string` \> | + +## Returns + +`string` + +## Properties + +| Property | Type | +| :------ | :------ | +| `keys` | `T` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Checker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Checker.md new file mode 100644 index 00000000000..1e071bb4ac5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Checker.md @@ -0,0 +1,633 @@ +--- +jsApi: true +title: "[I] Checker" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `anyType` | [`UnknownType`](Interface.UnknownType.md) | +| `errorType` | [`ErrorType`](Interface.ErrorType.md) | +| `neverType` | [`NeverType`](Interface.NeverType.md) | +| `typePrototype` | `TypePrototype` | +| `voidType` | [`VoidType`](Interface.VoidType.md) | + +## Methods + +### checkProgram + +```ts +checkProgram(): void +``` + +#### Returns + +`void` + +*** + +### checkSourceFile + +```ts +checkSourceFile(file): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `file` | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | + +#### Returns + +`void` + +*** + +### cloneType + +```ts +cloneType(type, additionalProps?): T +``` + +#### Type parameters + +| Parameter | +| :------ | +| `T` *extends* [`Type`](Type.Type.md) | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | `T` | +| `additionalProps`? | \{ [P in string \| number \| symbol]?: T[P] } | + +#### Returns + +`T` + +*** + +### createAndFinishType + +```ts +createAndFinishType(typeDef): T & TypePrototype +``` + +#### Type parameters + +| Parameter | +| :------ | +| `T` *extends* [`CreateTypeProps`](Type.CreateTypeProps.md) | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeDef` | `T` | + +#### Returns + +`T` & `TypePrototype` + +*** + +### createFunctionType + +```ts +createFunctionType(fn): FunctionType +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `fn` | (...`args`) => [`Type`](Type.Type.md) | + +#### Returns + +[`FunctionType`](Interface.FunctionType.md) + +*** + +### createLiteralType + +```ts +createLiteralType(value, node?): StringLiteral +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `string` | +| `node`? | [`StringLiteralNode`](Interface.StringLiteralNode.md) | + +#### Returns + +[`StringLiteral`](Interface.StringLiteral.md) + +```ts +createLiteralType(value, node?): NumericLiteral +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `number` | +| `node`? | [`NumericLiteralNode`](Interface.NumericLiteralNode.md) | + +#### Returns + +[`NumericLiteral`](Interface.NumericLiteral.md) + +```ts +createLiteralType(value, node?): BooleanLiteral +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `boolean` | +| `node`? | [`BooleanLiteralNode`](Interface.BooleanLiteralNode.md) | + +#### Returns + +[`BooleanLiteral`](Interface.BooleanLiteral.md) + +```ts +createLiteralType(value, node?): StringLiteral | NumericLiteral | BooleanLiteral +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `string` \| `number` \| `boolean` | +| `node`? | [`StringLiteralNode`](Interface.StringLiteralNode.md) \| [`NumericLiteralNode`](Interface.NumericLiteralNode.md) \| [`BooleanLiteralNode`](Interface.BooleanLiteralNode.md) | + +#### Returns + +[`StringLiteral`](Interface.StringLiteral.md) \| [`NumericLiteral`](Interface.NumericLiteral.md) \| [`BooleanLiteral`](Interface.BooleanLiteral.md) + +```ts +createLiteralType(value, node?): StringLiteral | NumericLiteral | BooleanLiteral +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `string` \| `number` \| `boolean` | +| `node`? | [`StringLiteralNode`](Interface.StringLiteralNode.md) \| [`NumericLiteralNode`](Interface.NumericLiteralNode.md) \| [`BooleanLiteralNode`](Interface.BooleanLiteralNode.md) | + +#### Returns + +[`StringLiteral`](Interface.StringLiteral.md) \| [`NumericLiteral`](Interface.NumericLiteral.md) \| [`BooleanLiteral`](Interface.BooleanLiteral.md) + +*** + +### createType + +```ts +createType(typeDef): T & TypePrototype & {isFinished: boolean;} +``` + +#### Type parameters + +| Parameter | +| :------ | +| `T` *extends* [`CreateTypeProps`](Type.CreateTypeProps.md) | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeDef` | `T` | + +#### Returns + +`T` & `TypePrototype` & \{`isFinished`: `boolean`;} + +*** + +### evalProjection + +```ts +evalProjection( + node, + target, + args): Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`ProjectionNode`](Interface.ProjectionNode.md) | +| `target` | [`Type`](Type.Type.md) | +| `args` | [`Type`](Type.Type.md)[] | + +#### Returns + +[`Type`](Type.Type.md) + +*** + +### finishType + +```ts +finishType(typeDef): T +``` + +#### Type parameters + +| Parameter | +| :------ | +| `T` *extends* [`Type`](Type.Type.md) | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeDef` | `T` | + +#### Returns + +`T` + +*** + +### getGlobalNamespaceNode + +```ts +getGlobalNamespaceNode(): NamespaceStatementNode +``` + +#### Returns + +[`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) + +*** + +### getGlobalNamespaceType + +```ts +getGlobalNamespaceType(): Namespace +``` + +#### Returns + +[`Namespace`](Interface.Namespace.md) + +*** + +### getLiteralType + +```ts +getLiteralType(node): StringLiteral +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`StringLiteralNode`](Interface.StringLiteralNode.md) | + +#### Returns + +[`StringLiteral`](Interface.StringLiteral.md) + +```ts +getLiteralType(node): NumericLiteral +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`NumericLiteralNode`](Interface.NumericLiteralNode.md) | + +#### Returns + +[`NumericLiteral`](Interface.NumericLiteral.md) + +```ts +getLiteralType(node): BooleanLiteral +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`BooleanLiteralNode`](Interface.BooleanLiteralNode.md) | + +#### Returns + +[`BooleanLiteral`](Interface.BooleanLiteral.md) + +```ts +getLiteralType(node): LiteralType +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`LiteralNode`](Type.LiteralNode.md) | + +#### Returns + +[`LiteralType`](Type.LiteralType.md) + +*** + +### getMergedSymbol + +```ts +getMergedSymbol(sym): undefined | Sym +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `sym` | `undefined` \| [`Sym`](Interface.Sym.md) | + +#### Returns + +`undefined` \| [`Sym`](Interface.Sym.md) + +*** + +### getNamespaceString + +```ts +getNamespaceString(type, options?): string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | `undefined` \| [`Namespace`](Interface.Namespace.md) | +| `options`? | [`TypeNameOptions`](Interface.TypeNameOptions.md) | + +#### Returns + +`string` + +#### Deprecated + +use `import { getNamespaceFullName } from "@typespec/compiler";` + +*** + +### getStdType + +```ts +getStdType(name): StdTypes[T] +``` + +Std type + +#### Type parameters + +| Parameter | +| :------ | +| `T` *extends* [`IntrinsicScalarName`](Type.IntrinsicScalarName.md) \| `"Array"` \| `"Record"` | + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `name` | `T` | Name | + +#### Returns + +[`StdTypes`](Type.StdTypes.md)[`T`] + +*** + +### getTypeForNode + +```ts +getTypeForNode(node): Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`Node`](Type.Node.md) | + +#### Returns + +[`Type`](Type.Type.md) + +*** + +### getTypeName + +```ts +getTypeName(type, options?): string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](Type.Type.md) | +| `options`? | [`TypeNameOptions`](Interface.TypeNameOptions.md) | + +#### Returns + +`string` + +#### Deprecated + +use `import { getTypeName } from "@typespec/compiler";` + +*** + +### isStdType + +```ts +isStdType(type, stdType?): type is Scalar & Object +``` + +Check if the given type is one of the built-in standard TypeSpec Types. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `type` | [`Scalar`](Interface.Scalar.md) | Type to check | +| `stdType`? | [`IntrinsicScalarName`](Type.IntrinsicScalarName.md) | If provided check is that standard type | + +#### Returns + +`type is Scalar & Object` + +```ts +isStdType(type, stdType?): type is Type & Object +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](Type.Type.md) | +| `stdType`? | [`IntrinsicScalarName`](Type.IntrinsicScalarName.md) \| `"Array"` \| `"Record"` | + +#### Returns + +`type is Type & Object` + +*** + +### isTypeAssignableTo + +```ts +isTypeAssignableTo( + source, + target, + diagnosticTarget): [boolean, readonly Diagnostic[]] +``` + +Check if the source type can be assigned to the target type. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `source` | [`Type`](Type.Type.md) \| [`ValueType`](Interface.ValueType.md) | Source type, should be assignable to the target. | +| `target` | [`Type`](Type.Type.md) \| [`ValueType`](Interface.ValueType.md) | Target type | +| `diagnosticTarget` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | Target for the diagnostic, unless something better can be inferred. | + +#### Returns + +[`boolean`, *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] + +[related, list of diagnostics] + +*** + +### mergeSourceFile + +```ts +mergeSourceFile(file): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `file` | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`JsSourceFileNode`](Interface.JsSourceFileNode.md) | + +#### Returns + +`void` + +*** + +### project + +```ts +project( + target, + projection, + args?): Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | [`Type`](Type.Type.md) | +| `projection` | [`ProjectionNode`](Interface.ProjectionNode.md) | +| `args`? | (`string` \| `number` \| `boolean` \| [`Type`](Type.Type.md))[] | + +#### Returns + +[`Type`](Type.Type.md) + +*** + +### resolveCompletions + +```ts +resolveCompletions(node): Map< string, TypeSpecCompletionItem > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`IdentifierNode`](Interface.IdentifierNode.md) | + +#### Returns + +`Map`< `string`, [`TypeSpecCompletionItem`](Interface.TypeSpecCompletionItem.md) \> + +*** + +### resolveIdentifier + +```ts +resolveIdentifier(node): undefined | Sym +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`IdentifierNode`](Interface.IdentifierNode.md) | + +#### Returns + +`undefined` \| [`Sym`](Interface.Sym.md) + +*** + +### resolveTypeReference + +```ts +resolveTypeReference(node): [undefined | Type, readonly Diagnostic[]] +``` + +Check and resolve a type for the given type reference node. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `node` | [`TypeReferenceNode`](Interface.TypeReferenceNode.md) | Node. | + +#### Returns + +[`undefined` \| [`Type`](Type.Type.md), *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] + +Resolved type and diagnostics if there was an error. + +*** + +### setUsingsForFile + +```ts +setUsingsForFile(file): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `file` | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerHost.md new file mode 100644 index 00000000000..d7220ec5c82 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerHost.md @@ -0,0 +1,267 @@ +--- +jsApi: true +title: "[I] CompilerHost" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `logSink` | [`LogSink`](Interface.LogSink.md) | - | +| `parseCache`? | `WeakMap`< [`SourceFile`](Interface.SourceFile.md), [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \> | Optional cache to reuse the results of parsing and binding across programs. | + +## Methods + +### fileURLToPath + +```ts +fileURLToPath(url): string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `url` | `string` | + +#### Returns + +`string` + +*** + +### getExecutionRoot + +```ts +getExecutionRoot(): string +``` + +#### Returns + +`string` + +*** + +### getJsImport + +```ts +getJsImport(path): Promise< Record< string, any > > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`< `Record`< `string`, `any` \> \> + +*** + +### getLibDirs + +```ts +getLibDirs(): string[] +``` + +#### Returns + +`string`[] + +*** + +### getSourceFileKind + +```ts +getSourceFileKind(path): undefined | SourceFileKind +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`undefined` \| [`SourceFileKind`](Type.SourceFileKind.md) + +*** + +### mkdirp + +```ts +mkdirp(path): Promise< undefined | string > +``` + +create directory recursively. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `path` | `string` | Path to the directory. | + +#### Returns + +`Promise`< `undefined` \| `string` \> + +*** + +### pathToFileURL + +```ts +pathToFileURL(path): string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`string` + +*** + +### readDir + +```ts +readDir(dir): Promise< string[] > +``` + +Read directory. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `dir` | `string` | + +#### Returns + +`Promise`< `string`[] \> + +list of file/directory in the given directory. Returns the name not the full path. + +*** + +### readFile + +```ts +readFile(path): Promise< SourceFile > +``` + +read a utf-8 or utf-8 with bom encoded file + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`< [`SourceFile`](Interface.SourceFile.md) \> + +*** + +### readUrl + +```ts +readUrl(url): Promise< SourceFile > +``` + +read a file at the given url. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `url` | `string` | + +#### Returns + +`Promise`< [`SourceFile`](Interface.SourceFile.md) \> + +*** + +### realpath + +```ts +realpath(path): Promise< string > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`< `string` \> + +*** + +### rm + +```ts +rm(path, options?): Promise< void > +``` + +Deletes a directory or file. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `path` | `string` | Path to the directory or file. | +| `options`? | [`RmOptions`](Interface.RmOptions.md) | - | + +#### Returns + +`Promise`< `void` \> + +*** + +### stat + +```ts +stat(path): Promise< {isDirectory: ; isFile: ;} > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`< \{`isDirectory`: ; `isFile`: ;} \> + +*** + +### writeFile + +```ts +writeFile(path, content): Promise< void > +``` + +Write the file. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `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/Interface.CompilerLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerLocationContext.md new file mode 100644 index 00000000000..0850e9c3986 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerLocationContext.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] CompilerLocationContext" + +--- +Built-in + +## Properties + +| Property | Type | +| :------ | :------ | +| `type` | `"compiler"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerOptions.md new file mode 100644 index 00000000000..5eb07d89720 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerOptions.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[I] CompilerOptions" + +--- +## Properties + +| 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](Interface.CompilerOptions.md#emit) and [options](Interface.CompilerOptions.md#options) instead.

Will be removed in March 2022 sprint. | +| `ignoreDeprecated`? | `boolean` | Suppress all `deprecated` warnings. | +| `linterRuleSet`? | [`LinterRuleSet`](Interface.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`](Interface.ParseOptions.md) | - | +| `trace`? | `string`[] | Trace area to enable. | +| `warningAsError`? | `boolean` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeclarationNode.md new file mode 100644 index 00000000000..3fcfe528c79 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeclarationNode.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[I] DeclarationNode" + +--- +## Extended By + +- [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) +- [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) +- [`OperationStatementNode`](Interface.OperationStatementNode.md) +- [`ModelStatementNode`](Interface.ModelStatementNode.md) +- [`ScalarStatementNode`](Interface.ScalarStatementNode.md) +- [`InterfaceStatementNode`](Interface.InterfaceStatementNode.md) +- [`UnionStatementNode`](Interface.UnionStatementNode.md) +- [`EnumStatementNode`](Interface.EnumStatementNode.md) +- [`AliasStatementNode`](Interface.AliasStatementNode.md) +- [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md) +- [`DecoratorDeclarationStatementNode`](Interface.DecoratorDeclarationStatementNode.md) +- [`FunctionDeclarationStatementNode`](Interface.FunctionDeclarationStatementNode.md) +- [`ProjectionParameterDeclarationNode`](Interface.ProjectionParameterDeclarationNode.md) +- [`ProjectionLambdaParameterDeclarationNode`](Interface.ProjectionLambdaParameterDeclarationNode.md) +- [`ProjectionStatementNode`](Interface.ProjectionStatementNode.md) +- [`JsSourceFileNode`](Interface.JsSourceFileNode.md) +- [`JsNamespaceDeclarationNode`](Interface.JsNamespaceDeclarationNode.md) + +## Properties + +| Property | Type | +| :------ | :------ | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratedType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratedType.md new file mode 100644 index 00000000000..caf20748a5d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratedType.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DecoratedType" + +--- +## Extended By + +- [`Model`](Interface.Model.md) +- [`ModelProperty`](Interface.ModelProperty.md) +- [`Scalar`](Interface.Scalar.md) +- [`Interface`](Interface.Interface.md) +- [`Enum`](Interface.Enum.md) +- [`EnumMember`](Interface.EnumMember.md) +- [`Operation`](Interface.Operation.md) +- [`Namespace`](Interface.Namespace.md) +- [`Union`](Interface.Union.md) +- [`UnionVariant`](Interface.UnionVariant.md) + +## Properties + +| Property | Type | +| :------ | :------ | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Decorator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Decorator.md new file mode 100644 index 00000000000..619425ea83b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Decorator.md @@ -0,0 +1,59 @@ +--- +jsApi: true +title: "[I] Decorator" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `implementation` | (...`args`) => `void` | - | +| `instantiationParameters`? | [`Type`](Type.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` | `"Decorator"` | - | +| `name` | \`@$\{string}\` | - | +| `namespace` | [`Namespace`](Interface.Namespace.md) | - | +| `node` | [`DecoratorDeclarationStatementNode`](Interface.DecoratorDeclarationStatementNode.md) | - | +| `parameters` | [`FunctionParameter`](Interface.FunctionParameter.md)[] | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `target` | [`FunctionParameter`](Interface.FunctionParameter.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorApplication.md new file mode 100644 index 00000000000..9edf692c459 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorApplication.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] DecoratorApplication" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `args` | [`DecoratorArgument`](Interface.DecoratorArgument.md)[] | +| `decorator` | [`DecoratorFunction`](Interface.DecoratorFunction.md) | +| `definition`? | [`Decorator`](Interface.Decorator.md) | +| `node`? | [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md) \| [`AugmentDecoratorStatementNode`](Interface.AugmentDecoratorStatementNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorArgument.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorArgument.md new file mode 100644 index 00000000000..07148c0b3e7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorArgument.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] DecoratorArgument" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `jsValue` | `string` \| `number` \| `boolean` \| [`Type`](Type.Type.md) | Marshalled value for use in Javascript. | +| `node`? | [`Node`](Type.Node.md) | - | +| `value` | [`Type`](Type.Type.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorContext.md new file mode 100644 index 00000000000..358c104ae05 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorContext.md @@ -0,0 +1,72 @@ +--- +jsApi: true +title: "[I] DecoratorContext" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `decoratorTarget` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | Point to the decorator target | +| `program` | [`Program`](Interface.Program.md) | - | + +## Methods + +### call + +```ts +call( + decorator, + target, + ...args): R +``` + +Helper to call out to another decorator + +#### Type parameters + +| Parameter | +| :------ | +| `T` *extends* [`Type`](Type.Type.md) | +| `A` *extends* `any`[] | +| `R` | + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `decorator` | (`context`, `target`, ...`args`) => `R` | Other decorator function | +| `target` | `T` | - | +| ...`args` | `A` | Args to pass to other decorator function | + +#### Returns + +`R` + +*** + +### getArgumentTarget + +```ts +getArgumentTarget(paramIndex): undefined | DiagnosticTarget +``` + +Function that can be used to retrieve the target for a parameter at the given index. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `paramIndex` | `number` | Parameter index in the typespec | + +#### Returns + +`undefined` \| [`DiagnosticTarget`](Type.DiagnosticTarget.md) + +#### Example + +```ts +@foo("bar", 123) -> $foo(context, target, arg0: string, arg1: number); + getArgumentTarget(0) -> target for arg0 + getArgumentTarget(1) -> target for arg1 +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDeclarationStatementNode.md new file mode 100644 index 00000000000..058008c901d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDeclarationStatementNode.md @@ -0,0 +1,34 @@ +--- +jsApi: true +title: "[I] DecoratorDeclarationStatementNode" + +--- +Represent a decorator declaration + +## Example + +```typespec +extern dec doc(target: Type, value: valueof string); +``` + +## Extends + +- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`DecoratorDeclarationStatement`](Enumeration.SyntaxKind.md#decoratordeclarationstatement) | - | +| `readonly` `modifierFlags` | [`ModifierFlags`](Enumeration.ModifierFlags.md) | - | +| `readonly` `modifiers` | *readonly* [`ExternKeywordNode`](Interface.ExternKeywordNode.md)[] | - | +| `readonly` `parameters` | [`FunctionParameterNode`](Interface.FunctionParameterNode.md)[] | Additional parameters | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`FunctionParameterNode`](Interface.FunctionParameterNode.md) | Decorator target. First parameter. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDefinition.md new file mode 100644 index 00000000000..8adac876035 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDefinition.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] DecoratorDefinition" + +--- +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` *extends* [`TypeKind`](Type.TypeKind.md) | - | +| `P` *extends* *readonly* [`DecoratorParamDefinition`](Interface.DecoratorParamDefinition.md)< [`TypeKind`](Type.TypeKind.md) \>[] | - | +| `S` *extends* [`DecoratorParamDefinition`](Interface.DecoratorParamDefinition.md)< [`TypeKind`](Type.TypeKind.md) \> \| `undefined` | `undefined` | + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `args` | `P` | List of positional arguments in the function. | +| `readonly` `name` | `string` | Name of the decorator. | +| `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/Interface.DecoratorExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorExpressionNode.md new file mode 100644 index 00000000000..214488f033b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorExpressionNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DecoratorExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `arguments` | *readonly* [`Expression`](Type.Expression.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`DecoratorExpression`](Enumeration.SyntaxKind.md#decoratorexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorFunction.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorFunction.md new file mode 100644 index 00000000000..0209eb7e6d6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorFunction.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[I] DecoratorFunction" + +--- +```ts +DecoratorFunction( + program, + target, + ...customArgs): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | `any` | +| ...`customArgs` | `any`[] | + +## Returns + +`void` + +## Properties + +| Property | Type | +| :------ | :------ | +| `namespace`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorParamDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorParamDefinition.md new file mode 100644 index 00000000000..9940cc6d4a7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorParamDefinition.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] DecoratorParamDefinition" + +--- +## Type parameters + +| Parameter | +| :------ | +| `K` *extends* [`TypeKind`](Type.TypeKind.md) | + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `kind` | `K` \| *readonly* `K`[] | Kind of the parameter | +| `optional`? | `boolean` | Is the parameter optional. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorValidator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorValidator.md new file mode 100644 index 00000000000..8731052121d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorValidator.md @@ -0,0 +1,35 @@ +--- +jsApi: true +title: "[I] DecoratorValidator" + +--- +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` *extends* [`TypeKind`](Type.TypeKind.md) | - | +| `P` *extends* *readonly* [`DecoratorParamDefinition`](Interface.DecoratorParamDefinition.md)< [`TypeKind`](Type.TypeKind.md) \>[] | - | +| `S` *extends* [`DecoratorParamDefinition`](Interface.DecoratorParamDefinition.md)< [`TypeKind`](Type.TypeKind.md) \> \| `undefined` | `undefined` | + +## Methods + +### validate + +```ts +validate( + context, + target, + parameters): boolean +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`InferredTypeSpecValue`](Type.InferredTypeSpecValue.md)< `T` \> | +| `parameters` | `InferParameters`< `P`, `S` \> | + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeprecatedDirective.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeprecatedDirective.md new file mode 100644 index 00000000000..c5faa7ab3a5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeprecatedDirective.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] DeprecatedDirective" + +--- +## Extends + +- [`DirectiveBase`](Interface.DirectiveBase.md) + +## Properties + +| Property | Type | +| :------ | :------ | +| `message` | `string` | +| `name` | `"deprecated"` | +| `node` | [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeprecationDetails.md new file mode 100644 index 00000000000..b826f1f4cfe --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeprecationDetails.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] DeprecationDetails" + +--- +Provides details on the deprecation of a given type. + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `message` | `string` | The deprecation message to display when the type is used. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Diagnostic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Diagnostic.md new file mode 100644 index 00000000000..5298e186ef2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Diagnostic.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] Diagnostic" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | +| `severity` | [`DiagnosticSeverity`](Type.DiagnosticSeverity.md) | +| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) \| *typeof* [`NoTarget`](Variable.NoTarget.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCollector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCollector.md new file mode 100644 index 00000000000..2ba901a037c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCollector.md @@ -0,0 +1,90 @@ +--- +jsApi: true +title: "[I] DiagnosticCollector" + +--- +Helper object to collect diagnostics from function following the diagnostics accessor pattern(foo() => [T, Diagnostic[]]) + +## Properties + +| Property | Type | +| :------ | :------ | +| `readonly` `diagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | + +## Methods + +### add + +```ts +add(diagnostic): void +``` + +Add a diagnostic to the collection + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `diagnostic` | [`Diagnostic`](Interface.Diagnostic.md) | Diagnostic to add. | + +#### Returns + +`void` + +*** + +### pipe + +```ts +pipe(result): T +``` + +Unwrap the Diagnostic result, add all the diagnostics and return the data. + +#### Type parameters + +| Parameter | +| :------ | +| `T` | + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `result` | [`DiagnosticResult`](Type.DiagnosticResult.md)< `T` \> | Accessor diagnostic result | + +#### Returns + +`T` + +*** + +### wrap + +```ts +wrap(value): DiagnosticResult< T > +``` + +Wrap the given value in a tuple including the diagnostics following the TypeSpec accessor pattern. + +#### Type parameters + +| Parameter | +| :------ | +| `T` | + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `value` | `T` | Accessor value to return | + +#### Returns + +[`DiagnosticResult`](Type.DiagnosticResult.md)< `T` \> + +#### Example + +```ts +return diagnostics.wrap(routes); +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCreator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCreator.md new file mode 100644 index 00000000000..e4fcac425e5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCreator.md @@ -0,0 +1,68 @@ +--- +jsApi: true +title: "[I] DiagnosticCreator" + +--- +## Type parameters + +| Parameter | +| :------ | +| `T` *extends* \{} | + +## Properties + +| Property | Type | +| :------ | :------ | +| `readonly` `diagnostics` | [`DiagnosticMap`](Type.DiagnosticMap.md)< `T` \> | +| `readonly` `type` | `T` | + +## Methods + +### createDiagnostic + +```ts +createDiagnostic(diag): Diagnostic +``` + +#### Type parameters + +| Parameter | Default | +| :------ | :------ | +| `C` *extends* `string` \| `number` \| `symbol` | - | +| `M` *extends* `string` \| `number` \| `symbol` | `"default"` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diag` | [`DiagnosticReport`](Type.DiagnosticReport.md)< `T`, `C`, `M` \> | + +#### Returns + +[`Diagnostic`](Interface.Diagnostic.md) + +*** + +### reportDiagnostic + +```ts +reportDiagnostic(program, diag): void +``` + +#### Type parameters + +| Parameter | Default | +| :------ | :------ | +| `C` *extends* `string` \| `number` \| `symbol` | - | +| `M` *extends* `string` \| `number` \| `symbol` | `"default"` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `diag` | [`DiagnosticReport`](Type.DiagnosticReport.md)< `T`, `C`, `M` \> | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticDefinition.md new file mode 100644 index 00000000000..f99ffd6efa7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticDefinition.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] DiagnosticDefinition" + +--- +## Type parameters + +| Parameter | +| :------ | +| `M` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | + +## Properties + +| Property | Type | +| :------ | :------ | +| `readonly` `messages` | `M` | +| `readonly` `severity` | `"error"` \| `"warning"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticMessages.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticMessages.md new file mode 100644 index 00000000000..bdc460bb33f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticMessages.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[I] DiagnosticMessages" + +--- +## Indexable + + \[`messageId`: `string`\]: `string` \| [`CallableMessage`](Interface.CallableMessage.md)< `string`[] \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveBase.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveBase.md new file mode 100644 index 00000000000..e9dce2bd832 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveBase.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[I] DirectiveBase" + +--- +## Extended By + +- [`SuppressDirective`](Interface.SuppressDirective.md) +- [`DeprecatedDirective`](Interface.DeprecatedDirective.md) + +## Properties + +| Property | Type | +| :------ | :------ | +| `node` | [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveExpressionNode.md new file mode 100644 index 00000000000..7345d1de2bd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveExpressionNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DirectiveExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `arguments` | *readonly* [`DirectiveArgument`](Type.DirectiveArgument.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`DirectiveExpression`](Enumeration.SyntaxKind.md#directiveexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Dirent.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Dirent.md new file mode 100644 index 00000000000..1847e66d528 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Dirent.md @@ -0,0 +1,34 @@ +--- +jsApi: true +title: "[I] Dirent" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `name` | `string` | + +## Methods + +### isDirectory + +```ts +isDirectory(): boolean +``` + +#### Returns + +`boolean` + +*** + +### isFile + +```ts +isFile(): boolean +``` + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiscriminatedUnion.md new file mode 100644 index 00000000000..6d567f800e1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiscriminatedUnion.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] DiscriminatedUnion" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `propertyName` | `string` | +| `variants` | `Map`< `string`, [`Model`](Interface.Model.md) \> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocNode.md new file mode 100644 index 00000000000..f775bd5ea4e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DocNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `content` | *readonly* [`DocTextNode`](Interface.DocTextNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`Doc`](Enumeration.SyntaxKind.md#doc) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `tags` | *readonly* [`DocTag`](Type.DocTag.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocParamTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocParamTagNode.md new file mode 100644 index 00000000000..16c886b801a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocParamTagNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] DocParamTagNode" + +--- +## Extends + +- [`DocTagBaseNode`](Interface.DocTagBaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `content` | *readonly* [`DocTextNode`](Interface.DocTextNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`DocParamTag`](Enumeration.SyntaxKind.md#docparamtag) | - | +| `readonly` `paramName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `tagName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocReturnsTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocReturnsTagNode.md new file mode 100644 index 00000000000..0d35e59ec6c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocReturnsTagNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DocReturnsTagNode" + +--- +## Extends + +- [`DocTagBaseNode`](Interface.DocTagBaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `content` | *readonly* [`DocTextNode`](Interface.DocTextNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`DocReturnsTag`](Enumeration.SyntaxKind.md#docreturnstag) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `tagName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTagBaseNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTagBaseNode.md new file mode 100644 index 00000000000..eb4c34712d1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTagBaseNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DocTagBaseNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `content` | *readonly* [`DocTextNode`](Interface.DocTextNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`SyntaxKind`](Enumeration.SyntaxKind.md) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `tagName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTemplateTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTemplateTagNode.md new file mode 100644 index 00000000000..47b7d5073ef --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTemplateTagNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] DocTemplateTagNode" + +--- +## Extends + +- [`DocTagBaseNode`](Interface.DocTagBaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `content` | *readonly* [`DocTextNode`](Interface.DocTextNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`DocTemplateTag`](Enumeration.SyntaxKind.md#doctemplatetag) | - | +| `readonly` `paramName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `tagName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTextNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTextNode.md new file mode 100644 index 00000000000..cc77d7f9547 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTextNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] DocTextNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`DocText`](Enumeration.SyntaxKind.md#doctext) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `text` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocUnknownTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocUnknownTagNode.md new file mode 100644 index 00000000000..74bcd2488dc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocUnknownTagNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DocUnknownTagNode" + +--- +## Extends + +- [`DocTagBaseNode`](Interface.DocTagBaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `content` | *readonly* [`DocTextNode`](Interface.DocTextNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`DocUnknownTag`](Enumeration.SyntaxKind.md#docunknowntag) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `tagName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmitContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmitContext.md new file mode 100644 index 00000000000..134eaf985f1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmitContext.md @@ -0,0 +1,44 @@ +--- +jsApi: true +title: "[I] EmitContext" + +--- +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `TOptions` *extends* `object` | `Record`< `string`, `never` \> | + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `emitterOutputDir` | `string` | Configured output dir for the emitter. Emitter should emit all output under that directory. | +| `options` | `TOptions` | Emitter custom options defined in createTypeSpecLibrary | +| `program` | [`Program`](Interface.Program.md) | TypeSpec Program. | + +## Methods + +### getAssetEmitter + +```ts +getAssetEmitter(TypeEmitterClass): AssetEmitter< T, TOptions > +``` + +Get an asset emitter to write emitted output to disk using a TypeEmitter + +#### Type parameters + +| Parameter | +| :------ | +| `T` | + +#### Parameters + +| 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/Interface.EmitFileOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmitFileOptions.md new file mode 100644 index 00000000000..3c19d0cb53e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmitFileOptions.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] EmitFileOptions" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `content` | `string` | +| `newLine`? | [`NewLine`](Type.NewLine.md) | +| `path` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmptyStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmptyStatementNode.md new file mode 100644 index 00000000000..dd327a6393f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmptyStatementNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] EmptyStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`EmptyStatement`](Enumeration.SyntaxKind.md#emptystatement) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.Enum.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Enum.md new file mode 100644 index 00000000000..3142d73270d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Enum.md @@ -0,0 +1,58 @@ +--- +jsApi: true +title: "[I] Enum" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | +| `instantiationParameters`? | [`Type`](Type.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` | `"Enum"` | - | +| `members` | `RekeyableMap`< `string`, [`EnumMember`](Interface.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`](Interface.Namespace.md) | - | +| `node` | [`EnumStatementNode`](Interface.EnumStatementNode.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMember.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMember.md new file mode 100644 index 00000000000..98265435b6e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMember.md @@ -0,0 +1,59 @@ +--- +jsApi: true +title: "[I] EnumMember" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | +| `enum` | [`Enum`](Interface.Enum.md) | - | +| `instantiationParameters`? | [`Type`](Type.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` | `"EnumMember"` | - | +| `name` | `string` | - | +| `node` | [`EnumMemberNode`](Interface.EnumMemberNode.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `sourceMember`? | [`EnumMember`](Interface.EnumMember.md) | when spread operators make new enum members,
this tracks the enum member we copied from. | +| `value`? | `string` \| `number` | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMemberNode.md new file mode 100644 index 00000000000..203b4697a1d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMemberNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] EnumMemberNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`EnumMember`](Enumeration.SyntaxKind.md#enummember) | - | +| `parent`? | [`EnumStatementNode`](Interface.EnumStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `value`? | [`StringLiteralNode`](Interface.StringLiteralNode.md) \| [`NumericLiteralNode`](Interface.NumericLiteralNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumSpreadMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumSpreadMemberNode.md new file mode 100644 index 00000000000..b6dd4a258fa --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumSpreadMemberNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] EnumSpreadMemberNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`EnumSpreadMember`](Enumeration.SyntaxKind.md#enumspreadmember) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`TypeReferenceNode`](Interface.TypeReferenceNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumStatementNode.md new file mode 100644 index 00000000000..ea4a30bdcea --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumStatementNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] EnumStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`EnumStatement`](Enumeration.SyntaxKind.md#enumstatement) | - | +| `readonly` `members` | *readonly* ([`EnumMemberNode`](Interface.EnumMemberNode.md) \| [`EnumSpreadMemberNode`](Interface.EnumSpreadMemberNode.md))[] | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ErrorType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ErrorType.md new file mode 100644 index 00000000000..e73fe85e89a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ErrorType.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[I] ErrorType" + +--- +## Extends + +- [`IntrinsicType`](Interface.IntrinsicType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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` | `"Intrinsic"` | - | +| `name` | `"ErrorType"` | - | +| `node`? | [`Node`](Type.Node.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`IntrinsicType`](Interface.IntrinsicType.md).[`projections`](Interface.IntrinsicType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`IntrinsicType`](Interface.IntrinsicType.md).[`projectionsByName`](Interface.IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ExternKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ExternKeywordNode.md new file mode 100644 index 00000000000..b63a5e24f16 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ExternKeywordNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ExternKeywordNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ExternKeyword`](Enumeration.SyntaxKind.md#externkeyword) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.FileLibraryMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FileLibraryMetadata.md new file mode 100644 index 00000000000..9a4e443908f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FileLibraryMetadata.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[I] FileLibraryMetadata" + +--- +## Extends + +- `LibraryMetadataBase` + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `bugs`? | `object` | - | +| `bugs.url`? | `string` | Url where to file bugs for this library. | +| `homepage`? | `string` | Library homepage. | +| `name`? | `string` | Library name as specified in the package.json or in exported $lib. | +| `type` | `"file"` | - | +| `version`? | `string` | Library version | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionDeclarationStatementNode.md new file mode 100644 index 00000000000..9bf566cd98c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionDeclarationStatementNode.md @@ -0,0 +1,34 @@ +--- +jsApi: true +title: "[I] FunctionDeclarationStatementNode" + +--- +Represent a function declaration + +## Example + +```typespec +extern fn camelCase(value: StringLiteral): StringLiteral; +``` + +## Extends + +- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`FunctionDeclarationStatement`](Enumeration.SyntaxKind.md#functiondeclarationstatement) | - | +| `readonly` `modifierFlags` | [`ModifierFlags`](Enumeration.ModifierFlags.md) | - | +| `readonly` `modifiers` | *readonly* [`ExternKeywordNode`](Interface.ExternKeywordNode.md)[] | - | +| `readonly` `parameters` | [`FunctionParameterNode`](Interface.FunctionParameterNode.md)[] | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `returnType`? | [`Expression`](Type.Expression.md) | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.FunctionParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameter.md new file mode 100644 index 00000000000..8ec9469a5b2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameter.md @@ -0,0 +1,58 @@ +--- +jsApi: true +title: "[I] FunctionParameter" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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` | `"FunctionParameter"` | - | +| `name` | `string` | - | +| `node` | [`FunctionParameterNode`](Interface.FunctionParameterNode.md) | - | +| `optional` | `boolean` | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `rest` | `boolean` | - | +| `type` | [`Type`](Type.Type.md) \| [`ValueType`](Interface.ValueType.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameterNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameterNode.md new file mode 100644 index 00000000000..710499fcf5b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameterNode.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[I] FunctionParameterNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`FunctionParameter`](Enumeration.SyntaxKind.md#functionparameter) | - | +| `readonly` `optional` | `boolean` | Parameter defined with `?` | +| `parent`? | [`Node`](Type.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. | +| `readonly` `rest` | `boolean` | Parameter defined with `...` notation. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `type`? | [`Expression`](Type.Expression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionType.md new file mode 100644 index 00000000000..83d61c03908 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionType.md @@ -0,0 +1,59 @@ +--- +jsApi: true +title: "[I] FunctionType" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `implementation` | (...`args`) => `unknown` | - | +| `instantiationParameters`? | [`Type`](Type.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` | `"Function"` | - | +| `name` | `string` | - | +| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | +| `node`? | [`FunctionDeclarationStatementNode`](Interface.FunctionDeclarationStatementNode.md) | - | +| `parameters` | [`FunctionParameter`](Interface.FunctionParameter.md)[] | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `returnType` | [`Type`](Type.Type.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierContext.md new file mode 100644 index 00000000000..db5daaff30a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierContext.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] IdentifierContext" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `kind` | [`IdentifierKind`](Enumeration.IdentifierKind.md) | +| `node` | [`Node`](Type.Node.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierNode.md new file mode 100644 index 00000000000..bbd0f1f78b2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] IdentifierNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`Identifier`](Enumeration.SyntaxKind.md#identifier) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `sv` | `string` | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ImportStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ImportStatementNode.md new file mode 100644 index 00000000000..fa14f72a128 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ImportStatementNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ImportStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ImportStatement`](Enumeration.SyntaxKind.md#importstatement) | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | - | +| `readonly` `path` | [`StringLiteralNode`](Interface.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.Interface.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Interface.md new file mode 100644 index 00000000000..322a0bfec36 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Interface.md @@ -0,0 +1,63 @@ +--- +jsApi: true +title: "[I] Interface" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md).[`TemplatedTypeBase`](Interface.TemplatedTypeBase.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | +| `instantiationParameters`? | [`Type`](Type.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` | `"Interface"` | - | +| `name` | `string` | - | +| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | +| `node` | [`InterfaceStatementNode`](Interface.InterfaceStatementNode.md) | - | +| `operations` | `RekeyableMap`< `string`, [`Operation`](Interface.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.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `sourceInterfaces` | [`Interface`](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](Interface.Model.md) to
[baseModel](Interface.ArrayModelType.md#basemodel). Operations from extended interfaces are copied
into [operations](Interface.Interface.md#operations). | +| `symbol`? | [`Sym`](Interface.Sym.md) | Late-bound symbol of this interface type. | +| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

use templateMapper instead. | +| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | +| `templateNode`? | [`Node`](Type.Node.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InterfaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InterfaceStatementNode.md new file mode 100644 index 00000000000..eb3baf3e126 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InterfaceStatementNode.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[I] InterfaceStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md).[`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `extends` | *readonly* [`TypeReferenceNode`](Interface.TypeReferenceNode.md)[] | - | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`InterfaceStatement`](Enumeration.SyntaxKind.md#interfacestatement) | - | +| `locals`? | `SymbolTable` | - | +| `readonly` `operations` | *readonly* [`OperationStatementNode`](Interface.OperationStatementNode.md)[] | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntersectionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntersectionExpressionNode.md new file mode 100644 index 00000000000..5f0a882d9a9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntersectionExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] IntersectionExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`IntersectionExpression`](Enumeration.SyntaxKind.md#intersectionexpression) | - | +| `readonly` `options` | *readonly* [`Expression`](Type.Expression.md)[] | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.IntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntrinsicType.md new file mode 100644 index 00000000000..077d1fa82bc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntrinsicType.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[I] IntrinsicType" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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` | `"Intrinsic"` | - | +| `name` | `"unknown"` \| `"never"` \| `"null"` \| `"void"` \| `"ErrorType"` | - | +| `node`? | [`Node`](Type.Node.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InvalidStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InvalidStatementNode.md new file mode 100644 index 00000000000..0f60cd491f9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InvalidStatementNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] InvalidStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`InvalidStatement`](Enumeration.SyntaxKind.md#invalidstatement) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.JSONSchemaValidator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JSONSchemaValidator.md new file mode 100644 index 00000000000..c327a58cefa --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JSONSchemaValidator.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[I] JSONSchemaValidator" + +--- +## Methods + +### validate + +```ts +validate(config, target): Diagnostic[] +``` + +Validate the configuration against its JSON Schema. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `config` | `unknown` | Configuration to validate. | +| `target` | [`SourceFile`](Interface.SourceFile.md) \| `YamlScript` \| *typeof* [`NoTarget`](Variable.NoTarget.md) | Source file target to use for diagnostics. | + +#### Returns + +[`Diagnostic`](Interface.Diagnostic.md)[] + +Diagnostics produced by schema validation of the configuration. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsNamespaceDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsNamespaceDeclarationNode.md new file mode 100644 index 00000000000..74b0c91bee0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsNamespaceDeclarationNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] JsNamespaceDeclarationNode" + +--- +## Extends + +- [`DeclarationNode`](Interface.DeclarationNode.md).[`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`JsNamespaceDeclaration`](Enumeration.SyntaxKind.md#jsnamespacedeclaration) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.JsSourceFileNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsSourceFileNode.md new file mode 100644 index 00000000000..60cf614fc9b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsSourceFileNode.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[I] JsSourceFileNode" + +--- +## Extends + +- [`DeclarationNode`](Interface.DeclarationNode.md).[`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `esmExports` | `any` | - | +| `readonly` `file` | [`SourceFile`](Interface.SourceFile.md) | - | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`JsSourceFile`](Enumeration.SyntaxKind.md#jssourcefile) | - | +| `readonly` `namespaceSymbols` | [`Sym`](Interface.Sym.md)[] | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.LibraryInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryInstance.md new file mode 100644 index 00000000000..f773d3610b8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryInstance.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] LibraryInstance" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `definition`? | [`TypeSpecLibrary`](Interface.TypeSpecLibrary.md)< `any`, `Record`< `string`, `never` \> \> | +| `entrypoint` | `undefined` \| [`JsSourceFileNode`](Interface.JsSourceFileNode.md) | +| `metadata` | [`LibraryMetadata`](Type.LibraryMetadata.md) | +| `module` | [`ModuleResolutionResult`](Type.ModuleResolutionResult.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryLocationContext.md new file mode 100644 index 00000000000..0d048fe4b44 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryLocationContext.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] LibraryLocationContext" + +--- +Defined in a library. + +## Properties + +| Property | Type | +| :------ | :------ | +| `metadata` | [`ModuleLibraryMetadata`](Interface.ModuleLibraryMetadata.md) | +| `type` | `"library"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LineAndCharacter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LineAndCharacter.md new file mode 100644 index 00000000000..908afd3e562 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LineAndCharacter.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[I] LineAndCharacter" + +--- +Identifies the position within a source file by line number and offset from +beginning of line. + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `character` | `number` | The offset in UTF-16 code units to the character from the beginning of the
line. 0-based.

NOTE: This is not necessarily the same as what a given text editor might
call the "column". Tabs, combining characters, surrogate pairs, and so on
can all cause an editor to report the column differently. Indeed, different
text editors report different column numbers for the same position in a
given document. | +| `line` | `number` | The line number. 0-based. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LineComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LineComment.md new file mode 100644 index 00000000000..71ec42ac29e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LineComment.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] LineComment" + +--- +## Extends + +- [`TextRange`](Interface.TextRange.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `kind` | [`LineComment`](Enumeration.SyntaxKind.md#linecomment) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterDefinition.md new file mode 100644 index 00000000000..fc648fb4f68 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterDefinition.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] LinterDefinition" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `ruleSets`? | `Record`< `string`, [`LinterRuleSet`](Interface.LinterRuleSet.md) \> | +| `rules` | [`LinterRuleDefinition`](Interface.LinterRuleDefinition.md)< `string`, [`DiagnosticMessages`](Interface.DiagnosticMessages.md) \>[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRule.md new file mode 100644 index 00000000000..c9a2a185489 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRule.md @@ -0,0 +1,49 @@ +--- +jsApi: true +title: "[I] LinterRule" + +--- +Resolved instance of a linter rule that will run. + +## Extends + +- [`LinterRuleDefinition`](Interface.LinterRuleDefinition.md)< `N`, `DM` \> + +## Type parameters + +| Parameter | +| :------ | +| `N` *extends* `string` | +| `DM` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `description` | `string` | - | +| `id` | `string` | Expanded rule id in format `:` | +| `messages` | `DM` | - | +| `name` | `N` | - | +| `severity` | `"warning"` | - | + +## Methods + +### create + +```ts +create(context): SemanticNodeListener +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`LinterRuleContext`](Interface.LinterRuleContext.md)< `DM` \> | + +#### Returns + +[`SemanticNodeListener`](Type.SemanticNodeListener.md) + +#### Inherited from + +[`LinterRuleDefinition`](Interface.LinterRuleDefinition.md).[`create`](Interface.LinterRuleDefinition.md#create) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleContext.md new file mode 100644 index 00000000000..b3eb8cbf3ce --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleContext.md @@ -0,0 +1,40 @@ +--- +jsApi: true +title: "[I] LinterRuleContext" + +--- +## Type parameters + +| Parameter | +| :------ | +| `DM` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | + +## Properties + +| Property | Type | +| :------ | :------ | +| `readonly` `program` | [`Program`](Interface.Program.md) | + +## Methods + +### reportDiagnostic + +```ts +reportDiagnostic(diag): void +``` + +#### Type parameters + +| Parameter | +| :------ | +| `M` *extends* `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diag` | [`LinterRuleDiagnosticReport`](Type.LinterRuleDiagnosticReport.md)< `DM`, `M` \> | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleDefinition.md new file mode 100644 index 00000000000..2fa4aa78dbc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleDefinition.md @@ -0,0 +1,42 @@ +--- +jsApi: true +title: "[I] LinterRuleDefinition" + +--- +## Extended By + +- [`LinterRule`](Interface.LinterRule.md) + +## Type parameters + +| Parameter | +| :------ | +| `N` *extends* `string` | +| `DM` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | + +## Properties + +| Property | Type | +| :------ | :------ | +| `description` | `string` | +| `messages` | `DM` | +| `name` | `N` | +| `severity` | `"warning"` | + +## Methods + +### create + +```ts +create(context): SemanticNodeListener +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`LinterRuleContext`](Interface.LinterRuleContext.md)< `DM` \> | + +#### Returns + +[`SemanticNodeListener`](Type.SemanticNodeListener.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleSet.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleSet.md new file mode 100644 index 00000000000..91bd0e0cc47 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleSet.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] LinterRuleSet" + +--- +## Properties + +| 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 | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ListOperationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ListOperationOptions.md new file mode 100644 index 00000000000..86c678fe2c3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ListOperationOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] ListOperationOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `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/Interface.LogInfo.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LogInfo.md new file mode 100644 index 00000000000..09cff0ca36a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LogInfo.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] LogInfo" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `code`? | `string` | +| `level` | [`LogLevel`](Type.LogLevel.md) | +| `message` | `string` | +| `target`? | [`DiagnosticTarget`](Type.DiagnosticTarget.md) \| *typeof* [`NoTarget`](Variable.NoTarget.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LogSink.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LogSink.md new file mode 100644 index 00000000000..7cde25780bb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LogSink.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] LogSink" + +--- +## Methods + +### log + +```ts +log(log): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `log` | [`ProcessedLog`](Interface.ProcessedLog.md) | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Logger.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Logger.md new file mode 100644 index 00000000000..39c03b43559 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Logger.md @@ -0,0 +1,76 @@ +--- +jsApi: true +title: "[I] Logger" + +--- +## Methods + +### error + +```ts +error(message): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `message` | `string` | + +#### Returns + +`void` + +*** + +### log + +```ts +log(log): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `log` | [`LogInfo`](Interface.LogInfo.md) | + +#### Returns + +`void` + +*** + +### trace + +```ts +trace(message): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `message` | `string` | + +#### Returns + +`void` + +*** + +### warn + +```ts +warn(message): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `message` | `string` | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.MemberExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.MemberExpressionNode.md new file mode 100644 index 00000000000..e1abe7a5da7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.MemberExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] MemberExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `base` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`MemberExpression`](Enumeration.SyntaxKind.md#memberexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `selector` | `"."` \| `"::"` | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.Model.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Model.md new file mode 100644 index 00000000000..595d5d5f41a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Model.md @@ -0,0 +1,66 @@ +--- +jsApi: true +title: "[I] Model" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md).[`TemplatedTypeBase`](Interface.TemplatedTypeBase.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `baseModel`? | [`Model`](Interface.Model.md) | Model this model extends. This represent inheritance. | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | +| `derivedModels` | [`Model`](Interface.Model.md)[] | Direct children. This is the reverse relation of [baseModel](Interface.ArrayModelType.md#basemodel) | +| `indexer`? | [`ModelIndexer`](Type.ModelIndexer.md) | - | +| `instantiationParameters`? | [`Type`](Type.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` | `"Model"` | - | +| `name` | `string` | - | +| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | +| `node`? | [`ModelStatementNode`](Interface.ModelStatementNode.md) \| [`ModelExpressionNode`](Interface.ModelExpressionNode.md) \| [`IntersectionExpressionNode`](Interface.IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](Interface.ProjectionModelExpressionNode.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `properties` | `RekeyableMap`< `string`, [`ModelProperty`](Interface.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](Function.walkPropertiesInherited.md) to enumerate all properties in the
inheritance hierarchy. | +| `sourceModel`? | [`Model`](Interface.Model.md) | The model that is referenced via `model is`. | +| `symbol`? | [`Sym`](Interface.Sym.md) | Late-bound symbol of this model type. | +| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

use templateMapper instead. | +| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | +| `templateNode`? | [`Node`](Type.Node.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelExpressionNode.md new file mode 100644 index 00000000000..c75f2cd5fa0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ModelExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ModelExpression`](Enumeration.SyntaxKind.md#modelexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `properties` | ([`ModelPropertyNode`](Interface.ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](Interface.ModelSpreadPropertyNode.md))[] | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ModelProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelProperty.md new file mode 100644 index 00000000000..55b2fe01908 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelProperty.md @@ -0,0 +1,61 @@ +--- +jsApi: true +title: "[I] ModelProperty" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | +| `default`? | [`Type`](Type.Type.md) | - | +| `instantiationParameters`? | [`Type`](Type.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` | `"ModelProperty"` | - | +| `model`? | [`Model`](Interface.Model.md) | - | +| `name` | `string` | - | +| `node` | [`ModelPropertyNode`](Interface.ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](Interface.ModelSpreadPropertyNode.md) \| [`ProjectionModelPropertyNode`](Interface.ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](Interface.ProjectionModelSpreadPropertyNode.md) | - | +| `optional` | `boolean` | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `sourceProperty`? | [`ModelProperty`](Interface.ModelProperty.md) | - | +| `type` | [`Type`](Type.Type.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelPropertyNode.md new file mode 100644 index 00000000000..333f90e367f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelPropertyNode.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[I] ModelPropertyNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | +| `default`? | [`Expression`](Type.Expression.md) | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`ModelProperty`](Enumeration.SyntaxKind.md#modelproperty) | - | +| `readonly` `optional` | `boolean` | - | +| `parent`? | [`ModelStatementNode`](Interface.ModelStatementNode.md) \| [`ModelExpressionNode`](Interface.ModelExpressionNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `value` | [`Expression`](Type.Expression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelSpreadPropertyNode.md new file mode 100644 index 00000000000..3a2ecf2072d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelSpreadPropertyNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ModelSpreadPropertyNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ModelSpreadProperty`](Enumeration.SyntaxKind.md#modelspreadproperty) | - | +| `parent`? | [`ModelStatementNode`](Interface.ModelStatementNode.md) \| [`ModelExpressionNode`](Interface.ModelExpressionNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`TypeReferenceNode`](Interface.TypeReferenceNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelStatementNode.md new file mode 100644 index 00000000000..66baba1706d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelStatementNode.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[I] ModelStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md).[`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `extends`? | [`Expression`](Type.Expression.md) | - | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `is`? | [`Expression`](Type.Expression.md) | - | +| `readonly` `kind` | [`ModelStatement`](Enumeration.SyntaxKind.md#modelstatement) | - | +| `locals`? | `SymbolTable` | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `properties` | *readonly* ([`ModelPropertyNode`](Interface.ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](Interface.ModelSpreadPropertyNode.md))[] | - | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModuleLibraryMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModuleLibraryMetadata.md new file mode 100644 index 00000000000..beb67925f2d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModuleLibraryMetadata.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ModuleLibraryMetadata" + +--- +Data for a library. Either loaded via a node_modules package or a standalone js file + +## Extends + +- `LibraryMetadataBase` + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `bugs`? | `object` | - | +| `bugs.url`? | `string` | Url where to file bugs for this library. | +| `homepage`? | `string` | Library homepage. | +| `name` | `string` | Library name as specified in the package.json or in exported $lib. | +| `type` | `"module"` | - | +| `version`? | `string` | Library version | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Namespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Namespace.md new file mode 100644 index 00000000000..e2c2845c2ae --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Namespace.md @@ -0,0 +1,66 @@ +--- +jsApi: true +title: "[I] Namespace" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `decoratorDeclarations` | `Map`< `string`, [`Decorator`](Interface.Decorator.md) \> | The decorators declared in the namespace.

Order is implementation-defined and may change. | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | +| `enums` | `Map`< `string`, [`Enum`](Interface.Enum.md) \> | The enums in the namespace.

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

Order is implementation-defined and may change. | +| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | +| `interfaces` | `Map`< `string`, [`Interface`](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) | +| `kind` | `"Namespace"` | - | +| `models` | `Map`< `string`, [`Model`](Interface.Model.md) \> | The models in the namespace.

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

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

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

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

Order is implementation-defined and may change. | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NamespaceNavigationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NamespaceNavigationOptions.md new file mode 100644 index 00000000000..164790c93e4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NamespaceNavigationOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] NamespaceNavigationOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `skipSubNamespaces`? | `boolean` | Recursively navigate sub namespaces.

**Default**

` false ` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NamespaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NamespaceStatementNode.md new file mode 100644 index 00000000000..330ea87038c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NamespaceStatementNode.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[I] NamespaceStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`NamespaceStatement`](Enumeration.SyntaxKind.md#namespacestatement) | - | +| `locals`? | `SymbolTable` | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `statements`? | [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) \| *readonly* [`Statement`](Type.Statement.md)[] | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.NavigationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NavigationOptions.md new file mode 100644 index 00000000000..fb9b16604c0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NavigationOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] NavigationOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `includeTemplateDeclaration`? | `boolean` | Skip non instantiated templates. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverKeywordNode.md new file mode 100644 index 00000000000..ef43549abec --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverKeywordNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] NeverKeywordNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`NeverKeyword`](Enumeration.SyntaxKind.md#neverkeyword) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.NeverType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverType.md new file mode 100644 index 00000000000..133dd290649 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverType.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[I] NeverType" + +--- +## Extends + +- [`IntrinsicType`](Interface.IntrinsicType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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` | `"Intrinsic"` | - | +| `name` | `"never"` | - | +| `node`? | [`Node`](Type.Node.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`IntrinsicType`](Interface.IntrinsicType.md).[`projections`](Interface.IntrinsicType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`IntrinsicType`](Interface.IntrinsicType.md).[`projectionsByName`](Interface.IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NodePackage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NodePackage.md new file mode 100644 index 00000000000..5cf75f5909c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NodePackage.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[I] NodePackage" + +--- +Type for package.json https://docs.npmjs.com/cli/v8/configuring-npm/package-json + +## Properties + +| Property | Type | +| :------ | :------ | +| `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"` | +| `version` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NullType.md new file mode 100644 index 00000000000..c3f85a362f5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NullType.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[I] NullType" + +--- +## Extends + +- [`IntrinsicType`](Interface.IntrinsicType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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` | `"Intrinsic"` | - | +| `name` | `"null"` | - | +| `node`? | [`Node`](Type.Node.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`IntrinsicType`](Interface.IntrinsicType.md).[`projections`](Interface.IntrinsicType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`IntrinsicType`](Interface.IntrinsicType.md).[`projectionsByName`](Interface.IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteral.md new file mode 100644 index 00000000000..0b088a741d6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteral.md @@ -0,0 +1,56 @@ +--- +jsApi: true +title: "[I] NumericLiteral" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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` | `"Number"` | - | +| `node`? | [`NumericLiteralNode`](Interface.NumericLiteralNode.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `value` | `number` | - | +| `valueAsString` | `string` | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteralNode.md new file mode 100644 index 00000000000..c450ebefc9d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteralNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] NumericLiteralNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`NumericLiteral`](Enumeration.SyntaxKind.md#numericliteral) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `value` | `number` | - | +| `readonly` `valueAsString` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ObjectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ObjectType.md new file mode 100644 index 00000000000..94b97f9bf49 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ObjectType.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[I] ObjectType" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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` | `"Object"` | - | +| `node`? | [`Node`](Type.Node.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `properties` | `Record`< `string`, [`Type`](Type.Type.md) \> | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Operation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Operation.md new file mode 100644 index 00000000000..25de67834db --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Operation.md @@ -0,0 +1,64 @@ +--- +jsApi: true +title: "[I] Operation" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md).[`TemplatedTypeBase`](Interface.TemplatedTypeBase.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | +| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | +| `interface`? | [`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) | +| `kind` | `"Operation"` | - | +| `name` | `string` | - | +| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | +| `node` | [`OperationStatementNode`](Interface.OperationStatementNode.md) | - | +| `parameters` | [`Model`](Interface.Model.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `returnType` | [`Type`](Type.Type.md) | - | +| `sourceOperation`? | [`Operation`](Interface.Operation.md) | The operation that is referenced via `op is`. | +| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

use templateMapper instead. | +| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | +| `templateNode`? | [`Node`](Type.Node.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureDeclarationNode.md new file mode 100644 index 00000000000..398bd7d3381 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureDeclarationNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] OperationSignatureDeclarationNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`OperationSignatureDeclaration`](Enumeration.SyntaxKind.md#operationsignaturedeclaration) | - | +| `readonly` `parameters` | [`ModelExpressionNode`](Interface.ModelExpressionNode.md) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `returnType` | [`Expression`](Type.Expression.md) | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.OperationSignatureReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureReferenceNode.md new file mode 100644 index 00000000000..5ce92957b08 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureReferenceNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] OperationSignatureReferenceNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `baseOperation` | [`TypeReferenceNode`](Interface.TypeReferenceNode.md) | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`OperationSignatureReference`](Enumeration.SyntaxKind.md#operationsignaturereference) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.OperationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationStatementNode.md new file mode 100644 index 00000000000..6ff3d7a4324 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationStatementNode.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[I] OperationStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md).[`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`OperationStatement`](Enumeration.SyntaxKind.md#operationstatement) | - | +| `locals`? | `SymbolTable` | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) \| [`InterfaceStatementNode`](Interface.InterfaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `signature` | [`OperationSignature`](Type.OperationSignature.md) | - | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ParseOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ParseOptions.md new file mode 100644 index 00000000000..b25dce3bc15 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ParseOptions.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] ParseOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `comments`? | `boolean` | When true, collect comment ranges in [comments](Interface.TypeSpecScriptNode.md#comments). | +| `docs`? | `boolean` | When true, parse doc comments into [docs](Interface.BaseNode.md#docs). | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProcessedLog.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProcessedLog.md new file mode 100644 index 00000000000..c1501285644 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProcessedLog.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] ProcessedLog" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `code`? | `string` | +| `level` | [`LogLevel`](Type.LogLevel.md) | +| `message` | `string` | +| `sourceLocation`? | [`SourceLocation`](Interface.SourceLocation.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Program.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Program.md new file mode 100644 index 00000000000..17061548814 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Program.md @@ -0,0 +1,252 @@ +--- +jsApi: true +title: "[I] Program" + +--- +## Extended By + +- [`ProjectedProgram`](Interface.ProjectedProgram.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `checker` | [`Checker`](Interface.Checker.md) | - | +| `compilerOptions` | [`CompilerOptions`](Interface.CompilerOptions.md) | - | +| `readonly` `diagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | - | +| `emitters` | `EmitterRef`[] | - | +| `host` | [`CompilerHost`](Interface.CompilerHost.md) | - | +| `jsSourceFiles` | `Map`< `string`, [`JsSourceFileNode`](Interface.JsSourceFileNode.md) \> | - | +| `literalTypes` | `Map`< `string` \| `number` \| `boolean`, [`LiteralType`](Type.LiteralType.md) \> | - | +| `mainFile`? | [`TypeSpecScriptNode`](Interface.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. | +| `sourceFiles` | `Map`< `string`, [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \> | All source files in the program, keyed by their file path. | +| `stateMaps` | `Map`< `symbol`, `StateMap` \> | - | +| `stateSets` | `Map`< `symbol`, `StateSet` \> | - | +| `tracer` | [`Tracer`](Interface.Tracer.md) | - | + +## Methods + +### getGlobalNamespaceType + +```ts +getGlobalNamespaceType(): Namespace +``` + +#### Returns + +[`Namespace`](Interface.Namespace.md) + +*** + +### getOption + +```ts +getOption(key): undefined | string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +`undefined` \| `string` + +*** + +### getSourceFileLocationContext + +```ts +getSourceFileLocationContext(sourceFile): LocationContext +``` + +Return location context of the given source file. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `sourceFile` | [`SourceFile`](Interface.SourceFile.md) | + +#### Returns + +[`LocationContext`](Type.LocationContext.md) + +*** + +### hasError + +```ts +hasError(): boolean +``` + +#### Returns + +`boolean` + +*** + +### loadTypeSpecScript + +```ts +loadTypeSpecScript(typespecScript): Promise< TypeSpecScriptNode > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typespecScript` | [`SourceFile`](Interface.SourceFile.md) | + +#### Returns + +`Promise`< [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \> + +*** + +### onValidate + +```ts +onValidate(cb, LibraryMetadata): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `cb` | (`program`) => `void` \| `Promise`< `void` \> | +| `LibraryMetadata` | [`LibraryMetadata`](Type.LibraryMetadata.md) | + +#### Returns + +`void` + +*** + +### reportDiagnostic + +```ts +reportDiagnostic(diagnostic): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostic` | [`Diagnostic`](Interface.Diagnostic.md) | + +#### Returns + +`void` + +*** + +### reportDiagnostics + +```ts +reportDiagnostics(diagnostics): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | + +#### Returns + +`void` + +*** + +### reportDuplicateSymbols + +```ts +reportDuplicateSymbols(symbols): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `symbols` | `undefined` \| `SymbolTable` | + +#### Returns + +`void` + +*** + +### resolveTypeReference + +```ts +resolveTypeReference(reference): [undefined | Type, readonly Diagnostic[]] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `reference` | `string` | + +#### Returns + +[`undefined` \| [`Type`](Type.Type.md), *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] + +*** + +### stateMap + +```ts +stateMap(key): Map< Type, any > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `symbol` | + +#### Returns + +`Map`< [`Type`](Type.Type.md), `any` \> + +*** + +### stateSet + +```ts +stateSet(key): Set< Type > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `symbol` | + +#### Returns + +`Set`< [`Type`](Type.Type.md) \> + +*** + +### trace + +```ts +trace(area, message): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `area` | `string` | +| `message` | `string` | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectLocationContext.md new file mode 100644 index 00000000000..7af9129aa41 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectLocationContext.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] ProjectLocationContext" + +--- +Defined in the user project. + +## Properties + +| Property | Type | +| :------ | :------ | +| `type` | `"project"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedNameView.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedNameView.md new file mode 100644 index 00000000000..8524c9571da --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedNameView.md @@ -0,0 +1,31 @@ +--- +jsApi: true +title: "[I] ProjectedNameView" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `program` | [`ProjectedProgram`](Interface.ProjectedProgram.md) | + +## Methods + +### getProjectedName + +```ts +getProjectedName(target): string +``` + +Get the name of the given entity in that scope. +If there is a projected name it returns that one otherwise return the original name. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | `Object` | + +#### Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedProgram.md new file mode 100644 index 00000000000..0a46f6c9881 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedProgram.md @@ -0,0 +1,305 @@ +--- +jsApi: true +title: "[I] ProjectedProgram" + +--- +## Extends + +- [`Program`](Interface.Program.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `checker` | [`Checker`](Interface.Checker.md) | - | +| `compilerOptions` | [`CompilerOptions`](Interface.CompilerOptions.md) | - | +| `readonly` `diagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | - | +| `emitters` | `EmitterRef`[] | - | +| `host` | [`CompilerHost`](Interface.CompilerHost.md) | - | +| `jsSourceFiles` | `Map`< `string`, [`JsSourceFileNode`](Interface.JsSourceFileNode.md) \> | - | +| `literalTypes` | `Map`< `string` \| `number` \| `boolean`, [`LiteralType`](Type.LiteralType.md) \> | - | +| `mainFile`? | [`TypeSpecScriptNode`](Interface.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. | +| `projector` | [`Projector`](Interface.Projector.md) | - | +| `sourceFiles` | `Map`< `string`, [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \> | All source files in the program, keyed by their file path. | +| `stateMaps` | `Map`< `symbol`, `StateMap` \> | - | +| `stateSets` | `Map`< `symbol`, `StateSet` \> | - | +| `tracer` | [`Tracer`](Interface.Tracer.md) | - | + +## Methods + +### getGlobalNamespaceType + +```ts +getGlobalNamespaceType(): Namespace +``` + +#### Returns + +[`Namespace`](Interface.Namespace.md) + +#### Inherited from + +[`Program`](Interface.Program.md).[`getGlobalNamespaceType`](Interface.Program.md#getglobalnamespacetype) + +*** + +### getOption + +```ts +getOption(key): undefined | string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`Program`](Interface.Program.md).[`getOption`](Interface.Program.md#getoption) + +*** + +### getSourceFileLocationContext + +```ts +getSourceFileLocationContext(sourceFile): LocationContext +``` + +Return location context of the given source file. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `sourceFile` | [`SourceFile`](Interface.SourceFile.md) | + +#### Returns + +[`LocationContext`](Type.LocationContext.md) + +#### Inherited from + +[`Program`](Interface.Program.md).[`getSourceFileLocationContext`](Interface.Program.md#getsourcefilelocationcontext) + +*** + +### hasError + +```ts +hasError(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +[`Program`](Interface.Program.md).[`hasError`](Interface.Program.md#haserror) + +*** + +### loadTypeSpecScript + +```ts +loadTypeSpecScript(typespecScript): Promise< TypeSpecScriptNode > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typespecScript` | [`SourceFile`](Interface.SourceFile.md) | + +#### Returns + +`Promise`< [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \> + +#### Inherited from + +[`Program`](Interface.Program.md).[`loadTypeSpecScript`](Interface.Program.md#loadtypespecscript) + +*** + +### onValidate + +```ts +onValidate(cb, LibraryMetadata): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `cb` | (`program`) => `void` \| `Promise`< `void` \> | +| `LibraryMetadata` | [`LibraryMetadata`](Type.LibraryMetadata.md) | + +#### Returns + +`void` + +#### Inherited from + +[`Program`](Interface.Program.md).[`onValidate`](Interface.Program.md#onvalidate) + +*** + +### reportDiagnostic + +```ts +reportDiagnostic(diagnostic): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostic` | [`Diagnostic`](Interface.Diagnostic.md) | + +#### Returns + +`void` + +#### Inherited from + +[`Program`](Interface.Program.md).[`reportDiagnostic`](Interface.Program.md#reportdiagnostic) + +*** + +### reportDiagnostics + +```ts +reportDiagnostics(diagnostics): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | + +#### Returns + +`void` + +#### Inherited from + +[`Program`](Interface.Program.md).[`reportDiagnostics`](Interface.Program.md#reportdiagnostics) + +*** + +### reportDuplicateSymbols + +```ts +reportDuplicateSymbols(symbols): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `symbols` | `undefined` \| `SymbolTable` | + +#### Returns + +`void` + +#### Inherited from + +[`Program`](Interface.Program.md).[`reportDuplicateSymbols`](Interface.Program.md#reportduplicatesymbols) + +*** + +### resolveTypeReference + +```ts +resolveTypeReference(reference): [undefined | Type, readonly Diagnostic[]] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `reference` | `string` | + +#### Returns + +[`undefined` \| [`Type`](Type.Type.md), *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] + +#### Inherited from + +[`Program`](Interface.Program.md).[`resolveTypeReference`](Interface.Program.md#resolvetypereference) + +*** + +### stateMap + +```ts +stateMap(key): Map< Type, any > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `symbol` | + +#### Returns + +`Map`< [`Type`](Type.Type.md), `any` \> + +#### Inherited from + +[`Program`](Interface.Program.md).[`stateMap`](Interface.Program.md#statemap) + +*** + +### stateSet + +```ts +stateSet(key): Set< Type > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `symbol` | + +#### Returns + +`Set`< [`Type`](Type.Type.md) \> + +#### Inherited from + +[`Program`](Interface.Program.md).[`stateSet`](Interface.Program.md#stateset) + +*** + +### trace + +```ts +trace(area, message): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `area` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[`Program`](Interface.Program.md).[`trace`](Interface.Program.md#trace) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projection.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projection.md new file mode 100644 index 00000000000..a5d0712386a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projection.md @@ -0,0 +1,56 @@ +--- +jsApi: true +title: "[I] Projection" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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` | `"Projection"` | - | +| `node` | `undefined` | - | +| `nodeByKind` | `Map`< `string`, [`ProjectionStatementNode`](Interface.ProjectionStatementNode.md) \> | - | +| `nodeByType` | `Map`< [`Type`](Type.Type.md), [`ProjectionStatementNode`](Interface.ProjectionStatementNode.md) \> | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionApplication.md new file mode 100644 index 00000000000..903c79966fc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionApplication.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] ProjectionApplication" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `arguments` | [`DecoratorArgumentValue`](Type.DecoratorArgumentValue.md)[] | +| `direction`? | `"to"` \| `"from"` | +| `projectionName` | `string` | +| `scope`? | [`Type`](Type.Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionArithmeticExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionArithmeticExpressionNode.md new file mode 100644 index 00000000000..18ea6df36ce --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionArithmeticExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionArithmeticExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionArithmeticExpression`](Enumeration.SyntaxKind.md#projectionarithmeticexpression) | - | +| `readonly` `left` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | +| `readonly` `op` | `"+"` \| `"-"` \| `"*"` \| `"/"` | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `right` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionBlockExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionBlockExpressionNode.md new file mode 100644 index 00000000000..a7197a56a91 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionBlockExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionBlockExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionBlockExpression`](Enumeration.SyntaxKind.md#projectionblockexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `statements` | [`ProjectionExpressionStatementNode`](Interface.ProjectionExpressionStatementNode.md)[] | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionCallExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionCallExpressionNode.md new file mode 100644 index 00000000000..115515b5f31 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionCallExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionCallExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `arguments` | [`ProjectionExpression`](Type.ProjectionExpression.md)[] | - | +| `readonly` `callKind` | `"method"` \| `"template"` | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionCallExpression`](Enumeration.SyntaxKind.md#projectioncallexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionDecoratorReferenceExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionDecoratorReferenceExpressionNode.md new file mode 100644 index 00000000000..b0ca698c5a8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionDecoratorReferenceExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionDecoratorReferenceExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionDecoratorReferenceExpression`](Enumeration.SyntaxKind.md#projectiondecoratorreferenceexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumMemberSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumMemberSelectorNode.md new file mode 100644 index 00000000000..b39b3952989 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumMemberSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionEnumMemberSelectorNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionEnumMemberSelector`](Enumeration.SyntaxKind.md#projectionenummemberselector) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionEnumSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumSelectorNode.md new file mode 100644 index 00000000000..96b6aa1453c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionEnumSelectorNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionEnumSelector`](Enumeration.SyntaxKind.md#projectionenumselector) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionEqualityExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEqualityExpressionNode.md new file mode 100644 index 00000000000..ca849a2a0a4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEqualityExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionEqualityExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionEqualityExpression`](Enumeration.SyntaxKind.md#projectionequalityexpression) | - | +| `readonly` `left` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | +| `readonly` `op` | `"=="` \| `"!="` | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `right` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionExpressionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionExpressionStatementNode.md new file mode 100644 index 00000000000..8411221e523 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionExpressionStatementNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionExpressionStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `expr` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionExpressionStatement`](Enumeration.SyntaxKind.md#projectionexpressionstatement) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionIfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionIfExpressionNode.md new file mode 100644 index 00000000000..3d3ab686f67 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionIfExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionIfExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `alternate`? | [`ProjectionIfExpressionNode`](Interface.ProjectionIfExpressionNode.md) \| [`ProjectionBlockExpressionNode`](Interface.ProjectionBlockExpressionNode.md) | - | +| `readonly` `consequent` | [`ProjectionBlockExpressionNode`](Interface.ProjectionBlockExpressionNode.md) | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionIfExpression`](Enumeration.SyntaxKind.md#projectionifexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `test` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionInterfaceSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionInterfaceSelectorNode.md new file mode 100644 index 00000000000..fd10db3868e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionInterfaceSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionInterfaceSelectorNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionInterfaceSelector`](Enumeration.SyntaxKind.md#projectioninterfaceselector) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionLambdaExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLambdaExpressionNode.md new file mode 100644 index 00000000000..f14e5191370 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLambdaExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionLambdaExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `body` | [`ProjectionBlockExpressionNode`](Interface.ProjectionBlockExpressionNode.md) | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionLambdaExpression`](Enumeration.SyntaxKind.md#projectionlambdaexpression) | - | +| `locals`? | `SymbolTable` | - | +| `readonly` `parameters` | *readonly* [`ProjectionLambdaParameterDeclarationNode`](Interface.ProjectionLambdaParameterDeclarationNode.md)[] | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionLambdaParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLambdaParameterDeclarationNode.md new file mode 100644 index 00000000000..2a14d424d4f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLambdaParameterDeclarationNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionLambdaParameterDeclarationNode" + +--- +## Extends + +- [`DeclarationNode`](Interface.DeclarationNode.md).[`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`ProjectionLambdaParameterDeclaration`](Enumeration.SyntaxKind.md#projectionlambdaparameterdeclaration) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionLogicalExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLogicalExpressionNode.md new file mode 100644 index 00000000000..7fa453116c3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLogicalExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionLogicalExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionLogicalExpression`](Enumeration.SyntaxKind.md#projectionlogicalexpression) | - | +| `readonly` `left` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | +| `readonly` `op` | "\|\|" \| `"&&"` | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `right` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionMemberExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionMemberExpressionNode.md new file mode 100644 index 00000000000..7fd144f5e0c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionMemberExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionMemberExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `base` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`ProjectionMemberExpression`](Enumeration.SyntaxKind.md#projectionmemberexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `selector` | `"."` \| `"::"` | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionModelExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelExpressionNode.md new file mode 100644 index 00000000000..0ce855ad02c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionModelExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionModelExpression`](Enumeration.SyntaxKind.md#projectionmodelexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `properties` | ([`ProjectionModelPropertyNode`](Interface.ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](Interface.ProjectionModelSpreadPropertyNode.md))[] | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionModelPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertyNode.md new file mode 100644 index 00000000000..36d349386fc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertyNode.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[I] ProjectionModelPropertyNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | +| `default`? | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`ProjectionModelProperty`](Enumeration.SyntaxKind.md#projectionmodelproperty) | - | +| `readonly` `optional` | `boolean` | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `value` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertySelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertySelectorNode.md new file mode 100644 index 00000000000..824360a1e4f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertySelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionModelPropertySelectorNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionModelPropertySelector`](Enumeration.SyntaxKind.md#projectionmodelpropertyselector) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionModelSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelSelectorNode.md new file mode 100644 index 00000000000..6a3d4d8e858 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionModelSelectorNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionModelSelector`](Enumeration.SyntaxKind.md#projectionmodelselector) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionModelSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelSpreadPropertyNode.md new file mode 100644 index 00000000000..777a0855966 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelSpreadPropertyNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionModelSpreadPropertyNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionModelSpreadProperty`](Enumeration.SyntaxKind.md#projectionmodelspreadproperty) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionNode.md new file mode 100644 index 00000000000..de8291a6ea8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionNode.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[I] ProjectionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `body` | *readonly* [`ProjectionExpressionStatementNode`](Interface.ProjectionExpressionStatementNode.md)[] | - | +| `readonly` `direction` | `"to"` \| `"from"` \| `"pre_to"` \| `"pre_from"` \| `""` | - | +| `readonly` `directionId` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`Projection`](Enumeration.SyntaxKind.md#projection) | - | +| `locals`? | `SymbolTable` | - | +| `readonly` `modifierIds` | *readonly* [`IdentifierNode`](Interface.IdentifierNode.md)[] | - | +| `readonly` `parameters` | [`ProjectionParameterDeclarationNode`](Interface.ProjectionParameterDeclarationNode.md)[] | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionOperationSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionOperationSelectorNode.md new file mode 100644 index 00000000000..7fc8178bfc4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionOperationSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionOperationSelectorNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionOperationSelector`](Enumeration.SyntaxKind.md#projectionoperationselector) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionParameterDeclarationNode.md new file mode 100644 index 00000000000..0fcfd1a397c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionParameterDeclarationNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionParameterDeclarationNode" + +--- +## Extends + +- [`DeclarationNode`](Interface.DeclarationNode.md).[`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`ProjectionParameterDeclaration`](Enumeration.SyntaxKind.md#projectionparameterdeclaration) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionReferenceNode.md new file mode 100644 index 00000000000..2b5b5d34a58 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionReferenceNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] ProjectionReferenceNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `arguments` | *readonly* [`Expression`](Type.Expression.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionReference`](Enumeration.SyntaxKind.md#projectionreference) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionRelationalExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionRelationalExpressionNode.md new file mode 100644 index 00000000000..90cb2e503fb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionRelationalExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionRelationalExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionRelationalExpression`](Enumeration.SyntaxKind.md#projectionrelationalexpression) | - | +| `readonly` `left` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | +| `readonly` `op` | `"<="` \| `">="` \| `"<"` \| `">"` | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `right` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionStatementNode.md new file mode 100644 index 00000000000..ecd01e3fd9a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionStatementNode.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[I] ProjectionStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `from`? | [`ProjectionNode`](Interface.ProjectionNode.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`ProjectionStatement`](Enumeration.SyntaxKind.md#projectionstatement) | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `preFrom`? | [`ProjectionNode`](Interface.ProjectionNode.md) | - | +| `preTo`? | [`ProjectionNode`](Interface.ProjectionNode.md) | - | +| `readonly` `projections` | *readonly* [`ProjectionNode`](Interface.ProjectionNode.md)[] | - | +| `readonly` `selector` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) \| [`ProjectionModelSelectorNode`](Interface.ProjectionModelSelectorNode.md) \| [`ProjectionModelPropertySelectorNode`](Interface.ProjectionModelPropertySelectorNode.md) \| [`ProjectionInterfaceSelectorNode`](Interface.ProjectionInterfaceSelectorNode.md) \| [`ProjectionOperationSelectorNode`](Interface.ProjectionOperationSelectorNode.md) \| [`ProjectionEnumSelectorNode`](Interface.ProjectionEnumSelectorNode.md) \| [`ProjectionEnumMemberSelectorNode`](Interface.ProjectionEnumMemberSelectorNode.md) \| [`ProjectionUnionSelectorNode`](Interface.ProjectionUnionSelectorNode.md) \| [`ProjectionUnionVariantSelectorNode`](Interface.ProjectionUnionVariantSelectorNode.md) | - | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `to`? | [`ProjectionNode`](Interface.ProjectionNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionTupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionTupleExpressionNode.md new file mode 100644 index 00000000000..557a8b45649 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionTupleExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionTupleExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionTupleExpression`](Enumeration.SyntaxKind.md#projectiontupleexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `values` | [`ProjectionExpression`](Type.ProjectionExpression.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnaryExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnaryExpressionNode.md new file mode 100644 index 00000000000..003e574543b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnaryExpressionNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] ProjectionUnaryExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionUnaryExpression`](Enumeration.SyntaxKind.md#projectionunaryexpression) | - | +| `readonly` `op` | `"!"` | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionSelectorNode.md new file mode 100644 index 00000000000..71a5107fbd4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionUnionSelectorNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionUnionSelector`](Enumeration.SyntaxKind.md#projectionunionselector) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ProjectionUnionVariantSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionVariantSelectorNode.md new file mode 100644 index 00000000000..033d5bd636a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionVariantSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionUnionVariantSelectorNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ProjectionUnionVariantSelector`](Enumeration.SyntaxKind.md#projectionunionvariantselector) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.Projector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projector.md new file mode 100644 index 00000000000..d4514e5a9f7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projector.md @@ -0,0 +1,32 @@ +--- +jsApi: true +title: "[I] Projector" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `parentProjector`? | [`Projector`](Interface.Projector.md) | +| `projectedGlobalNamespace`? | [`Namespace`](Interface.Namespace.md) | +| `projectedStartNode`? | [`Type`](Type.Type.md) | +| `projectedTypes` | `Map`< [`Type`](Type.Type.md), [`Type`](Type.Type.md) \> | +| `projections` | [`ProjectionApplication`](Interface.ProjectionApplication.md)[] | + +## Methods + +### projectType + +```ts +projectType(type): Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](Type.Type.md) | + +#### Returns + +[`Type`](Type.Type.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RecordModelType.md new file mode 100644 index 00000000000..0e7ba7d9b67 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RecordModelType.md @@ -0,0 +1,68 @@ +--- +jsApi: true +title: "[I] RecordModelType" + +--- +## Extends + +- [`Model`](Interface.Model.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `baseModel`? | [`Model`](Interface.Model.md) | Model this model extends. This represent inheritance. | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | +| `derivedModels` | [`Model`](Interface.Model.md)[] | Direct children. This is the reverse relation of [baseModel](Interface.ArrayModelType.md#basemodel) | +| `indexer` | `object` | - | +| `indexer.key` | [`Scalar`](Interface.Scalar.md) | - | +| `indexer.value` | [`Type`](Type.Type.md) | - | +| `instantiationParameters`? | [`Type`](Type.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` | `"Model"` | - | +| `name` | `string` | - | +| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | +| `node`? | [`ModelStatementNode`](Interface.ModelStatementNode.md) \| [`ModelExpressionNode`](Interface.ModelExpressionNode.md) \| [`IntersectionExpressionNode`](Interface.IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](Interface.ProjectionModelExpressionNode.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `properties` | `RekeyableMap`< `string`, [`ModelProperty`](Interface.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](Function.walkPropertiesInherited.md) to enumerate all properties in the
inheritance hierarchy. | +| `sourceModel`? | [`Model`](Interface.Model.md) | The model that is referenced via `model is`. | +| `symbol`? | [`Sym`](Interface.Sym.md) | Late-bound symbol of this model type. | +| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

use templateMapper instead. | +| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | +| `templateNode`? | [`Node`](Type.Node.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`Model`](Interface.Model.md).[`projections`](Interface.Model.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`Model`](Interface.Model.md).[`projectionsByName`](Interface.Model.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveCompilerOptionsOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveCompilerOptionsOptions.md new file mode 100644 index 00000000000..5e5b8905973 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveCompilerOptionsOptions.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[I] ResolveCompilerOptionsOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `args`? | `Record`< `string`, `string` \> | Any arguments to interpolate the config. | +| `configPath`? | `string` | Explicit config path. | +| `cwd`? | `string` | Current working directory. This will be used to interpolate `{cwd}` in the config.

**Default**

to `process.cwd()` | +| `entrypoint` | `string` | Absolute entrypoint path | +| `env`? | `Record`< `string`, `undefined` \| `string` \> | Environment variables.

**Default**

` process.env ` | +| `overrides`? | `Partial`< `TypeSpecConfig` \> | Compiler options to override the config | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveModuleHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveModuleHost.md new file mode 100644 index 00000000000..47795a4fde5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveModuleHost.md @@ -0,0 +1,64 @@ +--- +jsApi: true +title: "[I] ResolveModuleHost" + +--- +## Methods + +### readFile + +```ts +readFile(path): Promise< string > +``` + +Read a utf-8 encoded file. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`< `string` \> + +*** + +### realpath + +```ts +realpath(path): Promise< string > +``` + +Resolve the real path for the current host. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`< `string` \> + +*** + +### stat + +```ts +stat(path): Promise< {isDirectory: ; isFile: ;} > +``` + +Get information about the given path + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`< \{`isDirectory`: ; `isFile`: ;} \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveModuleOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveModuleOptions.md new file mode 100644 index 00000000000..664c9f1eda2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveModuleOptions.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] ResolveModuleOptions" + +--- +## Properties + +| 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` | When resolution reach package.json returns the path to the file relative to it.

**Default**

` pkg.main ` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedFile.md new file mode 100644 index 00000000000..23b4709d7c1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedFile.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] ResolvedFile" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `path` | `string` | +| `type` | `"file"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedModule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedModule.md new file mode 100644 index 00000000000..86b152549cf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedModule.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] ResolvedModule" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `mainFile` | `string` | Resolved main file for the module. | +| `manifest` | [`NodePackage`](Interface.NodePackage.md) | Value of package.json. | +| `path` | `string` | Root of the package. (Same level as package.json) | +| `type` | `"module"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnExpressionNode.md new file mode 100644 index 00000000000..4fecbbb63de --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ReturnExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`Return`](Enumeration.SyntaxKind.md#return) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `value` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnRecord.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnRecord.md new file mode 100644 index 00000000000..f6b70bdb3da --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnRecord.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] ReturnRecord" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `kind` | `"Return"` | +| `value` | [`Type`](Type.Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RmOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RmOptions.md new file mode 100644 index 00000000000..7599309b27b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RmOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] RmOptions" + +--- +## Properties + +| 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 ` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scalar.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scalar.md new file mode 100644 index 00000000000..b4d81a60f91 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scalar.md @@ -0,0 +1,63 @@ +--- +jsApi: true +title: "[I] Scalar" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md).[`TemplatedTypeBase`](Interface.TemplatedTypeBase.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `baseScalar`? | [`Scalar`](Interface.Scalar.md) | Scalar this scalar extends. | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | +| `derivedScalars` | [`Scalar`](Interface.Scalar.md)[] | Direct children. This is the reverse relation of

**See**

baseScalar | +| `instantiationParameters`? | [`Type`](Type.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` | `"Scalar"` | - | +| `name` | `string` | - | +| `namespace`? | [`Namespace`](Interface.Namespace.md) | Namespace the scalar was defined in. | +| `node` | [`ScalarStatementNode`](Interface.ScalarStatementNode.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `symbol`? | [`Sym`](Interface.Sym.md) | Late-bound symbol of this model type. | +| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

use templateMapper instead. | +| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | +| `templateNode`? | [`Node`](Type.Node.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ScalarStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ScalarStatementNode.md new file mode 100644 index 00000000000..21df4763e57 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ScalarStatementNode.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[I] ScalarStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md).[`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `extends`? | [`TypeReferenceNode`](Interface.TypeReferenceNode.md) | - | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`ScalarStatement`](Enumeration.SyntaxKind.md#scalarstatement) | - | +| `locals`? | `SymbolTable` | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scanner.md new file mode 100644 index 00000000000..3eb9cca8b09 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scanner.md @@ -0,0 +1,115 @@ +--- +jsApi: true +title: "[I] Scanner" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `file` | [`SourceFile`](Interface.SourceFile.md) | The source code being scanned. | +| `readonly` `position` | `number` | The offset in UTF-16 code units to the current position at the start of the next token. | +| `readonly` `token` | [`Token`](Enumeration.Token.md) | The current token | +| `readonly` `tokenFlags` | [`TokenFlags`](Enumeration.TokenFlags.md) | The flags on the current token. | +| `readonly` `tokenPosition` | `number` | The offset in UTF-16 code units to the start of the current token. | + +## Methods + +### eof + +```ts +eof(): boolean +``` + +Determine if the scanner has reached the end of the input. + +#### Returns + +`boolean` + +*** + +### getTokenText + +```ts +getTokenText(): string +``` + +The exact spelling of the current token. + +#### Returns + +`string` + +*** + +### getTokenValue + +```ts +getTokenValue(): string +``` + +The value of the current token. + +String literals are escaped and unquoted, identifiers are normalized, +and all other tokens return their exact spelling sames as +getTokenText(). + +#### Returns + +`string` + +*** + +### scan + +```ts +scan(): Token +``` + +Advance one token. + +#### Returns + +[`Token`](Enumeration.Token.md) + +*** + +### scanDoc + +```ts +scanDoc(): DocToken +``` + +Advance one token inside DocComment. Use inside [scanRange](Interface.Scanner.md#scanrange) callback over DocComment range. + +#### Returns + +[`DocToken`](Type.DocToken.md) + +*** + +### scanRange + +```ts +scanRange(range, callback): T +``` + +Reset the scanner to the given start and end positions, invoke the callback, and then restore scanner state. + +#### Type parameters + +| Parameter | +| :------ | +| `T` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `range` | [`TextRange`](Interface.TextRange.md) | +| `callback` | () => `T` | + +#### Returns + +`T` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SemanticToken.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SemanticToken.md new file mode 100644 index 00000000000..6f4c30c0ce7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SemanticToken.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] SemanticToken" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `end` | `number` | +| `kind` | [`SemanticTokenKind`](Enumeration.SemanticTokenKind.md) | +| `pos` | `number` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Server.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Server.md new file mode 100644 index 00000000000..0827c7ea2b0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Server.md @@ -0,0 +1,390 @@ +--- +jsApi: true +title: "[I] Server" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `readonly` `pendingMessages` | *readonly* `string`[] | +| `readonly` `workspaceFolders` | *readonly* [`ServerWorkspaceFolder`](Interface.ServerWorkspaceFolder.md)[] | + +## Methods + +### buildSemanticTokens + +```ts +buildSemanticTokens(params): Promise< SemanticTokens > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `SemanticTokensParams` | + +#### Returns + +`Promise`< `SemanticTokens` \> + +*** + +### checkChange + +```ts +checkChange(change): Promise< void > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `change` | `TextDocumentChangeEvent`< `TextDocument` \> | + +#### Returns + +`Promise`< `void` \> + +*** + +### compile + +```ts +compile(document): Promise< undefined | Program > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `document` | `TextDocument` \| `TextDocumentIdentifier` | + +#### Returns + +`Promise`< `undefined` \| [`Program`](Interface.Program.md) \> + +*** + +### complete + +```ts +complete(params): Promise< CompletionList > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `CompletionParams` | + +#### Returns + +`Promise`< `CompletionList` \> + +*** + +### documentClosed + +```ts +documentClosed(change): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `change` | `TextDocumentChangeEvent`< `TextDocument` \> | + +#### Returns + +`void` + +*** + +### findDocumentHighlight + +```ts +findDocumentHighlight(params): Promise< DocumentHighlight[] > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `DocumentHighlightParams` | + +#### Returns + +`Promise`< `DocumentHighlight`[] \> + +*** + +### findReferences + +```ts +findReferences(params): Promise< Location[] > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `ReferenceParams` | + +#### Returns + +`Promise`< `Location`[] \> + +*** + +### formatDocument + +```ts +formatDocument(params): Promise< TextEdit[] > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `DocumentFormattingParams` | + +#### Returns + +`Promise`< `TextEdit`[] \> + +*** + +### getDocumentSymbols + +```ts +getDocumentSymbols(params): Promise< DocumentSymbol[] > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `DocumentSymbolParams` | + +#### Returns + +`Promise`< `DocumentSymbol`[] \> + +*** + +### getFoldingRanges + +```ts +getFoldingRanges(getFoldingRanges): Promise< FoldingRange[] > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `getFoldingRanges` | `FoldingRangeParams` | + +#### Returns + +`Promise`< `FoldingRange`[] \> + +*** + +### getHover + +```ts +getHover(params): Promise< Hover > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `HoverParams` | + +#### Returns + +`Promise`< `Hover` \> + +*** + +### getSemanticTokens + +```ts +getSemanticTokens(params): Promise< SemanticToken[] > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `SemanticTokensParams` | + +#### Returns + +`Promise`< [`SemanticToken`](Interface.SemanticToken.md)[] \> + +*** + +### getSignatureHelp + +```ts +getSignatureHelp(params): Promise< undefined | SignatureHelp > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `SignatureHelpParams` | + +#### Returns + +`Promise`< `undefined` \| `SignatureHelp` \> + +*** + +### gotoDefinition + +```ts +gotoDefinition(params): Promise< Location[] > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `DefinitionParams` | + +#### Returns + +`Promise`< `Location`[] \> + +*** + +### initialize + +```ts +initialize(params): Promise< InitializeResult< any > > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `InitializeParams` | + +#### Returns + +`Promise`< `InitializeResult`< `any` \> \> + +*** + +### initialized + +```ts +initialized(params): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `InitializedParams` | + +#### Returns + +`void` + +*** + +### log + +```ts +log(message, details?): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `message` | `string` | +| `details`? | `any` | + +#### Returns + +`void` + +*** + +### prepareRename + +```ts +prepareRename(params): Promise< undefined | Range > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `PrepareRenameParams` | + +#### Returns + +`Promise`< `undefined` \| `Range` \> + +*** + +### rename + +```ts +rename(params): Promise< WorkspaceEdit > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `RenameParams` | + +#### Returns + +`Promise`< `WorkspaceEdit` \> + +*** + +### watchedFilesChanged + +```ts +watchedFilesChanged(params): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `DidChangeWatchedFilesParams` | + +#### Returns + +`void` + +*** + +### workspaceFoldersChanged + +```ts +workspaceFoldersChanged(e): Promise< void > +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `e` | `WorkspaceFoldersChangeEvent` | + +#### Returns + +`Promise`< `void` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerHost.md new file mode 100644 index 00000000000..5c27fd0c3d0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerHost.md @@ -0,0 +1,65 @@ +--- +jsApi: true +title: "[I] ServerHost" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `compilerHost` | [`CompilerHost`](Interface.CompilerHost.md) | +| `throwInternalErrors`? | `boolean` | + +## Methods + +### getOpenDocumentByURL + +```ts +getOpenDocumentByURL(url): undefined | TextDocument +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `url` | `string` | + +#### Returns + +`undefined` \| `TextDocument` + +*** + +### log + +```ts +log(message): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `message` | `string` | + +#### Returns + +`void` + +*** + +### sendDiagnostics + +```ts +sendDiagnostics(params): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `PublishDiagnosticsParams` | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerSourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerSourceFile.md new file mode 100644 index 00000000000..952a8d3bce9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerSourceFile.md @@ -0,0 +1,61 @@ +--- +jsApi: true +title: "[I] ServerSourceFile" + +--- +## Extends + +- [`SourceFile`](Interface.SourceFile.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `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. | +| `readonly` `text` | `string` | The source code text. | + +## Methods + +### getLineAndCharacterOfPosition + +```ts +getLineAndCharacterOfPosition(position): LineAndCharacter +``` + +Converts a one-dimensional position in the document (measured in UTF-16 +code units) to line number and offset from line start. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `position` | `number` | + +#### Returns + +[`LineAndCharacter`](Interface.LineAndCharacter.md) + +#### Inherited from + +[`SourceFile`](Interface.SourceFile.md).[`getLineAndCharacterOfPosition`](Interface.SourceFile.md#getlineandcharacterofposition) + +*** + +### getLineStarts + +```ts +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`[] + +#### Inherited from + +[`SourceFile`](Interface.SourceFile.md).[`getLineStarts`](Interface.SourceFile.md#getlinestarts) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerWorkspaceFolder.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerWorkspaceFolder.md new file mode 100644 index 00000000000..223df233301 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerWorkspaceFolder.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] ServerWorkspaceFolder" + +--- +## Extends + +- `WorkspaceFolder` + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | The name of the workspace folder. Used to refer to this
workspace folder in the user interface. | +| `path` | `string` | - | +| `uri` | `string` | The associated URI for this workspace folder. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceFile.md new file mode 100644 index 00000000000..ac03f2d94e4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceFile.md @@ -0,0 +1,52 @@ +--- +jsApi: true +title: "[I] SourceFile" + +--- +## Extended By + +- [`ServerSourceFile`](Interface.ServerSourceFile.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `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. | +| `readonly` `text` | `string` | The source code text. | + +## Methods + +### getLineAndCharacterOfPosition + +```ts +getLineAndCharacterOfPosition(position): LineAndCharacter +``` + +Converts a one-dimensional position in the document (measured in UTF-16 +code units) to line number and offset from line start. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `position` | `number` | + +#### Returns + +[`LineAndCharacter`](Interface.LineAndCharacter.md) + +*** + +### getLineStarts + +```ts +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/Interface.SourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceLocation.md new file mode 100644 index 00000000000..f010155f2e3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceLocation.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] SourceLocation" + +--- +## Extends + +- [`TextRange`](Interface.TextRange.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `file` | [`SourceFile`](Interface.SourceFile.md) | - | +| `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. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceLocationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceLocationOptions.md new file mode 100644 index 00000000000..2ca6fef0131 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceLocationOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] SourceLocationOptions" + +--- +## Properties + +| 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. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteral.md new file mode 100644 index 00000000000..62f6722416b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteral.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[I] StringLiteral" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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`? | [`StringLiteralNode`](Interface.StringLiteralNode.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `value` | `string` | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteralNode.md new file mode 100644 index 00000000000..08c49255a97 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteralNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] StringLiteralNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`StringLiteral`](Enumeration.SyntaxKind.md#stringliteral) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `value` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SuppressDirective.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SuppressDirective.md new file mode 100644 index 00000000000..90e85919287 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SuppressDirective.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] SuppressDirective" + +--- +## Extends + +- [`DirectiveBase`](Interface.DirectiveBase.md) + +## Properties + +| Property | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | +| `name` | `"suppress"` | +| `node` | [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Sym.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Sym.md new file mode 100644 index 00000000000..0440f53151f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Sym.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[I] Sym" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `declarations` | *readonly* [`Node`](Type.Node.md)[] | Nodes which contribute to this declaration | +| `exports`? | `SymbolTable` | Externally visible symbols contained inside this symbol. E.g. all declarations
in a namespace, or members of an enum. | +| `readonly` `flags` | [`SymbolFlags`](Enumeration.SymbolFlags.md) | - | +| `id`? | `number` | A unique identifier for this symbol. Used to look up the symbol links. | +| `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). | +| `metatypeMembers`? | `SymbolTable` | Symbol table | +| `readonly` `name` | `string` | The name of the symbol | +| `parent`? | [`Sym`](Interface.Sym.md) | The symbol containing this symbol, if any. E.g. for things declared in
a namespace, this refers to the namespace. | +| `symbolSource`? | [`Sym`](Interface.Sym.md) | For using symbols, this is the used symbol. | +| `type`? | [`Type`](Type.Type.md) | For late-bound symbols, this is the type referenced by the symbol. | +| `value`? | (...`args`) => `any` | For decorator and function symbols, this is the JS function implementation. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SymbolLinks.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SymbolLinks.md new file mode 100644 index 00000000000..18bbfa8110c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SymbolLinks.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] SymbolLinks" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `declaredType`? | [`Type`](Type.Type.md) | +| `instantiations`? | [`TypeInstantiationMap`](Interface.TypeInstantiationMap.md) | +| `type`? | [`Type`](Type.Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SyntheticLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SyntheticLocationContext.md new file mode 100644 index 00000000000..8fd539e649a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SyntheticLocationContext.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] SyntheticLocationContext" + +--- +Refer to a type that was not declared in a file + +## Properties + +| Property | Type | +| :------ | :------ | +| `type` | `"synthetic"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateDeclarationNode.md new file mode 100644 index 00000000000..e1f84cd95cc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateDeclarationNode.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[I] TemplateDeclarationNode" + +--- +## Extended By + +- [`OperationStatementNode`](Interface.OperationStatementNode.md) +- [`ModelStatementNode`](Interface.ModelStatementNode.md) +- [`ScalarStatementNode`](Interface.ScalarStatementNode.md) +- [`InterfaceStatementNode`](Interface.InterfaceStatementNode.md) +- [`UnionStatementNode`](Interface.UnionStatementNode.md) +- [`AliasStatementNode`](Interface.AliasStatementNode.md) + +## Properties + +| Property | Type | +| :------ | :------ | +| `locals`? | `SymbolTable` | +| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameter.md new file mode 100644 index 00000000000..ca5486435f7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameter.md @@ -0,0 +1,56 @@ +--- +jsApi: true +title: "[I] TemplateParameter" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `constraint`? | [`Type`](Type.Type.md) \| [`ValueType`](Interface.ValueType.md) | - | +| `default`? | [`Type`](Type.Type.md) | - | +| `instantiationParameters`? | [`Type`](Type.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` | `"TemplateParameter"` | - | +| `node` | [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameterDeclarationNode.md new file mode 100644 index 00000000000..62c6c2a285e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameterDeclarationNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] TemplateParameterDeclarationNode" + +--- +## Extends + +- [`DeclarationNode`](Interface.DeclarationNode.md).[`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `constraint`? | [`Expression`](Type.Expression.md) | - | +| `default`? | [`Expression`](Type.Expression.md) | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`TemplateParameterDeclaration`](Enumeration.SyntaxKind.md#templateparameterdeclaration) | - | +| `parent`? | [`TemplateableNode`](Type.TemplateableNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.TemplatedTypeBase.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplatedTypeBase.md new file mode 100644 index 00000000000..1a9b6dc2480 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplatedTypeBase.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[I] TemplatedTypeBase" + +--- +## Extended By + +- [`Model`](Interface.Model.md) +- [`Scalar`](Interface.Scalar.md) +- [`Interface`](Interface.Interface.md) +- [`Operation`](Interface.Operation.md) +- [`Union`](Interface.Union.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

use templateMapper instead. | +| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | +| `templateNode`? | [`Node`](Type.Node.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TextRange.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TextRange.md new file mode 100644 index 00000000000..6ebdc8f6eec --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TextRange.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] TextRange" + +--- +## Extended By + +- [`BaseNode`](Interface.BaseNode.md) +- [`LineComment`](Interface.LineComment.md) +- [`BlockComment`](Interface.BlockComment.md) +- [`SourceLocation`](Interface.SourceLocation.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tracer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tracer.md new file mode 100644 index 00000000000..27331e65a7f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tracer.md @@ -0,0 +1,47 @@ +--- +jsApi: true +title: "[I] Tracer" + +--- +## Methods + +### sub + +```ts +sub(subarea): Tracer +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `subarea` | `string` | + +#### Returns + +[`Tracer`](Interface.Tracer.md) + +*** + +### trace + +```ts +trace( + area, + message, + target?): void +``` + +Trace + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `area` | `string` | | +| `message` | `string` | | +| `target`? | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | - | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TracerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TracerOptions.md new file mode 100644 index 00000000000..b95aac96e56 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TracerOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] TracerOptions" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `filter`? | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tuple.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tuple.md new file mode 100644 index 00000000000..f9e9c1fbcd0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tuple.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[I] Tuple" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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` | `"Tuple"` | - | +| `node` | [`TupleExpressionNode`](Interface.TupleExpressionNode.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `values` | [`Type`](Type.Type.md)[] | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TupleExpressionNode.md new file mode 100644 index 00000000000..e3ecba2fa17 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TupleExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] TupleExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`TupleExpression`](Enumeration.SyntaxKind.md#tupleexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `values` | *readonly* [`Expression`](Type.Expression.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeInstantiationMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeInstantiationMap.md new file mode 100644 index 00000000000..dd2665c337d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeInstantiationMap.md @@ -0,0 +1,43 @@ +--- +jsApi: true +title: "[I] TypeInstantiationMap" + +--- +Maps type arguments to instantiated type. + +## Methods + +### get + +```ts +get(args): undefined | Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `args` | *readonly* [`Type`](Type.Type.md)[] | + +#### Returns + +`undefined` \| [`Type`](Type.Type.md) + +*** + +### set + +```ts +set(args, type): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `args` | *readonly* [`Type`](Type.Type.md)[] | +| `type` | [`Type`](Type.Type.md) | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeMapper.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeMapper.md new file mode 100644 index 00000000000..23a18a72c0e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeMapper.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[I] TypeMapper" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `args` | *readonly* [`Type`](Type.Type.md)[] | +| `map` | `Map`< [`TemplateParameter`](Interface.TemplateParameter.md), [`Type`](Type.Type.md) \> | +| `partial` | `boolean` | + +## Methods + +### getMappedType + +```ts +getMappedType(type): Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`TemplateParameter`](Interface.TemplateParameter.md) | + +#### Returns + +[`Type`](Type.Type.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeNameOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeNameOptions.md new file mode 100644 index 00000000000..85ef0e9cb90 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeNameOptions.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] TypeNameOptions" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `namespaceFilter`? | (`ns`) => `boolean` | +| `printable`? | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeReferenceNode.md new file mode 100644 index 00000000000..117561c33aa --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeReferenceNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] TypeReferenceNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `arguments` | *readonly* [`Expression`](Type.Expression.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`TypeReference`](Enumeration.SyntaxKind.md#typereference) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecCompletionItem.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecCompletionItem.md new file mode 100644 index 00000000000..811ed891114 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecCompletionItem.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] TypeSpecCompletionItem" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `label`? | `string` | Optional label if different from the text to complete. | +| `sym` | [`Sym`](Interface.Sym.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibrary.md new file mode 100644 index 00000000000..63a406b39ca --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibrary.md @@ -0,0 +1,121 @@ +--- +jsApi: true +title: "[I] TypeSpecLibrary" + +--- +Definition of a TypeSpec library + +## Extends + +- [`TypeSpecLibraryDef`](Interface.TypeSpecLibraryDef.md)< `T`, `E` \> + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` *extends* \{} | - | +| `E` *extends* `Record`< `string`, `any` \> | `Record`< `string`, `never` \> | + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `diagnostics` | [`DiagnosticMap`](Type.DiagnosticMap.md)< `T` \> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | +| `emitter`? | `object` | Emitter configuration if library is an emitter. | +| `emitter.options`? | [`JSONSchemaType`](Type.JSONSchemaType.md)< `E` \> | - | +| `emitterOptionValidator`? | [`JSONSchemaValidator`](Interface.JSONSchemaValidator.md) | JSON Schema validator for emitter options | +| `linter`? | [`LinterDefinition`](Interface.LinterDefinition.md) | Configuration if library is providing linting rules/rulesets. | +| `readonly` `name` | `string` | Name of the library. Must match the package.json name. | +| `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. | + +## Methods + +### createDiagnostic + +```ts +createDiagnostic(diag): Diagnostic +``` + +#### Type parameters + +| Parameter | +| :------ | +| `C` *extends* `string` \| `number` \| `symbol` | +| `M` *extends* `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diag` | [`DiagnosticReport`](Type.DiagnosticReport.md)< `T`, `C`, `M` \> | + +#### Returns + +[`Diagnostic`](Interface.Diagnostic.md) + +*** + +### createStateSymbol + +```ts +createStateSymbol(name): symbol +``` + +Get or create a symbol with the given name unique for that library. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | Symbol name scoped with the library name. | + +#### Returns + +`symbol` + +*** + +### 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`](Interface.Program.md) | + +#### Returns + +[`Tracer`](Interface.Tracer.md) + +*** + +### reportDiagnostic + +```ts +reportDiagnostic(program, diag): void +``` + +#### Type parameters + +| Parameter | +| :------ | +| `C` *extends* `string` \| `number` \| `symbol` | +| `M` *extends* `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `diag` | [`DiagnosticReport`](Type.DiagnosticReport.md)< `T`, `C`, `M` \> | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibraryDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibraryDef.md new file mode 100644 index 00000000000..221cd245026 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibraryDef.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[I] TypeSpecLibraryDef" + +--- +Definition of a TypeSpec library + +## Extended By + +- [`TypeSpecLibrary`](Interface.TypeSpecLibrary.md) + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` *extends* \{} | - | +| `E` *extends* `Record`< `string`, `any` \> | `Record`< `string`, `never` \> | + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `diagnostics` | [`DiagnosticMap`](Type.DiagnosticMap.md)< `T` \> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | +| `emitter`? | `object` | Emitter configuration if library is an emitter. | +| `emitter.options`? | [`JSONSchemaType`](Type.JSONSchemaType.md)< `E` \> | - | +| `linter`? | [`LinterDefinition`](Interface.LinterDefinition.md) | Configuration if library is providing linting rules/rulesets. | +| `readonly` `name` | `string` | Name of the library. Must match the package.json name. | +| `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/Interface.TypeSpecManifest.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecManifest.md new file mode 100644 index 00000000000..9b5afeb5681 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecManifest.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] TypeSpecManifest" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `commit` | `string` | Full commit sha. | +| `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/Interface.TypeSpecScriptNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecScriptNode.md new file mode 100644 index 00000000000..5055f8a9b12 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecScriptNode.md @@ -0,0 +1,32 @@ +--- +jsApi: true +title: "[I] TypeSpecScriptNode" + +--- +## Extends + +- [`DeclarationNode`](Interface.DeclarationNode.md).[`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `comments` | *readonly* [`Comment`](Type.Comment.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `file` | [`SourceFile`](Interface.SourceFile.md) | - | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `inScopeNamespaces` | *readonly* [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md)[] | - | +| `readonly` `kind` | [`TypeSpecScript`](Enumeration.SyntaxKind.md#typespecscript) | - | +| `readonly` `locals` | `SymbolTable` | - | +| `readonly` `namespaces` | [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md)[] | - | +| `parent`? | [`Node`](Type.Node.md) | - | +| `readonly` `parseDiagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | - | +| `readonly` `parseOptions` | [`ParseOptions`](Interface.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. | +| `readonly` `printable` | `boolean` | - | +| `readonly` `statements` | *readonly* [`Statement`](Type.Statement.md)[] | - | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `usings` | *readonly* [`UsingStatementNode`](Interface.UsingStatementNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Union.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Union.md new file mode 100644 index 00000000000..4ef641c18a5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Union.md @@ -0,0 +1,64 @@ +--- +jsApi: true +title: "[I] Union" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md).[`TemplatedTypeBase`](Interface.TemplatedTypeBase.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | +| `expression` | `boolean` | - | +| `instantiationParameters`? | [`Type`](Type.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` | `"Union"` | - | +| `name`? | `string` | - | +| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | +| `node` | [`UnionStatementNode`](Interface.UnionStatementNode.md) \| [`UnionExpressionNode`](Interface.UnionExpressionNode.md) | - | +| `readonly` `options` | [`Type`](Type.Type.md)[] | **Deprecated**

use variants | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `symbol`? | [`Sym`](Interface.Sym.md) | Late-bound symbol of this interface type. | +| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

use templateMapper instead. | +| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | +| `templateNode`? | [`Node`](Type.Node.md) | - | +| `variants` | `RekeyableMap`< `string` \| `symbol`, [`UnionVariant`](Interface.UnionVariant.md) \> | The variants of the union.

Variants are ordered in order that they appear in source. | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionExpressionNode.md new file mode 100644 index 00000000000..72a5e4c9674 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] UnionExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`UnionExpression`](Enumeration.SyntaxKind.md#unionexpression) | - | +| `readonly` `options` | *readonly* [`Expression`](Type.Expression.md)[] | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.UnionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionStatementNode.md new file mode 100644 index 00000000000..dc886ca7e4b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionStatementNode.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[I] UnionStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md).[`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`UnionStatement`](Enumeration.SyntaxKind.md#unionstatement) | - | +| `locals`? | `SymbolTable` | - | +| `readonly` `options` | *readonly* [`UnionVariantNode`](Interface.UnionVariantNode.md)[] | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariant.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariant.md new file mode 100644 index 00000000000..72b15fcc9ca --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariant.md @@ -0,0 +1,58 @@ +--- +jsApi: true +title: "[I] UnionVariant" + +--- +## Extends + +- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | +| `instantiationParameters`? | [`Type`](Type.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` | `"UnionVariant"` | - | +| `name` | `string` \| `symbol` | - | +| `node` | `undefined` \| [`UnionVariantNode`](Interface.UnionVariantNode.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | +| `type` | [`Type`](Type.Type.md) | - | +| `union` | [`Union`](Interface.Union.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariantNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariantNode.md new file mode 100644 index 00000000000..b3c80a37050 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariantNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] UnionVariantNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `id`? | [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `readonly` `kind` | [`UnionVariant`](Enumeration.SyntaxKind.md#unionvariant) | - | +| `parent`? | [`UnionStatementNode`](Interface.UnionStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `value` | [`Expression`](Type.Expression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnknownType.md new file mode 100644 index 00000000000..581bedf30a4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnknownType.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[I] UnknownType" + +--- +## Extends + +- [`IntrinsicType`](Interface.IntrinsicType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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` | `"Intrinsic"` | - | +| `name` | `"unknown"` | - | +| `node`? | [`Node`](Type.Node.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`IntrinsicType`](Interface.IntrinsicType.md).[`projections`](Interface.IntrinsicType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`IntrinsicType`](Interface.IntrinsicType.md).[`projectionsByName`](Interface.IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsageTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsageTracker.md new file mode 100644 index 00000000000..b8e5a277fc6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsageTracker.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[I] UsageTracker" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `readonly` `types` | *readonly* [`TrackableType`](Type.TrackableType.md)[] | + +## Methods + +### isUsedAs + +```ts +isUsedAs(type, usage): boolean +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`TrackableType`](Type.TrackableType.md) | +| `usage` | [`UsageFlags`](Enumeration.UsageFlags.md) | + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsingStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsingStatementNode.md new file mode 100644 index 00000000000..0517ce10cd7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsingStatementNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] UsingStatementNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`UsingStatement`](Enumeration.SyntaxKind.md#usingstatement) | - | +| `readonly` `name` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | +| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | +| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.ValueOfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueOfExpressionNode.md new file mode 100644 index 00000000000..718b8ab38bb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueOfExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ValueOfExpressionNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`ValueOfExpression`](Enumeration.SyntaxKind.md#valueofexpression) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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. | +| `readonly` `target` | [`Expression`](Type.Expression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueType.md new file mode 100644 index 00000000000..ddf24355717 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueType.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] ValueType" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `kind` | `"Value"` | +| `target` | [`Type`](Type.Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidKeywordNode.md new file mode 100644 index 00000000000..e710ec4c01b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidKeywordNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] VoidKeywordNode" + +--- +## Extends + +- [`BaseNode`](Interface.BaseNode.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | +| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | +| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | +| `readonly` `kind` | [`VoidKeyword`](Enumeration.SyntaxKind.md#voidkeyword) | - | +| `parent`? | [`Node`](Type.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. | +| `readonly` `symbol` | [`Sym`](Interface.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/Interface.VoidType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidType.md new file mode 100644 index 00000000000..3dd7b5b0759 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidType.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[I] VoidType" + +--- +## Extends + +- [`IntrinsicType`](Interface.IntrinsicType.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters`? | [`Type`](Type.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` | `"Intrinsic"` | - | +| `name` | `"void"` | - | +| `node`? | [`Node`](Type.Node.md) | - | +| `projectionBase`? | [`Type`](Type.Type.md) | - | +| `projectionSource`? | [`Type`](Type.Type.md) | - | +| `projector`? | [`Projector`](Interface.Projector.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Inherited from + +[`IntrinsicType`](Interface.IntrinsicType.md).[`projections`](Interface.IntrinsicType.md#projections) + +## Methods + +### projectionsByName + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] + +#### Inherited from + +[`IntrinsicType`](Interface.IntrinsicType.md).[`projectionsByName`](Interface.IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$deprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$deprecated.md new file mode 100644 index 00000000000..5a3bd1a992a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$deprecated.md @@ -0,0 +1,31 @@ +--- +jsApi: true +title: "[F] $deprecated" + +--- +```ts +$deprecated( + context, + target, + message): void +``` + +Mark a type as deprecated + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | DecoratorContext | +| `target` | [`Type`](Type.Type.md) | Decorator target | +| `message` | `string` | Deprecation target. | + +## Returns + +`void` + +## Example + +``` @deprecated("Foo is deprecated, use Bar instead.") + model Foo {} +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$discriminator.md new file mode 100644 index 00000000000..2ef3f559b1e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$discriminator.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $discriminator" + +--- +```ts +$discriminator( + context, + entity, + propertyName): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `entity` | [`Model`](Interface.Model.md) \| [`Union`](Interface.Union.md) | +| `propertyName` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$doc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$doc.md new file mode 100644 index 00000000000..7c51189dd37 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$doc.md @@ -0,0 +1,40 @@ +--- +jsApi: true +title: "[F] $doc" + +--- +```ts +$doc( + context, + target, + text, + sourceObject?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Type`](Type.Type.md) | +| `text` | `string` | +| `sourceObject`? | [`Type`](Type.Type.md) | + +## Returns + +`void` + +## Doc + +attaches a documentation string. Works great with multi-line string literals. + +The first argument to + +## Doc + +is a string, which may contain template parameters, enclosed in braces, +which are replaced with an attribute for the type (commonly "name") passed as the second (optional) argument. + +## Doc + +can be specified on any language element -- a model, an operation, a namespace, etc. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$docFromComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$docFromComment.md new file mode 100644 index 00000000000..7fa2d872eff --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$docFromComment.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $docFromComment" + +--- +```ts +$docFromComment( + context, + target, + text): void +``` + +to be used to set the `@doc` from doc comment. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Type`](Type.Type.md) | +| `text` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$encode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$encode.md new file mode 100644 index 00000000000..430bf45feea --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$encode.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $encode" + +--- +```ts +$encode( + context, + target, + encoding, + encodeAs?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | +| `encoding` | `string` \| [`EnumMember`](Interface.EnumMember.md) | +| `encodeAs`? | [`Scalar`](Interface.Scalar.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$error.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$error.md new file mode 100644 index 00000000000..51f911bc371 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$error.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $error" + +--- +```ts +$error(context, entity): void +``` + +`@error` decorator marks a model as an error type. + +`@error` can only be specified on a model. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `entity` | [`Model`](Interface.Model.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$format.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$format.md new file mode 100644 index 00000000000..0a0ac0102d9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$format.md @@ -0,0 +1,35 @@ +--- +jsApi: true +title: "[F] $format" + +--- +```ts +$format( + context, + target, + format): void +``` + +`@format` - specify the data format hint for a string type + +The first argument is a string that identifies the format that the string type expects. Any string +can be entered here, but a TypeSpec emitter must know how to interpret + +For TypeSpec specs that will be used with an OpenAPI emitter, the OpenAPI specification describes possible +valid values for a string type's format: + +https://github.com/OAI/OpenAPI-Specification/blob/3.0.3/versions/3.0.3.md#dataTypes + +`@format` can be specified on a type that extends from `string` or a `string`-typed model property. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | +| `format` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$friendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$friendlyName.md new file mode 100644 index 00000000000..8874104e7ed --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$friendlyName.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $friendlyName" + +--- +```ts +$friendlyName( + context, + target, + friendlyName, + sourceObject): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Type`](Type.Type.md) | +| `friendlyName` | `string` | +| `sourceObject` | `undefined` \| [`Type`](Type.Type.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$indexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$indexer.md new file mode 100644 index 00000000000..49df9710332 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$indexer.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $indexer" + +--- +```ts +$indexer( + context, + target, + key, + value): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Type`](Type.Type.md) | +| `key` | [`Scalar`](Interface.Scalar.md) | +| `value` | [`Type`](Type.Type.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$inspectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$inspectType.md new file mode 100644 index 00000000000..efb118f95fb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$inspectType.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $inspectType" + +--- +```ts +$inspectType( + program, + target, + text): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | +| `text` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$inspectTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$inspectTypeName.md new file mode 100644 index 00000000000..997a9bc3572 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$inspectTypeName.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $inspectTypeName" + +--- +```ts +$inspectTypeName( + program, + target, + text): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | +| `text` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$key.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$key.md new file mode 100644 index 00000000000..02f9dadc8bd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$key.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[F] $key" + +--- +```ts +$key( + context, + entity, + altName?): void +``` + +`@key` - mark a model property as the key to identify instances of that type + +The optional first argument accepts an alternate key name which may be used by emitters. +Otherwise, the name of the target property will be used. + +`@key` can only be applied to model properties. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `entity` | [`ModelProperty`](Interface.ModelProperty.md) | +| `altName`? | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$knownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$knownValues.md new file mode 100644 index 00000000000..66d72e679e8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$knownValues.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[F] $knownValues" + +--- +```ts +$knownValues( + context, + target, + knownValues): void +``` + +`@knownValues` marks a string type with an enum that contains all known values + +The first parameter is a reference to an enum type that describes all possible values that the +type accepts. + +`@knownValues` can only be applied to model types that extend `string`. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | - | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | Decorator target. Must be a string. (model Foo extends string) | +| `knownValues` | [`Enum`](Interface.Enum.md) | Must be an enum. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$list.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$list.md new file mode 100644 index 00000000000..72d75b0dbf9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$list.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] $list" + +--- +```ts +$list( + context, + target, + listedType?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Operation`](Interface.Operation.md) | +| `listedType`? | [`Type`](Type.Type.md) | + +## 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/Namespace.decorators.Function.$maxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxItems.md new file mode 100644 index 00000000000..c7493709601 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxItems.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $maxItems" + +--- +```ts +$maxItems( + context, + target, + maxItems): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Model`](Interface.Model.md) \| [`ModelProperty`](Interface.ModelProperty.md) | +| `maxItems` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxLength.md new file mode 100644 index 00000000000..109eed5f96c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxLength.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $maxLength" + +--- +```ts +$maxLength( + context, + target, + maxLength): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | +| `maxLength` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValue.md new file mode 100644 index 00000000000..e2bf1329915 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValue.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $maxValue" + +--- +```ts +$maxValue( + context, + target, + maxValue): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | +| `maxValue` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValueExclusive.md new file mode 100644 index 00000000000..11651b1b843 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValueExclusive.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $maxValueExclusive" + +--- +```ts +$maxValueExclusive( + context, + target, + maxValueExclusive): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | +| `maxValueExclusive` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minItems.md new file mode 100644 index 00000000000..8700f45f896 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minItems.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $minItems" + +--- +```ts +$minItems( + context, + target, + minItems): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Model`](Interface.Model.md) \| [`ModelProperty`](Interface.ModelProperty.md) | +| `minItems` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minLength.md new file mode 100644 index 00000000000..a11a844c26d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minLength.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $minLength" + +--- +```ts +$minLength( + context, + target, + minLength): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | +| `minLength` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValue.md new file mode 100644 index 00000000000..7202a9762d5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValue.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $minValue" + +--- +```ts +$minValue( + context, + target, + minValue): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | +| `minValue` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValueExclusive.md new file mode 100644 index 00000000000..a52fcb6024c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValueExclusive.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $minValueExclusive" + +--- +```ts +$minValueExclusive( + context, + target, + minValueExclusive): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | +| `minValueExclusive` | `number` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$overload.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$overload.md new file mode 100644 index 00000000000..99a14c1e5c3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$overload.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $overload" + +--- +```ts +$overload( + context, + target, + overloadBase): void +``` + +`@overload` - Indicate that the target overloads (specializes) the overloads type. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | DecoratorContext | +| `target` | [`Operation`](Interface.Operation.md) | The specializing operation declaration | +| `overloadBase` | [`Operation`](Interface.Operation.md) | The operation to be overloaded. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$parameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$parameterVisibility.md new file mode 100644 index 00000000000..db571c27bec --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$parameterVisibility.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $parameterVisibility" + +--- +```ts +$parameterVisibility( + context, + entity, + ...visibilities): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `entity` | [`Operation`](Interface.Operation.md) | +| ...`visibilities` | `string`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$pattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$pattern.md new file mode 100644 index 00000000000..1f3c9532be4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$pattern.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $pattern" + +--- +```ts +$pattern( + context, + target, + pattern): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | +| `pattern` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$projectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$projectedName.md new file mode 100644 index 00000000000..c13ade31e2e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$projectedName.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] $projectedName" + +--- +```ts +$projectedName( + context, + target, + projectionName, + projectedName): void +``` + +`@projectedName` - Indicate that this entity should be renamed according to the given projection. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | DecoratorContext | +| `target` | [`Type`](Type.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/Namespace.decorators.Function.$returnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$returnTypeVisibility.md new file mode 100644 index 00000000000..3499d00ccf6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$returnTypeVisibility.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $returnTypeVisibility" + +--- +```ts +$returnTypeVisibility( + context, + entity, + ...visibilities): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `entity` | [`Operation`](Interface.Operation.md) | +| ...`visibilities` | `string`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$secret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$secret.md new file mode 100644 index 00000000000..8d3a868e708 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$secret.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] $secret" + +--- +```ts +$secret(context, target): void +``` + +Mark a string as a secret value that should be treated carefully to avoid exposure + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | Decorator context | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.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/Namespace.decorators.Function.$service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$service.md new file mode 100644 index 00000000000..7b83d2fbbe8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$service.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $service" + +--- +```ts +$service( + context, + target, + options?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Namespace`](Interface.Namespace.md) | +| `options`? | [`Model`](Interface.Model.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$summary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$summary.md new file mode 100644 index 00000000000..945334ae808 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$summary.md @@ -0,0 +1,41 @@ +--- +jsApi: true +title: "[F] $summary" + +--- +```ts +$summary( + context, + target, + text, + sourceObject): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Type`](Type.Type.md) | +| `text` | `string` | +| `sourceObject` | [`Type`](Type.Type.md) | + +## Returns + +`void` + +## Summary + +attaches a documentation string. It is typically used to give a short, single-line +description, and can be used in combination with or instead of @doc. + +The first argument to + +## Summary + +is a string, which may contain template parameters, enclosed in braces, +which are replaced with an attribute for the type (commonly "name") passed as the second (optional) argument. + +## Summary + +can be specified on any language element -- a model, an operation, a namespace, etc. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$tag.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$tag.md new file mode 100644 index 00000000000..4538600b46d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$tag.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $tag" + +--- +```ts +$tag( + context, + target, + tag): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Interface`](Interface.Interface.md) \| [`Namespace`](Interface.Namespace.md) \| [`Operation`](Interface.Operation.md) | +| `tag` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$visibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$visibility.md new file mode 100644 index 00000000000..02bc1d1acbf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$visibility.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $visibility" + +--- +```ts +$visibility( + context, + target, + ...visibilities): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) | +| ...`visibilities` | `string`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withDefaultKeyVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withDefaultKeyVisibility.md new file mode 100644 index 00000000000..9267565d224 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withDefaultKeyVisibility.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $withDefaultKeyVisibility" + +--- +```ts +$withDefaultKeyVisibility( + context, + entity, + visibility): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `entity` | [`Model`](Interface.Model.md) | +| `visibility` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withOptionalProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withOptionalProperties.md new file mode 100644 index 00000000000..8fe0ce96847 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withOptionalProperties.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $withOptionalProperties" + +--- +```ts +$withOptionalProperties(context, target): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Model`](Interface.Model.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withUpdateableProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withUpdateableProperties.md new file mode 100644 index 00000000000..dc783a77d00 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withUpdateableProperties.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $withUpdateableProperties" + +--- +```ts +$withUpdateableProperties(context, target): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withVisibility.md new file mode 100644 index 00000000000..1545bdafcba --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withVisibility.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $withVisibility" + +--- +```ts +$withVisibility( + context, + target, + ...visibilities): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Model`](Interface.Model.md) | +| ...`visibilities` | `string`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withoutDefaultValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withoutDefaultValues.md new file mode 100644 index 00000000000..690d2cf11e9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withoutDefaultValues.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $withoutDefaultValues" + +--- +```ts +$withoutDefaultValues(context, target): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Model`](Interface.Model.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withoutOmittedProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withoutOmittedProperties.md new file mode 100644 index 00000000000..da55ca3a84b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withoutOmittedProperties.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $withoutOmittedProperties" + +--- +```ts +$withoutOmittedProperties( + context, + target, + omitProperties): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `target` | [`Model`](Interface.Model.md) | +| `omitProperties` | [`StringLiteral`](Interface.StringLiteral.md) \| [`Union`](Interface.Union.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.addService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.addService.md new file mode 100644 index 00000000000..0f2598349d8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.addService.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] addService" + +--- +```ts +addService( + program, + namespace, + details = {}): void +``` + +Mark the given namespace as a service. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `namespace` | [`Namespace`](Interface.Namespace.md) | Namespace | +| `details` | [`ServiceDetails`](Namespace.decorators.Interface.ServiceDetails.md) | Service details | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getAllTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getAllTags.md new file mode 100644 index 00000000000..8c20f9f2182 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getAllTags.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getAllTags" + +--- +```ts +getAllTags(program, target): string[] | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Interface`](Interface.Interface.md) \| [`Namespace`](Interface.Namespace.md) \| [`Operation`](Interface.Operation.md) | + +## Returns + +`string`[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDeprecated.md new file mode 100644 index 00000000000..fd9acc93115 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDeprecated.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getDeprecated" + +--- +```ts +getDeprecated(program, type): string | undefined +``` + +Return the deprecated message or undefined if not deprecated + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `type` | [`Type`](Type.Type.md) | Type | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminatedTypes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminatedTypes.md new file mode 100644 index 00000000000..010f94650de --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminatedTypes.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] getDiscriminatedTypes" + +--- +```ts +getDiscriminatedTypes(program): [Model | Union, Discriminator][] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | + +## Returns + +[[`Model`](Interface.Model.md) \| [`Union`](Interface.Union.md), [`Discriminator`](Namespace.decorators.Interface.Discriminator.md)][] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminator.md new file mode 100644 index 00000000000..d7c147425af --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminator.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getDiscriminator" + +--- +```ts +getDiscriminator(program, entity): Discriminator | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `entity` | [`Type`](Type.Type.md) | + +## Returns + +[`Discriminator`](Namespace.decorators.Interface.Discriminator.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDoc.md new file mode 100644 index 00000000000..75ba1fd04a9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDoc.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getDoc" + +--- +```ts +getDoc(program, target): string | undefined +``` + +Get the documentation string for the given type. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `target` | [`Type`](Type.Type.md) | Type | + +## Returns + +`string` \| `undefined` + +Documentation value diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDocData.md new file mode 100644 index 00000000000..2ff77ded318 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDocData.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getDocData" + +--- +```ts +getDocData(program, target): DocData | undefined +``` + +Get the documentation information for the given type. In most cases you probably just want to use [getDoc](Namespace.decorators.Function.getDoc.md) + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `target` | [`Type`](Type.Type.md) | Type | + +## Returns + +[`DocData`](Namespace.decorators.Interface.DocData.md) \| `undefined` + +Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getEncode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getEncode.md new file mode 100644 index 00000000000..59bb5473a7d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getEncode.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getEncode" + +--- +```ts +getEncode(program, target): EncodeData | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | + +## Returns + +[`EncodeData`](Namespace.decorators.Interface.EncodeData.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getFormat.md new file mode 100644 index 00000000000..8b881116154 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getFormat.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getFormat" + +--- +```ts +getFormat(program, target): string | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getFriendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getFriendlyName.md new file mode 100644 index 00000000000..bd3521c0d11 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getFriendlyName.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getFriendlyName" + +--- +```ts +getFriendlyName(program, target): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getIndexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getIndexer.md new file mode 100644 index 00000000000..faa83b1a59c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getIndexer.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getIndexer" + +--- +```ts +getIndexer(program, target): ModelIndexer | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +[`ModelIndexer`](Type.ModelIndexer.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getKeyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getKeyName.md new file mode 100644 index 00000000000..39f8adf52c3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getKeyName.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getKeyName" + +--- +```ts +getKeyName(program, property): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `property` | [`ModelProperty`](Interface.ModelProperty.md) | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getKnownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getKnownValues.md new file mode 100644 index 00000000000..429c2148f76 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getKnownValues.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getKnownValues" + +--- +```ts +getKnownValues(program, target): Enum | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | + +## Returns + +[`Enum`](Interface.Enum.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getListOperationType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getListOperationType.md new file mode 100644 index 00000000000..e787aa0161c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getListOperationType.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getListOperationType" + +--- +```ts +getListOperationType(program, target): Model | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +[`Model`](Interface.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/Namespace.decorators.Function.getMaxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxItems.md new file mode 100644 index 00000000000..83972eb67ee --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxItems.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMaxItems" + +--- +```ts +getMaxItems(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxLength.md new file mode 100644 index 00000000000..abe61ac08d9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxLength.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMaxLength" + +--- +```ts +getMaxLength(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxValue.md new file mode 100644 index 00000000000..10b64f280ac --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxValue.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMaxValue" + +--- +```ts +getMaxValue(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxValueExclusive.md new file mode 100644 index 00000000000..03b40a26ba8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxValueExclusive.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMaxValueExclusive" + +--- +```ts +getMaxValueExclusive(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinItems.md new file mode 100644 index 00000000000..cf2d940da61 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinItems.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMinItems" + +--- +```ts +getMinItems(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinLength.md new file mode 100644 index 00000000000..b1eee89b452 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinLength.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMinLength" + +--- +```ts +getMinLength(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinValue.md new file mode 100644 index 00000000000..c80dc57e78b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinValue.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMinValue" + +--- +```ts +getMinValue(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinValueExclusive.md new file mode 100644 index 00000000000..d2f63bd2dc2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinValueExclusive.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMinValueExclusive" + +--- +```ts +getMinValueExclusive(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getOverloadedOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getOverloadedOperation.md new file mode 100644 index 00000000000..4dd8aa5cdc0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getOverloadedOperation.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getOverloadedOperation" + +--- +```ts +getOverloadedOperation(program, operation): Operation | undefined +``` + +If the given operation overloads another operation, return that operation. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `operation` | [`Operation`](Interface.Operation.md) | The operation to check for an overload target. | + +## Returns + +[`Operation`](Interface.Operation.md) \| `undefined` + +The operation this operation overloads, if any. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getOverloads.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getOverloads.md new file mode 100644 index 00000000000..d7a0a7c7d0c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getOverloads.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getOverloads" + +--- +```ts +getOverloads(program, operation): Operation[] | undefined +``` + +Get all operations that are marked as overloads of the given operation + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `operation` | [`Operation`](Interface.Operation.md) | Operation | + +## Returns + +[`Operation`](Interface.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/Namespace.decorators.Function.getParameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getParameterVisibility.md new file mode 100644 index 00000000000..625682597e5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getParameterVisibility.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] getParameterVisibility" + +--- +```ts +getParameterVisibility(program, entity): string[] | undefined +``` + +Returns the visibilities of the parameters of the given operation, if provided with `@parameterVisibility`. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `entity` | [`Operation`](Interface.Operation.md) | + +## Returns + +`string`[] \| `undefined` + +## See + +[$parameterVisibility](Namespace.decorators.Function.$parameterVisibility.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getPattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getPattern.md new file mode 100644 index 00000000000..be61239a5d1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getPattern.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getPattern" + +--- +```ts +getPattern(program, target): string | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getProjectedName.md new file mode 100644 index 00000000000..68a1e47a8c5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getProjectedName.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] getProjectedName" + +--- +```ts +getProjectedName( + program, + target, + projectionName): string | undefined +``` + +Get the projected name of the given entity for the given projection. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `target` | [`Type`](Type.Type.md) | Target | +| `projectionName` | `string` | - | + +## Returns + +`string` \| `undefined` + +Projected name for the given projection diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getProjectedNames.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getProjectedNames.md new file mode 100644 index 00000000000..8c353c6ddcc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getProjectedNames.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getProjectedNames" + +--- +```ts +getProjectedNames(program, target): ReadonlyMap< string, string > | undefined +``` + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `target` | [`Type`](Type.Type.md) | Target | + +## 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/Namespace.decorators.Function.getPropertyType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getPropertyType.md new file mode 100644 index 00000000000..9b82067b771 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getPropertyType.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] getPropertyType" + +--- +```ts +getPropertyType(target): Type +``` + +Return the type of the property or the model itself. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | + +## Returns + +[`Type`](Type.Type.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getReturnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getReturnTypeVisibility.md new file mode 100644 index 00000000000..5673d6495c1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getReturnTypeVisibility.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] getReturnTypeVisibility" + +--- +```ts +getReturnTypeVisibility(program, entity): string[] | undefined +``` + +Returns the visibilities of the return type of the given operation, if provided with `@returnTypeVisibility`. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `entity` | [`Operation`](Interface.Operation.md) | + +## Returns + +`string`[] \| `undefined` + +## See + +[$returnTypeVisibility](Namespace.decorators.Function.$returnTypeVisibility.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getService.md new file mode 100644 index 00000000000..8e96397c943 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getService.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getService" + +--- +```ts +getService(program, namespace): Service | undefined +``` + +Get the service information for the given namespace. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `namespace` | [`Namespace`](Interface.Namespace.md) | Service namespace | + +## Returns + +[`Service`](Namespace.decorators.Interface.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/Namespace.decorators.Function.getSummary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getSummary.md new file mode 100644 index 00000000000..617350f6b65 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getSummary.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getSummary" + +--- +```ts +getSummary(program, type): string | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `type` | [`Type`](Type.Type.md) | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getTags.md new file mode 100644 index 00000000000..afb2bc5f14e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getTags.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getTags" + +--- +```ts +getTags(program, target): string[] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getVisibility.md new file mode 100644 index 00000000000..071b0b7d4e6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getVisibility.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getVisibility" + +--- +```ts +getVisibility(program, target): string[] | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`string`[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.hasProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.hasProjectedName.md new file mode 100644 index 00000000000..c868a22f2d5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.hasProjectedName.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] hasProjectedName" + +--- +```ts +hasProjectedName( + program, + target, + projectionName): boolean +``` + +Get the projected name of the given entity for the given projection. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `target` | [`Type`](Type.Type.md) | Target | +| `projectionName` | `string` | - | + +## Returns + +`boolean` + +Projected name for the given projection diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isArrayModelType.md new file mode 100644 index 00000000000..f2d3143d660 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isArrayModelType.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] isArrayModelType" + +--- +```ts +isArrayModelType(program, type): type is ArrayModelType +``` + +Check if a model is an array type. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | - | +| `type` | [`Model`](Interface.Model.md) | Model type | + +## Returns + +`type is ArrayModelType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isErrorModel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isErrorModel.md new file mode 100644 index 00000000000..2b75a17442f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isErrorModel.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isErrorModel" + +--- +```ts +isErrorModel(program, target): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isKey.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isKey.md new file mode 100644 index 00000000000..eca22a4ce86 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isKey.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isKey" + +--- +```ts +isKey(program, property): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `property` | [`ModelProperty`](Interface.ModelProperty.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isListOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isListOperation.md new file mode 100644 index 00000000000..95f487d76ab --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isListOperation.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] isListOperation" + +--- +```ts +isListOperation(program, target): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Operation`](Interface.Operation.md) | + +## Returns + +`boolean` + +## Deprecated + +Use `isListOperation` in `@typespec/rest` instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isNumericType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isNumericType.md new file mode 100644 index 00000000000..b10ba0bfcdc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isNumericType.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isNumericType" + +--- +```ts +isNumericType(program, target): target is Scalar +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) \| [`ProjectedProgram`](Interface.ProjectedProgram.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`target is Scalar` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isRecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isRecordModelType.md new file mode 100644 index 00000000000..36d412c3dc1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isRecordModelType.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] isRecordModelType" + +--- +```ts +isRecordModelType(program, type): type is ArrayModelType +``` + +Check if a model is an array type. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | - | +| `type` | [`Model`](Interface.Model.md) | Model type | + +## Returns + +`type is ArrayModelType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isSecret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isSecret.md new file mode 100644 index 00000000000..cc0fbc38fe1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isSecret.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isSecret" + +--- +```ts +isSecret(program, target): boolean | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`boolean` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isService.md new file mode 100644 index 00000000000..6ba2bffa6db --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isService.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] isService" + +--- +```ts +isService(program, namespace): boolean +``` + +Check if the namespace is defined as a service. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | +| `namespace` | [`Namespace`](Interface.Namespace.md) | Namespace | + +## Returns + +`boolean` + +Boolean diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isStringType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isStringType.md new file mode 100644 index 00000000000..990b2c8a6b2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isStringType.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isStringType" + +--- +```ts +isStringType(program, target): target is Scalar +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) \| [`ProjectedProgram`](Interface.ProjectedProgram.md) | +| `target` | [`Type`](Type.Type.md) | + +## Returns + +`target is Scalar` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isVisible.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isVisible.md new file mode 100644 index 00000000000..f52bb88bbf3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isVisible.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] isVisible" + +--- +```ts +isVisible( + program, + property, + visibilities): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | +| `property` | [`ModelProperty`](Interface.ModelProperty.md) | +| `visibilities` | *readonly* `string`[] | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.listServices.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.listServices.md new file mode 100644 index 00000000000..006e71ba534 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.listServices.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[F] listServices" + +--- +```ts +listServices(program): Service[] +``` + +List all the services defined in the typespec program + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](Interface.Program.md) | Program | + +## Returns + +[`Service`](Namespace.decorators.Interface.Service.md)[] + +List of service. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Discriminator.md new file mode 100644 index 00000000000..6aa4d020ba5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Discriminator.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] Discriminator" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `propertyName` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.DocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.DocData.md new file mode 100644 index 00000000000..d8a28107de5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.DocData.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] DocData" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `source` | `"comment"` \| `"@doc"` | How was the doc set.
- `@doc` means the `@doc` decorator was used
- `comment` means it was set from a `/** comment * /` | +| `value` | `string` | Doc value. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.EncodeData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.EncodeData.md new file mode 100644 index 00000000000..a2cccedf767 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.EncodeData.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] EncodeData" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `encoding` | `string` | +| `type` | [`Scalar`](Interface.Scalar.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Service.md new file mode 100644 index 00000000000..3bc44f243d9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Service.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] Service" + +--- +## Extends + +- [`ServiceDetails`](Namespace.decorators.Interface.ServiceDetails.md) + +## Properties + +| Property | Type | +| :------ | :------ | +| `title`? | `string` | +| `type` | [`Namespace`](Interface.Namespace.md) | +| `version`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.ServiceDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.ServiceDetails.md new file mode 100644 index 00000000000..943f43274b4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.ServiceDetails.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[I] ServiceDetails" + +--- +## Extended By + +- [`Service`](Namespace.decorators.Interface.Service.md) + +## Properties + +| Property | Type | +| :------ | :------ | +| `title`? | `string` | +| `version`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.BytesKnownEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.BytesKnownEncoding.md new file mode 100644 index 00000000000..edea522bebd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.BytesKnownEncoding.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] BytesKnownEncoding" + +--- +```ts +BytesKnownEncoding: "base64" | "base64url" +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DateTimeKnownEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DateTimeKnownEncoding.md new file mode 100644 index 00000000000..efd2cf4782b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DateTimeKnownEncoding.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] DateTimeKnownEncoding" + +--- +```ts +DateTimeKnownEncoding: "rfc3339" | "rfc7231" | "unixTimestamp" +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DurationKnownEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DurationKnownEncoding.md new file mode 100644 index 00000000000..ae18050b518 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DurationKnownEncoding.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] DurationKnownEncoding" + +--- +```ts +DurationKnownEncoding: "ISO8601" | "seconds" +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Variable.namespace.md new file mode 100644 index 00000000000..c23ac94a882 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Variable.namespace.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] namespace" + +--- +```ts +const namespace: "TypeSpec" = "TypeSpec" +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.md new file mode 100644 index 00000000000..be533bfc34f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.md @@ -0,0 +1,111 @@ +--- +jsApi: true +title: "[N] decorators" + +--- +## Index + +### Interfaces + +- [Discriminator](Namespace.decorators.Interface.Discriminator.md) +- [DocData](Namespace.decorators.Interface.DocData.md) +- [EncodeData](Namespace.decorators.Interface.EncodeData.md) +- [Service](Namespace.decorators.Interface.Service.md) +- [ServiceDetails](Namespace.decorators.Interface.ServiceDetails.md) + +### Type Aliases + +- [BytesKnownEncoding](Namespace.decorators.Type.BytesKnownEncoding.md) +- [DateTimeKnownEncoding](Namespace.decorators.Type.DateTimeKnownEncoding.md) +- [DurationKnownEncoding](Namespace.decorators.Type.DurationKnownEncoding.md) + +### Variables + +- [namespace](Namespace.decorators.Variable.namespace.md) + +### Functions + +- [$deprecated](Namespace.decorators.Function.$deprecated.md) +- [$discriminator](Namespace.decorators.Function.$discriminator.md) +- [$doc](Namespace.decorators.Function.$doc.md) +- [$docFromComment](Namespace.decorators.Function.$docFromComment.md) +- [$encode](Namespace.decorators.Function.$encode.md) +- [$error](Namespace.decorators.Function.$error.md) +- [$format](Namespace.decorators.Function.$format.md) +- [$friendlyName](Namespace.decorators.Function.$friendlyName.md) +- [$indexer](Namespace.decorators.Function.$indexer.md) +- [$inspectType](Namespace.decorators.Function.$inspectType.md) +- [$inspectTypeName](Namespace.decorators.Function.$inspectTypeName.md) +- [$key](Namespace.decorators.Function.$key.md) +- [$knownValues](Namespace.decorators.Function.$knownValues.md) +- [$list](Namespace.decorators.Function.$list.md) +- [$maxItems](Namespace.decorators.Function.$maxItems.md) +- [$maxLength](Namespace.decorators.Function.$maxLength.md) +- [$maxValue](Namespace.decorators.Function.$maxValue.md) +- [$maxValueExclusive](Namespace.decorators.Function.$maxValueExclusive.md) +- [$minItems](Namespace.decorators.Function.$minItems.md) +- [$minLength](Namespace.decorators.Function.$minLength.md) +- [$minValue](Namespace.decorators.Function.$minValue.md) +- [$minValueExclusive](Namespace.decorators.Function.$minValueExclusive.md) +- [$overload](Namespace.decorators.Function.$overload.md) +- [$parameterVisibility](Namespace.decorators.Function.$parameterVisibility.md) +- [$pattern](Namespace.decorators.Function.$pattern.md) +- [$projectedName](Namespace.decorators.Function.$projectedName.md) +- [$returnTypeVisibility](Namespace.decorators.Function.$returnTypeVisibility.md) +- [$secret](Namespace.decorators.Function.$secret.md) +- [$service](Namespace.decorators.Function.$service.md) +- [$summary](Namespace.decorators.Function.$summary.md) +- [$tag](Namespace.decorators.Function.$tag.md) +- [$visibility](Namespace.decorators.Function.$visibility.md) +- [$withDefaultKeyVisibility](Namespace.decorators.Function.$withDefaultKeyVisibility.md) +- [$withOptionalProperties](Namespace.decorators.Function.$withOptionalProperties.md) +- [$withUpdateableProperties](Namespace.decorators.Function.$withUpdateableProperties.md) +- [$withVisibility](Namespace.decorators.Function.$withVisibility.md) +- [$withoutDefaultValues](Namespace.decorators.Function.$withoutDefaultValues.md) +- [$withoutOmittedProperties](Namespace.decorators.Function.$withoutOmittedProperties.md) +- [addService](Namespace.decorators.Function.addService.md) +- [getAllTags](Namespace.decorators.Function.getAllTags.md) +- [getDeprecated](Namespace.decorators.Function.getDeprecated.md) +- [getDiscriminatedTypes](Namespace.decorators.Function.getDiscriminatedTypes.md) +- [getDiscriminator](Namespace.decorators.Function.getDiscriminator.md) +- [getDoc](Namespace.decorators.Function.getDoc.md) +- [getDocData](Namespace.decorators.Function.getDocData.md) +- [getEncode](Namespace.decorators.Function.getEncode.md) +- [getFormat](Namespace.decorators.Function.getFormat.md) +- [getFriendlyName](Namespace.decorators.Function.getFriendlyName.md) +- [getIndexer](Namespace.decorators.Function.getIndexer.md) +- [getKeyName](Namespace.decorators.Function.getKeyName.md) +- [getKnownValues](Namespace.decorators.Function.getKnownValues.md) +- [getListOperationType](Namespace.decorators.Function.getListOperationType.md) +- [getMaxItems](Namespace.decorators.Function.getMaxItems.md) +- [getMaxLength](Namespace.decorators.Function.getMaxLength.md) +- [getMaxValue](Namespace.decorators.Function.getMaxValue.md) +- [getMaxValueExclusive](Namespace.decorators.Function.getMaxValueExclusive.md) +- [getMinItems](Namespace.decorators.Function.getMinItems.md) +- [getMinLength](Namespace.decorators.Function.getMinLength.md) +- [getMinValue](Namespace.decorators.Function.getMinValue.md) +- [getMinValueExclusive](Namespace.decorators.Function.getMinValueExclusive.md) +- [getOverloadedOperation](Namespace.decorators.Function.getOverloadedOperation.md) +- [getOverloads](Namespace.decorators.Function.getOverloads.md) +- [getParameterVisibility](Namespace.decorators.Function.getParameterVisibility.md) +- [getPattern](Namespace.decorators.Function.getPattern.md) +- [getProjectedName](Namespace.decorators.Function.getProjectedName.md) +- [getProjectedNames](Namespace.decorators.Function.getProjectedNames.md) +- [getPropertyType](Namespace.decorators.Function.getPropertyType.md) +- [getReturnTypeVisibility](Namespace.decorators.Function.getReturnTypeVisibility.md) +- [getService](Namespace.decorators.Function.getService.md) +- [getSummary](Namespace.decorators.Function.getSummary.md) +- [getTags](Namespace.decorators.Function.getTags.md) +- [getVisibility](Namespace.decorators.Function.getVisibility.md) +- [hasProjectedName](Namespace.decorators.Function.hasProjectedName.md) +- [isArrayModelType](Namespace.decorators.Function.isArrayModelType.md) +- [isErrorModel](Namespace.decorators.Function.isErrorModel.md) +- [isKey](Namespace.decorators.Function.isKey.md) +- [isListOperation](Namespace.decorators.Function.isListOperation.md) +- [isNumericType](Namespace.decorators.Function.isNumericType.md) +- [isRecordModelType](Namespace.decorators.Function.isRecordModelType.md) +- [isSecret](Namespace.decorators.Function.isSecret.md) +- [isService](Namespace.decorators.Function.isService.md) +- [isStringType](Namespace.decorators.Function.isStringType.md) +- [isVisible](Namespace.decorators.Function.isVisible.md) +- [listServices](Namespace.decorators.Function.listServices.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlCompletionItem.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlCompletionItem.md new file mode 100644 index 00000000000..15f4838d1ef --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlCompletionItem.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[T] CadlCompletionItem" + +--- +```ts +CadlCompletionItem: TypeSpecCompletionItem +``` + +## Deprecated + +Use TypeSpecCompletionItem diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlLibrary.md new file mode 100644 index 00000000000..1d47104c6c9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlLibrary.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[T] CadlLibrary" + +--- +```ts +CadlLibrary: TypeSpecLibrary< T, E > +``` + +## Deprecated + +Use TypeSpecLibrary + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` *extends* \{} | - | +| `E` *extends* `Record`< `string`, `any` \> | `Record`< `string`, `never` \> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlLibraryDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlLibraryDef.md new file mode 100644 index 00000000000..4637b7885a1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlLibraryDef.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[T] CadlLibraryDef" + +--- +```ts +CadlLibraryDef: TypeSpecLibraryDef< T, E > +``` + +## Deprecated + +Use TypeSpecLibraryDef + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` *extends* \{} | - | +| `E` *extends* `Record`< `string`, `any` \> | `Record`< `string`, `never` \> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlManifest.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlManifest.md new file mode 100644 index 00000000000..fd114a7fbb5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlManifest.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[T] CadlManifest" + +--- +```ts +CadlManifest: TypeSpecManifest +``` + +## Deprecated + +Use TypeSpecManifest diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlScriptNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlScriptNode.md new file mode 100644 index 00000000000..5650378e26b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlScriptNode.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[T] CadlScriptNode" + +--- +```ts +CadlScriptNode: TypeSpecScriptNode +``` + +## Deprecated + +Use TypeSpecScriptNode diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlValue.md new file mode 100644 index 00000000000..88d1ccde0d8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlValue.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[T] CadlValue" + +--- +```ts +CadlValue: TypeSpecValue +``` + +## Deprecated + +Use TypeSpecValue diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Comment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Comment.md new file mode 100644 index 00000000000..ba32de2587a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Comment.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] Comment" + +--- +```ts +Comment: LineComment | BlockComment +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CreateTypeProps.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CreateTypeProps.md new file mode 100644 index 00000000000..e0a96fa7d2e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CreateTypeProps.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] CreateTypeProps" + +--- +```ts +CreateTypeProps: Omit< Type, "isFinished" | keyof TypePrototype > +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Declaration.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Declaration.md new file mode 100644 index 00000000000..1b4ee779508 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Declaration.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] Declaration" + +--- +```ts +Declaration: ModelStatementNode | ScalarStatementNode | InterfaceStatementNode | UnionStatementNode | NamespaceStatementNode | OperationStatementNode | TemplateParameterDeclarationNode | ProjectionStatementNode | ProjectionParameterDeclarationNode | ProjectionLambdaParameterDeclarationNode | EnumStatementNode | AliasStatementNode | DecoratorDeclarationStatementNode | FunctionDeclarationStatementNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DecoratorArgumentValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DecoratorArgumentValue.md new file mode 100644 index 00000000000..fa3a6d98432 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DecoratorArgumentValue.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[T] DecoratorArgumentValue" + +--- +```ts +DecoratorArgumentValue: Type | number | string | boolean +``` + +Type System types diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticFormat.md new file mode 100644 index 00000000000..9be50dfe29b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticFormat.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[T] DiagnosticFormat" + +--- +```ts +DiagnosticFormat: T[C][M] extends CallableMessage< infer A > ? {format: Record< A[number], string >;} : Record< string, unknown > +``` + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` *extends* \{} | - | +| `C` *extends* *keyof* `T` | - | +| `M` *extends* *keyof* `T`[`C`] | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticHandler.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticHandler.md new file mode 100644 index 00000000000..d0369b4ec79 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticHandler.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[T] DiagnosticHandler" + +--- +```ts +DiagnosticHandler: (diagnostic) => void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostic` | [`Diagnostic`](Interface.Diagnostic.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticMap.md new file mode 100644 index 00000000000..2417175f3ed --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticMap.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] DiagnosticMap" + +--- +```ts +DiagnosticMap: { readonly [code in keyof T]: DiagnosticDefinition } +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` *extends* \{} | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReport.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReport.md new file mode 100644 index 00000000000..855900debe6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReport.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[T] DiagnosticReport" + +--- +```ts +DiagnosticReport: DiagnosticReportWithoutTarget< T, C, M > & {target: DiagnosticTarget | typeof NoTarget;} +``` + +| Member | Type | +| :------ | :------ | +| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) \| *typeof* [`NoTarget`](Variable.NoTarget.md) | + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` *extends* \{} | - | +| `C` *extends* *keyof* `T` | - | +| `M` *extends* *keyof* `T`[`C`] | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReportWithoutTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReportWithoutTarget.md new file mode 100644 index 00000000000..974c42e5b06 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReportWithoutTarget.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[T] DiagnosticReportWithoutTarget" + +--- +```ts +DiagnosticReportWithoutTarget: {code: C; messageId: M;} & DiagnosticFormat< T, C, M > +``` + +| Member | Type | +| :------ | :------ | +| `code` | `C` | +| `messageId`? | `M` | + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` *extends* \{} | - | +| `C` *extends* *keyof* `T` | - | +| `M` *extends* *keyof* `T`[`C`] | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticResult.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticResult.md new file mode 100644 index 00000000000..338f9e4e2cd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticResult.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[T] DiagnosticResult" + +--- +```ts +DiagnosticResult: [T, readonly Diagnostic[]] +``` + +Return type of accessor functions in TypeSpec. +Tuple composed of: +- 0: Actual result of an accessor function +- 1: List of diagnostics that were emitted while retrieving the data. + +## Type parameters + +| Parameter | +| :------ | +| `T` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticSeverity.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticSeverity.md new file mode 100644 index 00000000000..785708e4bdb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticSeverity.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] DiagnosticSeverity" + +--- +```ts +DiagnosticSeverity: "error" | "warning" +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticTarget.md new file mode 100644 index 00000000000..5c2126b64af --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticTarget.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] DiagnosticTarget" + +--- +```ts +DiagnosticTarget: TypeSpecDiagnosticTarget | SourceLocation +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Directive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Directive.md new file mode 100644 index 00000000000..fb06b360af3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Directive.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] Directive" + +--- +```ts +Directive: SuppressDirective | DeprecatedDirective +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DirectiveArgument.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DirectiveArgument.md new file mode 100644 index 00000000000..967a385cda2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DirectiveArgument.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] DirectiveArgument" + +--- +```ts +DirectiveArgument: StringLiteralNode | IdentifierNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocContent.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocContent.md new file mode 100644 index 00000000000..cd72b386b04 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocContent.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] DocContent" + +--- +```ts +DocContent: DocTextNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocTag.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocTag.md new file mode 100644 index 00000000000..81adaaefd51 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocTag.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] DocTag" + +--- +```ts +DocTag: DocReturnsTagNode | DocParamTagNode | DocTemplateTagNode | DocUnknownTagNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocToken.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocToken.md new file mode 100644 index 00000000000..dbab252f6fe --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocToken.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] DocToken" + +--- +```ts +DocToken: NewLine | Whitespace | ConflictMarker | Star | At | CloseBrace | Identifier | DocText | DocCodeSpan | DocCodeFenceDelimiter | EndOfFile +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitOptionsFor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitOptionsFor.md new file mode 100644 index 00000000000..35dc0817782 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitOptionsFor.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[T] EmitOptionsFor" + +--- +```ts +EmitOptionsFor: C extends TypeSpecLibrary< infer _T, infer E > ? E : never +``` + +Get the options for the onEmit of this library. + +## Type parameters + +| Parameter | +| :------ | +| `C` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitterFunc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitterFunc.md new file mode 100644 index 00000000000..20398b74a12 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitterFunc.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[T] EmitterFunc" + +--- +```ts +EmitterFunc: (context) => Promise< void > | void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`EmitContext`](Interface.EmitContext.md) | + +## Returns + +`Promise`< `void` \> \| `void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Expression.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Expression.md new file mode 100644 index 00000000000..5915fbcbeb2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Expression.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] Expression" + +--- +```ts +Expression: ArrayExpressionNode | MemberExpressionNode | ModelExpressionNode | TupleExpressionNode | UnionExpressionNode | IntersectionExpressionNode | TypeReferenceNode | ValueOfExpressionNode | IdentifierNode | StringLiteralNode | NumericLiteralNode | BooleanLiteralNode | VoidKeywordNode | NeverKeywordNode | AnyKeywordNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredCadlValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredCadlValue.md new file mode 100644 index 00000000000..f97bfd770d4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredCadlValue.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[T] InferredCadlValue" + +--- +```ts +InferredCadlValue: InferredTypeSpecValue< K > +``` + +## Deprecated + +Use InferredTypeSpecValue + +## Type parameters + +| Parameter | +| :------ | +| `K` *extends* [`TypeKind`](Type.TypeKind.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredTypeSpecValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredTypeSpecValue.md new file mode 100644 index 00000000000..079c1b7a3d1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredTypeSpecValue.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] InferredTypeSpecValue" + +--- +```ts +InferredTypeSpecValue: K extends "Any" ? TypeSpecValue : K extends infer T[] ? InferredTypeSpecValue< T > : K extends "String" ? string : K extends "Number" ? number : K extends "Boolean" ? boolean : Type & {kind: K;} +``` + +## Type parameters + +| Parameter | +| :------ | +| `K` *extends* [`TypeKind`](Type.TypeKind.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.IntrinsicScalarName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.IntrinsicScalarName.md new file mode 100644 index 00000000000..67ca70d4820 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.IntrinsicScalarName.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] IntrinsicScalarName" + +--- +```ts +IntrinsicScalarName: "bytes" | "numeric" | "integer" | "float" | "int64" | "int32" | "int16" | "int8" | "uint64" | "uint32" | "uint16" | "uint8" | "safeint" | "float32" | "float64" | "decimal" | "decimal128" | "string" | "plainDate" | "plainTime" | "utcDateTime" | "offsetDateTime" | "duration" | "boolean" | "url" +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.JSONSchemaType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.JSONSchemaType.md new file mode 100644 index 00000000000..a600f0b505f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.JSONSchemaType.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] JSONSchemaType" + +--- +```ts +JSONSchemaType: AjvJSONSchemaType< T > +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LibraryMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LibraryMetadata.md new file mode 100644 index 00000000000..08ddb45dd4a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LibraryMetadata.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] LibraryMetadata" + +--- +```ts +LibraryMetadata: FileLibraryMetadata | ModuleLibraryMetadata +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticFormat.md new file mode 100644 index 00000000000..05536b67432 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticFormat.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[T] LinterRuleDiagnosticFormat" + +--- +```ts +LinterRuleDiagnosticFormat: T[M] extends CallableMessage< infer A > ? {format: Record< A[number], string >;} : Record< string, unknown > +``` + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | - | +| `M` *extends* *keyof* `T` | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReport.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReport.md new file mode 100644 index 00000000000..a45df833d79 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReport.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[T] LinterRuleDiagnosticReport" + +--- +```ts +LinterRuleDiagnosticReport: LinterRuleDiagnosticReportWithoutTarget< T, M > & {target: DiagnosticTarget | typeof NoTarget;} +``` + +| Member | Type | +| :------ | :------ | +| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) \| *typeof* [`NoTarget`](Variable.NoTarget.md) | + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | - | +| `M` *extends* *keyof* `T` | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReportWithoutTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReportWithoutTarget.md new file mode 100644 index 00000000000..1d573cc521f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReportWithoutTarget.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[T] LinterRuleDiagnosticReportWithoutTarget" + +--- +```ts +LinterRuleDiagnosticReportWithoutTarget: {messageId: M;} & LinterRuleDiagnosticFormat< T, M > +``` + +| Member | Type | +| :------ | :------ | +| `messageId`? | `M` | + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | - | +| `M` *extends* *keyof* `T` | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralNode.md new file mode 100644 index 00000000000..7f70f218ff7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralNode.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] LiteralNode" + +--- +```ts +LiteralNode: StringLiteralNode | NumericLiteralNode | BooleanLiteralNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralType.md new file mode 100644 index 00000000000..c3ea6d3e0e0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralType.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] LiteralType" + +--- +```ts +LiteralType: StringLiteral | NumericLiteral | BooleanLiteral +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LocationContext.md new file mode 100644 index 00000000000..f52bb7b4ab0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LocationContext.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] LocationContext" + +--- +```ts +LocationContext: ProjectLocationContext | CompilerLocationContext | SyntheticLocationContext | LibraryLocationContext +``` + +Represent a location context in the mind of the compiler. This can be: +- the user project +- a library +- the compiler(standard library) +- virtual diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LogLevel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LogLevel.md new file mode 100644 index 00000000000..113435ebcbf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LogLevel.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] LogLevel" + +--- +```ts +LogLevel: "trace" | "warning" | "error" +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MarshalledValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MarshalledValue.md new file mode 100644 index 00000000000..40ebf0e3b8b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MarshalledValue.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] MarshalledValue" + +--- +```ts +MarshalledValue: Type extends StringLiteral ? string : Type extends NumericLiteral ? number : Type extends BooleanLiteral ? boolean : Type +``` + +## Type parameters + +| Parameter | +| :------ | +| `Type` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerNode.md new file mode 100644 index 00000000000..64107f9db48 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerNode.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[T] MemberContainerNode" + +--- +```ts +MemberContainerNode: ModelStatementNode | ModelExpressionNode | InterfaceStatementNode | EnumStatementNode | UnionStatementNode +``` + +Node types that can have referencable members diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerType.md new file mode 100644 index 00000000000..74e929ff0fc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerType.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] MemberContainerType" + +--- +```ts +MemberContainerType: Model | Enum | Interface | Union +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberNode.md new file mode 100644 index 00000000000..3ddef84ed86 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberNode.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] MemberNode" + +--- +```ts +MemberNode: ModelPropertyNode | EnumMemberNode | OperationStatementNode | UnionVariantNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberType.md new file mode 100644 index 00000000000..848b7e4de38 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberType.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[T] MemberType" + +--- +```ts +MemberType: ModelProperty | EnumMember | Operation | UnionVariant +``` + +Type that can be used as members of a container type. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModelIndexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModelIndexer.md new file mode 100644 index 00000000000..3be50524dd7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModelIndexer.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[T] ModelIndexer" + +--- +```ts +ModelIndexer: object +``` + +## Type declaration + +| Member | Type | +| :------ | :------ | +| `key` | [`Scalar`](Interface.Scalar.md) | +| `value` | [`Type`](Type.Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Modifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Modifier.md new file mode 100644 index 00000000000..b7494012d28 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Modifier.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] Modifier" + +--- +```ts +Modifier: ExternKeywordNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModuleResolutionResult.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModuleResolutionResult.md new file mode 100644 index 00000000000..140911e6c12 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModuleResolutionResult.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] ModuleResolutionResult" + +--- +```ts +ModuleResolutionResult: ResolvedFile | ResolvedModule +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NeverIndexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NeverIndexer.md new file mode 100644 index 00000000000..7a60656117f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NeverIndexer.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[T] NeverIndexer" + +--- +```ts +NeverIndexer: object +``` + +## Type declaration + +| Member | Type | +| :------ | :------ | +| `key` | [`NeverType`](Interface.NeverType.md) | +| `value` | `undefined` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NewLine.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NewLine.md new file mode 100644 index 00000000000..fdf9c963ebe --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NewLine.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] NewLine" + +--- +```ts +NewLine: "lf" | "crlf" +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Node.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Node.md new file mode 100644 index 00000000000..bb3ad2945ce --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Node.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] Node" + +--- +```ts +Node: TypeSpecScriptNode | JsSourceFileNode | JsNamespaceDeclarationNode | TemplateParameterDeclarationNode | ProjectionParameterDeclarationNode | ProjectionLambdaParameterDeclarationNode | ModelPropertyNode | UnionVariantNode | OperationStatementNode | OperationSignatureDeclarationNode | OperationSignatureReferenceNode | EnumMemberNode | EnumSpreadMemberNode | ModelSpreadPropertyNode | DecoratorExpressionNode | DirectiveExpressionNode | Statement | Expression | FunctionParameterNode | Modifier | DocNode | DocContent | DocTag | ProjectionStatementItem | ProjectionExpression | ProjectionModelSelectorNode | ProjectionModelPropertySelectorNode | ProjectionInterfaceSelectorNode | ProjectionOperationSelectorNode | ProjectionEnumSelectorNode | ProjectionEnumMemberSelectorNode | ProjectionUnionSelectorNode | ProjectionUnionVariantSelectorNode | ProjectionModelPropertyNode | ProjectionModelSpreadPropertyNode | ProjectionStatementNode | ProjectionNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NodeCallback.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NodeCallback.md new file mode 100644 index 00000000000..473d0dd7813 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NodeCallback.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[T] NodeCallback" + +--- +```ts +NodeCallback: (c) => T +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `c` | [`Node`](Type.Node.md) | + +## Returns + +`T` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationContainer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationContainer.md new file mode 100644 index 00000000000..1f76aaf743f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationContainer.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] OperationContainer" + +--- +```ts +OperationContainer: Namespace | Interface | Operation +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationSignature.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationSignature.md new file mode 100644 index 00000000000..2e36f802924 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationSignature.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] OperationSignature" + +--- +```ts +OperationSignature: OperationSignatureDeclarationNode | OperationSignatureReferenceNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionExpression.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionExpression.md new file mode 100644 index 00000000000..7252af632fc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionExpression.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] ProjectionExpression" + +--- +```ts +ProjectionExpression: ProjectionLogicalExpressionNode | ProjectionRelationalExpressionNode | ProjectionEqualityExpressionNode | ProjectionUnaryExpressionNode | ProjectionArithmeticExpressionNode | ProjectionCallExpressionNode | ProjectionMemberExpressionNode | ProjectionDecoratorReferenceExpressionNode | ProjectionTupleExpressionNode | ProjectionModelExpressionNode | ProjectionIfExpressionNode | ProjectionBlockExpressionNode | ProjectionLambdaExpressionNode | StringLiteralNode | NumericLiteralNode | BooleanLiteralNode | IdentifierNode | VoidKeywordNode | NeverKeywordNode | AnyKeywordNode | ReturnExpressionNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionStatementItem.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionStatementItem.md new file mode 100644 index 00000000000..e5b661c5386 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionStatementItem.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] ProjectionStatementItem" + +--- +```ts +ProjectionStatementItem: ProjectionExpressionStatementNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ReferenceExpression.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ReferenceExpression.md new file mode 100644 index 00000000000..b463c72ef6d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ReferenceExpression.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] ReferenceExpression" + +--- +```ts +ReferenceExpression: TypeReferenceNode | MemberExpressionNode | IdentifierNode | VoidKeywordNode | NeverKeywordNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.RuleRef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.RuleRef.md new file mode 100644 index 00000000000..19f2475fb6e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.RuleRef.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[T] RuleRef" + +--- +```ts +RuleRef: \${string}/${string}\ +``` + +Reference to a rule. In this format `:` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ScopeNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ScopeNode.md new file mode 100644 index 00000000000..1cb4e7edd75 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ScopeNode.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] ScopeNode" + +--- +```ts +ScopeNode: NamespaceStatementNode | ModelStatementNode | InterfaceStatementNode | AliasStatementNode | TypeSpecScriptNode | JsSourceFileNode | ProjectionLambdaExpressionNode | ProjectionNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SemanticNodeListener.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SemanticNodeListener.md new file mode 100644 index 00000000000..79718ca9026 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SemanticNodeListener.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[T] SemanticNodeListener" + +--- +```ts +SemanticNodeListener: {root: (context) => void | undefined;} & TypeListeners +``` + +| Member | Type | +| :------ | :------ | +| `root`? | (`context`) => `void` \| `undefined` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SourceFileKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SourceFileKind.md new file mode 100644 index 00000000000..7e2eb480e7e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SourceFileKind.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[T] SourceFileKind" + +--- +```ts +SourceFileKind: "typespec" | "js" +``` + +Type of the source file that can be loaded via typespec diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Statement.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Statement.md new file mode 100644 index 00000000000..0b3e9db0e24 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Statement.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] Statement" + +--- +```ts +Statement: ImportStatementNode | ModelStatementNode | ScalarStatementNode | NamespaceStatementNode | InterfaceStatementNode | UnionStatementNode | UsingStatementNode | EnumStatementNode | AliasStatementNode | OperationStatementNode | DecoratorDeclarationStatementNode | FunctionDeclarationStatementNode | AugmentDecoratorStatementNode | EmptyStatementNode | InvalidStatementNode | ProjectionStatementNode +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypeName.md new file mode 100644 index 00000000000..f78f2b97bf2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypeName.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] StdTypeName" + +--- +```ts +StdTypeName: keyof StdTypes +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypes.md new file mode 100644 index 00000000000..bc0596293b7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypes.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[T] StdTypes" + +--- +```ts +StdTypes: {Array: Model; Record: Model;} & Record< IntrinsicScalarName, Scalar > +``` + +| Member | Type | +| :------ | :------ | +| `Array` | [`Model`](Interface.Model.md) | +| `Record` | [`Model`](Interface.Model.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplateableNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplateableNode.md new file mode 100644 index 00000000000..560da38b197 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplateableNode.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[T] TemplateableNode" + +--- +```ts +TemplateableNode: ModelStatementNode | ScalarStatementNode | AliasStatementNode | InterfaceStatementNode | OperationStatementNode | UnionStatementNode +``` + +Node that can be used as template diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplatedType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplatedType.md new file mode 100644 index 00000000000..02002bbabb0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplatedType.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[T] TemplatedType" + +--- +```ts +TemplatedType: Model | Operation | Interface | Union +``` + +Union of all the types that implement TemplatedTypeBase diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TrackableType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TrackableType.md new file mode 100644 index 00000000000..c2ec2763603 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TrackableType.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] TrackableType" + +--- +```ts +TrackableType: Model | Enum | Union | Tuple +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Type.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Type.md new file mode 100644 index 00000000000..dccdfc10b7c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Type.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] Type" + +--- +```ts +Type: Model | ModelProperty | Scalar | Interface | Enum | EnumMember | TemplateParameter | Namespace | Operation | StringLiteral | NumericLiteral | BooleanLiteral | Tuple | Union | UnionVariant | IntrinsicType | FunctionType | Decorator | FunctionParameter | ObjectType | Projection +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeKind.md new file mode 100644 index 00000000000..f6acdb52883 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeKind.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] TypeKind" + +--- +```ts +TypeKind: Type["kind"] | "Any" +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeListeners.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeListeners.md new file mode 100644 index 00000000000..6000b1afda4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeListeners.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] TypeListeners" + +--- +```ts +TypeListeners: UnionToIntersection< ListenerForType< Type > > +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOfDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOfDiagnostics.md new file mode 100644 index 00000000000..2705df5ada8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOfDiagnostics.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] TypeOfDiagnostics" + +--- +```ts +TypeOfDiagnostics: T extends DiagnosticMap< infer D > ? D : never +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` *extends* [`DiagnosticMap`](Type.DiagnosticMap.md)< `any` \> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOrReturnRecord.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOrReturnRecord.md new file mode 100644 index 00000000000..0c4bc243fb6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOrReturnRecord.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] TypeOrReturnRecord" + +--- +```ts +TypeOrReturnRecord: Type | ReturnRecord +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeSpecDiagnosticTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeSpecDiagnosticTarget.md new file mode 100644 index 00000000000..eb722cc033b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeSpecDiagnosticTarget.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[T] TypeSpecDiagnosticTarget" + +--- +```ts +TypeSpecDiagnosticTarget: Node | Type | Sym +``` + +Diagnostic target that can be used when working with TypeSpec types. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeSpecValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeSpecValue.md new file mode 100644 index 00000000000..6b7daa55102 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeSpecValue.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] TypeSpecValue" + +--- +```ts +TypeSpecValue: Type | string | number | boolean +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.WriteLine.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.WriteLine.md new file mode 100644 index 00000000000..a84cc2a76b4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.WriteLine.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[T] WriteLine" + +--- +```ts +WriteLine: (text?) => void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `text`? | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.CadlPrettierPlugin.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.CadlPrettierPlugin.md new file mode 100644 index 00000000000..f504e22fca8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.CadlPrettierPlugin.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[V] CadlPrettierPlugin" + +--- +```ts +const CadlPrettierPlugin: __module = TypeSpecPrettierPlugin +``` + +## Deprecated + +Use TypeSpecPrettierPlugin diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.Keywords.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.Keywords.md new file mode 100644 index 00000000000..fa2e31f6231 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.Keywords.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] Keywords" + +--- +```ts +const Keywords: ReadonlyMap< string, Token > +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.MANIFEST.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.MANIFEST.md new file mode 100644 index 00000000000..cff969ba0c1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.MANIFEST.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] MANIFEST" + +--- +```ts +const MANIFEST: TypeSpecManifest = manifest +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.NoTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.NoTarget.md new file mode 100644 index 00000000000..ae7a069ea5f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.NoTarget.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[V] NoTarget" + +--- +```ts +const NoTarget: typeof NoTarget +``` + +Used to explicitly specify that a diagnostic has no target. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.NodeHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.NodeHost.md new file mode 100644 index 00000000000..6e8a80c7853 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.NodeHost.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[V] NodeHost" + +--- +```ts +const NodeHost: CompilerHost +``` + +Implementation of the + +## See + +CompilerHost using the real file system. +This is the the CompilerHost used by TypeSpec CLI. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TokenDisplay.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TokenDisplay.md new file mode 100644 index 00000000000..82d992f8790 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TokenDisplay.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] TokenDisplay" + +--- +```ts +const TokenDisplay: readonly string[] +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TypeSpecPrettierPlugin.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TypeSpecPrettierPlugin.md new file mode 100644 index 00000000000..f08ce9e9f00 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TypeSpecPrettierPlugin.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] TypeSpecPrettierPlugin" + +--- +```ts +const TypeSpecPrettierPlugin: __module = formatter +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.altDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.altDirectorySeparator.md new file mode 100644 index 00000000000..a6e3d2bb533 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.altDirectorySeparator.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] altDirectorySeparator" + +--- +```ts +const altDirectorySeparator: "\\" = "\\" +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.cadlVersion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.cadlVersion.md new file mode 100644 index 00000000000..69db7c70a41 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.cadlVersion.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[V] cadlVersion" + +--- +```ts +const cadlVersion: any = typespecVersion +``` + +## Deprecated + +Use typespecVersion diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.directorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.directorySeparator.md new file mode 100644 index 00000000000..69aa8338654 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.directorySeparator.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[V] directorySeparator" + +--- +```ts +const directorySeparator: "/" = "/" +``` + +Internally, we represent paths as strings with '/' as the directory separator. +When we make system calls (eg: LanguageServiceHost.getDirectory()), +we expect the host to correctly handle paths in our specified format. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.typespecVersion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.typespecVersion.md new file mode 100644 index 00000000000..2779326d173 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.typespecVersion.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] typespecVersion" + +--- +```ts +const typespecVersion: any = manifest.version +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md new file mode 100644 index 00000000000..df7ef0b2018 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md @@ -0,0 +1,1380 @@ +--- +jsApi: true +title: "[P] JS Api" + +--- +## Index + +### Namespaces + +- [decorators](Namespace.decorators.md) + +### Enumerations + +- [IdentifierKind](Enumeration.IdentifierKind.md) +- [KeywordLimit](Enumeration.KeywordLimit.md) +- [ListenerFlow](Enumeration.ListenerFlow.md) +- [ModifierFlags](Enumeration.ModifierFlags.md) +- [NodeFlags](Enumeration.NodeFlags.md) +- [SemanticTokenKind](Enumeration.SemanticTokenKind.md) +- [SymbolFlags](Enumeration.SymbolFlags.md) +- [SyntaxKind](Enumeration.SyntaxKind.md) +- [Token](Enumeration.Token.md) +- [TokenFlags](Enumeration.TokenFlags.md) +- [UsageFlags](Enumeration.UsageFlags.md) + +### Classes + +- [DuplicateTracker](Class.DuplicateTracker.md) +- [EventEmitter](Class.EventEmitter.md) +- [InvalidEncodingError](Class.InvalidEncodingError.md) +- [ProjectionError](Class.ProjectionError.md) +- [Queue](Class.Queue.md) +- [ResolveModuleError](Class.ResolveModuleError.md) + +### Interfaces + +- [AliasStatementNode](Interface.AliasStatementNode.md) +- [AnyKeywordNode](Interface.AnyKeywordNode.md) +- [ArrayExpressionNode](Interface.ArrayExpressionNode.md) +- [ArrayModelType](Interface.ArrayModelType.md) +- [AugmentDecoratorStatementNode](Interface.AugmentDecoratorStatementNode.md) +- [BaseNode](Interface.BaseNode.md) +- [BaseType](Interface.BaseType.md) +- [BlockComment](Interface.BlockComment.md) +- [BooleanLiteral](Interface.BooleanLiteral.md) +- [BooleanLiteralNode](Interface.BooleanLiteralNode.md) +- [CallableMessage](Interface.CallableMessage.md) +- [Checker](Interface.Checker.md) +- [CompilerHost](Interface.CompilerHost.md) +- [CompilerLocationContext](Interface.CompilerLocationContext.md) +- [CompilerOptions](Interface.CompilerOptions.md) +- [DeclarationNode](Interface.DeclarationNode.md) +- [DecoratedType](Interface.DecoratedType.md) +- [Decorator](Interface.Decorator.md) +- [DecoratorApplication](Interface.DecoratorApplication.md) +- [DecoratorArgument](Interface.DecoratorArgument.md) +- [DecoratorContext](Interface.DecoratorContext.md) +- [DecoratorDeclarationStatementNode](Interface.DecoratorDeclarationStatementNode.md) +- [DecoratorDefinition](Interface.DecoratorDefinition.md) +- [DecoratorExpressionNode](Interface.DecoratorExpressionNode.md) +- [DecoratorFunction](Interface.DecoratorFunction.md) +- [DecoratorParamDefinition](Interface.DecoratorParamDefinition.md) +- [DecoratorValidator](Interface.DecoratorValidator.md) +- [DeprecatedDirective](Interface.DeprecatedDirective.md) +- [DeprecationDetails](Interface.DeprecationDetails.md) +- [Diagnostic](Interface.Diagnostic.md) +- [DiagnosticCollector](Interface.DiagnosticCollector.md) +- [DiagnosticCreator](Interface.DiagnosticCreator.md) +- [DiagnosticDefinition](Interface.DiagnosticDefinition.md) +- [DiagnosticMessages](Interface.DiagnosticMessages.md) +- [DirectiveBase](Interface.DirectiveBase.md) +- [DirectiveExpressionNode](Interface.DirectiveExpressionNode.md) +- [Dirent](Interface.Dirent.md) +- [DiscriminatedUnion](Interface.DiscriminatedUnion.md) +- [DocNode](Interface.DocNode.md) +- [DocParamTagNode](Interface.DocParamTagNode.md) +- [DocReturnsTagNode](Interface.DocReturnsTagNode.md) +- [DocTagBaseNode](Interface.DocTagBaseNode.md) +- [DocTemplateTagNode](Interface.DocTemplateTagNode.md) +- [DocTextNode](Interface.DocTextNode.md) +- [DocUnknownTagNode](Interface.DocUnknownTagNode.md) +- [EmitContext](Interface.EmitContext.md) +- [EmitFileOptions](Interface.EmitFileOptions.md) +- [EmptyStatementNode](Interface.EmptyStatementNode.md) +- [Enum](Interface.Enum.md) +- [EnumMember](Interface.EnumMember.md) +- [EnumMemberNode](Interface.EnumMemberNode.md) +- [EnumSpreadMemberNode](Interface.EnumSpreadMemberNode.md) +- [EnumStatementNode](Interface.EnumStatementNode.md) +- [ErrorType](Interface.ErrorType.md) +- [ExternKeywordNode](Interface.ExternKeywordNode.md) +- [FileLibraryMetadata](Interface.FileLibraryMetadata.md) +- [FunctionDeclarationStatementNode](Interface.FunctionDeclarationStatementNode.md) +- [FunctionParameter](Interface.FunctionParameter.md) +- [FunctionParameterNode](Interface.FunctionParameterNode.md) +- [FunctionType](Interface.FunctionType.md) +- [IdentifierContext](Interface.IdentifierContext.md) +- [IdentifierNode](Interface.IdentifierNode.md) +- [ImportStatementNode](Interface.ImportStatementNode.md) +- [Interface](Interface.Interface.md) +- [InterfaceStatementNode](Interface.InterfaceStatementNode.md) +- [IntersectionExpressionNode](Interface.IntersectionExpressionNode.md) +- [IntrinsicType](Interface.IntrinsicType.md) +- [InvalidStatementNode](Interface.InvalidStatementNode.md) +- [JSONSchemaValidator](Interface.JSONSchemaValidator.md) +- [JsNamespaceDeclarationNode](Interface.JsNamespaceDeclarationNode.md) +- [JsSourceFileNode](Interface.JsSourceFileNode.md) +- [LibraryInstance](Interface.LibraryInstance.md) +- [LibraryLocationContext](Interface.LibraryLocationContext.md) +- [LineAndCharacter](Interface.LineAndCharacter.md) +- [LineComment](Interface.LineComment.md) +- [LinterDefinition](Interface.LinterDefinition.md) +- [LinterRule](Interface.LinterRule.md) +- [LinterRuleContext](Interface.LinterRuleContext.md) +- [LinterRuleDefinition](Interface.LinterRuleDefinition.md) +- [LinterRuleSet](Interface.LinterRuleSet.md) +- [ListOperationOptions](Interface.ListOperationOptions.md) +- [LogInfo](Interface.LogInfo.md) +- [LogSink](Interface.LogSink.md) +- [Logger](Interface.Logger.md) +- [MemberExpressionNode](Interface.MemberExpressionNode.md) +- [Model](Interface.Model.md) +- [ModelExpressionNode](Interface.ModelExpressionNode.md) +- [ModelProperty](Interface.ModelProperty.md) +- [ModelPropertyNode](Interface.ModelPropertyNode.md) +- [ModelSpreadPropertyNode](Interface.ModelSpreadPropertyNode.md) +- [ModelStatementNode](Interface.ModelStatementNode.md) +- [ModuleLibraryMetadata](Interface.ModuleLibraryMetadata.md) +- [Namespace](Interface.Namespace.md) +- [NamespaceNavigationOptions](Interface.NamespaceNavigationOptions.md) +- [NamespaceStatementNode](Interface.NamespaceStatementNode.md) +- [NavigationOptions](Interface.NavigationOptions.md) +- [NeverKeywordNode](Interface.NeverKeywordNode.md) +- [NeverType](Interface.NeverType.md) +- [NodePackage](Interface.NodePackage.md) +- [NullType](Interface.NullType.md) +- [NumericLiteral](Interface.NumericLiteral.md) +- [NumericLiteralNode](Interface.NumericLiteralNode.md) +- [ObjectType](Interface.ObjectType.md) +- [Operation](Interface.Operation.md) +- [OperationSignatureDeclarationNode](Interface.OperationSignatureDeclarationNode.md) +- [OperationSignatureReferenceNode](Interface.OperationSignatureReferenceNode.md) +- [OperationStatementNode](Interface.OperationStatementNode.md) +- [ParseOptions](Interface.ParseOptions.md) +- [ProcessedLog](Interface.ProcessedLog.md) +- [Program](Interface.Program.md) +- [ProjectLocationContext](Interface.ProjectLocationContext.md) +- [ProjectedNameView](Interface.ProjectedNameView.md) +- [ProjectedProgram](Interface.ProjectedProgram.md) +- [Projection](Interface.Projection.md) +- [ProjectionApplication](Interface.ProjectionApplication.md) +- [ProjectionArithmeticExpressionNode](Interface.ProjectionArithmeticExpressionNode.md) +- [ProjectionBlockExpressionNode](Interface.ProjectionBlockExpressionNode.md) +- [ProjectionCallExpressionNode](Interface.ProjectionCallExpressionNode.md) +- [ProjectionDecoratorReferenceExpressionNode](Interface.ProjectionDecoratorReferenceExpressionNode.md) +- [ProjectionEnumMemberSelectorNode](Interface.ProjectionEnumMemberSelectorNode.md) +- [ProjectionEnumSelectorNode](Interface.ProjectionEnumSelectorNode.md) +- [ProjectionEqualityExpressionNode](Interface.ProjectionEqualityExpressionNode.md) +- [ProjectionExpressionStatementNode](Interface.ProjectionExpressionStatementNode.md) +- [ProjectionIfExpressionNode](Interface.ProjectionIfExpressionNode.md) +- [ProjectionInterfaceSelectorNode](Interface.ProjectionInterfaceSelectorNode.md) +- [ProjectionLambdaExpressionNode](Interface.ProjectionLambdaExpressionNode.md) +- [ProjectionLambdaParameterDeclarationNode](Interface.ProjectionLambdaParameterDeclarationNode.md) +- [ProjectionLogicalExpressionNode](Interface.ProjectionLogicalExpressionNode.md) +- [ProjectionMemberExpressionNode](Interface.ProjectionMemberExpressionNode.md) +- [ProjectionModelExpressionNode](Interface.ProjectionModelExpressionNode.md) +- [ProjectionModelPropertyNode](Interface.ProjectionModelPropertyNode.md) +- [ProjectionModelPropertySelectorNode](Interface.ProjectionModelPropertySelectorNode.md) +- [ProjectionModelSelectorNode](Interface.ProjectionModelSelectorNode.md) +- [ProjectionModelSpreadPropertyNode](Interface.ProjectionModelSpreadPropertyNode.md) +- [ProjectionNode](Interface.ProjectionNode.md) +- [ProjectionOperationSelectorNode](Interface.ProjectionOperationSelectorNode.md) +- [ProjectionParameterDeclarationNode](Interface.ProjectionParameterDeclarationNode.md) +- [ProjectionReferenceNode](Interface.ProjectionReferenceNode.md) +- [ProjectionRelationalExpressionNode](Interface.ProjectionRelationalExpressionNode.md) +- [ProjectionStatementNode](Interface.ProjectionStatementNode.md) +- [ProjectionTupleExpressionNode](Interface.ProjectionTupleExpressionNode.md) +- [ProjectionUnaryExpressionNode](Interface.ProjectionUnaryExpressionNode.md) +- [ProjectionUnionSelectorNode](Interface.ProjectionUnionSelectorNode.md) +- [ProjectionUnionVariantSelectorNode](Interface.ProjectionUnionVariantSelectorNode.md) +- [Projector](Interface.Projector.md) +- [RecordModelType](Interface.RecordModelType.md) +- [ResolveCompilerOptionsOptions](Interface.ResolveCompilerOptionsOptions.md) +- [ResolveModuleHost](Interface.ResolveModuleHost.md) +- [ResolveModuleOptions](Interface.ResolveModuleOptions.md) +- [ResolvedFile](Interface.ResolvedFile.md) +- [ResolvedModule](Interface.ResolvedModule.md) +- [ReturnExpressionNode](Interface.ReturnExpressionNode.md) +- [ReturnRecord](Interface.ReturnRecord.md) +- [RmOptions](Interface.RmOptions.md) +- [Scalar](Interface.Scalar.md) +- [ScalarStatementNode](Interface.ScalarStatementNode.md) +- [Scanner](Interface.Scanner.md) +- [SemanticToken](Interface.SemanticToken.md) +- [Server](Interface.Server.md) +- [ServerHost](Interface.ServerHost.md) +- [ServerSourceFile](Interface.ServerSourceFile.md) +- [ServerWorkspaceFolder](Interface.ServerWorkspaceFolder.md) +- [SourceFile](Interface.SourceFile.md) +- [SourceLocation](Interface.SourceLocation.md) +- [SourceLocationOptions](Interface.SourceLocationOptions.md) +- [StringLiteral](Interface.StringLiteral.md) +- [StringLiteralNode](Interface.StringLiteralNode.md) +- [SuppressDirective](Interface.SuppressDirective.md) +- [Sym](Interface.Sym.md) +- [SymbolLinks](Interface.SymbolLinks.md) +- [SyntheticLocationContext](Interface.SyntheticLocationContext.md) +- [TemplateDeclarationNode](Interface.TemplateDeclarationNode.md) +- [TemplateParameter](Interface.TemplateParameter.md) +- [TemplateParameterDeclarationNode](Interface.TemplateParameterDeclarationNode.md) +- [TemplatedTypeBase](Interface.TemplatedTypeBase.md) +- [TextRange](Interface.TextRange.md) +- [Tracer](Interface.Tracer.md) +- [TracerOptions](Interface.TracerOptions.md) +- [Tuple](Interface.Tuple.md) +- [TupleExpressionNode](Interface.TupleExpressionNode.md) +- [TypeInstantiationMap](Interface.TypeInstantiationMap.md) +- [TypeMapper](Interface.TypeMapper.md) +- [TypeNameOptions](Interface.TypeNameOptions.md) +- [TypeReferenceNode](Interface.TypeReferenceNode.md) +- [TypeSpecCompletionItem](Interface.TypeSpecCompletionItem.md) +- [TypeSpecLibrary](Interface.TypeSpecLibrary.md) +- [TypeSpecLibraryDef](Interface.TypeSpecLibraryDef.md) +- [TypeSpecManifest](Interface.TypeSpecManifest.md) +- [TypeSpecScriptNode](Interface.TypeSpecScriptNode.md) +- [Union](Interface.Union.md) +- [UnionExpressionNode](Interface.UnionExpressionNode.md) +- [UnionStatementNode](Interface.UnionStatementNode.md) +- [UnionVariant](Interface.UnionVariant.md) +- [UnionVariantNode](Interface.UnionVariantNode.md) +- [UnknownType](Interface.UnknownType.md) +- [UsageTracker](Interface.UsageTracker.md) +- [UsingStatementNode](Interface.UsingStatementNode.md) +- [ValueOfExpressionNode](Interface.ValueOfExpressionNode.md) +- [ValueType](Interface.ValueType.md) +- [VoidKeywordNode](Interface.VoidKeywordNode.md) +- [VoidType](Interface.VoidType.md) + +### Type Aliases + +- [CadlCompletionItem](Type.CadlCompletionItem.md) +- [CadlLibrary](Type.CadlLibrary.md) +- [CadlLibraryDef](Type.CadlLibraryDef.md) +- [CadlManifest](Type.CadlManifest.md) +- [CadlScriptNode](Type.CadlScriptNode.md) +- [CadlValue](Type.CadlValue.md) +- [Comment](Type.Comment.md) +- [CreateTypeProps](Type.CreateTypeProps.md) +- [Declaration](Type.Declaration.md) +- [DecoratorArgumentValue](Type.DecoratorArgumentValue.md) +- [DiagnosticFormat](Type.DiagnosticFormat.md) +- [DiagnosticHandler](Type.DiagnosticHandler.md) +- [DiagnosticMap](Type.DiagnosticMap.md) +- [DiagnosticReport](Type.DiagnosticReport.md) +- [DiagnosticReportWithoutTarget](Type.DiagnosticReportWithoutTarget.md) +- [DiagnosticResult](Type.DiagnosticResult.md) +- [DiagnosticSeverity](Type.DiagnosticSeverity.md) +- [DiagnosticTarget](Type.DiagnosticTarget.md) +- [Directive](Type.Directive.md) +- [DirectiveArgument](Type.DirectiveArgument.md) +- [DocContent](Type.DocContent.md) +- [DocTag](Type.DocTag.md) +- [DocToken](Type.DocToken.md) +- [EmitOptionsFor](Type.EmitOptionsFor.md) +- [EmitterFunc](Type.EmitterFunc.md) +- [Expression](Type.Expression.md) +- [InferredCadlValue](Type.InferredCadlValue.md) +- [InferredTypeSpecValue](Type.InferredTypeSpecValue.md) +- [IntrinsicScalarName](Type.IntrinsicScalarName.md) +- [JSONSchemaType](Type.JSONSchemaType.md) +- [LibraryMetadata](Type.LibraryMetadata.md) +- [LinterRuleDiagnosticFormat](Type.LinterRuleDiagnosticFormat.md) +- [LinterRuleDiagnosticReport](Type.LinterRuleDiagnosticReport.md) +- [LinterRuleDiagnosticReportWithoutTarget](Type.LinterRuleDiagnosticReportWithoutTarget.md) +- [LiteralNode](Type.LiteralNode.md) +- [LiteralType](Type.LiteralType.md) +- [LocationContext](Type.LocationContext.md) +- [LogLevel](Type.LogLevel.md) +- [MarshalledValue](Type.MarshalledValue.md) +- [MemberContainerNode](Type.MemberContainerNode.md) +- [MemberContainerType](Type.MemberContainerType.md) +- [MemberNode](Type.MemberNode.md) +- [MemberType](Type.MemberType.md) +- [ModelIndexer](Type.ModelIndexer.md) +- [Modifier](Type.Modifier.md) +- [ModuleResolutionResult](Type.ModuleResolutionResult.md) +- [NeverIndexer](Type.NeverIndexer.md) +- [NewLine](Type.NewLine.md) +- [Node](Type.Node.md) +- [NodeCallback](Type.NodeCallback.md) +- [OperationContainer](Type.OperationContainer.md) +- [OperationSignature](Type.OperationSignature.md) +- [ProjectionExpression](Type.ProjectionExpression.md) +- [ProjectionStatementItem](Type.ProjectionStatementItem.md) +- [ReferenceExpression](Type.ReferenceExpression.md) +- [RuleRef](Type.RuleRef.md) +- [ScopeNode](Type.ScopeNode.md) +- [SemanticNodeListener](Type.SemanticNodeListener.md) +- [SourceFileKind](Type.SourceFileKind.md) +- [Statement](Type.Statement.md) +- [StdTypeName](Type.StdTypeName.md) +- [StdTypes](Type.StdTypes.md) +- [TemplateableNode](Type.TemplateableNode.md) +- [TemplatedType](Type.TemplatedType.md) +- [TrackableType](Type.TrackableType.md) +- [Type](Type.Type.md) +- [TypeKind](Type.TypeKind.md) +- [TypeListeners](Type.TypeListeners.md) +- [TypeOfDiagnostics](Type.TypeOfDiagnostics.md) +- [TypeOrReturnRecord](Type.TypeOrReturnRecord.md) +- [TypeSpecDiagnosticTarget](Type.TypeSpecDiagnosticTarget.md) +- [TypeSpecValue](Type.TypeSpecValue.md) +- [WriteLine](Type.WriteLine.md) + +### Variables + +- [CadlPrettierPlugin](Variable.CadlPrettierPlugin.md) +- [Keywords](Variable.Keywords.md) +- [MANIFEST](Variable.MANIFEST.md) +- [NoTarget](Variable.NoTarget.md) +- [NodeHost](Variable.NodeHost.md) +- [TokenDisplay](Variable.TokenDisplay.md) +- [TypeSpecPrettierPlugin](Variable.TypeSpecPrettierPlugin.md) +- [altDirectorySeparator](Variable.altDirectorySeparator.md) +- [cadlVersion](Variable.cadlVersion.md) +- [directorySeparator](Variable.directorySeparator.md) +- [typespecVersion](Variable.typespecVersion.md) + +### Functions + +- [assertType](Function.assertType.md) +- [cadlTypeToJson](Function.cadlTypeToJson.md) +- [checkFormatCadl](Function.checkFormatCadl.md) +- [checkFormatTypeSpec](Function.checkFormatTypeSpec.md) +- [compile](Function.compile.md) +- [compilerAssert](Function.compilerAssert.md) +- [createCadlLibrary](Function.createCadlLibrary.md) +- [createChecker](Function.createChecker.md) +- [createDecoratorDefinition](Function.createDecoratorDefinition.md) +- [createDiagnosticCollector](Function.createDiagnosticCollector.md) +- [createDiagnosticCreator](Function.createDiagnosticCreator.md) +- [createProjectedNameProgram](Function.createProjectedNameProgram.md) +- [createRekeyableMap](Function.createRekeyableMap.md) +- [createRule](Function.createRule.md) +- [createScanner](Function.createScanner.md) +- [createServer](Function.createServer.md) +- [createSourceFile](Function.createSourceFile.md) +- [createStateAccessors](Function.createStateAccessors.md) +- [createTypeSpecLibrary](Function.createTypeSpecLibrary.md) +- [emitFile](Function.emitFile.md) +- [ensurePathIsNonModuleName](Function.ensurePathIsNonModuleName.md) +- [ensureTrailingDirectorySeparator](Function.ensureTrailingDirectorySeparator.md) +- [filterModelProperties](Function.filterModelProperties.md) +- [finishTypeForProgram](Function.finishTypeForProgram.md) +- [formatDiagnostic](Function.formatDiagnostic.md) +- [formatIdentifier](Function.formatIdentifier.md) +- [formatTypeSpec](Function.formatTypeSpec.md) +- [getAnyExtensionFromPath](Function.getAnyExtensionFromPath.md) +- [getBaseFileName](Function.getBaseFileName.md) +- [getCompletionNodeAtPosition](Function.getCompletionNodeAtPosition.md) +- [getDeprecationDetails](Function.getDeprecationDetails.md) +- [getDirectoryPath](Function.getDirectoryPath.md) +- [getDiscriminatedUnion](Function.getDiscriminatedUnion.md) +- [getEffectiveModelType](Function.getEffectiveModelType.md) +- [getFirstAncestor](Function.getFirstAncestor.md) +- [getFullyQualifiedSymbolName](Function.getFullyQualifiedSymbolName.md) +- [getIdentifierContext](Function.getIdentifierContext.md) +- [getLocationContext](Function.getLocationContext.md) +- [getNamespaceFullName](Function.getNamespaceFullName.md) +- [getNodeAtPosition](Function.getNodeAtPosition.md) +- [getNormalizedAbsolutePath](Function.getNormalizedAbsolutePath.md) +- [getNormalizedAbsolutePathWithoutRoot](Function.getNormalizedAbsolutePathWithoutRoot.md) +- [getNormalizedPathComponents](Function.getNormalizedPathComponents.md) +- [getOverriddenProperty](Function.getOverriddenProperty.md) +- [getParentTemplateNode](Function.getParentTemplateNode.md) +- [getPathComponents](Function.getPathComponents.md) +- [getPathFromPathComponents](Function.getPathFromPathComponents.md) +- [getProperty](Function.getProperty.md) +- [getRelativePathFromDirectory](Function.getRelativePathFromDirectory.md) +- [getRootLength](Function.getRootLength.md) +- [getSourceFileKindFromExt](Function.getSourceFileKindFromExt.md) +- [getSourceLocation](Function.getSourceLocation.md) +- [getTypeName](Function.getTypeName.md) +- [hasParseError](Function.hasParseError.md) +- [hasTrailingDirectorySeparator](Function.hasTrailingDirectorySeparator.md) +- [ignoreDiagnostics](Function.ignoreDiagnostics.md) +- [interpolatePath](Function.interpolatePath.md) +- [isAnyDirectorySeparator](Function.isAnyDirectorySeparator.md) +- [isCadlValueTypeOf](Function.isCadlValueTypeOf.md) +- [isComment](Function.isComment.md) +- [isDeclaredInNamespace](Function.isDeclaredInNamespace.md) +- [isDeclaredType](Function.isDeclaredType.md) +- [isDeprecated](Function.isDeprecated.md) +- [isErrorType](Function.isErrorType.md) +- [isGlobalNamespace](Function.isGlobalNamespace.md) +- [isImportStatement](Function.isImportStatement.md) +- [isIntrinsicType](Function.isIntrinsicType.md) +- [isKeyword](Function.isKeyword.md) +- [isModifier](Function.isModifier.md) +- [isNeverType](Function.isNeverType.md) +- [isNullType](Function.isNullType.md) +- [isPathAbsolute](Function.isPathAbsolute.md) +- [isProjectedProgram](Function.isProjectedProgram.md) +- [isPunctuation](Function.isPunctuation.md) +- [isStatementKeyword](Function.isStatementKeyword.md) +- [isStdNamespace](Function.isStdNamespace.md) +- [isTemplateDeclaration](Function.isTemplateDeclaration.md) +- [isTemplateDeclarationOrInstance](Function.isTemplateDeclarationOrInstance.md) +- [isTemplateInstance](Function.isTemplateInstance.md) +- [isTrivia](Function.isTrivia.md) +- [isTypeSpecValueTypeOf](Function.isTypeSpecValueTypeOf.md) +- [isUnknownType](Function.isUnknownType.md) +- [isUrl](Function.isUrl.md) +- [isVoidType](Function.isVoidType.md) +- [joinPaths](Function.joinPaths.md) +- [listOperationsIn](Function.listOperationsIn.md) +- [logDiagnostics](Function.logDiagnostics.md) +- [logVerboseTestOutput](Function.logVerboseTestOutput.md) +- [mapEventEmitterToNodeListener](Function.mapEventEmitterToNodeListener.md) +- [markDeprecated](Function.markDeprecated.md) +- [navigateProgram](Function.navigateProgram.md) +- [navigateType](Function.navigateType.md) +- [navigateTypesInNamespace](Function.navigateTypesInNamespace.md) +- [normalizePath](Function.normalizePath.md) +- [normalizeSlashes](Function.normalizeSlashes.md) +- [paramMessage](Function.paramMessage.md) +- [parse](Function.parse.md) +- [parseStandaloneTypeReference](Function.parseStandaloneTypeReference.md) +- [projectProgram](Function.projectProgram.md) +- [reducePathComponents](Function.reducePathComponents.md) +- [removeTrailingDirectorySeparator](Function.removeTrailingDirectorySeparator.md) +- [reportDeprecated](Function.reportDeprecated.md) +- [resolveCompilerOptions](Function.resolveCompilerOptions.md) +- [resolveModule](Function.resolveModule.md) +- [resolvePath](Function.resolvePath.md) +- [resolveUsages](Function.resolveUsages.md) +- [scopeNavigationToNamespace](Function.scopeNavigationToNamespace.md) +- [setCadlNamespace](Function.setCadlNamespace.md) +- [setTypeSpecNamespace](Function.setTypeSpecNamespace.md) +- [skipTrivia](Function.skipTrivia.md) +- [skipWhiteSpace](Function.skipWhiteSpace.md) +- [typespecTypeToJson](Function.typespecTypeToJson.md) +- [validateDecoratorNotOnType](Function.validateDecoratorNotOnType.md) +- [validateDecoratorParamCount](Function.validateDecoratorParamCount.md) +- [validateDecoratorParamType](Function.validateDecoratorParamType.md) +- [validateDecoratorTarget](Function.validateDecoratorTarget.md) +- [validateDecoratorTargetIntrinsic](Function.validateDecoratorTargetIntrinsic.md) +- [validateDecoratorUniqueOnNode](Function.validateDecoratorUniqueOnNode.md) +- [visitChildren](Function.visitChildren.md) +- [walkPropertiesInherited](Function.walkPropertiesInherited.md) + +## References + +### $deprecated + +Re-exports [$deprecated](Namespace.decorators.Function.$deprecated.md) + +```ts +$deprecated +``` + +*** + +### $discriminator + +Re-exports [$discriminator](Namespace.decorators.Function.$discriminator.md) + +```ts +$discriminator +``` + +*** + +### $doc + +Re-exports [$doc](Namespace.decorators.Function.$doc.md) + +```ts +$doc +``` + +*** + +### $docFromComment + +Re-exports [$docFromComment](Namespace.decorators.Function.$docFromComment.md) + +```ts +$docFromComment +``` + +*** + +### $encode + +Re-exports [$encode](Namespace.decorators.Function.$encode.md) + +```ts +$encode +``` + +*** + +### $error + +Re-exports [$error](Namespace.decorators.Function.$error.md) + +```ts +$error +``` + +*** + +### $format + +Re-exports [$format](Namespace.decorators.Function.$format.md) + +```ts +$format +``` + +*** + +### $friendlyName + +Re-exports [$friendlyName](Namespace.decorators.Function.$friendlyName.md) + +```ts +$friendlyName +``` + +*** + +### $indexer + +Re-exports [$indexer](Namespace.decorators.Function.$indexer.md) + +```ts +$indexer +``` + +*** + +### $inspectType + +Re-exports [$inspectType](Namespace.decorators.Function.$inspectType.md) + +```ts +$inspectType +``` + +*** + +### $inspectTypeName + +Re-exports [$inspectTypeName](Namespace.decorators.Function.$inspectTypeName.md) + +```ts +$inspectTypeName +``` + +*** + +### $key + +Re-exports [$key](Namespace.decorators.Function.$key.md) + +```ts +$key +``` + +*** + +### $knownValues + +Re-exports [$knownValues](Namespace.decorators.Function.$knownValues.md) + +```ts +$knownValues +``` + +*** + +### $list + +Re-exports [$list](Namespace.decorators.Function.$list.md) + +```ts +$list +``` + +*** + +### $maxItems + +Re-exports [$maxItems](Namespace.decorators.Function.$maxItems.md) + +```ts +$maxItems +``` + +*** + +### $maxLength + +Re-exports [$maxLength](Namespace.decorators.Function.$maxLength.md) + +```ts +$maxLength +``` + +*** + +### $maxValue + +Re-exports [$maxValue](Namespace.decorators.Function.$maxValue.md) + +```ts +$maxValue +``` + +*** + +### $maxValueExclusive + +Re-exports [$maxValueExclusive](Namespace.decorators.Function.$maxValueExclusive.md) + +```ts +$maxValueExclusive +``` + +*** + +### $minItems + +Re-exports [$minItems](Namespace.decorators.Function.$minItems.md) + +```ts +$minItems +``` + +*** + +### $minLength + +Re-exports [$minLength](Namespace.decorators.Function.$minLength.md) + +```ts +$minLength +``` + +*** + +### $minValue + +Re-exports [$minValue](Namespace.decorators.Function.$minValue.md) + +```ts +$minValue +``` + +*** + +### $minValueExclusive + +Re-exports [$minValueExclusive](Namespace.decorators.Function.$minValueExclusive.md) + +```ts +$minValueExclusive +``` + +*** + +### $overload + +Re-exports [$overload](Namespace.decorators.Function.$overload.md) + +```ts +$overload +``` + +*** + +### $parameterVisibility + +Re-exports [$parameterVisibility](Namespace.decorators.Function.$parameterVisibility.md) + +```ts +$parameterVisibility +``` + +*** + +### $pattern + +Re-exports [$pattern](Namespace.decorators.Function.$pattern.md) + +```ts +$pattern +``` + +*** + +### $projectedName + +Re-exports [$projectedName](Namespace.decorators.Function.$projectedName.md) + +```ts +$projectedName +``` + +*** + +### $returnTypeVisibility + +Re-exports [$returnTypeVisibility](Namespace.decorators.Function.$returnTypeVisibility.md) + +```ts +$returnTypeVisibility +``` + +*** + +### $secret + +Re-exports [$secret](Namespace.decorators.Function.$secret.md) + +```ts +$secret +``` + +*** + +### $service + +Re-exports [$service](Namespace.decorators.Function.$service.md) + +```ts +$service +``` + +*** + +### $summary + +Re-exports [$summary](Namespace.decorators.Function.$summary.md) + +```ts +$summary +``` + +*** + +### $tag + +Re-exports [$tag](Namespace.decorators.Function.$tag.md) + +```ts +$tag +``` + +*** + +### $visibility + +Re-exports [$visibility](Namespace.decorators.Function.$visibility.md) + +```ts +$visibility +``` + +*** + +### $withDefaultKeyVisibility + +Re-exports [$withDefaultKeyVisibility](Namespace.decorators.Function.$withDefaultKeyVisibility.md) + +```ts +$withDefaultKeyVisibility +``` + +*** + +### $withOptionalProperties + +Re-exports [$withOptionalProperties](Namespace.decorators.Function.$withOptionalProperties.md) + +```ts +$withOptionalProperties +``` + +*** + +### $withUpdateableProperties + +Re-exports [$withUpdateableProperties](Namespace.decorators.Function.$withUpdateableProperties.md) + +```ts +$withUpdateableProperties +``` + +*** + +### $withVisibility + +Re-exports [$withVisibility](Namespace.decorators.Function.$withVisibility.md) + +```ts +$withVisibility +``` + +*** + +### $withoutDefaultValues + +Re-exports [$withoutDefaultValues](Namespace.decorators.Function.$withoutDefaultValues.md) + +```ts +$withoutDefaultValues +``` + +*** + +### $withoutOmittedProperties + +Re-exports [$withoutOmittedProperties](Namespace.decorators.Function.$withoutOmittedProperties.md) + +```ts +$withoutOmittedProperties +``` + +*** + +### BytesKnownEncoding + +Re-exports [BytesKnownEncoding](Namespace.decorators.Type.BytesKnownEncoding.md) + +```ts +BytesKnownEncoding +``` + +*** + +### DateTimeKnownEncoding + +Re-exports [DateTimeKnownEncoding](Namespace.decorators.Type.DateTimeKnownEncoding.md) + +```ts +DateTimeKnownEncoding +``` + +*** + +### Discriminator + +Re-exports [Discriminator](Namespace.decorators.Interface.Discriminator.md) + +```ts +Discriminator +``` + +*** + +### DocData + +Re-exports [DocData](Namespace.decorators.Interface.DocData.md) + +```ts +DocData +``` + +*** + +### DurationKnownEncoding + +Re-exports [DurationKnownEncoding](Namespace.decorators.Type.DurationKnownEncoding.md) + +```ts +DurationKnownEncoding +``` + +*** + +### EncodeData + +Re-exports [EncodeData](Namespace.decorators.Interface.EncodeData.md) + +```ts +EncodeData +``` + +*** + +### Service + +Re-exports [Service](Namespace.decorators.Interface.Service.md) + +```ts +Service +``` + +*** + +### ServiceDetails + +Re-exports [ServiceDetails](Namespace.decorators.Interface.ServiceDetails.md) + +```ts +ServiceDetails +``` + +*** + +### addService + +Re-exports [addService](Namespace.decorators.Function.addService.md) + +```ts +addService +``` + +*** + +### getAllTags + +Re-exports [getAllTags](Namespace.decorators.Function.getAllTags.md) + +```ts +getAllTags +``` + +*** + +### getDeprecated + +Re-exports [getDeprecated](Namespace.decorators.Function.getDeprecated.md) + +```ts +getDeprecated +``` + +*** + +### getDiscriminatedTypes + +Re-exports [getDiscriminatedTypes](Namespace.decorators.Function.getDiscriminatedTypes.md) + +```ts +getDiscriminatedTypes +``` + +*** + +### getDiscriminator + +Re-exports [getDiscriminator](Namespace.decorators.Function.getDiscriminator.md) + +```ts +getDiscriminator +``` + +*** + +### getDoc + +Re-exports [getDoc](Namespace.decorators.Function.getDoc.md) + +```ts +getDoc +``` + +*** + +### getDocData + +Re-exports [getDocData](Namespace.decorators.Function.getDocData.md) + +```ts +getDocData +``` + +*** + +### getEncode + +Re-exports [getEncode](Namespace.decorators.Function.getEncode.md) + +```ts +getEncode +``` + +*** + +### getFormat + +Re-exports [getFormat](Namespace.decorators.Function.getFormat.md) + +```ts +getFormat +``` + +*** + +### getFriendlyName + +Re-exports [getFriendlyName](Namespace.decorators.Function.getFriendlyName.md) + +```ts +getFriendlyName +``` + +*** + +### getIndexer + +Re-exports [getIndexer](Namespace.decorators.Function.getIndexer.md) + +```ts +getIndexer +``` + +*** + +### getKeyName + +Re-exports [getKeyName](Namespace.decorators.Function.getKeyName.md) + +```ts +getKeyName +``` + +*** + +### getKnownValues + +Re-exports [getKnownValues](Namespace.decorators.Function.getKnownValues.md) + +```ts +getKnownValues +``` + +*** + +### getListOperationType + +Re-exports [getListOperationType](Namespace.decorators.Function.getListOperationType.md) + +```ts +getListOperationType +``` + +*** + +### getMaxItems + +Re-exports [getMaxItems](Namespace.decorators.Function.getMaxItems.md) + +```ts +getMaxItems +``` + +*** + +### getMaxLength + +Re-exports [getMaxLength](Namespace.decorators.Function.getMaxLength.md) + +```ts +getMaxLength +``` + +*** + +### getMaxValue + +Re-exports [getMaxValue](Namespace.decorators.Function.getMaxValue.md) + +```ts +getMaxValue +``` + +*** + +### getMaxValueExclusive + +Re-exports [getMaxValueExclusive](Namespace.decorators.Function.getMaxValueExclusive.md) + +```ts +getMaxValueExclusive +``` + +*** + +### getMinItems + +Re-exports [getMinItems](Namespace.decorators.Function.getMinItems.md) + +```ts +getMinItems +``` + +*** + +### getMinLength + +Re-exports [getMinLength](Namespace.decorators.Function.getMinLength.md) + +```ts +getMinLength +``` + +*** + +### getMinValue + +Re-exports [getMinValue](Namespace.decorators.Function.getMinValue.md) + +```ts +getMinValue +``` + +*** + +### getMinValueExclusive + +Re-exports [getMinValueExclusive](Namespace.decorators.Function.getMinValueExclusive.md) + +```ts +getMinValueExclusive +``` + +*** + +### getOverloadedOperation + +Re-exports [getOverloadedOperation](Namespace.decorators.Function.getOverloadedOperation.md) + +```ts +getOverloadedOperation +``` + +*** + +### getOverloads + +Re-exports [getOverloads](Namespace.decorators.Function.getOverloads.md) + +```ts +getOverloads +``` + +*** + +### getParameterVisibility + +Re-exports [getParameterVisibility](Namespace.decorators.Function.getParameterVisibility.md) + +```ts +getParameterVisibility +``` + +*** + +### getPattern + +Re-exports [getPattern](Namespace.decorators.Function.getPattern.md) + +```ts +getPattern +``` + +*** + +### getProjectedName + +Re-exports [getProjectedName](Namespace.decorators.Function.getProjectedName.md) + +```ts +getProjectedName +``` + +*** + +### getProjectedNames + +Re-exports [getProjectedNames](Namespace.decorators.Function.getProjectedNames.md) + +```ts +getProjectedNames +``` + +*** + +### getPropertyType + +Re-exports [getPropertyType](Namespace.decorators.Function.getPropertyType.md) + +```ts +getPropertyType +``` + +*** + +### getReturnTypeVisibility + +Re-exports [getReturnTypeVisibility](Namespace.decorators.Function.getReturnTypeVisibility.md) + +```ts +getReturnTypeVisibility +``` + +*** + +### getService + +Re-exports [getService](Namespace.decorators.Function.getService.md) + +```ts +getService +``` + +*** + +### getSummary + +Re-exports [getSummary](Namespace.decorators.Function.getSummary.md) + +```ts +getSummary +``` + +*** + +### getTags + +Re-exports [getTags](Namespace.decorators.Function.getTags.md) + +```ts +getTags +``` + +*** + +### getVisibility + +Re-exports [getVisibility](Namespace.decorators.Function.getVisibility.md) + +```ts +getVisibility +``` + +*** + +### hasProjectedName + +Re-exports [hasProjectedName](Namespace.decorators.Function.hasProjectedName.md) + +```ts +hasProjectedName +``` + +*** + +### isArrayModelType + +Re-exports [isArrayModelType](Namespace.decorators.Function.isArrayModelType.md) + +```ts +isArrayModelType +``` + +*** + +### isErrorModel + +Re-exports [isErrorModel](Namespace.decorators.Function.isErrorModel.md) + +```ts +isErrorModel +``` + +*** + +### isKey + +Re-exports [isKey](Namespace.decorators.Function.isKey.md) + +```ts +isKey +``` + +*** + +### isListOperation + +Re-exports [isListOperation](Namespace.decorators.Function.isListOperation.md) + +```ts +isListOperation +``` + +*** + +### isNumericType + +Re-exports [isNumericType](Namespace.decorators.Function.isNumericType.md) + +```ts +isNumericType +``` + +*** + +### isRecordModelType + +Re-exports [isRecordModelType](Namespace.decorators.Function.isRecordModelType.md) + +```ts +isRecordModelType +``` + +*** + +### isSecret + +Re-exports [isSecret](Namespace.decorators.Function.isSecret.md) + +```ts +isSecret +``` + +*** + +### isService + +Re-exports [isService](Namespace.decorators.Function.isService.md) + +```ts +isService +``` + +*** + +### isStringType + +Re-exports [isStringType](Namespace.decorators.Function.isStringType.md) + +```ts +isStringType +``` + +*** + +### isVisible + +Re-exports [isVisible](Namespace.decorators.Function.isVisible.md) + +```ts +isVisible +``` + +*** + +### listServices + +Re-exports [listServices](Namespace.decorators.Function.listServices.md) + +```ts +listServices +``` + +*** + +### namespace + +Re-exports [namespace](Namespace.decorators.Variable.namespace.md) + +```ts +namespace +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$action.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$action.md index 4cf2c1f8dc8..1c468312acd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$action.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$action.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $action" ---- +--- ```ts $action( context, @@ -12,16 +12,12 @@ $action( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `name`? | `string` | +| `entity` | `Operation` | +| `name`? | `string` | ## Returns `void` - -## Source - -[rest.ts:468](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L468) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSegment.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSegment.md index 83b005f528b..28395ca1fc3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSegment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSegment.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $actionSegment" ---- +--- ```ts $actionSegment( context, @@ -12,16 +12,12 @@ $actionSegment( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `name` | `string` | +| `entity` | `Operation` | +| `name` | `string` | ## Returns `void` - -## Source - -[rest.ts:443](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L443) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSeparator.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSeparator.md index c4b27f5c14a..d9f5b76671c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSeparator.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $actionSeparator" ---- +--- ```ts $actionSeparator( context, @@ -11,22 +11,18 @@ $actionSeparator( ``` `@actionSeparator` defines the separator string that is used to precede the action name -in auto-generated actions. + in auto-generated actions. `@actionSeparator` can only be applied to model properties, operation parameters, or operations. ## Parameters -| Parameter | Type | -| :---------- | :---------------------------------------- | -| `context` | `DecoratorContext` | -| `entity` | `Model` \| `ModelProperty` \| `Operation` | -| `separator` | `"/"` \| `":"` \| `"/:"` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Model` \| `ModelProperty` \| `Operation` | +| `separator` | `"/"` \| `":"` \| `"/:"` | ## Returns `void` - -## Source - -[rest.ts:239](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L239) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$autoRoute.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$autoRoute.md index 81ca7578cce..56c6bc5b29c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$autoRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$autoRoute.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $autoRoute" ---- +--- ```ts $autoRoute(context, entity): void ``` @@ -10,20 +10,16 @@ $autoRoute(context, entity): void `@autoRoute` enables automatic route generation for an operation or interface. When applied to an operation, it automatically generates the operation's route based on path parameter -metadata. When applied to an interface, it causes all operations under that scope to have +metadata. When applied to an interface, it causes all operations under that scope to have auto-generated routes. ## Parameters -| Parameter | Type | -| :-------- | :------------------------- | -| `context` | `DecoratorContext` | -| `entity` | `Interface` \| `Operation` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Interface` \| `Operation` | ## Returns `void` - -## Source - -[rest.ts:162](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L162) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$collectionAction.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$collectionAction.md index 44dc68f37a0..f2d8fa47f55 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$collectionAction.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$collectionAction.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $collectionAction" ---- +--- ```ts $collectionAction( context, @@ -13,17 +13,13 @@ $collectionAction( ## Parameters -| Parameter | Type | -| :------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `resourceType` | `Model` | -| `name`? | `string` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Operation` | +| `resourceType` | `Model` | +| `name`? | `string` | ## Returns `void` - -## Source - -[rest.ts:501](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L501) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$copyResourceKeyParameters.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$copyResourceKeyParameters.md index 57867698e0a..50c31104f8d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$copyResourceKeyParameters.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$copyResourceKeyParameters.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $copyResourceKeyParameters" ---- +--- ```ts $copyResourceKeyParameters( context, @@ -12,16 +12,12 @@ $copyResourceKeyParameters( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Model` | -| `filter`? | `string` | +| `entity` | `Model` | +| `filter`? | `string` | ## Returns `void` - -## Source - -[resource.ts:133](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/resource.ts#L133) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrReplacesResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrReplacesResource.md index 0b461a7d002..e285937ef41 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrReplacesResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrReplacesResource.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $createsOrReplacesResource" ---- +--- ```ts $createsOrReplacesResource( context, @@ -12,16 +12,12 @@ $createsOrReplacesResource( ## Parameters -| Parameter | Type | -| :------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `resourceType` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Operation` | +| `resourceType` | `Model` | ## Returns `void` - -## Source - -[rest.ts:381](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L381) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrUpdatesResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrUpdatesResource.md index 9b199ce099c..c036f4c4a48 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrUpdatesResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrUpdatesResource.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $createsOrUpdatesResource" ---- +--- ```ts $createsOrUpdatesResource( context, @@ -12,16 +12,12 @@ $createsOrUpdatesResource( ## Parameters -| Parameter | Type | -| :------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `resourceType` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Operation` | +| `resourceType` | `Model` | ## Returns `void` - -## Source - -[rest.ts:389](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L389) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsResource.md index 4eecf6bccd7..149c7d938b3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsResource.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $createsResource" ---- +--- ```ts $createsResource( context, @@ -12,16 +12,12 @@ $createsResource( ## Parameters -| Parameter | Type | -| :------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `resourceType` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Operation` | +| `resourceType` | `Model` | ## Returns `void` - -## Source - -[rest.ts:370](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L370) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$deletesResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$deletesResource.md index 7caed0cda27..1672feccae9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$deletesResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$deletesResource.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $deletesResource" ---- +--- ```ts $deletesResource( context, @@ -12,16 +12,12 @@ $deletesResource( ## Parameters -| Parameter | Type | -| :------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `resourceType` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Operation` | +| `resourceType` | `Model` | ## Returns `void` - -## Source - -[rest.ts:405](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L405) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$listsResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$listsResource.md index c2af6b691b9..e1498b3d8c6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$listsResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$listsResource.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $listsResource" ---- +--- ```ts $listsResource( context, @@ -12,16 +12,12 @@ $listsResource( ## Parameters -| Parameter | Type | -| :------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `resourceType` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Operation` | +| `resourceType` | `Model` | ## Returns `void` - -## Source - -[rest.ts:413](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L413) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$onValidate.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$onValidate.md index d825ca0e11e..212e92eb72e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$onValidate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$onValidate.md @@ -1,22 +1,18 @@ --- jsApi: true title: "[F] $onValidate" ---- +--- ```ts $onValidate(program): void ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | ## Returns `void` - -## Source - -[validate.ts:91](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/validate.ts#L91) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$parentResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$parentResource.md index 0a8c4887eb3..601b4c33e75 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$parentResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$parentResource.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $parentResource" ---- +--- ```ts $parentResource( context, @@ -13,23 +13,19 @@ $parentResource( `@parentResource` marks a model with a reference to its parent resource type The first argument should be a reference to a model type which will be treated as the parent -type of the target model type. This will cause the `@key` properties of all parent types of +type of the target model type. This will cause the `@key` properties of all parent types of the target type to show up in operations of the `Resource*` interfaces defined in this library. `@parentResource` can only be applied to models. ## Parameters -| Parameter | Type | -| :----------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Type` | -| `parentType` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Type` | +| `parentType` | `Model` | ## Returns `void` - -## Source - -[resource.ts:183](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/resource.ts#L183) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$readsResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$readsResource.md index c92ad425e5d..5f6132505af 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$readsResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$readsResource.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $readsResource" ---- +--- ```ts $readsResource( context, @@ -12,16 +12,12 @@ $readsResource( ## Parameters -| Parameter | Type | -| :------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `resourceType` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Operation` | +| `resourceType` | `Model` | ## Returns `void` - -## Source - -[rest.ts:366](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L366) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resource.md index 79e34124858..02fe95a956e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resource.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $resource" ---- +--- ```ts $resource( context, @@ -13,23 +13,19 @@ $resource( `@resource` marks a model as a resource type. The first argument should be the name of the collection that the resources -belong to. For example, a resource type `Widget` might have a collection +belong to. For example, a resource type `Widget` might have a collection name of `widgets`. `@resource` can only be applied to models. ## Parameters -| Parameter | Type | -| :--------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Model` | -| `collectionName` | `string` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Model` | +| `collectionName` | `string` | ## Returns `void` - -## Source - -[rest.ts:265](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L265) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceLocation.md index bd5d3c5401c..12d1f0b8a3e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceLocation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceLocation.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $resourceLocation" ---- +--- ```ts $resourceLocation( context, @@ -12,16 +12,12 @@ $resourceLocation( ## Parameters -| Parameter | Type | -| :------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Model` | -| `resourceType` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Model` | +| `resourceType` | `Model` | ## Returns `void` - -## Source - -[rest.ts:548](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L548) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceTypeForKeyParam.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceTypeForKeyParam.md index e5e00774c0e..04aa3cc85cb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceTypeForKeyParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceTypeForKeyParam.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $resourceTypeForKeyParam" ---- +--- ```ts $resourceTypeForKeyParam( context, @@ -12,16 +12,12 @@ $resourceTypeForKeyParam( ## Parameters -| Parameter | Type | -| :------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Type` | -| `resourceType` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Type` | +| `resourceType` | `Type` | ## Returns `void` - -## Source - -[resource.ts:69](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/resource.ts#L69) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segment.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segment.md index 1b5d8d6739d..0562ef2f3c6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segment.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $segment" ---- +--- ```ts $segment( context, @@ -19,16 +19,12 @@ path parameter's name field. ## Parameters -| Parameter | Type | -| :-------- | :---------------------------------------- | -| `context` | `DecoratorContext` | -| `entity` | `Model` \| `ModelProperty` \| `Operation` | -| `name` | `string` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Model` \| `ModelProperty` \| `Operation` | +| `name` | `string` | ## Returns `void` - -## Source - -[rest.ts:198](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L198) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segmentOf.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segmentOf.md index 0169b6c417c..c6912a9035a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segmentOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segmentOf.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $segmentOf" ---- +--- ```ts $segmentOf( context, @@ -12,16 +12,12 @@ $segmentOf( ## Parameters -| Parameter | Type | -| :------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `resourceType` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Operation` | +| `resourceType` | `Model` | ## Returns `void` - -## Source - -[rest.ts:214](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L214) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$updatesResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$updatesResource.md index 0b8dc2164e1..22dba9def62 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$updatesResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$updatesResource.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $updatesResource" ---- +--- ```ts $updatesResource( context, @@ -12,16 +12,12 @@ $updatesResource( ## Parameters -| Parameter | Type | -| :------------- | :----------------- | -| `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `resourceType` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Operation` | +| `resourceType` | `Model` | ## Returns `void` - -## Source - -[rest.ts:397](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L397) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getAction.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getAction.md index 712604e76dc..ff9533a06f5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getAction.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getAction.md @@ -1,27 +1,23 @@ --- jsApi: true title: "[F] getAction" ---- +--- ```ts getAction(program, operation): string | null | undefined ``` -## Deprecated - -Use getActionDetails instead. - ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `operation` | `Operation` | ## Returns `string` \| `null` \| `undefined` -## Source +## Deprecated -[rest.ts:495](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L495) +Use getActionDetails instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionDetails.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionDetails.md index 184e8757833..2553d3238d9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionDetails.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getActionDetails" ---- +--- ```ts getActionDetails(program, operation): ActionDetails | undefined ``` @@ -11,15 +11,11 @@ Gets the ActionDetails for the specified operation if it has previously been mar ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `operation` | `Operation` | ## Returns [`ActionDetails`](Interface.ActionDetails.md) \| `undefined` - -## Source - -[rest.ts:485](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L485) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSegment.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSegment.md index 80a73ebc50e..4a67666f95f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSegment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSegment.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getActionSegment" ---- +--- ```ts getActionSegment(program, entity): string | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `string` \| `undefined` - -## Source - -[rest.ts:447](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L447) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSeparator.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSeparator.md index e7e7a725e58..ad10e29315f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSeparator.md @@ -1,25 +1,21 @@ --- jsApi: true title: "[F] getActionSeparator" ---- +--- ```ts getActionSeparator(program, entity): string | undefined ``` ## Parameters -| Parameter | Type | Description | -| :-------- | :-------- | :------------------- | +| Parameter | Type | Description | +| :------ | :------ | :------ | | `program` | `Program` | the TypeSpec program | -| `entity` | `Type` | the target entity | +| `entity` | `Type` | the target entity | ## Returns `string` \| `undefined` the action separator string - -## Source - -[rest.ts:252](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L252) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionAction.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionAction.md index c3ed1da335a..d1641f55e9f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionAction.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionAction.md @@ -1,27 +1,23 @@ --- jsApi: true title: "[F] getCollectionAction" ---- +--- ```ts getCollectionAction(program, operation): string | null | undefined ``` -## Deprecated - -Use getCollectionActionDetails instead. - ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `operation` | `Operation` | ## Returns `string` \| `null` \| `undefined` -## Source +## Deprecated -[rest.ts:539](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L539) +Use getCollectionActionDetails instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionActionDetails.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionActionDetails.md index 0bdb4c7a9aa..616a43d6d7c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionActionDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionActionDetails.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getCollectionActionDetails" ---- +--- ```ts getCollectionActionDetails(program, operation): ActionDetails | undefined ``` @@ -11,15 +11,11 @@ Gets the ActionDetails for the specified operation if it has previously been mar ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `operation` | `Operation` | ## Returns [`ActionDetails`](Interface.ActionDetails.md) \| `undefined` - -## Source - -[rest.ts:529](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L529) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getParentResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getParentResource.md index 1f593ee1b6e..035bf89e60e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getParentResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getParentResource.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getParentResource" ---- +--- ```ts getParentResource(program, resourceType): Model | undefined ``` ## Parameters -| Parameter | Type | -| :------------- | :-------- | -| `program` | `Program` | -| `resourceType` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `resourceType` | `Model` | ## Returns `Model` \| `undefined` - -## Source - -[resource.ts:170](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/resource.ts#L170) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceLocationType.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceLocationType.md index 9e395b955bd..ef5607dd0c9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceLocationType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceLocationType.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getResourceLocationType" ---- +--- ```ts getResourceLocationType(program, entity): Model | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Scalar` | +| `entity` | `Scalar` | ## Returns `Model` \| `undefined` - -## Source - -[rest.ts:561](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L561) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceOperation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceOperation.md index f3d5d54572a..dda429a6eb8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceOperation.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getResourceOperation" ---- +--- ```ts getResourceOperation(program, typespecOperation): ResourceOperation | undefined ``` ## Parameters -| Parameter | Type | -| :------------------ | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `typespecOperation` | `Operation` | ## Returns [`ResourceOperation`](Interface.ResourceOperation.md) \| `undefined` - -## Source - -[rest.ts:359](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L359) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeForKeyParam.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeForKeyParam.md index 565d3ac838c..916fa74d2ab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeForKeyParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeForKeyParam.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getResourceTypeForKeyParam" ---- +--- ```ts getResourceTypeForKeyParam(program, param): Model | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------------- | -| `program` | `Program` | -| `param` | `ModelProperty` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `param` | `ModelProperty` | ## Returns `Model` \| `undefined` - -## Source - -[resource.ts:83](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/resource.ts#L83) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeKey.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeKey.md index 947a962406f..8293311d8c3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeKey.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getResourceTypeKey" ---- +--- ```ts getResourceTypeKey(program, resourceType): ResourceKey | undefined ``` ## Parameters -| Parameter | Type | -| :------------- | :-------- | -| `program` | `Program` | -| `resourceType` | `Model` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `resourceType` | `Model` | ## Returns [`ResourceKey`](Interface.ResourceKey.md) \| `undefined` - -## Source - -[resource.ts:36](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/resource.ts#L36) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getSegment.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getSegment.md index 7e1be86c783..4b391cbea41 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getSegment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getSegment.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getSegment" ---- +--- ```ts getSegment(program, entity): string | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | +| `entity` | `Type` | ## Returns `string` \| `undefined` - -## Source - -[rest.ts:227](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L227) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isAutoRoute.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isAutoRoute.md index 656e0878267..a2e3f25b11a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isAutoRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isAutoRoute.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] isAutoRoute" ---- +--- ```ts isAutoRoute(program, entity): boolean ``` ## Parameters -| Parameter | Type | -| :-------- | :------------------------- | -| `program` | `Program` | -| `entity` | `Interface` \| `Operation` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `entity` | `Interface` \| `Operation` | ## Returns `boolean` - -## Source - -[rest.ts:182](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L182) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isListOperation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isListOperation.md index 49e92aee2d7..0ace542980e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isListOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isListOperation.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] isListOperation" ---- +--- ```ts isListOperation(program, target): boolean ``` @@ -11,15 +11,11 @@ Returns `true` if the given operation is marked as a list operation. ## Parameters -| Parameter | Type | Description | -| :-------- | :---------- | :------------------- | -| `program` | `Program` | the TypeSpec program | -| `target` | `Operation` | the target operation | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | `Program` | the TypeSpec program | +| `target` | `Operation` | the target operation | ## Returns `boolean` - -## Source - -[rest.ts:425](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L425) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceOperation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceOperation.md index 413146985c2..1b6f49e80ad 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceOperation.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] setResourceOperation" ---- +--- ```ts setResourceOperation( context, @@ -13,17 +13,13 @@ setResourceOperation( ## Parameters -| Parameter | Type | -| :------------- | :------------------------------------------------- | -| `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `resourceType` | `Model` | -| `operation` | [`ResourceOperations`](Type.ResourceOperations.md) | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Operation` | +| `resourceType` | `Model` | +| `operation` | [`ResourceOperations`](Type.ResourceOperations.md) | ## Returns `void` - -## Source - -[rest.ts:335](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L335) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceTypeKey.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceTypeKey.md index e50c54c2174..a11233e6f75 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceTypeKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceTypeKey.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] setResourceTypeKey" ---- +--- ```ts setResourceTypeKey( program, @@ -12,16 +12,12 @@ setResourceTypeKey( ## Parameters -| Parameter | Type | -| :------------- | :-------------- | -| `program` | `Program` | -| `resourceType` | `Model` | -| `keyProperty` | `ModelProperty` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `resourceType` | `Model` | +| `keyProperty` | `ModelProperty` | ## Returns `void` - -## Source - -[resource.ts:25](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/resource.ts#L25) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ActionDetails.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ActionDetails.md index 2e44cff7aee..449ba33cf4c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ActionDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ActionDetails.md @@ -1,13 +1,13 @@ --- jsApi: true title: "[I] ActionDetails" ---- +--- Provides details about an action or collection action. ## Properties -| Property | Type | Description | -| :------- | :----------------------------- | :-------------------------------------------------------------------------------------------------------------------------- | -| `kind` | `"automatic"` \| `"specified"` | Identifies whether the action's name was generated from the original
operation name or if it was explicitly specified. | -| `name` | `string` | The name of the action | +| Property | Type | Description | +| :------ | :------ | :------ | +| `kind` | `"automatic"` \| `"specified"` | Identifies whether the action's name was generated from the original
operation name or if it was explicitly specified. | +| `name` | `string` | The name of the action | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.AutoRouteOptions.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.AutoRouteOptions.md index 900458240a4..9281e498440 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.AutoRouteOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.AutoRouteOptions.md @@ -1,10 +1,10 @@ --- jsApi: true title: "[I] AutoRouteOptions" ---- +--- ## Properties -| Property | Type | -| :------------------ | :---------------------------------------------------------------------------------------- | +| Property | Type | +| :------ | :------ | | `routeParamFilter`? | (`op`, `param`) => `undefined` \| [`FilteredRouteParam`](Interface.FilteredRouteParam.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.FilteredRouteParam.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.FilteredRouteParam.md index eed6a88b008..6a4a20575b5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.FilteredRouteParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.FilteredRouteParam.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] FilteredRouteParam" ---- +--- ## Properties -| Property | Type | -| :---------------------------- | :-------- | +| Property | Type | +| :------ | :------ | | `excludeFromOperationParams`? | `boolean` | -| `routeParamString`? | `string` | +| `routeParamString`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceKey.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceKey.md index 00532803189..a64a336659a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceKey.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] ResourceKey" ---- +--- ## Properties -| Property | Type | -| :------------- | :-------------- | -| `keyProperty` | `ModelProperty` | -| `resourceType` | `Model` | +| Property | Type | +| :------ | :------ | +| `keyProperty` | `ModelProperty` | +| `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceOperation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceOperation.md index 01245ee4daf..8a499662319 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceOperation.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] ResourceOperation" ---- +--- ## Properties -| Property | Type | -| :------------- | :------- | -| `operation` | `string` | -| `resourceType` | `Model` | +| Property | Type | +| :------ | :------ | +| `operation` | `string` | +| `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Type.ResourceOperations.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Type.ResourceOperations.md index fd46f8f4cb3..a686bfb4d60 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Type.ResourceOperations.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Type.ResourceOperations.md @@ -1,18 +1,8 @@ --- jsApi: true title: "[T] ResourceOperations" ---- +--- ```ts -ResourceOperations: "read" | - "create" | - "createOrReplace" | - "createOrUpdate" | - "update" | - "delete" | - "list"; +ResourceOperations: "read" | "create" | "createOrReplace" | "createOrUpdate" | "update" | "delete" | "list" ``` - -## Source - -[rest.ts:294](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/rest.ts#L294) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Variable.namespace.md index 8b27eebcd9d..e773eb7ea1a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Variable.namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Variable.namespace.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[V] namespace" ---- +--- ```ts -const namespace: "TypeSpec.Rest" = "TypeSpec.Rest"; +const namespace: "TypeSpec.Rest" = "TypeSpec.Rest" ``` - -## Source - -[index.ts:1](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/rest/src/index.ts#L1) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/index.md index c0ec356db71..7fbe7ed41cc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/index.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[P] JS Api" ---- +--- ## Index ### Interfaces diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Class.VersionMap.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Class.VersionMap.md index 683b1a72bfd..26216f1a74a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Class.VersionMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Class.VersionMap.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[C] VersionMap" ---- +--- ## Constructors -### constructor() +### new VersionMap ```ts new VersionMap(namespace, enumType): VersionMap @@ -13,23 +13,19 @@ new VersionMap(namespace, enumType): VersionMap #### Parameters -| Parameter | Type | -| :---------- | :---------- | +| Parameter | Type | +| :------ | :------ | | `namespace` | `Namespace` | -| `enumType` | `Enum` | +| `enumType` | `Enum` | #### Returns [`VersionMap`](Class.VersionMap.md) -#### Source - -[versioning/src/versioning.ts:266](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L266) - ## Properties -| Property | Type | -| :-------------- | :-------------------------------------------------------- | +| Property | Type | +| :------ | :------ | | `private` `map` | `Map`< `EnumMember`, [`Version`](Interface.Version.md) \> | ## Accessors @@ -40,13 +36,9 @@ new VersionMap(namespace, enumType): VersionMap get size(): number ``` -#### Source - -[versioning/src/versioning.ts:288](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L288) - ## Methods -### getVersionForEnumMember() +### getVersionForEnumMember ```ts getVersionForEnumMember(member): undefined | Version @@ -54,21 +46,17 @@ getVersionForEnumMember(member): undefined | Version #### Parameters -| Parameter | Type | -| :-------- | :----------- | -| `member` | `EnumMember` | +| Parameter | Type | +| :------ | :------ | +| `member` | `EnumMember` | #### Returns `undefined` \| [`Version`](Interface.Version.md) -#### Source +*** -[versioning/src/versioning.ts:280](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L280) - ---- - -### getVersions() +### getVersions ```ts getVersions(): Version[] @@ -77,7 +65,3 @@ getVersions(): Version[] #### Returns [`Version`](Interface.Version.md)[] - -#### Source - -[versioning/src/versioning.ts:284](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L284) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Enumeration.Availability.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Enumeration.Availability.md index 19d2bdf7250..f3ebf5e3b83 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Enumeration.Availability.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Enumeration.Availability.md @@ -1,13 +1,13 @@ --- jsApi: true title: "[E] Availability" ---- +--- ## Enumeration Members -| Member | Value | -| :------------ | :-------------- | -| `Added` | `"Added"` | -| `Available` | `"Available"` | -| `Removed` | `"Removed"` | -| `Unavailable` | `"Unavailable"` | +| Member | Value | +| :------ | :------ | +| `Added` | ``"Added"`` | +| `Available` | ``"Available"`` | +| `Removed` | ``"Removed"`` | +| `Unavailable` | ``"Unavailable"`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$added.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$added.md index bd45fcebe11..427365c86ca 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$added.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$added.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $added" ---- +--- ```ts $added( context, @@ -12,16 +12,12 @@ $added( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `t` | `Type` | -| `v` | `EnumMember` | +| `t` | `Type` | +| `v` | `EnumMember` | ## Returns `void` - -## Source - -[versioning/src/versioning.ts:49](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L49) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$madeOptional.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$madeOptional.md index ae8fedd13bf..b99920915d1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$madeOptional.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$madeOptional.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $madeOptional" ---- +--- ```ts $madeOptional( context, @@ -12,16 +12,12 @@ $madeOptional( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `t` | `ModelProperty` | -| `v` | `EnumMember` | +| `t` | `ModelProperty` | +| `v` | `EnumMember` | ## Returns `void` - -## Source - -[versioning/src/versioning.ts:173](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L173) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$onValidate.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$onValidate.md index d9357b764d6..212e92eb72e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$onValidate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$onValidate.md @@ -1,22 +1,18 @@ --- jsApi: true title: "[F] $onValidate" ---- +--- ```ts $onValidate(program): void ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | ## Returns `void` - -## Source - -[versioning/src/validate.ts:24](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/validate.ts#L24) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$removed.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$removed.md index f3990d04216..5e16f2b3896 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$removed.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$removed.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $removed" ---- +--- ```ts $removed( context, @@ -12,16 +12,12 @@ $removed( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `t` | `Type` | -| `v` | `EnumMember` | +| `t` | `Type` | +| `v` | `EnumMember` | ## Returns `void` - -## Source - -[versioning/src/versioning.ts:66](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L66) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$renamedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$renamedFrom.md index 5a13a30318b..2fe3b9d3b8c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$renamedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$renamedFrom.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $renamedFrom" ---- +--- ```ts $renamedFrom( context, @@ -13,17 +13,13 @@ $renamedFrom( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `t` | `Type` | -| `v` | `EnumMember` | -| `oldName` | `string` | +| `t` | `Type` | +| `v` | `EnumMember` | +| `oldName` | `string` | ## Returns `void` - -## Source - -[versioning/src/versioning.ts:150](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L150) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$returnTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$returnTypeChangedFrom.md index c64f3b6f878..3cb63b6ec97 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$returnTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$returnTypeChangedFrom.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $returnTypeChangedFrom" ---- +--- ```ts $returnTypeChangedFrom( context, @@ -13,17 +13,13 @@ $returnTypeChangedFrom( ## Parameters -| Parameter | Type | -| :-------------- | :----------------- | -| `context` | `DecoratorContext` | -| `op` | `Operation` | -| `v` | `EnumMember` | -| `oldReturnType` | `any` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `op` | `Operation` | +| `v` | `EnumMember` | +| `oldReturnType` | `any` | ## Returns `void` - -## Source - -[versioning/src/versioning.ts:124](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L124) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$typeChangedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$typeChangedFrom.md index 5a06b37de37..299d21dd7be 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$typeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$typeChangedFrom.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $typeChangedFrom" ---- +--- ```ts $typeChangedFrom( context, @@ -13,17 +13,13 @@ $typeChangedFrom( ## Parameters -| Parameter | Type | -| :-------- | :----------------- | +| Parameter | Type | +| :------ | :------ | | `context` | `DecoratorContext` | -| `prop` | `ModelProperty` | -| `v` | `EnumMember` | -| `oldType` | `any` | +| `prop` | `ModelProperty` | +| `v` | `EnumMember` | +| `oldType` | `any` | ## Returns `void` - -## Source - -[versioning/src/versioning.ts:93](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L93) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$useDependency.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$useDependency.md index 49e1936575c..4db99dd2ccc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$useDependency.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$useDependency.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $useDependency" ---- +--- ```ts $useDependency( context, @@ -12,16 +12,12 @@ $useDependency( ## Parameters -| Parameter | Type | -| :------------------ | :-------------------------- | -| `context` | `DecoratorContext` | -| `target` | `EnumMember` \| `Namespace` | -| ...`versionRecords` | `EnumMember`[] | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `EnumMember` \| `Namespace` | +| ...`versionRecords` | `EnumMember`[] | ## Returns `void` - -## Source - -[versioning/src/versioning.ts:320](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L320) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$versioned.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$versioned.md index 5efd26acd34..5cf3e83131f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$versioned.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$versioned.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] $versioned" ---- +--- ```ts $versioned( context, @@ -12,16 +12,12 @@ $versioned( ## Parameters -| Parameter | Type | -| :--------- | :----------------- | -| `context` | `DecoratorContext` | -| `t` | `Namespace` | -| `versions` | `Enum` | +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `t` | `Namespace` | +| `versions` | `Enum` | ## Returns `void` - -## Source - -[versioning/src/versioning.ts:293](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L293) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.buildVersionProjections.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.buildVersionProjections.md index e9c2797cf2f..a9d48aba135 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.buildVersionProjections.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.buildVersionProjections.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] buildVersionProjections" ---- +--- ```ts buildVersionProjections(program, rootNs): VersionProjections[] ``` ## Parameters -| Parameter | Type | -| :-------- | :---------- | -| `program` | `Program` | -| `rootNs` | `Namespace` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `rootNs` | `Namespace` | ## Returns `VersionProjections`[] - -## Source - -[versioning/src/versioning.ts:576](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L576) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.existsAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.existsAtVersion.md index 1aa26a831ba..6ed50afbdf0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.existsAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.existsAtVersion.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] existsAtVersion" ---- +--- ```ts existsAtVersion( p, @@ -12,16 +12,12 @@ existsAtVersion( ## Parameters -| Parameter | Type | -| :----------- | :----------- | -| `p` | `Program` | -| `type` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `type` | `Type` | | `versionKey` | `ObjectType` | ## Returns `boolean` - -## Source - -[versioning/src/versioning.ts:769](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L769) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.findVersionedNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.findVersionedNamespace.md index 445b049380a..5e282acbda9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.findVersionedNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.findVersionedNamespace.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] findVersionedNamespace" ---- +--- ```ts findVersionedNamespace(program, namespace): Namespace | undefined ``` ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `namespace` | `Namespace` | ## Returns `Namespace` \| `undefined` - -## Source - -[versioning/src/versioning.ts:304](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L304) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAddedOnVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAddedOnVersions.md index 67a3116db6b..6ac4df5d6e4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAddedOnVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAddedOnVersions.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getAddedOnVersions" ---- +--- ```ts getAddedOnVersions(p, t): Version[] | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | -| `p` | `Program` | -| `t` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `t` | `Type` | ## Returns [`Version`](Interface.Version.md)[] \| `undefined` - -## Source - -[versioning/src/versioning.ts:248](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L248) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMap.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMap.md index 9d70442a3a3..df024297dce 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMap.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getAvailabilityMap" ---- +--- ```ts getAvailabilityMap(program, type): Map< string, Availability > | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `type` | `Type` | +| `type` | `Type` | ## Returns `Map`< `string`, [`Availability`](Enumeration.Availability.md) \> \| `undefined` - -## Source - -[versioning/src/versioning.ts:686](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L686) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMapInTimeline.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMapInTimeline.md index 240c1492409..473853b3a38 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMapInTimeline.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMapInTimeline.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getAvailabilityMapInTimeline" ---- +--- ```ts getAvailabilityMapInTimeline( program, @@ -12,16 +12,12 @@ getAvailabilityMapInTimeline( ## Parameters -| Parameter | Type | -| :--------- | :------------------- | -| `program` | `Program` | -| `type` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `type` | `Type` | | `timeline` | `VersioningTimeline` | ## Returns `Map`< `TimelineMoment`, [`Availability`](Enumeration.Availability.md) \> \| `undefined` - -## Source - -[versioning/src/versioning.ts:729](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L729) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getMadeOptionalOn.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getMadeOptionalOn.md index f234e8c6e9f..9a365a49a6e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getMadeOptionalOn.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getMadeOptionalOn.md @@ -1,25 +1,21 @@ --- jsApi: true title: "[F] getMadeOptionalOn" ---- +--- ```ts getMadeOptionalOn(p, t): Version | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | -| `p` | `Program` | -| `t` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `t` | `Type` | ## Returns [`Version`](Interface.Version.md) \| `undefined` version when the given type was made optional if applicable. - -## Source - -[versioning/src/versioning.ts:259](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L259) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getNameAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getNameAtVersion.md index 7b85278caff..5f5ed25ad47 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getNameAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getNameAtVersion.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getNameAtVersion" ---- +--- ```ts getNameAtVersion( p, @@ -12,10 +12,10 @@ getNameAtVersion( ## Parameters -| Parameter | Type | -| :----------- | :----------- | -| `p` | `Program` | -| `t` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `t` | `Type` | | `versionKey` | `ObjectType` | ## Returns @@ -23,7 +23,3 @@ getNameAtVersion( `string` get old name if applicable. - -## Source - -[versioning/src/versioning.ts:196](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L196) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRemovedOnVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRemovedOnVersions.md index 4096e7547ba..d0577928806 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRemovedOnVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRemovedOnVersions.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getRemovedOnVersions" ---- +--- ```ts getRemovedOnVersions(p, t): Version[] | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | -| `p` | `Program` | -| `t` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `t` | `Type` | ## Returns [`Version`](Interface.Version.md)[] \| `undefined` - -## Source - -[versioning/src/versioning.ts:252](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L252) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRenamedFromVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRenamedFromVersions.md index f4a9e6d3ebc..c45c5920898 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRenamedFromVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRenamedFromVersions.md @@ -1,25 +1,21 @@ --- jsApi: true title: "[F] getRenamedFromVersions" ---- +--- ```ts getRenamedFromVersions(p, t): Version[] | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | -| `p` | `Program` | -| `t` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `t` | `Type` | ## Returns [`Version`](Interface.Version.md)[] \| `undefined` the list of versions for which this decorator has been applied - -## Source - -[versioning/src/versioning.ts:189](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L189) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeBeforeVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeBeforeVersion.md index c6ae05cf274..b3410dbd575 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeBeforeVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeBeforeVersion.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getReturnTypeBeforeVersion" ---- +--- ```ts getReturnTypeBeforeVersion( p, @@ -12,10 +12,10 @@ getReturnTypeBeforeVersion( ## Parameters -| Parameter | Type | -| :----------- | :----------- | -| `p` | `Program` | -| `t` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `t` | `Type` | | `versionKey` | `ObjectType` | ## Returns @@ -23,7 +23,3 @@ getReturnTypeBeforeVersion( `any` get old type if applicable. - -## Source - -[versioning/src/versioning.ts:234](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L234) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeChangedFrom.md index 71b05b8d30c..c245dabd7a6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeChangedFrom.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getReturnTypeChangedFrom" ---- +--- ```ts getReturnTypeChangedFrom(p, t): Map< Version, Type > | undefined ``` @@ -11,17 +11,13 @@ Returns the mapping of versions to old return type values, if applicable ## Parameters -| Parameter | Type | Description | -| :-------- | :-------- | :--------------- | -| `p` | `Program` | TypeSpec program | -| `t` | `Type` | type to query | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `p` | `Program` | TypeSpec program | +| `t` | `Type` | type to query | ## Returns `Map`< [`Version`](Interface.Version.md), `Type` \> \| `undefined` Map of versions to old types, if any - -## Source - -[versioning/src/versioning.ts:120](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L120) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeBeforeVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeBeforeVersion.md index f4a8f95c689..b23d9a37384 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeBeforeVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeBeforeVersion.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getTypeBeforeVersion" ---- +--- ```ts getTypeBeforeVersion( p, @@ -12,10 +12,10 @@ getTypeBeforeVersion( ## Parameters -| Parameter | Type | -| :----------- | :----------- | -| `p` | `Program` | -| `t` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `t` | `Type` | | `versionKey` | `ObjectType` | ## Returns @@ -23,7 +23,3 @@ getTypeBeforeVersion( `Type` \| `undefined` get old type if applicable. - -## Source - -[versioning/src/versioning.ts:213](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L213) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeChangedFrom.md index 26c0425eefd..93758cfd095 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeChangedFrom.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getTypeChangedFrom" ---- +--- ```ts getTypeChangedFrom(p, t): Map< Version, Type > | undefined ``` @@ -11,17 +11,13 @@ Returns the mapping of versions to old type values, if applicable ## Parameters -| Parameter | Type | Description | -| :-------- | :-------- | :--------------- | -| `p` | `Program` | TypeSpec program | -| `t` | `Type` | type to query | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `p` | `Program` | TypeSpec program | +| `t` | `Type` | type to query | ## Returns `Map`< [`Version`](Interface.Version.md), `Type` \> \| `undefined` Map of versions to old types, if any - -## Source - -[versioning/src/versioning.ts:89](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L89) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getUseDependencies.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getUseDependencies.md index 622d5ee470e..c1172e32f61 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getUseDependencies.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getUseDependencies.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getUseDependencies" ---- +--- ```ts getUseDependencies( program, @@ -12,16 +12,12 @@ getUseDependencies( ## Parameters -| Parameter | Type | Default value | -| :----------- | :-------------------- | :------------ | -| `program` | `Program` | `undefined` | -| `target` | `Enum` \| `Namespace` | `undefined` | -| `searchEnum` | `boolean` | `true` | +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `program` | `Program` | `undefined` | +| `target` | `Enum` \| `Namespace` | `undefined` | +| `searchEnum` | `boolean` | `true` | ## Returns `Map`< `Namespace`, `Map`< [`Version`](Interface.Version.md), [`Version`](Interface.Version.md) \> \| [`Version`](Interface.Version.md) \> \| `undefined` - -## Source - -[versioning/src/versioning.ts:359](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L359) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersion.md index fa90f638a23..e294003881c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersion.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] getVersion" ---- +--- ```ts getVersion(program, namespace): VersionMap | undefined ``` @@ -11,15 +11,11 @@ Get the version map of the namespace. ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `namespace` | `Namespace` | ## Returns [`VersionMap`](Class.VersionMap.md) \| `undefined` - -## Source - -[versioning/src/versioning.ts:300](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L300) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionDependencies.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionDependencies.md index 550a59d8bd8..155d631a413 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionDependencies.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionDependencies.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getVersionDependencies" ---- +--- ```ts getVersionDependencies(program, namespace): Map< Namespace, Map< Version, Version > | Version > | undefined ``` ## Parameters -| Parameter | Type | -| :---------- | :---------- | -| `program` | `Program` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | | `namespace` | `Namespace` | ## Returns `Map`< `Namespace`, `Map`< [`Version`](Interface.Version.md), [`Version`](Interface.Version.md) \> \| [`Version`](Interface.Version.md) \> \| `undefined` - -## Source - -[versioning/src/versioning.ts:433](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L433) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionForEnumMember.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionForEnumMember.md index fd89f73a4f7..4c6a4a36de0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionForEnumMember.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionForEnumMember.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getVersionForEnumMember" ---- +--- ```ts getVersionForEnumMember(program, member): Version | undefined ``` ## Parameters -| Parameter | Type | -| :-------- | :----------- | -| `program` | `Program` | -| `member` | `EnumMember` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `member` | `EnumMember` | ## Returns [`Version`](Interface.Version.md) \| `undefined` - -## Source - -[versioning/src/versioning.ts:805](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L805) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersions.md index 49a81a1491d..93bf1f312c2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersions.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getVersions" ---- +--- ```ts getVersions(p, t): [Namespace, VersionMap] | [] ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | -| `p` | `Program` | -| `t` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `t` | `Type` | ## Returns [`Namespace`, [`VersionMap`](Class.VersionMap.md)] \| [] - -## Source - -[versioning/src/versioning.ts:624](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L624) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionsForEnum.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionsForEnum.md index 58ed199ef44..3e6278433d6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionsForEnum.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionsForEnum.md @@ -1,23 +1,19 @@ --- jsApi: true title: "[F] getVersionsForEnum" ---- +--- ```ts getVersionsForEnum(program, en): [Namespace, VersionMap] | [] ``` ## Parameters -| Parameter | Type | -| :-------- | :-------- | +| Parameter | Type | +| :------ | :------ | | `program` | `Program` | -| `en` | `Enum` | +| `en` | `Enum` | ## Returns [`Namespace`, [`VersionMap`](Class.VersionMap.md)] \| [] - -## Source - -[versioning/src/versioning.ts:610](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L610) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentNameAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentNameAtVersion.md index d5ffc0df4f9..fe25913984e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentNameAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentNameAtVersion.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] hasDifferentNameAtVersion" ---- +--- ```ts hasDifferentNameAtVersion( p, @@ -12,16 +12,12 @@ hasDifferentNameAtVersion( ## Parameters -| Parameter | Type | -| :-------- | :----------- | -| `p` | `Program` | -| `type` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `type` | `Type` | | `version` | `ObjectType` | ## Returns `boolean` - -## Source - -[versioning/src/versioning.ts:779](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L779) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentReturnTypeAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentReturnTypeAtVersion.md index 93d07837131..bb51bbe47d3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentReturnTypeAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentReturnTypeAtVersion.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] hasDifferentReturnTypeAtVersion" ---- +--- ```ts hasDifferentReturnTypeAtVersion( p, @@ -12,16 +12,12 @@ hasDifferentReturnTypeAtVersion( ## Parameters -| Parameter | Type | -| :-------- | :----------- | -| `p` | `Program` | -| `type` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `type` | `Type` | | `version` | `ObjectType` | ## Returns `boolean` - -## Source - -[versioning/src/versioning.ts:797](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L797) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentTypeAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentTypeAtVersion.md index f8bb9c5760f..c40d0ab2240 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentTypeAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentTypeAtVersion.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] hasDifferentTypeAtVersion" ---- +--- ```ts hasDifferentTypeAtVersion( p, @@ -12,16 +12,12 @@ hasDifferentTypeAtVersion( ## Parameters -| Parameter | Type | -| :-------- | :----------- | -| `p` | `Program` | -| `type` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `type` | `Type` | | `version` | `ObjectType` | ## Returns `boolean` - -## Source - -[versioning/src/versioning.ts:793](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L793) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.indexTimeline.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.indexTimeline.md index 2c5d6db26b1..5c481fbb380 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.indexTimeline.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.indexTimeline.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] indexTimeline" ---- +--- ```ts indexTimeline( program, @@ -12,16 +12,12 @@ indexTimeline( ## Parameters -| Parameter | Type | -| :----------------- | :------------------- | -| `program` | `Program` | -| `timeline` | `VersioningTimeline` | -| `projectingMoment` | `TimelineMoment` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `timeline` | `VersioningTimeline` | +| `projectingMoment` | `TimelineMoment` | ## Returns `ObjectType` & `TypePrototype` & \{`isFinished`: `boolean`;} - -## Source - -[versioning/src/versioning.ts:552](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L552) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.madeOptionalAfter.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.madeOptionalAfter.md index 687a6986b05..2caebd7479f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.madeOptionalAfter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.madeOptionalAfter.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] madeOptionalAfter" ---- +--- ```ts madeOptionalAfter( program, @@ -12,16 +12,12 @@ madeOptionalAfter( ## Parameters -| Parameter | Type | -| :----------- | :----------- | -| `program` | `Program` | -| `type` | `Type` | +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `type` | `Type` | | `versionKey` | `ObjectType` | ## Returns `boolean` - -## Source - -[versioning/src/versioning.ts:783](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L783) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.resolveVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.resolveVersions.md index ef068f69a96..ddb1823ba75 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.resolveVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.resolveVersions.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[F] resolveVersions" ---- +--- ```ts resolveVersions(program, rootNs): VersionResolution[] ``` @@ -11,15 +11,11 @@ Resolve the version to use for all namespace for each of the root namespace vers ## Parameters -| Parameter | Type | Description | -| :-------- | :---------- | :-------------- | -| `program` | `Program` | | -| `rootNs` | `Namespace` | Root namespace. | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | `Program` | | +| `rootNs` | `Namespace` | Root namespace. | ## Returns [`VersionResolution`](Interface.VersionResolution.md)[] - -## Source - -[versioning/src/versioning.ts:508](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L508) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.Version.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.Version.md index 9f19fbc8f84..8f751744cfb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.Version.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.Version.md @@ -1,14 +1,14 @@ --- jsApi: true title: "[I] Version" ---- +--- ## Properties -| Property | Type | -| :----------- | :----------- | +| Property | Type | +| :------ | :------ | | `enumMember` | `EnumMember` | -| `index` | `number` | -| `name` | `string` | -| `namespace` | `Namespace` | -| `value` | `string` | +| `index` | `number` | +| `name` | `string` | +| `namespace` | `Namespace` | +| `value` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.VersionResolution.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.VersionResolution.md index 8eb9a2fc390..d0fb320224b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.VersionResolution.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.VersionResolution.md @@ -1,11 +1,11 @@ --- jsApi: true title: "[I] VersionResolution" ---- +--- ## Properties -| Property | Type | Description | -| :------------ | :------------------------------------------------------- | :------------------------------------------------------------ | -| `rootVersion` | `undefined` \| [`Version`](Interface.Version.md) | Version for the root namespace. `undefined` if not versioned. | -| `versions` | `Map`< `Namespace`, [`Version`](Interface.Version.md) \> | Resolved version for all the referenced namespaces. | +| Property | Type | Description | +| :------ | :------ | :------ | +| `rootVersion` | `undefined` \| [`Version`](Interface.Version.md) | Version for the root namespace. `undefined` if not versioned. | +| `versions` | `Map`< `Namespace`, [`Version`](Interface.Version.md) \> | Resolved version for all the referenced namespaces. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Variable.namespace.md index 5a8c0c0265e..ca36f2a94ba 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Variable.namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Variable.namespace.md @@ -1,12 +1,8 @@ --- jsApi: true title: "[V] namespace" ---- +--- ```ts -const namespace: "TypeSpec.Versioning" = "TypeSpec.Versioning"; +const namespace: "TypeSpec.Versioning" = "TypeSpec.Versioning" ``` - -## Source - -[versioning/src/versioning.ts:30](https://github.com/markcowl/cadl/blob/1a6d2b70/packages/versioning/src/versioning.ts#L30) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/index.md index 778d0cb7dc2..c62ca865f95 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/index.md @@ -1,8 +1,8 @@ --- jsApi: true title: "[P] JS Api" ---- +--- ## Index ### Enumerations diff --git a/packages/website/versioned_sidebars/version-latest-sidebars.json b/packages/website/versioned_sidebars/version-latest-sidebars.json index 82e94321556..75637305ef4 100644 --- a/packages/website/versioned_sidebars/version-latest-sidebars.json +++ b/packages/website/versioned_sidebars/version-latest-sidebars.json @@ -47,6 +47,7 @@ "language-basics/imports", "language-basics/namespaces", "language-basics/decorators", + "language-basics/documentation", "language-basics/scalars", "language-basics/models", "language-basics/operations", @@ -65,6 +66,7 @@ "label": "TypeSpec Standard Library", "items": [ "standard-library/built-in-decorators", + "standard-library/built-in-data-types", { "type": "autogenerated", "dirName": "standard-library/reference"