diff --git a/.chronus/changes/Issue3632-2024-6-12-17-16-46.md b/.chronus/changes/Issue3632-2024-6-12-17-16-46.md deleted file mode 100644 index 0919a1488..000000000 --- a/.chronus/changes/Issue3632-2024-6-12-17-16-46.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Moved compiler dependencies to peer and dev for scaffolded projects. \ No newline at end of file diff --git a/.chronus/changes/allow-override-verb-2024-6-1-19-54-42.md b/.chronus/changes/allow-override-verb-2024-6-1-19-54-42.md deleted file mode 100644 index eb379ae98..000000000 --- a/.chronus/changes/allow-override-verb-2024-6-1-19-54-42.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/http" ---- - -Allow overriding base operation verb diff --git a/.chronus/changes/avoid-break-from-stacktrace-2024-5-20-11-21-0.md b/.chronus/changes/avoid-break-from-stacktrace-2024-5-20-11-21-0.md deleted file mode 100644 index ee508d404..000000000 --- a/.chronus/changes/avoid-break-from-stacktrace-2024-5-20-11-21-0.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Fix crash of language server on firefox \ No newline at end of file diff --git a/.chronus/changes/deprecate-get-asset-emitter-2024-5-4-16-18-29.md b/.chronus/changes/deprecate-get-asset-emitter-2024-5-4-16-18-29.md deleted file mode 100644 index e782b0126..000000000 --- a/.chronus/changes/deprecate-get-asset-emitter-2024-5-4-16-18-29.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Deprecate getAssetEmitter and recommend calling `createAssetEmitter` directly diff --git a/.chronus/changes/deprecate-get-asset-emitter-2024-5-4-16-38-47.md b/.chronus/changes/deprecate-get-asset-emitter-2024-5-4-16-38-47.md deleted file mode 100644 index 1ac7a664c..000000000 --- a/.chronus/changes/deprecate-get-asset-emitter-2024-5-4-16-38-47.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/json-schema" - - "@typespec/openapi3" ---- - -Fix issue that could result in invalid document generation when running `tsp compile` from another directory diff --git a/.chronus/changes/docs-errorsDoc-and-returnsDoc-decorators-2024-6-8-17-47-51.md b/.chronus/changes/docs-errorsDoc-and-returnsDoc-decorators-2024-6-8-17-47-51.md deleted file mode 100644 index d0f595208..000000000 --- a/.chronus/changes/docs-errorsDoc-and-returnsDoc-decorators-2024-6-8-17-47-51.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" - - "@typespec/http" ---- - -Fix doc errors for `@errorsDoc` and `@returnsDoc` decorators diff --git a/.chronus/changes/examples-2024-5-12-22-55-41.md b/.chronus/changes/examples-2024-5-12-22-55-41.md deleted file mode 100644 index 7204996e2..000000000 --- a/.chronus/changes/examples-2024-5-12-22-55-41.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/openapi3" ---- - -Add support for new `@example` and `@opExample` decorator diff --git a/.chronus/changes/examples-2024-5-14-18-46-26.md b/.chronus/changes/examples-2024-5-14-18-46-26.md deleted file mode 100644 index cef4d5be6..000000000 --- a/.chronus/changes/examples-2024-5-14-18-46-26.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Add new `@example` and `@opExample` decorator to provide examples on types and operations. - - ```tsp - @example(#{ - id: "some", - date: utcDateTime.fromISO("2020-01-01T00:00:00Z"), - timeout: duration.fromISO("PT1M"), - }) - model Foo { - id: string; - date: utcDateTime; - - @encode("seconds", int32) timeout: duration; - } - ``` - - ```tsp - @opExample( - #{ - parameters: #{ - pet: #{ - id: "some", - name: "Fluffy", - dob: plainDate.fromISO("2020-01-01"), - }, - }, - returnType: #{ - id: "some", - name: "Fluffy", - dob: plainDate.fromISO("2020-01-01"), - }, - }, - #{ title: "First", description: "Show creating a pet" } - ) - op createPet(pet: Pet): Pet; - ``` diff --git a/.chronus/changes/expose-necessary-api-for-httppart-2024-5-27-18-23-11.md b/.chronus/changes/expose-necessary-api-for-httppart-2024-5-27-18-23-11.md deleted file mode 100644 index 4fdc148c5..000000000 --- a/.chronus/changes/expose-necessary-api-for-httppart-2024-5-27-18-23-11.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/http" ---- - -Expose `getHttpPart` and types functions \ No newline at end of file diff --git a/.chronus/changes/fix-breaking-change-2024-6-10-19-47-36.md b/.chronus/changes/fix-breaking-change-2024-6-10-19-47-36.md deleted file mode 100644 index b73282d56..000000000 --- a/.chronus/changes/fix-breaking-change-2024-6-10-19-47-36.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" ---- - -Fix breaking change with `formatIdentifier` renamed to `printIdentifier` diff --git a/.chronus/changes/fix-classify-single-using-2024-6-8-9-56-27.md b/.chronus/changes/fix-classify-single-using-2024-6-8-9-56-27.md deleted file mode 100644 index 1deac9544..000000000 --- a/.chronus/changes/fix-classify-single-using-2024-6-8-9-56-27.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Fix semantic highlighting of using of single namespace \ No newline at end of file diff --git a/.chronus/changes/fix-expression-cast-to-object-2024-6-11-19-32-52.md b/.chronus/changes/fix-expression-cast-to-object-2024-6-11-19-32-52.md deleted file mode 100644 index 968edd1ca..000000000 --- a/.chronus/changes/fix-expression-cast-to-object-2024-6-11-19-32-52.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Do not cast model expression to object value if the constraint is allowing the type diff --git a/.chronus/changes/fix-formatting-object-array-literal-hug-2024-5-13-20-4-7.md b/.chronus/changes/fix-formatting-object-array-literal-hug-2024-5-13-20-4-7.md deleted file mode 100644 index 49283b977..000000000 --- a/.chronus/changes/fix-formatting-object-array-literal-hug-2024-5-13-20-4-7.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Fix formatting of object and array literal in decorator to hug parenthesis diff --git a/.chronus/changes/fix-formatting-scalar-constr-call-2024-6-11-19-13-55.md b/.chronus/changes/fix-formatting-scalar-constr-call-2024-6-11-19-13-55.md deleted file mode 100644 index 4c7322a3c..000000000 --- a/.chronus/changes/fix-formatting-scalar-constr-call-2024-6-11-19-13-55.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Fix formatting of scalar constructor called with no args diff --git a/.chronus/changes/fix-install-vs-extension-2024-6-3-17-17-1.md b/.chronus/changes/fix-install-vs-extension-2024-6-3-17-17-1.md deleted file mode 100644 index 8844b8794..000000000 --- a/.chronus/changes/fix-install-vs-extension-2024-6-3-17-17-1.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Fix 'typespec vs install' command on windows \ No newline at end of file diff --git a/.chronus/changes/fix-playground-program-viewer-crash-2024-5-14-15-45-7.md b/.chronus/changes/fix-playground-program-viewer-crash-2024-5-14-15-45-7.md deleted file mode 100644 index 4ba954c53..000000000 --- a/.chronus/changes/fix-playground-program-viewer-crash-2024-5-14-15-45-7.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/playground" ---- - -Add error recovery for viewer that crash diff --git a/.chronus/changes/fix-playground-program-viewer-crash-2024-5-14-16-11-12.md b/.chronus/changes/fix-playground-program-viewer-crash-2024-5-14-16-11-12.md deleted file mode 100644 index b289e7c25..000000000 --- a/.chronus/changes/fix-playground-program-viewer-crash-2024-5-14-16-11-12.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/html-program-viewer" ---- - -Fix crash in program viewer when trying to display new value type diff --git a/.chronus/changes/fix-react-hooks-2024-6-8-15-40-17.md b/.chronus/changes/fix-react-hooks-2024-6-8-15-40-17.md deleted file mode 100644 index 5164d4b49..000000000 --- a/.chronus/changes/fix-react-hooks-2024-6-8-15-40-17.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/html-program-viewer" - - "@typespec/playground" ---- - -Enable react hooks linting and fix issues diff --git a/.chronus/changes/fix-test-path-2024-6-5-14-0-33.md b/.chronus/changes/fix-test-path-2024-6-5-14-0-33.md deleted file mode 100644 index b65a45b1a..000000000 --- a/.chronus/changes/fix-test-path-2024-6-5-14-0-33.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Fix templates initialized on node 22 \ No newline at end of file diff --git a/.chronus/changes/friendly-name-no-carry-over-2024-6-9-23-6-32.md b/.chronus/changes/friendly-name-no-carry-over-2024-6-9-23-6-32.md deleted file mode 100644 index 1caf38e7e..000000000 --- a/.chronus/changes/friendly-name-no-carry-over-2024-6-9-23-6-32.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: breaking -packages: - - "@typespec/compiler" ---- - -Do not carry over `@friendlyName` with `model is` or `op is` - - ```tsp - @friendlyName("Abc{T}", T) - model Foo {} - - model Bar is Foo; - - // This can be changed to - model Abcstring is Foo; - ``` diff --git a/.chronus/changes/http-server-javascript-2024-6-5-12-35-40.md b/.chronus/changes/http-server-javascript-2024-6-5-12-35-40.md deleted file mode 100644 index e95ee443b..000000000 --- a/.chronus/changes/http-server-javascript-2024-6-5-12-35-40.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/http-server-javascript" ---- - -Added the experimental HTTP server generator for JavaScript. diff --git a/.chronus/changes/http-trailing-slash-2024-6-2-23-8-57.md b/.chronus/changes/http-trailing-slash-2024-6-2-23-8-57.md deleted file mode 100644 index d4013eea9..000000000 --- a/.chronus/changes/http-trailing-slash-2024-6-2-23-8-57.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: breaking -packages: - - "@typespec/http" ---- - -Keep trailing slash when building http routes, this is breaking if you used to have `@route()` ending with `/`. - - | TypeSpec | Before | After | - | ---------------------------------------------------------------- | ----------------- | ------------------ | - | `@route("users/")` | `users` | `users/` | - | `@route("users")` | `users` | `users` | - | on interface `@route("users/")` and on op `@route("addresses/")` | `users/addresses` | `users/addresses/` | - | on interface `@route("users/")` and on op `@route("addresses")` | `users/addresses` | `users/addresses` | diff --git a/.chronus/changes/import-openapi3-playground-2024-6-5-19-48-11.md b/.chronus/changes/import-openapi3-playground-2024-6-5-19-48-11.md deleted file mode 100644 index 957a83097..000000000 --- a/.chronus/changes/import-openapi3-playground-2024-6-5-19-48-11.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/openapi3" ---- diff --git a/.chronus/changes/import-openapi3-playground-2024-6-5-19-58-23.md b/.chronus/changes/import-openapi3-playground-2024-6-5-19-58-23.md deleted file mode 100644 index 015131423..000000000 --- a/.chronus/changes/import-openapi3-playground-2024-6-5-19-58-23.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/playground" ---- - -Add new property on the playground to add custom buttons on the toolbar diff --git a/.chronus/changes/init-git-ignore-2024-6-3-16-23-13.md b/.chronus/changes/init-git-ignore-2024-6-3-16-23-13.md deleted file mode 100644 index 98dbb9697..000000000 --- a/.chronus/changes/init-git-ignore-2024-6-3-16-23-13.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Adds option to `tsp init` to generate .gitignore file \ No newline at end of file diff --git a/.chronus/changes/oa3-to-ts-2024-5-26-13-27-36.md b/.chronus/changes/oa3-to-ts-2024-5-26-13-27-36.md deleted file mode 100644 index 2f593379b..000000000 --- a/.chronus/changes/oa3-to-ts-2024-5-26-13-27-36.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/openapi3" ---- - -Adds support for converting OpenAPI3 specs to TypeSpec via the new tsp-openapi3 CLI included in the `@typespec/openapi3` package. diff --git a/.chronus/changes/print-id-helper-2024-6-9-15-50-59.md b/.chronus/changes/print-id-helper-2024-6-9-15-50-59.md deleted file mode 100644 index f441bba5f..000000000 --- a/.chronus/changes/print-id-helper-2024-6-9-15-50-59.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/compiler" ---- - diff --git a/.chronus/changes/set-info-object-2024-6-3-0-48-13.md b/.chronus/changes/set-info-object-2024-6-3-0-48-13.md deleted file mode 100644 index f0284cc51..000000000 --- a/.chronus/changes/set-info-object-2024-6-3-0-48-13.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/openapi" ---- - -Adds public function for setting info object diff --git a/.chronus/changes/set-openapi3-extension-security-schemes-2024-6-2-17-4-20.md b/.chronus/changes/set-openapi3-extension-security-schemes-2024-6-2-17-4-20.md deleted file mode 100644 index 812dec5b1..000000000 --- a/.chronus/changes/set-openapi3-extension-security-schemes-2024-6-2-17-4-20.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/openapi3" ---- - -Apply openapi3 extension on Security schemes diff --git a/.chronus/changes/set-openapi3-extension-security-schemes-2024-6-2-17-7-34.md b/.chronus/changes/set-openapi3-extension-security-schemes-2024-6-2-17-7-34.md deleted file mode 100644 index b75808a1a..000000000 --- a/.chronus/changes/set-openapi3-extension-security-schemes-2024-6-2-17-7-34.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/http" ---- - -Expose `model` property on `HttpAuth` to retrieve original type used to define security scheme diff --git a/.chronus/changes/tsp-openapi3-emit-on-bad-format-2024-6-9-16-12-22.md b/.chronus/changes/tsp-openapi3-emit-on-bad-format-2024-6-9-16-12-22.md deleted file mode 100644 index 0c6d0c2fd..000000000 --- a/.chronus/changes/tsp-openapi3-emit-on-bad-format-2024-6-9-16-12-22.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/openapi3" ---- - -Updates tsp-openapi3 to always emit main.tsp when formatting encounters an error. \ No newline at end of file diff --git a/.chronus/changes/tsp-openapi3-fix-doc-newlines-2024-6-15-10-28-34.md b/.chronus/changes/tsp-openapi3-fix-doc-newlines-2024-6-15-10-28-34.md deleted file mode 100644 index 0904838f7..000000000 --- a/.chronus/changes/tsp-openapi3-fix-doc-newlines-2024-6-15-10-28-34.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/openapi3" ---- - -Updates tsp-openapi3 doc line wrapping to only automatically create newlines when they are present in the original documentation. \ No newline at end of file diff --git a/.chronus/changes/tsp-openapi3-namespacing-2024-6-15-22-37-45.md b/.chronus/changes/tsp-openapi3-namespacing-2024-6-15-22-37-45.md deleted file mode 100644 index 6d1cca42b..000000000 --- a/.chronus/changes/tsp-openapi3-namespacing-2024-6-15-22-37-45.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/openapi3" ---- - -Updates tsp-openapi3 to escape identifiers that would otherwise be invalid, and automatically resolve namespaces for schemas with dots in their names. \ No newline at end of file diff --git a/.chronus/changes/typegraph-v2-2024-6-1-10-17-58.md b/.chronus/changes/typegraph-v2-2024-6-1-10-17-58.md deleted file mode 100644 index 2f0cbc64a..000000000 --- a/.chronus/changes/typegraph-v2-2024-6-1-10-17-58.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/playground" ---- - -Extract splitpane into separate package diff --git a/.chronus/changes/typegraph-v2-2024-6-1-17-14-9.md b/.chronus/changes/typegraph-v2-2024-6-1-17-14-9.md deleted file mode 100644 index fa501754b..000000000 --- a/.chronus/changes/typegraph-v2-2024-6-1-17-14-9.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/html-program-viewer" ---- - -Complete new dynamic UI to navigate the TypeSpec type graph diff --git a/.chronus/changes/upgrade-deps-july-2024-2024-6-1-20-41-3.md b/.chronus/changes/upgrade-deps-july-2024-2024-6-1-20-41-3.md deleted file mode 100644 index 650629904..000000000 --- a/.chronus/changes/upgrade-deps-july-2024-2024-6-1-20-41-3.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: dependencies -packages: - - "@typespec/bundler" - - "@typespec/compiler" - - "@typespec/eslint-plugin" - - "@typespec/html-program-viewer" - - "@typespec/http" - - "@typespec/internal-build-utils" - - "@typespec/json-schema" - - "@typespec/library-linter" - - "@typespec/openapi" - - "@typespec/openapi3" - - "@typespec/playground" - - "@typespec/prettier-plugin-typespec" - - "@typespec/protobuf" - - "@typespec/rest" - - tmlanguage-generator - - typespec-vscode - - "@typespec/versioning" - - "@typespec/xml" ---- - -Dependency updates July 2024 diff --git a/.chronus/changes/version_optional-2024-6-11-17-40-39.md b/.chronus/changes/version_optional-2024-6-11-17-40-39.md deleted file mode 100644 index 67ebcd602..000000000 --- a/.chronus/changes/version_optional-2024-6-11-17-40-39.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/versioning" ---- - -Updated doc of madeOptional diff --git a/.chronus/changes/witemple-no-override-required-as-optional-2024-5-25-14-39-2.md b/.chronus/changes/witemple-no-override-required-as-optional-2024-5-25-14-39-2.md deleted file mode 100644 index 2287d803c..000000000 --- a/.chronus/changes/witemple-no-override-required-as-optional-2024-5-25-14-39-2.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -changeKind: breaking -packages: - - "@typespec/compiler" ---- - -Disallows overriding a required inherited property with an optional property. - -In previous versions of TypeSpec, it was possible to override a required property with an optional property. This is no longer allowed. This change may result in errors in your code if you were relying on this bug, but specifications that used this behavior are likely to have been exposed to errors resulting from incoherent type checking behavior. - -The following example demonstrates the behavior that is no longer allowed: - -```tsp -model Base { - example: string; -} - -model Child extends Base { - example?: string; -} -``` - -In this example, the `Child` model overrides the `example` property from the `Base` model with an optional property. This is no longer allowed. diff --git a/packages/bundler/CHANGELOG.md b/packages/bundler/CHANGELOG.md index d98cc3df6..3159ff000 100644 --- a/packages/bundler/CHANGELOG.md +++ b/packages/bundler/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/bundler +## 0.1.5 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + + ## 0.1.4 ### Bump dependencies diff --git a/packages/bundler/package.json b/packages/bundler/package.json index ab67fdf03..9eab15796 100644 --- a/packages/bundler/package.json +++ b/packages/bundler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/bundler", - "version": "0.1.4", + "version": "0.1.5", "author": "Microsoft Corporation", "description": "Package to bundle a TypeSpec library.", "homepage": "https://typespec.io", diff --git a/packages/compiler/CHANGELOG.md b/packages/compiler/CHANGELOG.md index 6772d6c83..71ce7b165 100644 --- a/packages/compiler/CHANGELOG.md +++ b/packages/compiler/CHANGELOG.md @@ -1,5 +1,95 @@ # Change Log - @typespec/compiler +## 0.58.0 + +### Bug Fixes + +- [#3623](https://github.com/microsoft/typespec/pull/3623) Fix crash of language server on firefox +- [#3516](https://github.com/microsoft/typespec/pull/3516) Deprecate getAssetEmitter and recommend calling `createAssetEmitter` directly +- [#3767](https://github.com/microsoft/typespec/pull/3767) Fix semantic highlighting of using of single namespace +- [#3824](https://github.com/microsoft/typespec/pull/3824) Do not cast model expression to object value if the constraint is allowing the type +- [#3577](https://github.com/microsoft/typespec/pull/3577) Fix formatting of object and array literal in decorator to hug parenthesis +- [#3823](https://github.com/microsoft/typespec/pull/3823) Fix formatting of scalar constructor called with no args +- [#3743](https://github.com/microsoft/typespec/pull/3743) Fix 'typespec vs install' command on windows +- [#3605](https://github.com/microsoft/typespec/pull/3605) Fix templates initialized on node 22 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + +### Features + +- [#3699](https://github.com/microsoft/typespec/pull/3699) Moved compiler dependencies to peer and dev for scaffolded projects. +- [#3572](https://github.com/microsoft/typespec/pull/3572) Add new `@example` and `@opExample` decorator to provide examples on types and operations. + + ```tsp + @example(#{ + id: "some", + date: utcDateTime.fromISO("2020-01-01T00:00:00Z"), + timeout: duration.fromISO("PT1M"), + }) + model Foo { + id: string; + date: utcDateTime; + + @encode("seconds", int32) timeout: duration; + } + ``` + + ```tsp + @opExample( + #{ + parameters: #{ + pet: #{ + id: "some", + name: "Fluffy", + dob: plainDate.fromISO("2020-01-01"), + }, + }, + returnType: #{ + id: "some", + name: "Fluffy", + dob: plainDate.fromISO("2020-01-01"), + }, + }, + #{ title: "First", description: "Show creating a pet" } + ) + op createPet(pet: Pet): Pet; + ``` +- [#3751](https://github.com/microsoft/typespec/pull/3751) Adds option to `tsp init` to generate .gitignore file + +### Breaking Changes + +- [#3793](https://github.com/microsoft/typespec/pull/3793) Do not carry over `@friendlyName` with `model is` or `op is` + + ```tsp + @friendlyName("Abc{T}", T) + model Foo {} + + model Bar is Foo; + + // This can be changed to + model Abcstring is Foo; + ``` +- [#3659](https://github.com/microsoft/typespec/pull/3659) Disallows overriding a required inherited property with an optional property. + +In previous versions of TypeSpec, it was possible to override a required property with an optional property. This is no longer allowed. This change may result in errors in your code if you were relying on this bug, but specifications that used this behavior are likely to have been exposed to errors resulting from incoherent type checking behavior. + +The following example demonstrates the behavior that is no longer allowed: + +```tsp +model Base { + example: string; +} + +model Child extends Base { + example?: string; +} +``` + +In this example, the `Child` model overrides the `example` property from the `Base` model with an optional property. This is no longer allowed. + + ## 0.57.0 diff --git a/packages/compiler/package.json b/packages/compiler/package.json index e614b3b24..cad76f1ea 100644 --- a/packages/compiler/package.json +++ b/packages/compiler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/compiler", - "version": "0.57.0", + "version": "0.58.0", "description": "TypeSpec Compiler Preview", "author": "Microsoft Corporation", "license": "MIT", diff --git a/packages/compiler/templates/scaffolding.json b/packages/compiler/templates/scaffolding.json index 869a016ad..c9b687406 100644 --- a/packages/compiler/templates/scaffolding.json +++ b/packages/compiler/templates/scaffolding.json @@ -3,12 +3,12 @@ "title": "Empty project", "description": "Create an empty project.", "libraries": [], - "compilerVersion": "0.57.0" + "compilerVersion": "0.58.0" }, "rest": { "title": "Generic REST API", "description": "Create a project representing a generic REST API", - "compilerVersion": "0.57.0", + "compilerVersion": "0.58.0", "libraries": [ "@typespec/http", "@typespec/rest", @@ -23,7 +23,7 @@ "library-ts": { "title": "TypeSpec Library (With TypeScript)", "description": "Create a new package to add decorators or linters to typespec.", - "compilerVersion": "0.57.0", + "compilerVersion": "0.58.0", "libraries": [], "files": [ { @@ -99,7 +99,7 @@ "emitter-ts": { "title": "TypeSpec Emitter (With TypeScript)", "description": "Create a new package that will be emitting typespec", - "compilerVersion": "0.57.0", + "compilerVersion": "0.58.0", "libraries": [], "files": [ { diff --git a/packages/eslint-plugin-typespec/CHANGELOG.md b/packages/eslint-plugin-typespec/CHANGELOG.md index 4a10be0b2..96c820c8a 100644 --- a/packages/eslint-plugin-typespec/CHANGELOG.md +++ b/packages/eslint-plugin-typespec/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/eslint-plugin +## 0.58.0 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + + ## 0.57.0 ### Bump dependencies diff --git a/packages/eslint-plugin-typespec/package.json b/packages/eslint-plugin-typespec/package.json index d2c02ae6b..23b961c90 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.57.0", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "Eslint plugin providing set of rules to be used in the JS/TS code of TypeSpec libraries", "homepage": "https://typespec.io", diff --git a/packages/html-program-viewer/CHANGELOG.md b/packages/html-program-viewer/CHANGELOG.md index a5aca219d..15f5dfcd9 100644 --- a/packages/html-program-viewer/CHANGELOG.md +++ b/packages/html-program-viewer/CHANGELOG.md @@ -1,5 +1,20 @@ # Change Log - @typespec/html-program-viewer +## 0.58.0 + +### Bug Fixes + +- [#3585](https://github.com/microsoft/typespec/pull/3585) Fix crash in program viewer when trying to display new value type + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + +### Features + +- [#3713](https://github.com/microsoft/typespec/pull/3713) Complete new dynamic UI to navigate the TypeSpec type graph + + ## 0.57.0 ### Bump dependencies diff --git a/packages/html-program-viewer/package.json b/packages/html-program-viewer/package.json index b24d256a7..2835d5fdc 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.57.0", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting an html view of the program.", "homepage": "https://typespec.io", diff --git a/packages/http-server-javascript/CHANGELOG.md b/packages/http-server-javascript/CHANGELOG.md new file mode 100644 index 000000000..6cdd41cb3 --- /dev/null +++ b/packages/http-server-javascript/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog - @typespec/http-server-javascript + + + +## 0.58.0 + +No changes, version bump only. diff --git a/packages/http-server-javascript/package.json b/packages/http-server-javascript/package.json index c626134f1..865bbd019 100644 --- a/packages/http-server-javascript/package.json +++ b/packages/http-server-javascript/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/http-server-javascript", - "version": "0.58.0-alpha.1", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "TypeSpec HTTP server code generator for JavaScript", "homepage": "https://github.com/microsoft/typespec", diff --git a/packages/http/CHANGELOG.md b/packages/http/CHANGELOG.md index 0aacae8bb..a9b6284ae 100644 --- a/packages/http/CHANGELOG.md +++ b/packages/http/CHANGELOG.md @@ -1,5 +1,29 @@ # Change Log - @typespec/http +## 0.58.0 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + +### Features + +- [#3717](https://github.com/microsoft/typespec/pull/3717) Allow overriding base operation verb +- [#3676](https://github.com/microsoft/typespec/pull/3676) Expose `getHttpPart` and types functions +- [#3732](https://github.com/microsoft/typespec/pull/3732) Expose `model` property on `HttpAuth` to retrieve original type used to define security scheme + +### Breaking Changes + +- [#3737](https://github.com/microsoft/typespec/pull/3737) Keep trailing slash when building http routes, this is breaking if you used to have `@route()` ending with `/`. + + | TypeSpec | Before | After | + | ---------------------------------------------------------------- | ----------------- | ------------------ | + | `@route("users/")` | `users` | `users/` | + | `@route("users")` | `users` | `users` | + | on interface `@route("users/")` and on op `@route("addresses/")` | `users/addresses` | `users/addresses/` | + | on interface `@route("users/")` and on op `@route("addresses")` | `users/addresses` | `users/addresses` | + + ## 0.57.0 ### Bug Fixes diff --git a/packages/http/package.json b/packages/http/package.json index 4c3737ad0..57e0bf4da 100644 --- a/packages/http/package.json +++ b/packages/http/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/http", - "version": "0.57.0", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "TypeSpec HTTP protocol binding", "homepage": "https://github.com/microsoft/typespec", diff --git a/packages/internal-build-utils/CHANGELOG.md b/packages/internal-build-utils/CHANGELOG.md index dc426171a..eb103cecb 100644 --- a/packages/internal-build-utils/CHANGELOG.md +++ b/packages/internal-build-utils/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/internal-build-utils +## 0.58.0 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + + ## 0.57.0 ### Bump dependencies diff --git a/packages/internal-build-utils/package.json b/packages/internal-build-utils/package.json index 0532b5a1b..52c14b954 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.57.0", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "Internal library to TypeSpec providing helpers to build.", "homepage": "https://typespec.io", diff --git a/packages/json-schema/CHANGELOG.md b/packages/json-schema/CHANGELOG.md index 25c57cf69..342dc9345 100644 --- a/packages/json-schema/CHANGELOG.md +++ b/packages/json-schema/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log - @typespec/json-schema +## 0.58.0 + +### Bug Fixes + +- [#3516](https://github.com/microsoft/typespec/pull/3516) Fix issue that could result in invalid document generation when running `tsp compile` from another directory + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + + ## 0.57.0 ### Bug Fixes diff --git a/packages/json-schema/package.json b/packages/json-schema/package.json index a6df8e3e3..ab5666826 100644 --- a/packages/json-schema/package.json +++ b/packages/json-schema/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/json-schema", - "version": "0.57.0", + "version": "0.58.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", diff --git a/packages/library-linter/CHANGELOG.md b/packages/library-linter/CHANGELOG.md index f7cd7fa79..be732ef00 100644 --- a/packages/library-linter/CHANGELOG.md +++ b/packages/library-linter/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/library-linter +## 0.58.0 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + + ## 0.57.0 ### Bump dependencies diff --git a/packages/library-linter/package.json b/packages/library-linter/package.json index 6e78ecd0a..8571ca284 100644 --- a/packages/library-linter/package.json +++ b/packages/library-linter/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/library-linter", - "version": "0.57.0", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "TypeSpec library for linting another library.", "homepage": "https://typespec.io", diff --git a/packages/openapi/CHANGELOG.md b/packages/openapi/CHANGELOG.md index be8d63cbd..ba3e935be 100644 --- a/packages/openapi/CHANGELOG.md +++ b/packages/openapi/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log - @typespec/openapi +## 0.58.0 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + +### Features + +- [#3626](https://github.com/microsoft/typespec/pull/3626) Adds public function for setting info object + + ## 0.57.0 ### Bump dependencies diff --git a/packages/openapi/package.json b/packages/openapi/package.json index ef46702a7..3c048ad82 100644 --- a/packages/openapi/package.json +++ b/packages/openapi/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi", - "version": "0.57.0", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "TypeSpec library providing OpenAPI concepts", "homepage": "https://typespec.io", diff --git a/packages/openapi3/CHANGELOG.md b/packages/openapi3/CHANGELOG.md index 3766d08fe..7c6000c11 100644 --- a/packages/openapi3/CHANGELOG.md +++ b/packages/openapi3/CHANGELOG.md @@ -1,5 +1,25 @@ # Change Log - @typespec/openapi3 +## 0.58.0 + +### Bug Fixes + +- [#3516](https://github.com/microsoft/typespec/pull/3516) Fix issue that could result in invalid document generation when running `tsp compile` from another directory +- [#3794](https://github.com/microsoft/typespec/pull/3794) Updates tsp-openapi3 to always emit main.tsp when formatting encounters an error. +- [#3839](https://github.com/microsoft/typespec/pull/3839) Updates tsp-openapi3 doc line wrapping to only automatically create newlines when they are present in the original documentation. + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + +### Features + +- [#3572](https://github.com/microsoft/typespec/pull/3572) Add support for new `@example` and `@opExample` decorator +- [#3663](https://github.com/microsoft/typespec/pull/3663) Adds support for converting OpenAPI3 specs to TypeSpec via the new tsp-openapi3 CLI included in the `@typespec/openapi3` package. +- [#3732](https://github.com/microsoft/typespec/pull/3732) Apply openapi3 extension on Security schemes +- [#3844](https://github.com/microsoft/typespec/pull/3844) Updates tsp-openapi3 to escape identifiers that would otherwise be invalid, and automatically resolve namespaces for schemas with dots in their names. + + ## 0.57.0 ### Bug Fixes diff --git a/packages/openapi3/package.json b/packages/openapi3/package.json index 397097ef0..474a410e5 100644 --- a/packages/openapi3/package.json +++ b/packages/openapi3/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi3", - "version": "0.57.0", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding and converting OpenAPI3 to TypeSpec", "homepage": "https://typespec.io", diff --git a/packages/playground/CHANGELOG.md b/packages/playground/CHANGELOG.md index 486437fba..2dbb422c0 100644 --- a/packages/playground/CHANGELOG.md +++ b/packages/playground/CHANGELOG.md @@ -1,5 +1,18 @@ # Change Log - @typespec/playground +## 0.4.0 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + +### Features + +- [#3585](https://github.com/microsoft/typespec/pull/3585) Add error recovery for viewer that crash +- [#3750](https://github.com/microsoft/typespec/pull/3750) Add new property on the playground to add custom buttons on the toolbar +- [#3713](https://github.com/microsoft/typespec/pull/3713) Extract splitpane into separate package + + ## 0.3.0 ### Bug Fixes diff --git a/packages/playground/package.json b/packages/playground/package.json index d9eb8ccfa..272513f54 100644 --- a/packages/playground/package.json +++ b/packages/playground/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/playground", - "version": "0.3.0", + "version": "0.4.0", "author": "Microsoft Corporation", "description": "TypeSpec playground UI components.", "homepage": "https://typespec.io", diff --git a/packages/prettier-plugin-typespec/CHANGELOG.md b/packages/prettier-plugin-typespec/CHANGELOG.md index 0df35dd7e..268176182 100644 --- a/packages/prettier-plugin-typespec/CHANGELOG.md +++ b/packages/prettier-plugin-typespec/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/prettier-plugin-typespec +## 0.58.0 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + + ## 0.57.0 ### Bump dependencies diff --git a/packages/prettier-plugin-typespec/package.json b/packages/prettier-plugin-typespec/package.json index 1ec601557..1923f305c 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.57.0", + "version": "0.58.0", "description": "", "main": "dist/index.js", "scripts": { diff --git a/packages/protobuf/CHANGELOG.md b/packages/protobuf/CHANGELOG.md index 9f9254fb7..6a84cc91d 100644 --- a/packages/protobuf/CHANGELOG.md +++ b/packages/protobuf/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/protobuf +## 0.58.0 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + + ## 0.57.0 ### Bug Fixes diff --git a/packages/protobuf/package.json b/packages/protobuf/package.json index 9a09e6c16..b02c69b35 100644 --- a/packages/protobuf/package.json +++ b/packages/protobuf/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/protobuf", - "version": "0.57.0", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "TypeSpec library and emitter for Protobuf (gRPC)", "homepage": "https://github.com/microsoft/typespec", diff --git a/packages/rest/CHANGELOG.md b/packages/rest/CHANGELOG.md index 5b16c1a97..fb8fcf7ae 100644 --- a/packages/rest/CHANGELOG.md +++ b/packages/rest/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/rest +## 0.58.0 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + + ## 0.57.0 ### Bug Fixes diff --git a/packages/rest/package.json b/packages/rest/package.json index fc979be7d..4635dcdbf 100644 --- a/packages/rest/package.json +++ b/packages/rest/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/rest", - "version": "0.57.0", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "TypeSpec REST protocol binding", "homepage": "https://typespec.io", diff --git a/packages/tmlanguage-generator/CHANGELOG.md b/packages/tmlanguage-generator/CHANGELOG.md index 54a484f0b..85ba87058 100644 --- a/packages/tmlanguage-generator/CHANGELOG.md +++ b/packages/tmlanguage-generator/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - tmlanguage-generator +## 0.5.7 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + + ## 0.5.6 ### Bump dependencies diff --git a/packages/tmlanguage-generator/package.json b/packages/tmlanguage-generator/package.json index 8eeae0522..3bf9df58c 100644 --- a/packages/tmlanguage-generator/package.json +++ b/packages/tmlanguage-generator/package.json @@ -1,6 +1,6 @@ { "name": "tmlanguage-generator", - "version": "0.5.6", + "version": "0.5.7", "author": "Microsoft Corporation", "description": "Helper library to generate TextMate syntax highlighting tmLanguage files.", "homepage": "https://github.com/microsoft/typespec/tree/main/packages/tmlanguage-generator", diff --git a/packages/typespec-vs/CHANGELOG.md b/packages/typespec-vs/CHANGELOG.md index 6b9c0020a..45301e997 100644 --- a/packages/typespec-vs/CHANGELOG.md +++ b/packages/typespec-vs/CHANGELOG.md @@ -1,5 +1,9 @@ # Change Log - typespec-vs +## 0.58.0 + +No changes, version bump only. + ## 0.57.0 ### Features diff --git a/packages/typespec-vs/package.json b/packages/typespec-vs/package.json index 6a9aee001..55616c6b6 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.57.0", + "version": "0.58.0", "description": "TypeSpec Language Support for Visual Studio", "homepage": "https://typespec.io", "readme": "https://github.com/microsoft/typespec/blob/main/README.md", diff --git a/packages/typespec-vscode/CHANGELOG.md b/packages/typespec-vscode/CHANGELOG.md index 0bc3d1ebe..898c6395b 100644 --- a/packages/typespec-vscode/CHANGELOG.md +++ b/packages/typespec-vscode/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - typespec-vscode +## 0.58.0 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + + ## 0.57.0 ### Bump dependencies diff --git a/packages/typespec-vscode/package.json b/packages/typespec-vscode/package.json index fd7675e30..41870145f 100644 --- a/packages/typespec-vscode/package.json +++ b/packages/typespec-vscode/package.json @@ -1,6 +1,6 @@ { "name": "typespec-vscode", - "version": "0.57.0", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "TypeSpec language support for VS Code", "homepage": "https://typespec.io", diff --git a/packages/versioning/CHANGELOG.md b/packages/versioning/CHANGELOG.md index c65654fb7..16b3b82de 100644 --- a/packages/versioning/CHANGELOG.md +++ b/packages/versioning/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/versioning +## 0.58.0 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + + ## 0.57.0 ### Bug Fixes diff --git a/packages/versioning/package.json b/packages/versioning/package.json index 3698a3242..d9cdb6b03 100644 --- a/packages/versioning/package.json +++ b/packages/versioning/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/versioning", - "version": "0.57.0", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "TypeSpec library for declaring and emitting versioned APIs", "homepage": "https://typespec.io", diff --git a/packages/website/playground-versions.json b/packages/website/playground-versions.json index 82e9bb798..d698e1048 100644 --- a/packages/website/playground-versions.json +++ b/packages/website/playground-versions.json @@ -1,4 +1,5 @@ [ + "0.58.x", "0.57.x", "0.56.x", "0.55.x", diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/classes/JsonSchemaEmitter.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/classes/JsonSchemaEmitter.md index 31162e03e..a405279f0 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/classes/JsonSchemaEmitter.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/classes/JsonSchemaEmitter.md @@ -7,372 +7,14 @@ title: "[C] JsonSchemaEmitter" - `TypeEmitter`<`Record`<`string`, `any`\>, [`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> -## Constructors - -### new JsonSchemaEmitter() - -```ts -new JsonSchemaEmitter(emitter): JsonSchemaEmitter -``` - -Constructs a TypeEmitter. Do not use this constructor directly, instead -call `createAssetEmitter` on the emitter context object. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `AssetEmitter`<`Record`<`string`, `any`\>, [`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> | The asset emitter | - -#### Returns - -[`JsonSchemaEmitter`](JsonSchemaEmitter.md) - -#### Inherited from - -`TypeEmitter, JSONSchemaEmitterOptions>.constructor` - ## Properties -| Property | Modifier | Type | Default value | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `#idDuplicateTracker` | `private` | `DuplicateTracker`<`string`, `DiagnosticTarget`\> | `...` | - | -| `#refToDecl` | `private` | `Map`<`string`, `Declaration`<`Record`<`string`, `unknown`\>\>\> | `...` | - | -| `#typeForSourceFile` | `private` | `Map`<`SourceFile`<`any`\>, [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md)\> | `...` | - | -| `emitter` | `protected` | `AssetEmitter`<`Record`<`string`, `any`\>, [`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> | `undefined` | `TypeEmitter.emitter` | +| Property | Modifier | Type | Inherited from | +| ------ | ------ | ------ | ------ | +| `emitter` | `protected` | `AssetEmitter`<`Record`<`string`, `any`\>, [`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> | `TypeEmitter.emitter` | ## Methods -### #applyConstraints() - -```ts -private #applyConstraints(type, schema): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | \| `Enum` \| `Model` \| `ModelProperty` \| `Scalar` \| `Union` \| `UnionVariant` | -| `schema` | `ObjectBuilder`<`unknown`\> | - -#### Returns - -`void` - -*** - -### #createDeclaration() - -```ts -private #createDeclaration( - type, - name, -schema): Declaration> -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | -| `name` | `string` | -| `schema` | `ObjectBuilder`<`unknown`\> | - -#### Returns - -`Declaration`<`Record`<`string`, `any`\>\> - -*** - -### #fileExtension() - -```ts -private #fileExtension(): "json" | "yaml" -``` - -#### Returns - -`"json"` \| `"yaml"` - -*** - -### #finalizeSourceFileContent() - -```ts -private #finalizeSourceFileContent(sourceFile): Record -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `sourceFile` | `SourceFile`<`object`\> | - -#### Returns - -`Record`<`string`, `any`\> - -*** - -### #getCurrentSourceFile() - -```ts -private #getCurrentSourceFile(): SourceFile -``` - -#### Returns - -`SourceFile`<`object`\> - -*** - -### #getDeclId() - -```ts -private #getDeclId(type, name): string -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | -| `name` | `string` | - -#### Returns - -`string` - -*** - -### #getDefaultValue() - -```ts -private #getDefaultValue(type, defaultType): any -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | `Type` | -| `defaultType` | `Type` | - -#### Returns - -`any` - -*** - -### #getRootSchemaProps() - -```ts -private #getRootSchemaProps(type, name): object -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | -| `name` | `string` | - -#### Returns - -`object` - -| Member | Type | Value | -| :------ | :------ | :------ | -| `$id` | `string` | ... | -| `$schema` | `string` | "https://json-schema.org/draft/2020-12/schema" | - -*** - -### #getSchemaForScalar() - -```ts -private #getSchemaForScalar(scalar): object -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `scalar` | `Scalar` | - -#### Returns - -`object` - -*** - -### #getSchemaForStdScalars() - -```ts -private #getSchemaForStdScalars(baseBuiltIn): object | object | object | object -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `baseBuiltIn` | `Scalar` | - -#### Returns - -`object` \| `object` \| `object` \| `object` - -*** - -### #initializeSchema() - -```ts -private #initializeSchema( - type, - name, -props): ObjectBuilder -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | -| `name` | `string` | -| `props` | `Record`<`string`, `unknown`\> | - -#### Returns - -`ObjectBuilder`<`unknown`\> - -*** - -### #isStdType() - -```ts -private #isStdType(type): boolean -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | `Type` | - -#### Returns - -`boolean` - -*** - -### #newFileScope() - -```ts -private #newFileScope(type): object -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | - -#### Returns - -`object` - -| Member | Type | Value | -| :------ | :------ | :------ | -| `scope` | `Scope`<`Record`<`string`, `any`\>\> | sourceFile.globalScope | - -*** - -### #reportDuplicateIds() - -```ts -private #reportDuplicateIds(): void -``` - -#### Returns - -`void` - -*** - -### #requiredModelProperties() - -```ts -private #requiredModelProperties(model): undefined | string[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `model` | `Model` | - -#### Returns - -`undefined` \| `string`[] - -*** - -### #serializeSourceFileContent() - -```ts -private #serializeSourceFileContent(content): string -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `content` | `Record`<`string`, `any`\> | - -#### Returns - -`string` - -*** - -### #shouldEmitRootSchema() - -```ts -private #shouldEmitRootSchema(type): boolean -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | - -#### Returns - -`boolean` - -*** - -### #trackId() - -```ts -private #trackId(id, target): string -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `id` | `string` | -| `target` | `DiagnosticTarget` | - -#### Returns - -`string` - -*** - ### arrayDeclaration() ```ts @@ -385,7 +27,7 @@ elementType): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `array` | `Model` | | `name` | `string` | | `elementType` | `Type` | @@ -409,7 +51,7 @@ arrayDeclarationContext(array): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `array` | `Model` | #### Returns @@ -434,7 +76,7 @@ arrayDeclarationReferenceContext( #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `array` | `Model` | | `name` | `string` | | `elementType` | `Type` | @@ -458,7 +100,7 @@ arrayLiteral(array, elementType): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `array` | `Model` | | `elementType` | `Type` | @@ -481,7 +123,7 @@ arrayLiteralContext(array, elementType): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `array` | `Model` | | `elementType` | `Type` | @@ -504,7 +146,7 @@ arrayLiteralReferenceContext(array, elementType): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `array` | `Model` | | `elementType` | `Type` | @@ -527,7 +169,7 @@ booleanLiteral(boolean): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `boolean` | `BooleanLiteral` | #### Returns @@ -549,7 +191,7 @@ booleanLiteralContext(boolean): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `boolean` | `BooleanLiteral` | #### Returns @@ -577,7 +219,7 @@ By default if the target is a declaration it will call to [reference](JsonSchema #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `target` | `EmitEntity`<`Record`<`string`, `any`\>\> | Reference target. | | `scope` | `undefined` \| `Scope`<`Record`<`string`, `any`\>\> | Current scope. | | `cycle` | `ReferenceCycle` | - | @@ -603,7 +245,7 @@ declarationName(declarationType): undefined | string #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `declarationType` | `TypeSpecDeclaration` | #### Returns @@ -625,7 +267,7 @@ enumDeclaration(en, name): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `en` | `Enum` | | `name` | `string` | @@ -648,7 +290,7 @@ enumDeclarationContext(en): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `en` | `Enum` | #### Returns @@ -670,7 +312,7 @@ enumDeclarationReferenceContext(en, name): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `en` | `Enum` | | `name` | `string` | @@ -693,7 +335,7 @@ enumMember(member): EmitterOutput> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `member` | `EnumMember` | #### Returns @@ -715,7 +357,7 @@ enumMemberContext(member): object #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `member` | `EnumMember` | #### Returns @@ -734,10 +376,13 @@ enumMemberContext(member): object enumMemberReference(member): EmitterOutput> ``` +Emit an enum member reference (e.g. as created by the `SomeEnum.member` syntax +in TypeSpec). By default, this will emit nothing. + #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `member` | `EnumMember` | #### Returns @@ -759,7 +404,7 @@ enumMembers(en): EmitterOutput> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `en` | `Enum` | #### Returns @@ -781,7 +426,7 @@ enumMembersContext(en): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `en` | `Enum` | #### Returns @@ -803,7 +448,7 @@ interfaceDeclaration(iface, name): EmitterOutput> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `iface` | `Interface` | | `name` | `string` | @@ -826,7 +471,7 @@ interfaceDeclarationContext(iface, name): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `iface` | `Interface` | | `name` | `string` | @@ -849,7 +494,7 @@ interfaceDeclarationOperations(iface): EmitterOutput> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `iface` | `Interface` | #### Returns @@ -871,7 +516,7 @@ interfaceDeclarationOperationsContext(iface): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `iface` | `Interface` | #### Returns @@ -893,7 +538,7 @@ interfaceDeclarationOperationsReferenceContext(iface): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `iface` | `Interface` | #### Returns @@ -915,7 +560,7 @@ interfaceDeclarationReferenceContext(iface, name): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `iface` | `Interface` | | `name` | `string` | @@ -938,7 +583,7 @@ interfaceOperationDeclaration(operation, name): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `intrinsic` | `IntrinsicType` | | `name` | `string` | @@ -1030,7 +675,7 @@ intrinsicContext(intrinsic, name): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `intrinsic` | `IntrinsicType` | | `name` | `string` | @@ -1050,12 +695,15 @@ intrinsicContext(intrinsic, name): Context modelDeclaration(model, name): EmitterOutput ``` +Emit a model declaration (e.g. as created by `model Foo { }` syntax in +TypeSpec). + #### Parameters -| Parameter | Type | -| :------ | :------ | -| `model` | `Model` | -| `name` | `string` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `model` | `Model` | | +| `name` | `string` | - | #### Returns @@ -1073,12 +721,14 @@ modelDeclaration(model, name): EmitterOutput modelDeclarationContext(model, name): Context ``` +Set lexical context for a model declaration. + #### Parameters -| Parameter | Type | -| :------ | :------ | -| `model` | `Model` | -| `name` | `string` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `model` | `Model` | | +| `name` | `string` | the model's declaration name as retrieved from the `declarationName` method. | #### Returns @@ -1101,7 +751,7 @@ Set reference context for a model declaration. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `model` | `Model` | | | `name` | `string` | - | @@ -1121,12 +771,17 @@ Set reference context for a model declaration. modelInstantiation(model, name): EmitterOutput> ``` +Emit a model instantiation (e.g. as created by `Box` syntax in +TypeSpec). In some cases, `name` is undefined because a good name could +not be found for the instantiation. This often occurs with for instantiations +involving type expressions like `Box`. + #### Parameters -| Parameter | Type | -| :------ | :------ | -| `model` | `Model` | -| `name` | `undefined` \| `string` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `model` | `Model` | | +| `name` | `undefined` \| `string` | The name of the instantiation as retrieved from the `declarationName` method. | #### Returns @@ -1144,12 +799,14 @@ modelInstantiation(model, name): EmitterOutput> modelInstantiationContext(model, name): Context ``` +Set lexical context for a model instantiation. + #### Parameters -| Parameter | Type | -| :------ | :------ | -| `model` | `Model` | -| `name` | `undefined` \| `string` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `model` | `Model` | | +| `name` | `undefined` \| `string` | - | #### Returns @@ -1172,7 +829,7 @@ Set reference context for a model declaration. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `model` | `Model` | | | `name` | `undefined` \| `string` | - | @@ -1192,11 +849,13 @@ Set reference context for a model declaration. modelLiteral(model): EmitterOutput ``` +Emit a model literal (e.g. as created by `{}` syntax in TypeSpec). + #### Parameters -| Parameter | Type | -| :------ | :------ | -| `model` | `Model` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `model` | `Model` | | #### Returns @@ -1219,7 +878,7 @@ Set lexical context for a model literal. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `model` | `Model` | | #### Returns @@ -1243,7 +902,7 @@ Set reference context for a model literal. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `model` | `Model` | | #### Returns @@ -1262,11 +921,14 @@ Set reference context for a model literal. modelProperties(model): EmitterOutput ``` +Emit a model's properties. Unless overridden, this method will emit each of +the model's properties and return a no emit result. + #### Parameters -| Parameter | Type | -| :------ | :------ | -| `model` | `Model` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `model` | `Model` | | #### Returns @@ -1287,7 +949,7 @@ modelPropertiesContext(model): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `model` | `Model` | #### Returns @@ -1309,7 +971,7 @@ modelPropertiesReferenceContext(model): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `model` | `Model` | #### Returns @@ -1328,11 +990,13 @@ modelPropertiesReferenceContext(model): Context modelPropertyLiteral(property): EmitterOutput ``` +Emit a property of a model. + #### Parameters -| Parameter | Type | -| :------ | :------ | -| `property` | `ModelProperty` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `property` | `ModelProperty` | | #### Returns @@ -1355,7 +1019,7 @@ Set lexical context for a property of a model. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `property` | `ModelProperty` | | #### Returns @@ -1379,7 +1043,7 @@ Set reference context for a property of a model. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `property` | `ModelProperty` | | #### Returns @@ -1398,11 +1062,16 @@ Set reference context for a property of a model. modelPropertyReference(property): EmitterOutput ``` +Emit a model property reference (e.g. as created by the `SomeModel.prop` +syntax in TypeSpec). By default, this will emit the type of the referenced +property and return that result. In other words, the emit will look as if +`SomeModel.prop` were replaced with the type of `prop`. + #### Parameters -| Parameter | Type | -| :------ | :------ | -| `property` | `ModelProperty` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `property` | `ModelProperty` | | #### Returns @@ -1425,7 +1094,7 @@ Emit a namespace #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `namespace` | `Namespace` | | #### Returns @@ -1451,7 +1120,7 @@ Set lexical context for a namespace #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `namespace` | `Namespace` | | #### Returns @@ -1475,7 +1144,7 @@ Set reference context for a namespace. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `namespace` | `Namespace` | | #### Returns @@ -1497,7 +1166,7 @@ numericLiteral(number): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `number` | `NumericLiteral` | #### Returns @@ -1519,7 +1188,7 @@ numericLiteralContext(number): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `number` | `NumericLiteral` | #### Returns @@ -1541,7 +1210,7 @@ operationDeclaration(operation, name): EmitterOutput> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `operation` | `Operation` | | `name` | `string` | @@ -1564,7 +1233,7 @@ operationDeclarationContext(operation, name): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `operation` | `Operation` | | `name` | `string` | @@ -1587,7 +1256,7 @@ operationDeclarationReferenceContext(operation, name): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `operation` | `Operation` | | `name` | `string` | @@ -1610,7 +1279,7 @@ operationParameters(operation, parameters): EmitterOutput> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `operation` | `Operation` | | `parameters` | `Model` | @@ -1633,7 +1302,7 @@ operationParametersContext(operation, parameters): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `operation` | `Operation` | | `parameters` | `Model` | @@ -1656,7 +1325,7 @@ operationParametersReferenceContext(operation, parameters): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `operation` | `Operation` | | `parameters` | `Model` | @@ -1679,7 +1348,7 @@ operationReturnType(operation, returnType): EmitterOutput> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `operation` | `Operation` | | `returnType` | `Type` | @@ -1702,7 +1371,7 @@ operationReturnTypeContext(operation, returnType): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `operation` | `Operation` | | `returnType` | `Type` | @@ -1725,7 +1394,7 @@ operationReturnTypeReferenceContext(operation, returnType): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `operation` | `Operation` | | `returnType` | `Type` | @@ -1752,7 +1421,7 @@ single file, use this method to establish your main source file and set the #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | | #### Returns @@ -1780,7 +1449,7 @@ commonScope): object | EmitEntity> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `targetDeclaration` | `Declaration`<`Record`<`string`, `unknown`\>\> | | `pathUp` | `Scope`<`Record`<`string`, `unknown`\>\>[] | | `pathDown` | `Scope`<`Record`<`string`, `unknown`\>\>[] | @@ -1805,7 +1474,7 @@ scalarDeclaration(scalar, name): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `scalar` | `Scalar` | | `name` | `string` | @@ -1828,7 +1497,7 @@ scalarDeclarationContext(scalar): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `scalar` | `Scalar` | #### Returns @@ -1850,7 +1519,7 @@ scalarDeclarationReferenceContext(scalar, name): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `scalar` | `Scalar` | | `name` | `string` | @@ -1873,7 +1542,7 @@ scalarInstantiation(scalar, name): EmitterOutput> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `scalar` | `Scalar` | | `name` | `undefined` \| `string` | @@ -1896,7 +1565,7 @@ scalarInstantiationContext(scalar, name): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `scalar` | `Scalar` | | `name` | `undefined` \| `string` | @@ -1919,7 +1588,7 @@ sourceFile(sourceFile): EmittedSourceFile #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `sourceFile` | `SourceFile`<`object`\> | #### Returns @@ -1941,7 +1610,7 @@ stringLiteral(string): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `string` | `StringLiteral` | #### Returns @@ -1963,7 +1632,7 @@ stringLiteralContext(string): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `string` | `StringLiteral` | #### Returns @@ -1985,7 +1654,7 @@ stringTemplate(string): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `string` | `StringTemplate` | #### Returns @@ -2007,7 +1676,7 @@ stringTemplateContext(string): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `string` | `StringTemplate` | #### Returns @@ -2029,7 +1698,7 @@ tupleLiteral(tuple): EmitterOutput> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `tuple` | `Tuple` | #### Returns @@ -2051,7 +1720,7 @@ tupleLiteralContext(tuple): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `tuple` | `Tuple` | #### Returns @@ -2073,7 +1742,7 @@ tupleLiteralReferenceContext(tuple): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `tuple` | `Tuple` | #### Returns @@ -2095,7 +1764,7 @@ tupleLiteralValues(tuple): EmitterOutput> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `tuple` | `Tuple` | #### Returns @@ -2117,7 +1786,7 @@ tupleLiteralValuesContext(tuple): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `tuple` | `Tuple` | #### Returns @@ -2139,7 +1808,7 @@ tupleLiteralValuesReferenceContext(tuple): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `tuple` | `Tuple` | #### Returns @@ -2161,7 +1830,7 @@ unionDeclaration(union, name): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `union` | `Union` | | `name` | `string` | @@ -2184,7 +1853,7 @@ unionDeclarationContext(union): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `union` | `Union` | #### Returns @@ -2206,7 +1875,7 @@ unionDeclarationReferenceContext(union): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `union` | `Union` | #### Returns @@ -2228,7 +1897,7 @@ unionInstantiation(union, name): EmitterOutput> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `union` | `Union` | | `name` | `string` | @@ -2251,7 +1920,7 @@ unionInstantiationContext(union, name): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `union` | `Union` | | `name` | `string` | @@ -2274,7 +1943,7 @@ unionInstantiationReferenceContext(union, name): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `union` | `Union` | | `name` | `string` | @@ -2297,7 +1966,7 @@ unionLiteral(union): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `union` | `Union` | #### Returns @@ -2319,7 +1988,7 @@ unionLiteralContext(union): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `union` | `Union` | #### Returns @@ -2341,7 +2010,7 @@ unionLiteralReferenceContext(union): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `union` | `Union` | #### Returns @@ -2363,7 +2032,7 @@ unionVariant(variant): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `variant` | `UnionVariant` | #### Returns @@ -2385,7 +2054,7 @@ unionVariantContext(union): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `union` | `Union` | #### Returns @@ -2407,7 +2076,7 @@ unionVariantReferenceContext(union): Context #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `union` | `Union` | #### Returns @@ -2429,7 +2098,7 @@ unionVariants(union): EmitterOutput #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `union` | `Union` | #### Returns @@ -2483,7 +2152,7 @@ writeOutput(sourceFiles): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `sourceFiles` | `SourceFile`<`Record`<`string`, `any`\>\>[] | #### Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$baseUri.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$baseUri.md index 8f234ca49..d93559e2d 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$baseUri.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$baseUri.md @@ -13,7 +13,7 @@ function $baseUri( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Namespace` | | `baseUri` | `string` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contains.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contains.md index d5484c186..799e68667 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contains.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contains.md @@ -13,7 +13,7 @@ function $contains( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | `value` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentEncoding.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentEncoding.md index 4d0b4ec55..1e8d79ff5 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentEncoding.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentEncoding.md @@ -13,7 +13,7 @@ function $contentEncoding( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` \| `Scalar` | | `value` | `string` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentMediaType.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentMediaType.md index 75398e2f1..5c394cb49 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentMediaType.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentMediaType.md @@ -13,7 +13,7 @@ function $contentMediaType( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` \| `Scalar` | | `value` | `string` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentSchema.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentSchema.md index 0eda2dfb7..3d3deebbc 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentSchema.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentSchema.md @@ -13,7 +13,7 @@ function $contentSchema( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` \| `Scalar` | | `value` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$extension.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$extension.md index 81a4882c3..90e0f4e1b 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$extension.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$extension.md @@ -14,7 +14,7 @@ function $extension( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | `key` | `string` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$id.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$id.md index 7703e347b..8bf83aaa5 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$id.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$id.md @@ -13,7 +13,7 @@ function $id( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | `id` | `string` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$jsonSchema.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$jsonSchema.md index a5ae169a3..ada6102c8 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$jsonSchema.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$jsonSchema.md @@ -13,7 +13,7 @@ function $jsonSchema( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | `baseUri`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxContains.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxContains.md index 9a4708a79..07c61eb80 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxContains.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxContains.md @@ -13,7 +13,7 @@ function $maxContains( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | `value` | `number` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxProperties.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxProperties.md index 6c56d5a71..f565d60fb 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxProperties.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxProperties.md @@ -13,7 +13,7 @@ function $maxProperties( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | `value` | `number` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minContains.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minContains.md index 169a7b9f6..e9e96f689 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minContains.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minContains.md @@ -13,7 +13,7 @@ function $minContains( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | `value` | `number` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minProperties.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minProperties.md index 9be6c745a..466f93699 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minProperties.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minProperties.md @@ -13,7 +13,7 @@ function $minProperties( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | `value` | `number` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$multipleOf.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$multipleOf.md index 4270c0306..ec8f0aa4d 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$multipleOf.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$multipleOf.md @@ -13,7 +13,7 @@ function $multipleOf( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` \| `Scalar` | | `value` | `Numeric` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$onEmit.md index c46bfb3a8..101e31093 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$onEmit.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$onEmit.md @@ -10,7 +10,7 @@ function $onEmit(context): Promise ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `EmitContext`<[`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$oneOf.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$oneOf.md index 832826d15..803a49ce4 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$oneOf.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$oneOf.md @@ -10,7 +10,7 @@ function $oneOf(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` \| `Union` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$prefixItems.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$prefixItems.md index 515d72544..1d9805059 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$prefixItems.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$prefixItems.md @@ -13,7 +13,7 @@ function $prefixItems( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | `value` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$uniqueItems.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$uniqueItems.md index 5ab84ce2a..5a801e806 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$uniqueItems.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$uniqueItems.md @@ -10,7 +10,7 @@ function $uniqueItems(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$validatesRawJson.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$validatesRawJson.md index 5fc01f023..757552c77 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$validatesRawJson.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$validatesRawJson.md @@ -13,7 +13,7 @@ function $validatesRawJson( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Model` | | `value` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/findBaseUri.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/findBaseUri.md index 28feb6c13..b6c2db6aa 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/findBaseUri.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/findBaseUri.md @@ -10,7 +10,7 @@ function findBaseUri(program, target): string | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Namespace` \| [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getBaseUri.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getBaseUri.md index f074f6cd8..a7f76c28b 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getBaseUri.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getBaseUri.md @@ -10,7 +10,7 @@ function getBaseUri(program, target): any ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContains.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContains.md index 181cc3605..80c233804 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContains.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContains.md @@ -10,7 +10,7 @@ function getContains(program, target): any ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentEncoding.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentEncoding.md index 28386f05a..eb6c8c701 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentEncoding.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentEncoding.md @@ -10,7 +10,7 @@ function getContentEncoding(program, target): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentMediaType.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentMediaType.md index eb09e5131..3ec4f95b3 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentMediaType.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentMediaType.md @@ -10,7 +10,7 @@ function getContentMediaType(program, target): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentSchema.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentSchema.md index dc5caf343..5dffbe2d1 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentSchema.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentSchema.md @@ -10,7 +10,7 @@ function getContentSchema(program, target): any ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getExtensions.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getExtensions.md index b3839c561..30100f345 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getExtensions.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getExtensions.md @@ -10,7 +10,7 @@ function getExtensions(program, target): ExtensionRecord[] ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getId.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getId.md index 96eb2ddd1..fc2402d90 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getId.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getId.md @@ -10,7 +10,7 @@ function getId(program, target): any ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchema.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchema.md index c55fd50a1..9513b6ce5 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchema.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchema.md @@ -10,7 +10,7 @@ function getJsonSchema(program, target): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchemaTypes.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchemaTypes.md index f0e50e58e..4727aa162 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchemaTypes.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchemaTypes.md @@ -10,7 +10,7 @@ function getJsonSchemaTypes(program): (Namespace | Model)[] ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxContains.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxContains.md index ebdaf9638..9ab60d199 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxContains.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxContains.md @@ -10,7 +10,7 @@ function getMaxContains(program, target): any ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxProperties.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxProperties.md index ffe2b13e0..5fded5aaf 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxProperties.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxProperties.md @@ -10,7 +10,7 @@ function getMaxProperties(program, target): any ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinContains.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinContains.md index 655d17193..a4e126c44 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinContains.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinContains.md @@ -10,7 +10,7 @@ function getMinContains(program, target): any ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinProperties.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinProperties.md index d1503e2cd..3312a232d 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinProperties.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinProperties.md @@ -10,7 +10,7 @@ function getMinProperties(program, target): any ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOf.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOf.md index d71713148..d41dff43f 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOf.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOf.md @@ -10,7 +10,7 @@ function getMultipleOf(program, target): number | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOfAsNumeric.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOfAsNumeric.md index 5858be8ac..7aba1277d 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOfAsNumeric.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOfAsNumeric.md @@ -10,7 +10,7 @@ function getMultipleOfAsNumeric(program, target): Numeric | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getPrefixItems.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getPrefixItems.md index 2255917a9..70f52663d 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getPrefixItems.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getPrefixItems.md @@ -10,7 +10,7 @@ function getPrefixItems(program, target): Tuple | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getUniqueItems.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getUniqueItems.md index 7e635d44b..3149efb27 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getUniqueItems.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getUniqueItems.md @@ -10,7 +10,7 @@ function getUniqueItems(program, target): any ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md index 18fdb24b3..cf6997cdd 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md @@ -10,7 +10,7 @@ function isJsonSchemaDeclaration(program, target): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isOneOf.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isOneOf.md index 5ddb0ed41..62a7b728c 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isOneOf.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isOneOf.md @@ -10,7 +10,7 @@ function isOneOf(program, target): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/interfaces/ExtensionRecord.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/interfaces/ExtensionRecord.md index cad8f6a47..fc3d076fa 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/interfaces/ExtensionRecord.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/interfaces/ExtensionRecord.md @@ -6,6 +6,6 @@ title: "[I] ExtensionRecord" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `key` | `string` | | `value` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md index 394f0e2a6..4697276c4 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md @@ -6,9 +6,9 @@ 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.

| +| `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)

| +| `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/emitters/json-schema/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/variables/$lib.md index 7e37857aa..9950627c7 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/variables/$lib.md @@ -9,11 +9,11 @@ const $lib: TypeSpecLibrary; ## Type declaration -| Member | Type | Value | -| :------ | :------ | :------ | -| `duplicate-id` | `object` | ... | -| `duplicate-id.default` | `CallableMessage`<[`string`]\> | ... | -| `invalid-default` | `object` | ... | -| `invalid-default.default` | `CallableMessage`<[`string`]\> | ... | -| `unknown-scalar` | `object` | ... | -| `unknown-scalar.default` | `CallableMessage`<[`string`]\> | ... | +| Name | Type | +| ------ | ------ | +| `duplicate-id` | `object` | +| `duplicate-id.default` | `CallableMessage`<[`string`]\> | +| `invalid-default` | `object` | +| `invalid-default.default` | `CallableMessage`<[`string`]\> | +| `unknown-scalar` | `object` | +| `unknown-scalar.default` | `CallableMessage`<[`string`]\> | diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/cli.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/cli.md new file mode 100644 index 000000000..3f8beaefe --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/cli.md @@ -0,0 +1,229 @@ +--- +title: OpenAPI3 to TypeSpec +--- + +# tsp-openapi3 CLI + +:::warning +The OpenAPI3 to TypeSpec conversion purpose is a one time conversion to help you get started with TypeSpec. +The output can change in future versions of TypeSpec without being considered a breaking change. +::: + +## Converting OpenAPI 3 into TypeSpec + +This package includes the `tsp-openapi3` CLI for converting OpenAPI 3 specs into TypeSpec. +The generated TypeSpec depends on the `@typespec/http`, `@typespec/openapi` and `@typespec/openapi3` libraries. + +### Usage + +1. via the command line + +```bash +tsp-openapi3 ./openapi3spec.yml --output-dir ./tsp-output +``` + +### tsp-openapi3 arguments + +The path to the OpenAPI3 yaml or json file **must** be passed as a position argument. + +The named arguments are: + +| Name | Type | Required | Description | +| ---------- | ------- | -------- | ---------------------------------------------------------------------------------------- | +| output-dir | string | required | The output directory for generated TypeSpec files. Will be created if it does not exist. | +| help | boolean | optional | Show help. | + +## Examples + +### 1. Convert component schemas into models + +All schemas present at `#/components/schemas` will be converted into a model or scalar as appropriate. + + + + + + + + + + + +
OpenAPI3TypeSpec
+ +```yml +components: + schemas: + Widget: + type: object + required: + - id + - weight + - color + properties: + id: + type: string + weight: + type: integer + format: int32 + color: + type: string + enum: + - red + - blue + uuid: + type: string + format: uuid +``` + + + +```tsp +model Widget { + id: string; + weight: int32; + color: "red" | "blue"; +} + +@format("uuid") +scalar uuid extends string; +``` + +
+ +### 2. Convert component parameters into models or fields + +All parameters present at `#/components/parameters` will be converted to a field in a model. If the model doesn't exist in `#/components/schemas`, then it will be created. + + + + + + + + + + + + + + + + +
OpenAPI3TypeSpec
+ +```yml +components: + parameters: + Widget.id: + name: id + in: path + required: true + schema: + type: string + schemas: + Widget: + type: object + required: + - id + - weight + - color + properties: + id: + type: string + weight: + type: integer + format: int32 + color: + type: string + enum: + - red + - blue +``` + + + +```tsp +model Widget { + @path id: string; + weight: int32; + color: "red" | "blue"; +} +``` + +
+ +```yml +components: + parameters: + Foo.id: + name: id + in: path + required: true + schema: + type: string +``` + + + +```tsp +model Foo { + @path id: string; +} +``` + +
+ +### 3. Convert path routes to operations + +All routes using one of the HTTP methods supported by `@typespec/http` will be converted into operations at the file namespace level. A model is also generated for each operation response. + +At this time, no automatic operation grouping under interfaces is performed. + + + + + + + + + + + +
OpenAPI3TypeSpec
+ +```yml +paths: + /{id}: + get: + operationId: readWidget + parameters: + - name: id + in: path + required: true + schema: + type: string + responses: + "200": + description: The request has succeeded. + content: + application/json: + schema: + $ref: "#/components/schemas/Widget" +``` + + + +```tsp +/** + * The request has succeeded. + */ +model readWidget200ApplicationJsonResponse { + @statusCode statusCode: 200; + @bodyRoot body: Widget; +} + +@route("/{id}") @get op readWidget(@path id: string): readWidget200ApplicationJsonResponse; +``` + +
diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/index.mdx b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/index.mdx index 712b79d86..63b200c63 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/index.mdx +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/index.mdx @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem'; # Overview -TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding +TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding and converting OpenAPI3 to TypeSpec ## Install diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$onEmit.md index 4a527d7cd..1322ad44a 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$onEmit.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$onEmit.md @@ -10,7 +10,7 @@ function $onEmit(context): Promise ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `EmitContext`<`OpenAPI3EmitterOptions`\> | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$oneOf.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$oneOf.md index 832826d15..803a49ce4 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$oneOf.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$oneOf.md @@ -10,7 +10,7 @@ function $oneOf(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` \| `Union` | diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$useRef.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$useRef.md index 497a2e7f0..0719403e3 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$useRef.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$useRef.md @@ -13,7 +13,7 @@ function $useRef( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `ref` | `string` | diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/convertOpenAPI3Document.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/convertOpenAPI3Document.md new file mode 100644 index 000000000..1ae25a4d3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/convertOpenAPI3Document.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] convertOpenAPI3Document" + +--- +```ts +function convertOpenAPI3Document(document): Promise +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `document` | `OpenAPI3Document` | + +## Returns + +`Promise`<`string`\> diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOneOf.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOneOf.md index 09cafaf08..9226bca31 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOneOf.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOneOf.md @@ -10,7 +10,7 @@ function getOneOf(program, entity): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOpenAPI3.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOpenAPI3.md index ce97cdc22..e4fe03690 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOpenAPI3.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOpenAPI3.md @@ -13,7 +13,7 @@ returned as a JS object. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | The program to emit to OpenAPI 3 | | `options` | `Omit`<`OpenAPI3EmitterOptions`, `IrrelevantOpenAPI3EmitterOptionsForObject`\> | OpenAPI 3 emit options | diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getRef.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getRef.md index a8d8f611d..a750c6bb7 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getRef.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getRef.md @@ -10,7 +10,7 @@ function getRef(program, entity): string | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/resolveOptions.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/resolveOptions.md index b0c7b783b..07faab5a8 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/resolveOptions.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/resolveOptions.md @@ -10,7 +10,7 @@ function resolveOptions(context): ResolvedOpenAPI3EmitterOptions ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `EmitContext`<`OpenAPI3EmitterOptions`\> | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/index.md index 760a93c04..a4934ae1a 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/index.md @@ -17,6 +17,7 @@ title: "[P] JS API" - [$onEmit](functions/$onEmit.md) - [$oneOf](functions/$oneOf.md) - [$useRef](functions/$useRef.md) +- [convertOpenAPI3Document](functions/convertOpenAPI3Document.md) - [getOneOf](functions/getOneOf.md) - [getOpenAPI3](functions/getOpenAPI3.md) - [getRef](functions/getRef.md) diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/interfaces/ResolvedOpenAPI3EmitterOptions.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/interfaces/ResolvedOpenAPI3EmitterOptions.md index 094d89f82..bfd509ce7 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/interfaces/ResolvedOpenAPI3EmitterOptions.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/interfaces/ResolvedOpenAPI3EmitterOptions.md @@ -6,7 +6,7 @@ title: "[I] ResolvedOpenAPI3EmitterOptions" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `fileType` | `FileType` | | `includeXTypeSpecName` | `"never"` \| `"inline-only"` | | `newLine` | `NewLine` | diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md index d937506ac..79a6dc3b5 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md @@ -9,41 +9,41 @@ const $lib: TypeSpecLibrary; ## Type declaration -| Member | Type | Value | -| :------ | :------ | :------ | -| `duplicate-header` | `object` | ... | -| `duplicate-header.default` | `CallableMessage`<[`"header"`]\> | ... | -| `empty-enum` | `object` | ... | +| Name | Type | Default value | +| ------ | ------ | ------ | +| `duplicate-header` | `object` | - | +| `duplicate-header.default` | `CallableMessage`<[`"header"`]\> | - | +| `empty-enum` | `object` | - | | `empty-enum.default` | `"Empty enums are not supported for OpenAPI v3 - enums must have at least one value."` | "Empty enums are not supported for OpenAPI v3 - enums must have at least one value." | -| `empty-union` | `object` | ... | +| `empty-union` | `object` | - | | `empty-union.default` | `"Empty unions are not supported for OpenAPI v3 - enums must have at least one value."` | "Empty unions are not supported for OpenAPI v3 - enums must have at least one value." | -| `enum-unique-type` | `object` | ... | +| `enum-unique-type` | `object` | - | | `enum-unique-type.default` | `"Enums are not supported unless all options are literals of the same type."` | "Enums are not supported unless all options are literals of the same type." | -| `inconsistent-shared-route-request-visibility` | `object` | ... | +| `inconsistent-shared-route-request-visibility` | `object` | - | | `inconsistent-shared-route-request-visibility.default` | "All operations with \`@sharedRoutes\` must have the same \`@requestVisibility\`." | "All operations with \`@sharedRoutes\` must have the same \`@requestVisibility\`." | -| `inline-cycle` | `object` | ... | -| `inline-cycle.default` | `CallableMessage`<[`"type"`]\> | ... | -| `invalid-default` | `object` | ... | -| `invalid-default.default` | `CallableMessage`<[`"type"`]\> | ... | -| `invalid-format` | `object` | ... | -| `invalid-format.default` | `CallableMessage`<[`"value"`, `"paramType"`]\> | ... | -| `invalid-model-property` | `object` | ... | -| `invalid-model-property.default` | `CallableMessage`<[`"type"`]\> | ... | -| `invalid-schema` | `object` | ... | -| `invalid-schema.default` | `CallableMessage`<[`"type"`]\> | ... | -| `invalid-server-variable` | `object` | ... | -| `invalid-server-variable.default` | `CallableMessage`<[`"propName"`]\> | ... | -| `oneof-union` | `object` | ... | +| `inline-cycle` | `object` | - | +| `inline-cycle.default` | `CallableMessage`<[`"type"`]\> | - | +| `invalid-default` | `object` | - | +| `invalid-default.default` | `CallableMessage`<[`"type"`]\> | - | +| `invalid-format` | `object` | - | +| `invalid-format.default` | `CallableMessage`<[`"value"`, `"paramType"`]\> | - | +| `invalid-model-property` | `object` | - | +| `invalid-model-property.default` | `CallableMessage`<[`"type"`]\> | - | +| `invalid-schema` | `object` | - | +| `invalid-schema.default` | `CallableMessage`<[`"type"`]\> | - | +| `invalid-server-variable` | `object` | - | +| `invalid-server-variable.default` | `CallableMessage`<[`"propName"`]\> | - | +| `oneof-union` | `object` | - | | `oneof-union.default` | `"@oneOf decorator can only be used on a union or a model property which type is a union."` | "@oneOf decorator can only be used on a union or a model property which type is a union." | -| `path-query` | `object` | ... | -| `path-query.default` | `"OpenAPI does not allow paths containing a query string."` | ... | -| `resource-namespace` | `object` | ... | +| `path-query` | `object` | - | +| `path-query.default` | `"OpenAPI does not allow paths containing a query string."` | - | +| `resource-namespace` | `object` | - | | `resource-namespace.default` | `"Resource goes on namespace"` | "Resource goes on namespace" | -| `status-code-in-default-response` | `object` | ... | +| `status-code-in-default-response` | `object` | - | | `status-code-in-default-response.default` | `"a default response should not have an explicit status code"` | "a default response should not have an explicit status code" | -| `union-null` | `object` | ... | +| `union-null` | `object` | - | | `union-null.default` | `"Cannot have a union containing only null types."` | "Cannot have a union containing only null types." | -| `unsupported-auth` | `object` | ... | -| `unsupported-auth.default` | `CallableMessage`<[`"authType"`]\> | ... | -| `unsupported-status-code-range` | `object` | ... | -| `unsupported-status-code-range.default` | `CallableMessage`<[`"start"`, `"end"`]\> | ... | +| `unsupported-auth` | `object` | - | +| `unsupported-auth.default` | `CallableMessage`<[`"authType"`]\> | - | +| `unsupported-status-code-range` | `object` | - | +| `unsupported-status-code-range.default` | `CallableMessage`<[`"start"`, `"end"`]\> | - | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md index 1f986a6d7..d558e14ca 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md @@ -14,7 +14,7 @@ function $externRef( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `ctx` | `DecoratorContext` | | `target` | `Model` | | `path` | `StringLiteral` | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md index 126640d9c..7ba279c59 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md @@ -10,12 +10,10 @@ function $field( index): void ``` -Decorate a model property with a field index. Field indices are required for all fields of emitted messages. - ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `context` | `DecoratorContext` | - | | `target` | `ModelProperty` | | | `index` | `number` | - | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md index ec6b2c1dc..3e23c4873 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md @@ -10,7 +10,7 @@ function $message(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md index fe68dd6fb..5a2342b41 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md @@ -12,7 +12,7 @@ Emitter main function. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `ctx` | `EmitContext`<`ProtobufEmitterOptions`\> | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md index dcb288747..290869457 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md @@ -12,7 +12,7 @@ Validation function ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md index 58b621f3a..eb9bdf31b 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md @@ -15,7 +15,7 @@ Declare a Protobuf package. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `context` | `DecoratorContext` | - | | `target` | `Namespace` | target decorator namespace | | `details`? | `Type` | - | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md index 7f2f63801..124862e3b 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md @@ -13,7 +13,7 @@ function $reserve( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | ...`reservations` | `unknown`[] | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md index 1cf0977d9..c018b72a9 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md @@ -12,7 +12,7 @@ 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 | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md index c5f5b6d0e..20778e77f 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md @@ -13,7 +13,7 @@ function $stream( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | | `mode` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md index 0cc936860..c5a06eb91 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md @@ -12,7 +12,7 @@ Determines whether a type represents a Protobuf map. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | the program context | | `m` | `Type` | the type to test | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/interfaces/PackageDetails.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/interfaces/PackageDetails.md index e8ac5de5d..b15fe216e 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/interfaces/PackageDetails.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/interfaces/PackageDetails.md @@ -6,5 +6,5 @@ title: "[I] PackageDetails" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `name?` | `string` | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/variables/$lib.md index b94a11578..fddb2046c 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/variables/$lib.md @@ -9,49 +9,49 @@ const $lib: TypeSpecLibrary = TypeSpecPro ## Type declaration -| Member | Type | Value | -| :------ | :------ | :------ | -| `anonymous-model` | `object` | ... | +| Name | Type | Default value | +| ------ | ------ | ------ | +| `anonymous-model` | `object` | - | | `anonymous-model.default` | `string` | "anonymous models cannot be used in Protobuf messages" | -| `field-index` | `object` | ... | -| `field-index.invalid` | `CallableMessage`<[`string`]\> | ... | -| `field-index.missing` | `CallableMessage`<[`string`]\> | ... | -| `field-index.out-of-bounds` | `CallableMessage`<[`string`, `string`]\> | ... | -| `field-index.reserved` | `CallableMessage`<[`string`]\> | ... | -| `field-index.user-reserved` | `CallableMessage`<[`string`]\> | ... | -| `field-index.user-reserved-range` | `CallableMessage`<[`string`]\> | ... | -| `field-name` | `object` | ... | -| `field-name.user-reserved` | `CallableMessage`<[`string`]\> | ... | -| `illegal-reservation` | `object` | ... | +| `field-index` | `object` | - | +| `field-index.invalid` | `CallableMessage`<[`string`]\> | - | +| `field-index.missing` | `CallableMessage`<[`string`]\> | - | +| `field-index.out-of-bounds` | `CallableMessage`<[`string`, `string`]\> | - | +| `field-index.reserved` | `CallableMessage`<[`string`]\> | - | +| `field-index.user-reserved` | `CallableMessage`<[`string`]\> | - | +| `field-index.user-reserved-range` | `CallableMessage`<[`string`]\> | - | +| `field-name` | `object` | - | +| `field-name.user-reserved` | `CallableMessage`<[`string`]\> | - | +| `illegal-reservation` | `object` | - | | `illegal-reservation.default` | `string` | "reservation value must be a string literal, uint32 literal, or a tuple of two uint32 literals denoting a range" | -| `invalid-package-name` | `object` | ... | -| `invalid-package-name.default` | `CallableMessage`<[`string`]\> | ... | -| `model-not-in-package` | `object` | ... | -| `model-not-in-package.default` | `CallableMessage`<[`string`]\> | ... | -| `namespace-collision` | `object` | ... | -| `namespace-collision.default` | `CallableMessage`<[`string`]\> | ... | -| `nested-array` | `object` | ... | +| `invalid-package-name` | `object` | - | +| `invalid-package-name.default` | `CallableMessage`<[`string`]\> | - | +| `model-not-in-package` | `object` | - | +| `model-not-in-package.default` | `CallableMessage`<[`string`]\> | - | +| `namespace-collision` | `object` | - | +| `namespace-collision.default` | `CallableMessage`<[`string`]\> | - | +| `nested-array` | `object` | - | | `nested-array.default` | `string` | "nested arrays are not supported by the Protobuf emitter" | -| `package` | `object` | ... | -| `package.disallowed-option-type` | `CallableMessage`<[`string`, `string`]\> | ... | -| `root-operation` | `object` | ... | +| `package` | `object` | - | +| `package.disallowed-option-type` | `CallableMessage`<[`string`, `string`]\> | - | +| `root-operation` | `object` | - | | `root-operation.default` | `string` | "operations in the root namespace are not supported (no associated Protobuf service)" | -| `unconvertible-enum` | `object` | ... | +| `unconvertible-enum` | `object` | - | | `unconvertible-enum.default` | `string` | "enums must explicitly assign exactly one integer to each member to be used in a Protobuf message" | | `unconvertible-enum.no-zero-first` | `string` | "the first variant of an enum must be set to zero to be used in a Protobuf message" | -| `unspeakable-template-argument` | `object` | ... | -| `unspeakable-template-argument.default` | `CallableMessage`<[`string`]\> | ... | -| `unsupported-field-type` | `object` | ... | +| `unspeakable-template-argument` | `object` | - | +| `unspeakable-template-argument.default` | `CallableMessage`<[`string`]\> | - | +| `unsupported-field-type` | `object` | - | | `unsupported-field-type.recursive-map` | `string` | "a protobuf map's 'value' type may not refer to another map" | -| `unsupported-field-type.unconvertible` | `CallableMessage`<[`string`]\> | ... | +| `unsupported-field-type.unconvertible` | `CallableMessage`<[`string`]\> | - | | `unsupported-field-type.union` | `string` | "a message field's type may not be a union" | -| `unsupported-field-type.unknown-intrinsic` | `CallableMessage`<[`string`]\> | ... | -| `unsupported-field-type.unknown-scalar` | `CallableMessage`<[`string`]\> | ... | -| `unsupported-input-type` | `object` | ... | +| `unsupported-field-type.unknown-intrinsic` | `CallableMessage`<[`string`]\> | - | +| `unsupported-field-type.unknown-scalar` | `CallableMessage`<[`string`]\> | - | +| `unsupported-input-type` | `object` | - | | `unsupported-input-type.unconvertible` | `string` | "input parameters cannot be converted to a Protobuf message" | | `unsupported-input-type.wrong-number` | `string` | "Protobuf methods must accept exactly one Model input (an empty model will do)" | | `unsupported-input-type.wrong-type` | `string` | "Protobuf methods may only accept a named Model as an input" | -| `unsupported-intrinsic` | `object` | ... | -| `unsupported-intrinsic.default` | `CallableMessage`<[`string`]\> | ... | -| `unsupported-return-type` | `object` | ... | +| `unsupported-intrinsic` | `object` | - | +| `unsupported-intrinsic.default` | `CallableMessage`<[`string`]\> | - | +| `unsupported-return-type` | `object` | - | | `unsupported-return-type.default` | `string` | "Protobuf methods must return a named Model" | 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 1922ef1e3..05d3cb92a 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/basics.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/basics.md @@ -154,7 +154,8 @@ Alternatively, you can add these as scripts in your `package.json` to make them "clean": "rimraf ./dist ./temp", "build": "tsc -p .", "watch": "tsc -p . --watch", - "test": "node --test ./dist/test/**/*.test.js", + "test": "node --test ./dist/test/**/*.test.js", // Node 22+ + "test": "node --test ./dist/test/" // Node 18, 20 } ``` diff --git a/packages/website/versioned_docs/version-latest/extending-typespec/emitter-framework.md b/packages/website/versioned_docs/version-latest/extending-typespec/emitter-framework.md index 4999dcd03..4ca5c613e 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/emitter-framework.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/emitter-framework.md @@ -5,6 +5,10 @@ title: Emitter framework # Emitter framework +:::warning +The emitter framework has many issues in its current form and a V2 using a completely different approach is in the works. Use with caution. +::: + The emitter framework simplifies the process of creating emitters from TypeSpec to other assets, compared to manually navigating the type graph. This framework provides a straightforward way to manage all the types that TypeSpec might present, and helps you determine when you've covered all features. The also solves complex problems such as constructing references between types, handling circular references, and propagating the context of the types you're emitting based on their containers or where they're referenced from. Additionally, it offers a class-based inheritance model that simplifies the extension and customization of existing emitters. @@ -13,6 +17,8 @@ The also solves complex problems such as constructing references between types, Before you start, make sure to read the 'Getting Started' section under the [emitter basics](./emitters-basics.md) topic. To use the framework, you will need an emitter library and a `$onEmit` function. +All of the emitter framework functionality can be found in `@typespec/compiler/emitter-framework` + ## Creating your own emitter When you create an emitter using the emitter framework, you will use various types from the framework. Here's a high-level overview of these types: @@ -31,8 +37,10 @@ The asset emitter drives the emit process. It has methods for taking TypeSpec ty To create your asset emitter, call `getAssetEmitter` on your emit context in `$onEmit`. It takes the TypeEmitter which is covered in the next section. Once created, you can call `emitProgram()` to emit every type in the TypeSpec graph. Alternatively, you can call `emitType(someType)` to emit specific types. ```typescript +import { createAssetEmitter } from "@typespec/compiler/emitter-framework"; + export async function $onEmit(context: EmitContext) { - const assetEmitter = context.getAssetEmitter(MyTypeEmitter); + const assetEmitter = createAssetEmitter(MyTypeEmitter); // emit my entire TypeSpec program assetEmitter.emitProgram(); diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http.md deleted file mode 100644 index 72de51b7a..000000000 --- a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -title: Getting Started with TypeSpec For Http ---- - -Let's create a REST API definition with TypeSpec. TypeSpec has an official HTTP API "binding" called `@typespec/http`. It's a set of TypeSpec declarations and decorators that describe HTTP APIs and can be used by code generators to generate OpenAPI descriptions, implementation code, and the like. -Built on top of the HTTP library, there is the REST library `@typespec/rest` which provide some REST concepts like resources. - -TypeSpec also has an official OpenAPI emitter called `@typespec/openapi3` that consumes the HTTP API bindings and emits standard [OpenAPI 3.0](https://spec.openapis.org/oas/v3.0.3) descriptions. This can then be fed in to any OpenAPI code generation pipeline. - -References: - -- [HTTP library](../libraries/http/reference) -- [REST library](../libraries/rest/reference) -- [OpenAPI 3 emitter](../emitters/openapi3/reference) - -## Setup - -:::note -Make sure to have installed the [editor extension](../introduction/installation.md#install-the-vs-and-vscode-extensions) to get syntax highlighting and intellisense. -::: - -1. Make a new folder somewhere -2. Run `npx --package=@typespec/compiler tsp init` and select the `Generic REST API` template -3. Run `npm install` to install dependencies -4. Run `npx tsp compile .` to compile the initial file - You can either run `npx tsp compile . --watch` to automatically compile change on save or keep running the command manually after that. - -Resulting file structure: - -``` -main.tsp -tspconfig.yaml -package.json -node_modules/ -tsp-output/ - @typespec/ - openapi3/ - openapi.yaml -``` - -## Service definition and metadata - -A definition for a service is the namespace that contains all the operations for the service and carries top-level metadata like service name and version. TypeSpec offers the following decorators for providing this metadata, and all are optional. - -- `@service` - Mark a namespace as a service namespace. Takes in the following options: - - `title`: Name of the service - - `version`: Version of the service -- `@server` - (In `TypeSpec.Http`) the host of the service. Can accept parameters. - -Here's an example that uses these to define a Pet Store service: - -```typespec -using TypeSpec.Http; -using TypeSpec.Rest; - -/** - * This is a sample server Petstore server. - */ -@service({ - title: "Pet Store Service", -}) -@server("https://example.com", "Single server endpoint") -namespace PetStore; -``` - -The `server` keyword can take a third parameter with parameters as necessary: - -```typespec -@server("https://{region}.foo.com", "Regional endpoint", { - /** Region name */ - region?: string = "westus", -}) -``` - -## Resources & routes - -Resource is a general term for anything that can be identified by a URL and manipulated by HTTP methods. -In TypeSpec, the operations for a resource are typically grouped in a namespace. You declare such a namespace by adding the `@route` decorator to provide the path to that resource: - -```typespec -@route("/pets") -namespace Pets { - -} -``` - -Lets add a pet model in the namespace - -```tsp -model Pet { - @minLength(100) - name: string; - - @minValue(0) - @maxValue(100) - age: int32; - - kind: "dog" | "cat" | "fish"; -} -``` - -To define an operation on this resource, you need to provide the HTTP verb for the route using the `@get`, `@head` `@post`, `@put`, `@patch`, or `@delete` decorators. If an HTTP method decorator is not specified then the default is post if there is a body and get otherwise. Lets add an operation to our `Pets` resource: - -```typespec -@route("/pets") -namespace Pets { - op list(): Pet[]; - - // or you could also use - @get op listPets(): Pet[]; -} -``` - -### Automatic route generation - -Instead of manually specifying routes using the `@route` decorator, you automatically generate routes from operation parameters by applying the `@autoRoute` decorator to an operation or interface containing operations. - -For this to work, an operation's path parameters (those marked with `@path`) must also be marked with -the `@segment` decorator to define the preceding path segment. - -This is especially useful when reusing common parameter sets defined as model types. - -For example: - -```typespec -model CommonParameters { - @path - @segment("tenants") - tenantId: string; - - @path - @segment("users") - userName: string; -} - -model User { - name: string; -} -@error -model Error { - message: string; -} - -@autoRoute -interface UserOperations { - @get - getUser(...CommonParameters): User | Error; - - @put - updateUser(...CommonParameters, user: User): User | Error; -} -``` - -This will result in the following route for both operations - -```text -/tenants/{tenantId}/users/{userName} -``` - -## Path and query parameters - -Model properties and parameters which should be passed as path and query parameters use the `@path` and `@query` decorators respectively. Let's modify our list operation to support pagination, and add a read operation to our Pets resource: - -```typespec -@route("/pets") -namespace Pets { - op list(@query skip?: int32, @query top?: int32): Pet[]; - op read(@path petId: int32): Pet; -} -``` - -Path parameters are appended to the URL unless a substitution with that parameter name exists on the resource path. For example, we might define a sub-resource using the following TypeSpec. Note how the path parameter for our sub-resource's list operation corresponds to the substitution in the URL. - -```typespec -@route("/pets/{petId}/toys") -namespace PetToys { - model Toy { - name: string; - } - op list(@path petId: int32): Toy[]; -} -``` - -## Headers - -Model properties and parameters that should be passed in a header use the `@header` decorator. The decorator takes the header name as a parameter. If a header name is not provided, it is inferred from the property or parameter name. Let's add `etag` support to our pet store's read operation. - -```typespec -@route("/pets") -namespace Pets { - op list(@query skip: int32, @query top: int32): Pet[]; - op read(@path petId: int32, @header ifMatch?: string): { - @header eTag: string; - @body pet: Pet; - }; - @post - op create(@body pet: Pet): {}; -} -``` - -## Request & response bodies - -Request and response bodies can be declared explicitly using the `@body` decorator. Let's add an endpoint to create a pet. Let's also use this decorator for the responses, although this doesn't change anything about the API. - -```typespec -@route("/pets") -namespace Pets { - op list(@query skip: int32, @query top: int32): { - @body pets: Pet[]; - }; - op read(@path petId: int32): { - @body pet: Pet; - }; - @post - op create(@body pet: Pet): {}; -} -``` - -Note that in the absence of explicit `@body`: - -1. The set of parameters that are not marked @header, @query, or @path form the request body. -2. The set of properties of the return model that are not marked @header, @query, or @path form the response body. -3. If the return type is not a model, then it defines the response body. - -This is how we were able to return Pet and Pet[] bodies without using @body for list and read. We can actually write -create in the same terse style by spreading the Pet object into the parameter list like this: - -```typespec -@route("/pets") -namespace Pets { - @post - op create(...Pet): {}; -} -``` - -## Status codes - -Use the `@statusCode` decorator on a property to declare a status code for a response. Generally, setting this to just `int32` isn't particularly useful. Instead, use number literal types to create a discriminated union of response types. Let's add status codes to our responses, and add a 404 response to our read endpoint. - -```typespec -@route("/pets") -namespace Pets { - op list(@query skip: int32, @query top: int32): { - @statusCode statusCode: 200; - @body pets: Pet[]; - }; - op read(@path petId: int32, @header ifMatch?: string): { - @statusCode statusCode: 200; - @header eTag: string; - @body pet: Pet; - } | { - @statusCode statusCode: 404; - }; - op create(@body pet: Pet): { - @statusCode statusCode: 204; - }; -} -``` diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/00-index.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/00-index.md new file mode 100644 index 000000000..2680f3a0c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/00-index.md @@ -0,0 +1,19 @@ +--- +title: Getting Started with TypeSpec For Http +pagination_next: getting-started/getting-started-http/setup # Explicitly needed as its also being the category page https://github.com/facebook/docusaurus/issues/6183 +--- + +# Getting Started with TypeSpec for HTTP + +Let's create a REST API definition with TypeSpec. TypeSpec has an official HTTP API "binding" called `@typespec/http`. It's a set of TypeSpec declarations and decorators that describe HTTP APIs and can be used by code generators to generate OpenAPI descriptions, implementation code, and the like. Built on top of the HTTP library, there is the REST library `@typespec/rest` which provides some REST concepts like resources. + +TypeSpec also has an official OpenAPI emitter called `@typespec/openapi3` that consumes the HTTP API bindings and emits standard [OpenAPI 3.0](https://spec.openapis.org/oas/v3.0.3) descriptions. This can then be fed into any OpenAPI code generation pipeline. + +Additionally, TypeSpec includes the `@typespec/versioning` library for handling service versioning. + +References: + +- [HTTP library](../../libraries/http/reference) +- [REST library](../../libraries/rest/reference) +- [OpenAPI 3 emitter](../../emitters/openapi3/reference) +- [Versioning library](../../libraries/versioning/reference) diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/01-setup.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/01-setup.md new file mode 100644 index 000000000..8f6c0c8d6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/01-setup.md @@ -0,0 +1,27 @@ +--- +title: Setup +--- + +# Setup + +:::note +Make sure to have installed the [editor extension](../../introduction/installation.md#install-the-vs-and-vscode-extensions) to get syntax highlighting and IntelliSense. +::: + +1. Make a new folder somewhere. +2. Run `tsp init` and select the `Generic REST API` template. +3. Run `tsp install` to install dependencies. +4. Run `tsp compile .` to compile the initial file. You can either run `tsp compile . --watch` to automatically compile changes on save or keep running the command manually after that. + +Resulting file structure: + +``` +main.tsp +tspconfig.yaml +package.json +node_modules/ +tsp-output/ + @typespec/ + openapi3/ + openapi.yaml +``` diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/02-service-definition.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/02-service-definition.md new file mode 100644 index 000000000..a29cafc36 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/02-service-definition.md @@ -0,0 +1,41 @@ +--- +title: Service Definition and Metadata +--- + +# Service Definition and Metadata + +A service definition in TypeSpec is a namespace that contains all the operations for the service. This namespace can carry top-level metadata such as the service name and version. TypeSpec provides several decorators to specify this metadata. While these decorators are optional, they add valuable information that can be used by tools and code generators to produce more informative and accurate outputs: + +- **`@service`**: Marks a namespace as a service namespace. It accepts the following options: + - `title`: The name of the service. +- **`@server`**: (From `TypeSpec.Http`) Specifies the host of the service. It can also accept parameters to define dynamic parts of the URL. + +Here's an example that uses these to define a Pet Store service: + +```typespec +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; + +/** + * This is a sample Pet Store server. + */ +@service({ + title: "Pet Store Service", +}) +@server("https://example.com", "Single server endpoint") +namespace PetStore; +``` + +The `@server` decorator can take a third parameter with additional parameters as necessary: + +```typespec +@server("https://{region}.foo.com", "Regional endpoint", { + /** Region name */ + region?: string = "westus", +}) +``` diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/03-versioning.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/03-versioning.md new file mode 100644 index 000000000..2b27d29b2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/03-versioning.md @@ -0,0 +1,43 @@ +--- +title: Versioning +--- + +# Versioning + +TypeSpec includes the `@typespec/versioning` library for handling service versioning. This library allows you to define different versions of your API and manage changes over time. + +Versioning is important for maintaining backward compatibility and ensuring that clients can continue to use your API as it evolves. + +It may seem premature to introduce versioning before we even have a spec, but it's worthwhile to consider versioning from the beginning of your API design process to avoid breaking changes later on. + +## Using the `@versioned` decorator + +The `@versioned` decorator is used to mark a namespace as versioned by a provided enum. This enum describes the supported versions of the service. + +Here's an example that extends our Pet Store service to include versioning: + +```typespec +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; + +/** + * This is a sample Pet Store server. + */ +@service({ + title: "Pet Store Service", +}) +@server("https://example.com", "Single server endpoint") +@versioned(Versions) +namespace PetStore; +enum Versions { + v1: "1.0.0", + v2: "2.0.0", +} +``` + +We'll make use of the versioning introduced here in an upcoming section of this guide. diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/04-resources-routes-status.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/04-resources-routes-status.md new file mode 100644 index 000000000..cdd3451a7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/04-resources-routes-status.md @@ -0,0 +1,117 @@ +--- +title: Resources, Routes, and Status Codes +--- + +# Resources, Routes, and Status Codes + +## Resources and Routes + +A resource is a general term for anything that can be identified by a URI and manipulated by HTTP methods. In TypeSpec, the operations for a resource are typically grouped in a route namespace. You declare a route namespace by adding the `@route` decorator to provide the path to that resource: + +```typespec +@route("/pets") +namespace Pets { + +} +``` + +Namespaces can be nested to encapsulate different levels of information. For example, you can have a `Pets` namespace that contains operations for managing pets, and a `Toys` namespace that contains operations for managing pet toys, all within the `PetStore` namespace. + +Let's add a `Pets` namespace within the `Petstore` namespace, and a `Pet` model to represent unique pets. `Toys` will be added in a later section to demonstrate versioning. + +```typespec +namespace PetStore { + enum Versions { + v1: "1.0.0", + v2: "2.0.0", + } + + @route("/pets") + namespace Pets { + @added(Versions.v1) + model Pet { + @minLength(1) + name: string; + + @minValue(0) + @maxValue(100) + age: int32; + + kind: "dog" | "cat" | "fish" | "bird" | "reptile"; + } + } +} +``` + +To define operations on this resource, you need to provide the HTTP verbs for the route using `operation` decorators. If an HTTP method decorator is not specified, then the default is `@post` if there is a body and `@get` otherwise. + +## Status Codes + +HTTP status codes are used to indicate the result of an HTTP request. They provide information about whether the request was successful, if there was an error, or if additional action is needed. In TypeSpec, you can use the `@statusCode` decorator to specify the status codes for your API responses. + +### Common HTTP Status Codes + +Here are some common HTTP status codes and their meanings: + +- **200 OK**: The request was successful, and the server returned the requested resource. +- **201 Created**: The request was successful, and a new resource was created. +- **204 No Content**: The request was successful, but there is no content to return. +- **400 Bad Request**: The server could not understand the request due to invalid syntax. +- **401 Unauthorized**: The client must authenticate itself to get the requested response. +- **403 Forbidden**: The client does not have access rights to the content. +- **404 Not Found**: The server cannot find the requested resource. +- **500 Internal Server Error**: The server encountered an unexpected condition that prevented it from fulfilling the request. + +### Using the `@statusCode` Decorator + +The `@statusCode` decorator is used to specify the status code for a response. You can use number literal types to create a discriminated union of response types, allowing you to handle different status codes in a single operation. + +Let's add `list` and `create` operations to our `Pets` resource and use the `@statusCode` decorator to specify the status codes for each operation. + +```typespec +@route("/pets") +namespace Pets { + op list(@query skip: int32, @query top: int32): { + @statusCode statusCode: 200; + @body pets: Pet[]; + }; + + @post + op create(@body pet: Pet): { + @statusCode statusCode: 201; + } | { + @statusCode statusCode: 400; + @body error: Error; + }; +} +``` + +**Note**: The `@body` decorator and error handling are introduced here but will be covered in detail in later sections. + +### Handling Multiple Status Codes + +By using discriminated unions, you can handle multiple status codes in a single operation. This allows you to provide detailed responses based on different conditions. + +For example, let's add error handling to the `create` operation: + +```typespec +@route("/pets") +namespace Pets { + @post + op create(@body pet: Pet): { + @statusCode statusCode: 201; + } | { + @statusCode statusCode: 400; + @body error: Error; + }; +} +``` + +We'll cover error handling in more detail in the next section. + +In this example: + +- The `create` operation returns a `201 Created` status code when a new pet is successfully created. +- If there is a validation error, the operation returns a `400 Bad Request` status code with an error message. + +By defining status codes for your API responses, you can provide clear and consistent feedback to clients, making it easier for them to understand and handle different scenarios. This helps improve the overall user experience and ensures that your API is robust and reliable. diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/05-error-handling.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/05-error-handling.md new file mode 100644 index 000000000..3525054c2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/05-error-handling.md @@ -0,0 +1,60 @@ +--- +title: Error Handling +--- + +# Error Handling + +Error handling is a crucial aspect of API design. It ensures that clients receive meaningful feedback when something goes wrong, allowing them to handle errors gracefully. + +Common error scenarios include validation errors, authorization errors, resource not found errors, and server errors. + +## Defining Error Models + +In TypeSpec, you can define custom error models to represent different types of errors. These models can include properties such as error codes, messages, and additional details. + +```typespec +@error +model ValidationError { + code: "VALIDATION_ERROR"; + message: string; + details: string[]; +} + +@error +model NotFoundError { + code: "NOT_FOUND"; + message: string; +} + +@error +model InternalServerError { + code: "INTERNAL_SERVER_ERROR"; + message: string; +} +``` + +## Handling Different Types of Errors + +You can handle different types of errors by defining operations that return multiple possible responses using discriminated unions. + +```typespec +@route("/pets") +namespace Pets { + @post + op create(@body pet: Pet): { + @statusCode statusCode: 201; + } | { + @statusCode statusCode: 400; + @body error: ValidationError; + } | { + @statusCode statusCode: 500; + @body error: InternalServerError; + }; +} +``` + +## Best Practices + +- **Consistent Error Response Format**: Use a consistent format for all error responses to make it easier for clients to handle errors. +- **Meaningful Error Messages**: Provide clear and actionable error messages to help clients understand what went wrong and how to fix it. +- **Standard HTTP Status Codes**: Use standard HTTP status codes to indicate the type of error (e.g., 400 for validation errors, 404 for not found errors, 500 for server errors). diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/06-path-query-parameters.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/06-path-query-parameters.md new file mode 100644 index 000000000..dfeccfa38 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/06-path-query-parameters.md @@ -0,0 +1,75 @@ +--- +title: Path and Query Parameters +--- + +# Path and Query Parameters + +In TypeSpec, you can specify parameters that should be passed in the URL path or as query parameters. This is done using the `@path` and `@query` decorators, respectively. + +## Path Parameters + +Path parameters are parts of the URL that are variable and are used to identify specific resources. They are marked with the `@path` decorator. These parameters are appended to the URL unless a substitution with that parameter name exists in the resource path. + +For example, let's define a `read` operation that retrieves a specific pet by its ID: + +```typespec +@route("/pets") +namespace Pets { + op read(@path petId: int32): { + @statusCode statusCode: 200; + @body pet: Pet; + } | { + @statusCode statusCode: 404; + @body error: NotFoundError; + }; +} +``` + +In this example, `petId` is a path parameter. The resulting URL for this operation might look like `/pets/123`, where `123` is the value of `petId`. + +## Query Parameters + +Query parameters are used to filter or modify the results of an operation. They are marked with the `@query` decorator and are appended to the URL as key-value pairs. + +For example, let's modify our `list` operation to support pagination using query parameters: + +```typespec +@route("/pets") +namespace Pets { + op list(@query skip?: int32, @query top?: int32): { + @statusCode statusCode: 200; + @body pets: Pet[]; + }; +} +``` + +In this example, `skip` and `top` are query parameters. The resulting URL for this operation might look like `/pets?skip=10&top=20`, where `skip` and `top` are used to control pagination. + +## Combining Path and Query Parameters + +You can combine path and query parameters in a single operation. For example, let's define a `search` operation that retrieves pets by their type and supports pagination: + +```typespec +@route("/pets/{type}") +namespace Pets { + model Pet { + @minLength(1) + name: string; + + @minValue(0) + @maxValue(100) + age: int32; + + kind: "dog" | "cat" | "fish" | "bird" | "reptile"; + } + + op search(@path type: string, @query skip?: int32, @query top?: int32): { + @statusCode statusCode: 200; + @body pets: Pet[]; + }; +} +``` + +In this example, `type` is a path parameter, and `skip` and `top` are query parameters. The resulting URL for this operation might look like `/pets/dog?skip=10&top=20`, where `dog` is the value of `type`, and `skip` and `top` are used for pagination. + +By using the `@path` and `@query` decorators, you can clearly define how parameters should be passed in the URL, making your API more intuitive and easier to use. diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/07-headers.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/07-headers.md new file mode 100644 index 000000000..75a8ee76e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/07-headers.md @@ -0,0 +1,116 @@ +--- +title: Headers +--- + +# Headers + +Headers are used to pass additional information with the request or response. Model properties and parameters that should be passed in a header use the `@header` decorator. The decorator takes the header name as a parameter. If a header name is not provided, it is inferred from the property or parameter name. + +## Using the `@header` Decorator + +The `@header` decorator can be used to specify headers in both requests and responses. Here are some common use cases: + +- **Authorization**: Passing authentication tokens. +- **Content-Type**: Specifying the media type of the resource. +- **Custom Headers**: Any application-specific headers. + +### Example: Authorization Header + +Let's add an `Authorization` header to a request: + +```typespec +@route("/pets") +namespace Pets { + op list(@header Authorization: string): { + @statusCode statusCode: 200; + @body pets: Pet[]; + }; +} +``` + +### Example: Content-Type Header + +Let's specify the `Content-Type` header in a response: + +```typespec +@route("/pets") +namespace Pets { + op create(@header Authorization: string, @body pet: Pet): { + @statusCode statusCode: 201; + @header Content-Type: "application/json"; + }; +} +``` + +In this example, the `Content-Type` header is used to specify that the response body is in JSON format. + +## Example: `etag` Header + +`etag` stands for "entity tag" and is a part of HTTP headers used for web cache validation and conditional requests from browsers for resources. It is a unique identifier assigned by a web server to a specific version of a resource found at a URL. If the resource content changes, a new and different `etag` is assigned. + +Let's update our pet store operations to include new operations and update existing operations with relevant headers: + +```typespec +@route("/pets") +namespace Pets { + op list(@header Authorization: string, @query skip: int32, @query top: int32): { + @statusCode statusCode: 200; + @body pets: Pet[]; + }; + + op read(@header Authorization: string, @path petId: int32, @header ifMatch?: string): { + @statusCode statusCode: 200; + @header eTag: string; + @body pet: Pet; + } | { + @statusCode statusCode: 404; + @body error: NotFoundError; + }; + + @post + op create(@header Authorization: string, @body pet: Pet): { + @statusCode statusCode: 201; + @header Content-Type: "application/json"; + } | { + @statusCode statusCode: 400; + @body error: ValidationError; + } | { + @statusCode statusCode: 500; + @body error: InternalServerError; + }; + + @put + op update(@header Authorization: string, @path petId: int32, @body pet: Pet): { + @statusCode statusCode: 200; + @header Content-Type: "application/json"; + @body updatedPet: Pet; + } | { + @statusCode statusCode: 404; + @body error: NotFoundError; + } | { + @statusCode statusCode: 400; + @body error: ValidationError; + } | { + @statusCode statusCode: 500; + @body error: InternalServerError; + }; + + @delete + op delete(@header Authorization: string, @path petId: int32): { + @statusCode statusCode: 204; + } | { + @statusCode statusCode: 404; + @body error: NotFoundError; + } | { + @statusCode statusCode: 500; + @body error: InternalServerError; + }; +} +``` + +In this example: + +- The `Authorization` header is used in all operations to pass an authentication token. +- The `ifMatch` header is used in the `read` operation to specify the `etag` value that the client has. The server can then compare this value with the current `etag` of the resource. +- The `eTag` header is included in the `read` response to provide the current `etag` value of the resource. +- The `Content-Type` header is used in the `create` and `update` operations to specify that the response body is in JSON format. diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/08-request-response-bodies.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/08-request-response-bodies.md new file mode 100644 index 000000000..bad19793f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/08-request-response-bodies.md @@ -0,0 +1,156 @@ +--- +title: Request and Response Bodies +--- + +# Request and Response Bodies + +Request and response bodies can be declared explicitly using the `@body` decorator. This decorator helps to clearly indicate which part of the model is the body of the request or response. While it may not change the API's functionality, it provides several benefits: + +1. **Clarity and readability**: Using the `@body` decorator makes it explicit which part of the model is intended to be the body. This can improve the readability of the code, making it easier for developers to understand the structure of the API. +2. **Consistency**: Applying the `@body` decorator consistently across your API definitions can help maintain a uniform style. This can be particularly useful in larger projects with multiple contributors. +3. **Tooling and documentation**: Some tools and documentation generators may rely on the `@body` decorator to produce more accurate and detailed outputs. By explicitly marking the body, you ensure that these tools can correctly interpret and document your API. + +Let's revisit some of or pet store operations that use the `@body` decorator: + +```typespec +@route("/pets") +namespace Pets { + model Pet { + @minLength(1) + name: string; + + @minValue(0) + @maxValue(100) + age: int32; + + kind: "dog" | "cat" | "fish" | "bird" | "reptile"; + } + + op list(@header Authorization: string, @query skip?: int32, @query top?: int32): { + @statusCode statusCode: 200; + @body pets: Pet[]; + }; + + op read(@header Authorization: string, @path petId: int32): { + @statusCode statusCode: 200; + @body pet: Pet; + } | { + @statusCode statusCode: 404; + @body error: NotFoundError; + }; + + @post + op create(@header Authorization: string, @body pet: Pet): { + @statusCode statusCode: 201; + @header contentType: "application/json"; + @body message: string; + } | { + @statusCode statusCode: 400; + @body error: ValidationError; + } | { + @statusCode statusCode: 500; + @body error: InternalServerError; + }; +} +``` + +### Explanation + +- **Pet Model**: The `Pet` model defines the structure of a pet with fields for `name`, `age`, and `kind`. + + - `name`: A string field with a minimum length of 1. + - `age`: An integer field with a minimum value of 0 and a maximum value of 100. + - `kind`: A string field that can be one of "dog", "cat", "fish", "bird", or "reptile". + +- **list Operation**: The `list` operation returns a list of pets. The response body is explicitly marked with the `@body` decorator to indicate that it contains an array of `Pet` objects. + +- **read Operation**: The `read` operation retrieves a specific pet by its ID. The response body is explicitly marked with the `@body` decorator to indicate that it contains a `Pet` object. + +- **create Operation**: The `create` operation creates a new pet. The request body is explicitly marked with the `@body` decorator to indicate that it contains a `Pet` object. This means that when a client sends a request to create a new pet, the request body must include the `name`, `age`, and `kind` fields as defined in the `Pet` model. + +### Example Request for Create Operation + +Here is an example of what the request body might look like when creating a new pet: + +```json +{ + "name": "Buddy", + "age": 5, + "kind": "dog" +} +``` + +This JSON object matches the structure of the `Pet` model, with fields for `name`, `age`, and `kind`. + +### Implicit vs. Explicit `@body` + +Note that in the absence of an explicit `@body`: + +1. **Request Body**: The set of parameters that are not marked with `@header`, `@query`, or `@path` will automatically form the request body. + +2. **Response Body**: The set of properties of the return model that are not marked with `@header`, `@query`, or `@path` will automatically form the response body. + +3. **Non-Model Return Types**: If the return type of an operation is not a model (e.g., a primitive type like `string` or `int32`), then that return type itself defines the response body. For example, if an operation returns a `string` without using the `@body` decorator, the `string` will be the response body. + +Here's an example to illustrate these points: + +```typespec +@route("/example") +namespace Example { + op implicitBody(param1: string, param2: int32): string { + // param1 and param2 form the request body + // The return type (string) forms the response body + } +} +``` + +In this example: + +- `param1` and `param2` are not marked with `@header`, `@query`, or `@path`, so they automatically form the request body. +- The return type is `string`, so the response body is the `string` itself. + +### `@bodyRoot` Decorator + +The `@bodyRoot` decorator is used when you want to specify that the entire body of the request or response should be a single value, rather than an object with multiple properties. This is useful when the body is a primitive type or a single model instance. + +#### Example + +Let's revisit some of our pet store operations that can benefit from using the `@bodyRoot` decorator: + +```typespec +@route("/pets") +namespace Pets { + @post + op create(@header Authorization: string, @bodyRoot pet: Pet): { + @statusCode statusCode: 201; + @header contentType: "application/json"; + @bodyRoot message: string; + } | { + @statusCode statusCode: 400; + @bodyRoot error: ValidationError; + } | { + @statusCode statusCode: 500; + @bodyRoot error: InternalServerError; + }; + + op read(@header Authorization: string, @path petId: int32): { + @statusCode statusCode: 200; + @header eTag: string; + @bodyRoot pet: Pet; + } | { + @statusCode statusCode: 404; + @bodyRoot error: NotFoundError; + }; +} +``` + +In this example: + +- The `@bodyRoot` decorator is used to indicate that the entire request body for the `create` operation is the `pet` parameter. +- The `@bodyRoot` decorator is also used to indicate that the entire response body for the `create` and `read` operations is either the `message`, `pet`, or `error` value. + +### Recommendation + +While TypeSpec can infer the request and response bodies in the absence of an explicit `@body` decorator, this can sometimes be confusing for developers. Therefore, it is recommended to use the `@body` decorator explicitly to clearly indicate which part of the model is intended to be the body. This improves the readability and maintainability of your API definitions. + +Similarly, use the `@bodyRoot` decorator when the entire body should be a single value. This makes it clear that the body is not an object with multiple properties, but a single entity, improving clarity and consistency in your API definitions. diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/09-interfaces.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/09-interfaces.md new file mode 100644 index 000000000..1932d7070 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/09-interfaces.md @@ -0,0 +1,30 @@ +--- +title: Interfaces +--- + +# Interfaces + +In TypeSpec, an interface is a way to define a set of operations that can be grouped together. Interfaces are particularly useful when you want to apply the same set of operations to different resources or when you want to use automatic route generation, covered in the next section. + +## Defining an Interface + +Let's define an interface for managing pet toys. Since we've decided to extend our pet store service to support toys, we'll need to version the service. We'll add support for toys in version 2 of our pet store service: + +```typespec +@added(Versions.v2) +interface ToyOperations { + @get + getToy(@path petId: int32, @path toyId: int32): Toy | NotFoundError; + + @put + updateToy(@path petId: int32, @path toyId: int32, @body toy: Toy): Toy | NotFoundError; +} +``` + +In this example, the `ToyOperations` interface defines two operations: `getToy` and `updateToy`. The `@added(Versions.v2)` decorator indicates that these operations are part of version 2 of the service. + +## Using Interfaces + +Interfaces can be used to group operations that apply to different resources. This helps in maintaining a consistent structure and reusing common operations. + +We'll use the `ToyOperations` interface to automatically generate routs and operations for managing pet toys in the next section. diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/10-automatic-route-generation.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/10-automatic-route-generation.md new file mode 100644 index 000000000..455823344 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/10-automatic-route-generation.md @@ -0,0 +1,76 @@ +--- +title: Resources and Routes +--- + +# Automatic Route Generation + +Automatic route generation in TypeSpec allows you to generate URL paths for your API operations automatically, reducing the need to manually specify routes. This is achieved using the `@autoRoute` decorator. + +### Key Concepts + +- **@autoRoute**: Automatically generates routes for operations in an interface. +- **@path**: Marks a parameter as part of the URL path. +- **@segment**: Defines the specific part of the URL path that the parameter belongs to. + +### Example: Managing Pet Toys + +Let's extend our Pet Store example to include operations for managing pet toys. We'll define a `Toy` model and use the `ToyOperations` interface we previously defined to generate operations for getting and updating toy information. We'll define a `CommonParameters` model to define common path parameters for both pet and toy operations. + +Additionally, we'll use the `@added` decorator to indicate that these operations are part of version 2 of the service. + +#### Step 1: Define Common Parameters + +```typespec +model CommonParameters { + @path + @segment("pets") + petId: int32; + + @added(Versions.v2) + @path + @segment("toys") + toyId: int32; +} +``` + +- **CommonParameters**: This model defines common path parameters for pets and toys. + - `petId`: Part of the URL segment `/pets/{petId}`. + - `toyId`: Part of the URL segment `/toys/{toyId}`. + +#### Step 2: Define the Toy Model + +```typespec +@added(Versions.v2) +model Toy { + name: string; +} +``` + +- **Toy**: This model defines the structure of a toy, with a `name` property. + +#### Step 3: Extend the ToyOperations Interface to use Common Parameters + +```typespec +@autoRoute +interface ToyOperations { + @added(Versions.v2) + @get + getToy(...CommonParameters): Toy | NotFoundError; + + @added(Versions.v2) + @put + updateToy(...CommonParameters, toy: Toy): Toy | NotFoundError; +} +``` + +#### Resulting Routes + +The `@autoRoute` decorator and the `CommonParameters` model will generate the following routes for the operations: + +```text +/pets/{petId}/toys/{toyId} +``` + +By using the @autoRoute decorator in TypeSpec, you can significantly simplify the process of defining routes for your API operations. This approach not only reduces the need for manual route specification but also ensures consistency and reduces the likelihood of errors. + +Automatic route generation is particularly useful when dealing with complex APIs that have multiple nested resources, as it allows you to maintain a clear and organized structure. diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/11-summary.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/11-summary.md new file mode 100644 index 000000000..8acc9041c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http/11-summary.md @@ -0,0 +1,177 @@ +--- +title: Summary +--- + +# Summary + +In this tutorial, we have covered the basics of creating a REST API definition using TypeSpec. We started by setting up a new TypeSpec project and then defined a Pet Store service with various operations. We explored how to use decorators to define routes, handle path and query parameters, manage headers, and specify request and response bodies. We also looked at how to automatically generate routes, define status codes, handle errors, and manage versioning. + +By following these steps, you should now have a good understanding of how to use TypeSpec to define and manage your HTTP APIs. For more advanced features and detailed documentation, refer to the official TypeSpec documentation and community resources. + +## Complete Code Example + +Here's the complete Pet Store service definition written in TypeSpec: + +```tsp tryit="{"emit": ["@typespec/openapi3"]}" +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; + +/** + * This is a sample Pet Store server. + */ +@service({ + title: "Pet Store Service", +}) +@server("https://example.com", "Single server endpoint") +@versioned(Versions) +namespace PetStore; +enum Versions { + v1: "1.0.0", + v2: "2.0.0", +} + +@route("/pets") +namespace Pets { + @added(Versions.v1) + model Pet { + @minLength(1) + name: string; + + @minValue(0) + @maxValue(100) + age: int32; + + kind: "dog" | "cat" | "fish" | "bird" | "reptile"; + } + + op list(@header Authorization: string, @query skip?: int32, @query top?: int32): { + @statusCode statusCode: 200; + @body pets: Pet[]; + }; + + op read(@header Authorization: string, @path petId: int32, @header ifMatch?: string): { + @statusCode statusCode: 200; + @header eTag: string; + @body pet: Pet; + } | { + @statusCode statusCode: 404; + @body error: NotFoundError; + }; + + @post + op create(@header Authorization: string, @body pet: Pet): { + @statusCode statusCode: 201; + @header contentType: "application/json"; + @body message: string; + } | { + @statusCode statusCode: 400; + @body error: ValidationError; + } | { + @statusCode statusCode: 500; + @body error: InternalServerError; + }; + + @put + op update(@header Authorization: string, @path petId: int32, @body pet: Pet): + | { + @statusCode statusCode: 200; + @header contentType: "application/json"; + @body updatedPet: Pet; + } + | { + @statusCode statusCode: 404; + @body error: NotFoundError; + } + | { + @statusCode statusCode: 400; + @body error: ValidationError; + } + | { + @statusCode statusCode: 500; + @body error: InternalServerError; + }; + + @delete + op delete(@header Authorization: string, @path petId: int32): { + @statusCode statusCode: 204; + } | { + @statusCode statusCode: 404; + @body error: NotFoundError; + } | { + @statusCode statusCode: 500; + @body error: InternalServerError; + }; + + // Search operation combining path and query parameters + op search( + @header Authorization: string, + @path type: string, + @query skip?: int32, + @query top?: int32, + ): { + @statusCode statusCode: 200; + @body pets: Pet[]; + }; +} + +model CommonParameters { + @path + @segment("pets") + petId: int32; + + @added(Versions.v2) + @path + @segment("toys") + toyId: int32; +} + +@added(Versions.v2) +model Toy { + name: string; +} + +@error +model ValidationError { + code: "VALIDATION_ERROR"; + message: string; + details: string[]; +} + +@error +model NotFoundError { + code: "NOT_FOUND"; + message: string; +} + +@error +model InternalServerError { + code: "INTERNAL_SERVER_ERROR"; + message: string; +} + +@autoRoute +interface ToyOperations { + @added(Versions.v2) + @get + getToy(...CommonParameters): Toy | NotFoundError; + + @added(Versions.v2) + @put + updateToy(...CommonParameters, toy: Toy): Toy | NotFoundError; +} +``` + +Running `tsp compile .` will generate two versions of the OpenAPI description for this service in your `tsp-output` folder, one for each version defined in the `Versions` enum. + +``` +tsp-output/ +┗ @typespec/ + ┗ openapi3/ +┃ ┣ openapi.1.0.0.yaml +┃ ┗ openapi.2.0.0.yaml +``` diff --git a/packages/website/versioned_docs/version-latest/getting-started/getting-started.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started.md index ace47b6f5..e047f4e54 100644 --- a/packages/website/versioned_docs/version-latest/getting-started/getting-started.md +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started.md @@ -5,4 +5,5 @@ title: Getting Started # Getting started with TypeSpec -- [Get started with HTTP in TypeSpec](./getting-started-http.md) +- [Get started with TypeSpec for HTTP](./getting-started-http/getting-started-http-00 + .md) diff --git a/packages/website/versioned_docs/version-latest/language-basics/enums.md b/packages/website/versioned_docs/version-latest/language-basics/enums.md index b45ba682a..7abb25dfd 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/enums.md +++ b/packages/website/versioned_docs/version-latest/language-basics/enums.md @@ -9,7 +9,7 @@ Enums, short for enumerations, provide a way for developers to define a collecti ## The basics -You can declare enums using the `enum` keyword. The members of an enum are separated by commas `,` and can be either `identifier` TypeSpecs or `string literal`s. +You can declare enums using the `enum` keyword. The members of an enum are separated by commas `,` and can be either [`identifier`](./identifiers.md) TypeSpecs or `string literal`s. ```typespec enum Direction { diff --git a/packages/website/versioned_docs/version-latest/language-basics/identifiers.md b/packages/website/versioned_docs/version-latest/language-basics/identifiers.md new file mode 100644 index 000000000..2f4d0e95c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/language-basics/identifiers.md @@ -0,0 +1,26 @@ +--- +title: Identifiers +--- + +# Identifiers + +Identifiers are used to name models, enums, properties, and other entities in TypeSpec. An identifier is a sequence of one or more characters that must start with a letter, emoji, underscore, or dollar sign, and be followed by letters, numbers, emoji, underscores, or dollar signs. TypeSpec implements [UAX31-R1b stable identifiers](http://www.unicode.org/reports/tr31/#R1b) with the [emoji profile](http://www.unicode.org/reports/tr31/#Emoji_Profile). + +Examples: + +- ✅ `cat` +- ✅ `Dog` +- ✅ `_Item2` +- ✅ `$money$` +- ✅ `🎉` +- ✅ `🚀` +- ❌ `1cat` +- ❌ `*dog` + +## Reserved identifiers + +All keywords are reserved identifiers in TypeSpec. However they can still be used when escaping with wrapping with `\`` characters. + +```tsp +model `enum` {} +``` diff --git a/packages/website/versioned_docs/version-latest/language-basics/interfaces.md b/packages/website/versioned_docs/version-latest/language-basics/interfaces.md index 9fd647e5e..01452f2c9 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/interfaces.md +++ b/packages/website/versioned_docs/version-latest/language-basics/interfaces.md @@ -7,7 +7,7 @@ title: Interfaces Interfaces are useful for grouping and reusing [operations](./operations.md). -You can declare interfaces using the `interface` keyword. +You can declare interfaces using the `interface` keyword. Its name must be an [`identifier`](./identifiers.md). ```typespec interface SampleInterface { diff --git a/packages/website/versioned_docs/version-latest/language-basics/models.md b/packages/website/versioned_docs/version-latest/language-basics/models.md index 63c945613..d59170942 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/models.md +++ b/packages/website/versioned_docs/version-latest/language-basics/models.md @@ -18,7 +18,7 @@ Models can be categorized into two main types: A Record model is a structure that consists of named fields, referred to as properties. -- The name can be an `identifier` or `string literal`. +- The name can be an [`identifier`](./identifiers.md) or `string literal`. - The type can be any type reference. - Properties are arranged in a specific order. Refer to [property ordering](#property-ordering) for more details. diff --git a/packages/website/versioned_docs/version-latest/language-basics/operations.md b/packages/website/versioned_docs/version-latest/language-basics/operations.md index b01b8ae59..4f774eeaf 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/operations.md +++ b/packages/website/versioned_docs/version-latest/language-basics/operations.md @@ -7,7 +7,7 @@ title: Operations Operations are essentially service endpoints, characterized by an operation name, parameters, and a return type. -You can declare operations using the `op` keyword: +You can declare operations using the `op` keyword. Its name must be an [`identifier`](./identifiers.md). ```typespec op ping(): void; diff --git a/packages/website/versioned_docs/version-latest/language-basics/scalars.md b/packages/website/versioned_docs/version-latest/language-basics/scalars.md index 13b295ece..93a97f2f5 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/scalars.md +++ b/packages/website/versioned_docs/version-latest/language-basics/scalars.md @@ -6,7 +6,7 @@ title: Scalars Scalars are simple types that don't have any fields. Examples of these include `string`, `int32`, `boolean`, and so on. -You can declare a scalar by using the `scalar` keyword. +You can declare a scalar by using the `scalar` keyword. Its name must be an [`identifier`](./identifiers.md). ```typespec scalar ternary; diff --git a/packages/website/versioned_docs/version-latest/language-basics/unions.md b/packages/website/versioned_docs/version-latest/language-basics/unions.md index 3dc94816a..9c1014c0f 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/unions.md +++ b/packages/website/versioned_docs/version-latest/language-basics/unions.md @@ -24,6 +24,8 @@ In this example, `Breed` can be either a `Beagle`, a `GermanShepherd`, or a `Gol Named unions allow you to assign a name to the union and provide explicit variant references. Named unions are somewhat similar to [enums](./enums.md), but instead of having `string` or `numeric` values, they use [record models](./models.md). +A named union can be declared with the `union` keyword. Its name must be an [`identifier`](./identifiers.md). + ```typespec union Breed { beagle: Beagle, diff --git a/packages/website/versioned_docs/version-latest/libraries/http-server-javascript/reference/emitter.md b/packages/website/versioned_docs/version-latest/libraries/http-server-javascript/reference/emitter.md new file mode 100644 index 000000000..48a590d5e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http-server-javascript/reference/emitter.md @@ -0,0 +1,36 @@ +--- +title: "Emitter usage" +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +# Emitter + +## Usage + +1. Via the command line + +```bash +tsp compile . --emit=@typespec/http-server-javascript +``` + +2. Via the config + +```yaml +emit: + - "@typespec/http-server-javascript" +``` + +## Emitter options + +### `features` + +**Type:** `object` + +### `omit-unreachable-types` + +**Type:** `boolean` + +### `no-format` + +**Type:** `boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/http-server-javascript/reference/index.mdx b/packages/website/versioned_docs/version-latest/libraries/http-server-javascript/reference/index.mdx new file mode 100644 index 000000000..f49d39fb1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http-server-javascript/reference/index.mdx @@ -0,0 +1,36 @@ +--- +title: Overview +sidebar_position: 0 +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Overview + +TypeSpec HTTP server code generator for JavaScript + +## Install + + + + +```bash +npm install @typespec/http-server-javascript +``` + + + + +```bash +npm install --save-peer @typespec/http-server-javascript +``` + + + + +## Emitter usage + +[See documentation](./emitter.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/http/authentication.md b/packages/website/versioned_docs/version-latest/libraries/http/authentication.md index b21632364..04a7a9fa0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/authentication.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/authentication.md @@ -157,29 +157,32 @@ The `OAuth2` security scheme can have a list of scopes that must be granted to t When different operations have different scopes, you will likely want to create a template that allows providing OAuth scopes without having to respecify the other properties of the security scheme: ```tsp -alias MyOAuth2 = OAuth2Auth<[{ - type: OAuth2FlowType.implicit; - authorizationUrl: "https://api.example.com/oauth2/authorize"; - refreshUrl: "https://api.example.com/oauth2/refresh"; -}], Scopes>; - -@useAuth> +@useAuth(MyOAuth2<["read"]>) namespace DemoService; +alias MyOAuth2 = OAuth2Auth< + [ + { + type: OAuth2FlowType.implicit; + authorizationUrl: "https://api.example.com/oauth2/authorize"; + refreshUrl: "https://api.example.com/oauth2/refresh"; + } + ], + Scopes +>; // Use OAuth2 with the "read" scope op list(): string[]; // Use OAuth2 with the "read" scope or no authentication at all -@useAuth | NoAuth> +@useAuth(MyOAuth2<["read"]> | NoAuth) op read(): string; // Use OAuth2 with the "write" scope -@useAuth(MyAuth<["write"]>) +@useAuth(MyOAuth2<["write"]>) op write(value: string): void; // Use OAuth2 with the "delete" scope -@useAuth(MyAuth<["delete"]>) +@useAuth(MyOAuth2<["delete"]>) op delete(value: string): void; - ``` diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/enumerations/Visibility.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/enumerations/Visibility.md index e5182c696..094ddf993 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/enumerations/Visibility.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/enumerations/Visibility.md @@ -9,7 +9,7 @@ REST API. ## Enumeration Members | Enumeration Member | Value | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `All` | `31` | - | | `Create` | `2` | - | | `Delete` | `8` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$body.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$body.md index 5cc14bfaf..1de2cb898 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$body.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$body.md @@ -10,7 +10,7 @@ function $body(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyIgnore.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyIgnore.md index 9f293d443..1f4d446f4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyIgnore.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyIgnore.md @@ -10,7 +10,7 @@ function $bodyIgnore(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyRoot.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyRoot.md index 5529cd6c7..433f41ab3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyRoot.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyRoot.md @@ -10,7 +10,7 @@ function $bodyRoot(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$delete.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$delete.md index b00afa63e..2141d9fc3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$delete.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$delete.md @@ -10,7 +10,7 @@ function $delete(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$get.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$get.md index 5f3bb1830..fd952a312 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$get.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$get.md @@ -10,7 +10,7 @@ function $get(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$head.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$head.md index 5fd1aad51..babe6213c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$head.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$head.md @@ -10,7 +10,7 @@ function $head(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$header.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$header.md index dffade512..2008638bf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$header.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$header.md @@ -13,7 +13,7 @@ function $header( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | | `headerNameOrOptions`? | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md index b84ebd405..a81354d96 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md @@ -17,10 +17,10 @@ decorator. ## 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.

| +| `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 diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$multipartBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$multipartBody.md index 88463e2fb..7b610d54f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$multipartBody.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$multipartBody.md @@ -10,7 +10,7 @@ function $multipartBody(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$onValidate.md index 3b2236c14..42cb14e22 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$onValidate.md @@ -10,7 +10,7 @@ function $onValidate(program): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$patch.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$patch.md index ef801972f..86e9e6a5b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$patch.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$patch.md @@ -10,7 +10,7 @@ function $patch(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$path.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$path.md index 49c40f1c8..582811a32 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$path.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$path.md @@ -13,7 +13,7 @@ function $path( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | | `paramName`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$post.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$post.md index 9e697c030..3fdcd0a49 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$post.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$post.md @@ -10,7 +10,7 @@ function $post(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$put.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$put.md index 066c404e6..0d62de388 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$put.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$put.md @@ -10,7 +10,7 @@ function $put(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$query.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$query.md index 17707f346..8e531d644 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$query.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$query.md @@ -13,7 +13,7 @@ function $query( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | | `queryNameOrOptions`? | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$route.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$route.md index b0070ad78..81088edde 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$route.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$route.md @@ -22,7 +22,7 @@ it will be used as a prefix to the route URI of the operation. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Namespace` \| `Interface` \| `Operation` | | `path` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$server.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$server.md index c20e7d244..61a4bcf9d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$server.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$server.md @@ -17,7 +17,7 @@ Configure the server url for the service. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `context` | `DecoratorContext` | Decorator context | | `target` | `Namespace` | Decorator target (must be a namespace) | | `url` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$sharedRoute.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$sharedRoute.md index 01bdd2f12..d990493e0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$sharedRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$sharedRoute.md @@ -17,7 +17,7 @@ route path as long as those operations are also marked with `@sharedRoute`. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$statusCode.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$statusCode.md index 5dd150fc0..9cc524468 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$statusCode.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$statusCode.md @@ -10,7 +10,7 @@ function $statusCode(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$useAuth.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$useAuth.md index 1a26fa694..cecc10605 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$useAuth.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$useAuth.md @@ -13,7 +13,7 @@ function $useAuth( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `entity` | `Namespace` \| `Interface` \| `Operation` | | `authConfig` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/DefaultRouteProducer.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/DefaultRouteProducer.md index 7a57cd686..c6b3dc7e4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/DefaultRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/DefaultRouteProducer.md @@ -15,7 +15,7 @@ options): DiagnosticResult ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | | `parentSegments` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/createMetadataInfo.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/createMetadataInfo.md index f9336794a..81d75c063 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/createMetadataInfo.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/createMetadataInfo.md @@ -10,7 +10,7 @@ function createMetadataInfo(program, options?): MetadataInfo ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `options`? | [`MetadataInfoOptions`](../interfaces/MetadataInfoOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllHttpServices.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllHttpServices.md index 63be58d9b..e1abf9a66 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllHttpServices.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllHttpServices.md @@ -12,7 +12,7 @@ Returns all the services defined. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllRoutes.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllRoutes.md index 813c4cf38..bd577d602 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllRoutes.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllRoutes.md @@ -10,7 +10,7 @@ function getAllRoutes(program, options?): [HttpOperation[], readonly Diagnostic[ ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthentication.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthentication.md index 252ed715b..12d9c9486 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthentication.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthentication.md @@ -10,7 +10,7 @@ function getAuthentication(program, entity): Authentication | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Namespace` \| `Interface` \| `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthenticationForOperation.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthenticationForOperation.md index 23a521e01..4db0f7e1d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthenticationForOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthenticationForOperation.md @@ -12,7 +12,7 @@ Resolve the authentication for a given operation. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | Program | | `operation` | `Operation` | Operation | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getContentTypes.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getContentTypes.md index 7899a7315..d42532c16 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getContentTypes.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getContentTypes.md @@ -12,7 +12,7 @@ Resolve the content types from a model property by looking at the value. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `property` | `ModelProperty` | Model property | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldName.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldName.md index a6b583974..c125e1b02 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldName.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldName.md @@ -10,7 +10,7 @@ function getHeaderFieldName(program, entity): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldOptions.md index 9e85658f1..6fd754d34 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldOptions.md @@ -10,7 +10,7 @@ function getHeaderFieldOptions(program, entity): HeaderFieldOptions ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpFileModel.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpFileModel.md index 7749f7942..a2fd1253c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpFileModel.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpFileModel.md @@ -10,7 +10,7 @@ function getHttpFileModel(program, type): HttpFileModel | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `type` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpOperation.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpOperation.md index d54ac7b37..13b5845c0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpOperation.md @@ -15,7 +15,7 @@ Return the Http Operation details for a given TypeSpec operation. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | - | | `operation` | `Operation` | Operation | | `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | Optional option on how to resolve the http details. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpPart.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpPart.md new file mode 100644 index 000000000..d9b8b9476 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpPart.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getHttpPart" + +--- +```ts +function getHttpPart(program, target): HttpPart | undefined +``` + +Return the http part information on a model that is an `HttpPart` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | `Program` | +| `target` | `Type` | + +## Returns + +[`HttpPart`](../interfaces/HttpPart.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpService.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpService.md index 7e4e9d230..98ec272ea 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpService.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpService.md @@ -13,7 +13,7 @@ function getHttpService( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `serviceNamespace` | `Namespace` | | `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationParameters.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationParameters.md index 67dafeed6..dc93c66c0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationParameters.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationParameters.md @@ -15,7 +15,7 @@ function getOperationParameters( ## Parameters | Parameter | Type | Default value | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | `undefined` | | `operation` | `Operation` | `undefined` | | `overloadBase`? | [`HttpOperation`](../interfaces/HttpOperation.md) | `undefined` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationVerb.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationVerb.md index 5b85538de..fb1092332 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationVerb.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationVerb.md @@ -10,7 +10,7 @@ function getOperationVerb(program, entity): HttpVerb | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamName.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamName.md index f39230064..bd0ee3c8b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamName.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamName.md @@ -10,7 +10,7 @@ function getPathParamName(program, entity): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamOptions.md index 872a2f4a5..3f1348667 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamOptions.md @@ -10,7 +10,7 @@ function getPathParamOptions(program, entity): PathParameterOptions ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamName.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamName.md index 4dfd6c0c6..026c518cb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamName.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamName.md @@ -10,7 +10,7 @@ function getQueryParamName(program, entity): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamOptions.md index 4015e2f4e..ca7b8d726 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamOptions.md @@ -10,7 +10,7 @@ function getQueryParamOptions(program, entity): QueryParameterOptions ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRequestVisibility.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRequestVisibility.md index 6ac692587..295642532 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRequestVisibility.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRequestVisibility.md @@ -18,7 +18,7 @@ Determines the visibility to use for a request with the given verb. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `verb` | [`HttpVerb`](../type-aliases/HttpVerb.md) | The HTTP verb for the operation. | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getResponsesForOperation.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getResponsesForOperation.md index ba6bc612f..9f7e2c1b6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getResponsesForOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getResponsesForOperation.md @@ -12,7 +12,7 @@ Get the responses for a given operation. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteOptionsForNamespace.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteOptionsForNamespace.md index 33550417e..dded9ac45 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteOptionsForNamespace.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteOptionsForNamespace.md @@ -10,7 +10,7 @@ function getRouteOptionsForNamespace(program, namespace): RouteOptions | undefin ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `namespace` | `Namespace` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRoutePath.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRoutePath.md index 5f4acf70f..ca60d7959 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRoutePath.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRoutePath.md @@ -10,7 +10,7 @@ function getRoutePath(program, entity): RoutePath | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Namespace` \| `Interface` \| `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteProducer.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteProducer.md index bddacdbe6..c1a9b440c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteProducer.md @@ -10,7 +10,7 @@ function getRouteProducer(program, operation): RouteProducer ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getServers.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getServers.md index 3cf369155..084e3da7a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getServers.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getServers.md @@ -10,7 +10,7 @@ function getServers(program, type): HttpServer[] | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `type` | `Namespace` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodeDescription.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodeDescription.md index 674d4f91d..19458f901 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodeDescription.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodeDescription.md @@ -19,7 +19,7 @@ function getStatusCodeDescription(statusCode): | "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" + | "Access is forbidden." | "The server cannot find the requested resource." | "The request conflicts with the current state of the server." | "Precondition failed." @@ -29,7 +29,7 @@ function getStatusCodeDescription(statusCode): ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `statusCode` | `string` \| `number` \| [`HttpStatusCodeRange`](../interfaces/HttpStatusCodeRange.md) | ## Returns @@ -48,7 +48,7 @@ function getStatusCodeDescription(statusCode): \| `"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"` + \| `"Access is forbidden."` \| `"The server cannot find the requested resource."` \| `"The request conflicts with the current state of the server."` \| `"Precondition failed."` diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodes.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodes.md index 79d891474..a4406cd13 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodes.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodes.md @@ -10,7 +10,7 @@ function getStatusCodes(program, entity): HttpStatusCodes ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md index 0a617dac4..a961b8657 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md @@ -10,7 +10,7 @@ function getStatusCodesWithDiagnostics(program, type): [HttpStatusCodes, readonl ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `type` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getVisibilitySuffix.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getVisibilitySuffix.md index 45f9c8f23..b8189b77c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getVisibilitySuffix.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getVisibilitySuffix.md @@ -24,7 +24,7 @@ Examples (with canonicalVisibility = Visibility.Read): ## Parameters | Parameter | Type | Default value | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | `undefined` | | `canonicalVisibility` | `undefined` \| [`Visibility`](../enumerations/Visibility.md) | `Visibility.None` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md index 81697379b..6cd9d60ac 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md @@ -13,7 +13,7 @@ inapplicable metadata. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `property` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md index 034fd5c2b..b5e66439c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md @@ -13,7 +13,7 @@ function includeInterfaceRoutesInNamespace( ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | Program | | `target` | `Namespace` | Target namespace | | `sourceInterface` | `string` | Interface that should be included in namespace. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadata.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadata.md index a870973c5..47979caa1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadata.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadata.md @@ -23,7 +23,7 @@ given visibility. ## Parameters | Parameter | Type | Default value | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | `undefined` | | `property` | `ModelProperty` | `undefined` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | `undefined` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadataOrBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadataOrBody.md index 6f0fe6f87..f2910bbfd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadataOrBody.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadataOrBody.md @@ -17,7 +17,7 @@ applicable with the given visibility. ## Parameters | Parameter | Type | Default value | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | `undefined` | | `property` | `ModelProperty` | `undefined` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | `undefined` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBody.md index 59284ca31..18d72d8e4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBody.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBody.md @@ -10,7 +10,7 @@ function isBody(program, entity): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyIgnore.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyIgnore.md index 8a9963d8a..6f2f67292 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyIgnore.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyIgnore.md @@ -10,7 +10,7 @@ function isBodyIgnore(program, entity): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyRoot.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyRoot.md index 5497d28d6..a8d52d5f6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyRoot.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyRoot.md @@ -10,7 +10,7 @@ function isBodyRoot(program, entity): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isContentTypeHeader.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isContentTypeHeader.md index 04f2847e9..6ec85a24b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isContentTypeHeader.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isContentTypeHeader.md @@ -10,7 +10,7 @@ function isContentTypeHeader(program, property): boolean ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | Program | | `property` | `ModelProperty` | Model property. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHeader.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHeader.md index 6d083e744..9c64c1d4c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHeader.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHeader.md @@ -10,7 +10,7 @@ function isHeader(program, entity): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHttpFile.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHttpFile.md index 5fb912b51..adaf4c0c6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHttpFile.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHttpFile.md @@ -12,7 +12,7 @@ Check if the given type is an `HttpFile` ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `type` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMetadata.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMetadata.md index 81e82a2bc..9fca1c926 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMetadata.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMetadata.md @@ -13,7 +13,7 @@ metadata if it is marked `@header`, `@query`, `@path`, or `@statusCode`. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `property` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMultipartBodyProperty.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMultipartBodyProperty.md index f148eda70..c9e673ac8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMultipartBodyProperty.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMultipartBodyProperty.md @@ -10,7 +10,7 @@ function isMultipartBodyProperty(program, entity): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOrExtendsHttpFile.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOrExtendsHttpFile.md index 9151de70f..73e586620 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOrExtendsHttpFile.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOrExtendsHttpFile.md @@ -10,7 +10,7 @@ function isOrExtendsHttpFile(program, type): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `type` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOverloadSameEndpoint.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOverloadSameEndpoint.md index d02d3a193..c8afeb92e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOverloadSameEndpoint.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOverloadSameEndpoint.md @@ -10,7 +10,7 @@ function isOverloadSameEndpoint(overload): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `overload` | [`HttpOperation`](../interfaces/HttpOperation.md) & `object` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isPathParam.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isPathParam.md index 92a47e647..319a98d12 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isPathParam.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isPathParam.md @@ -10,7 +10,7 @@ function isPathParam(program, entity): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isQueryParam.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isQueryParam.md index 5bee8b633..8dffd8ce0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isQueryParam.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isQueryParam.md @@ -10,7 +10,7 @@ function isQueryParam(program, entity): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isSharedRoute.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isSharedRoute.md index 1865ac3f8..d5273173e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isSharedRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isSharedRoute.md @@ -10,7 +10,7 @@ function isSharedRoute(program, operation): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isStatusCode.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isStatusCode.md index edb677d4d..e8c12533b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isStatusCode.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isStatusCode.md @@ -10,7 +10,7 @@ function isStatusCode(program, entity): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isVisible.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isVisible.md index aa384d141..ab4220941 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isVisible.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isVisible.md @@ -15,7 +15,7 @@ Determines if the given property is visible with the given visibility. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `property` | `ModelProperty` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/listHttpOperationsIn.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/listHttpOperationsIn.md index 63199fd04..1d4fa965e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/listHttpOperationsIn.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/listHttpOperationsIn.md @@ -15,7 +15,7 @@ Get all the Http Operation in the given container. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | Program | | `container` | [`OperationContainer`](../type-aliases/OperationContainer.md) | Namespace or interface containing operations | | `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | Resolution options | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/reportIfNoRoutes.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/reportIfNoRoutes.md index eb6cde3d8..242cf7c46 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/reportIfNoRoutes.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/reportIfNoRoutes.md @@ -10,7 +10,7 @@ function reportIfNoRoutes(program, routes): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `routes` | [`HttpOperation`](../interfaces/HttpOperation.md)[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveAuthentication.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveAuthentication.md index a7954f0b5..f832f1542 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveAuthentication.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveAuthentication.md @@ -12,7 +12,7 @@ Compute the authentication for a given service. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `service` | [`HttpService`](../interfaces/HttpService.md) | Http Service | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolvePathAndParameters.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolvePathAndParameters.md index a7b88a653..7a6324b8f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolvePathAndParameters.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolvePathAndParameters.md @@ -14,7 +14,7 @@ options): DiagnosticResult ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | | `overloadBase` | `undefined` \| [`HttpOperation`](../interfaces/HttpOperation.md) | @@ -24,8 +24,8 @@ options): DiagnosticResult `DiagnosticResult`<`object`\> -| Member | Type | -| :------ | :------ | +| Name | Type | +| ------ | ------ | | `parameters` | [`HttpOperationParameters`](../interfaces/HttpOperationParameters.md) | | `path` | `string` | | `pathSegments` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveRequestVisibility.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveRequestVisibility.md index 85e91784b..382fb6f0a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveRequestVisibility.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveRequestVisibility.md @@ -16,7 +16,7 @@ Otherwise, returns the default visibility based on the HTTP verb for the operati ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | - | | `operation` | `Operation` | The TypeSpec Operation for the request. | | `verb` | [`HttpVerb`](../type-aliases/HttpVerb.md) | The HTTP verb for the operation. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setAuthentication.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setAuthentication.md index 23ee0309d..a74a4e468 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setAuthentication.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setAuthentication.md @@ -13,7 +13,7 @@ function setAuthentication( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Namespace` \| `Interface` \| `Operation` | | `auth` | [`Authentication`](../interfaces/Authentication.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRoute.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRoute.md index 389bd1023..8d09214f5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRoute.md @@ -13,7 +13,7 @@ function setRoute( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `entity` | `Type` | | `details` | [`RoutePath`](../interfaces/RoutePath.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteOptionsForNamespace.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteOptionsForNamespace.md index 5bfef1b03..7519a5cb5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteOptionsForNamespace.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteOptionsForNamespace.md @@ -13,7 +13,7 @@ function setRouteOptionsForNamespace( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `namespace` | `Namespace` | | `options` | [`RouteOptions`](../interfaces/RouteOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteProducer.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteProducer.md index 7373fc77a..a25593412 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteProducer.md @@ -13,7 +13,7 @@ function setRouteProducer( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | | `routeProducer` | [`RouteProducer`](../type-aliases/RouteProducer.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setSharedRoute.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setSharedRoute.md index 2ac77c5c5..16db0d5e3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setSharedRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setSharedRoute.md @@ -10,7 +10,7 @@ function setSharedRoute(program, operation): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setStatusCode.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setStatusCode.md index 71f2022f0..742db4cd7 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setStatusCode.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setStatusCode.md @@ -13,7 +13,7 @@ function setStatusCode( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Model` \| `ModelProperty` | | `codes` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/validateRouteUnique.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/validateRouteUnique.md index fb476a572..81b0511b0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/validateRouteUnique.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/validateRouteUnique.md @@ -13,7 +13,7 @@ function validateRouteUnique( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `diagnostics` | `DiagnosticCollector` | | `operations` | [`HttpOperation`](../interfaces/HttpOperation.md)[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/index.md index 71a5e1c5f..bba96b241 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/index.md @@ -30,6 +30,8 @@ title: "[P] JS API" - [HttpOperationPart](interfaces/HttpOperationPart.md) - [HttpOperationResponse](interfaces/HttpOperationResponse.md) - [HttpOperationResponseContent](interfaces/HttpOperationResponseContent.md) +- [HttpPart](interfaces/HttpPart.md) +- [HttpPartOptions](interfaces/HttpPartOptions.md) - [HttpServer](interfaces/HttpServer.md) - [HttpService](interfaces/HttpService.md) - [HttpServiceAuthentication](interfaces/HttpServiceAuthentication.md) @@ -110,6 +112,7 @@ title: "[P] JS API" - [getHeaderFieldOptions](functions/getHeaderFieldOptions.md) - [getHttpFileModel](functions/getHttpFileModel.md) - [getHttpOperation](functions/getHttpOperation.md) +- [getHttpPart](functions/getHttpPart.md) - [getHttpService](functions/getHttpService.md) - [getOperationParameters](functions/getOperationParameters.md) - [getOperationVerb](functions/getOperationVerb.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AnyHttpAuthRef.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AnyHttpAuthRef.md index 4fcad2a4d..4b60ea962 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AnyHttpAuthRef.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AnyHttpAuthRef.md @@ -6,6 +6,6 @@ title: "[I] AnyHttpAuthRef" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `auth` | `readonly` | [`HttpAuth`](../type-aliases/HttpAuth.md) | | `kind` | `readonly` | `"any"` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ApiKeyAuth.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ApiKeyAuth.md index a96c2194b..ba6a8bdd9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ApiKeyAuth.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ApiKeyAuth.md @@ -26,19 +26,20 @@ Cookie: X-API-KEY=abcdef12345 - [`HttpAuthBase`](HttpAuthBase.md) -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `TLocation` *extends* `ApiKeyLocation` | | `TName` *extends* `string` | ## Properties -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | -| `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | -| `in` | `TLocation` | - | - | -| `name` | `TName` | - | - | -| `type` | `"apiKey"` | - | - | +| Property | Modifier | Type | Description | Inherited from | +| ------ | ------ | ------ | ------ | ------ | +| `description?` | `public` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `id` | `public` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | +| `in` | `public` | `TLocation` | - | - | +| `model` | `readonly` | `Model` | Model that defined the authentication | [`HttpAuthBase`](HttpAuthBase.md).`model` | +| `name` | `public` | `TName` | - | - | +| `type` | `public` | `"apiKey"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/Authentication.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/Authentication.md index 622326645..4ff3c9ec3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/Authentication.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/Authentication.md @@ -6,5 +6,5 @@ title: "[I] Authentication" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `options` | [`AuthenticationOption`](AuthenticationOption.md)[] | Either one of those options can be used independently to authenticate. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthenticationOption.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthenticationOption.md index 02df8838a..f16b1c43f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthenticationOption.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthenticationOption.md @@ -6,5 +6,5 @@ title: "[I] AuthenticationOption" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `schemes` | [`HttpAuth`](../type-aliases/HttpAuth.md)[] | For this authentication option all the given auth have to be used together. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthenticationOptionReference.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthenticationOptionReference.md index fc332206a..4756c2220 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthenticationOptionReference.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthenticationOptionReference.md @@ -6,5 +6,5 @@ title: "[I] AuthenticationOptionReference" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `all` | `readonly` | [`HttpAuthRef`](../type-aliases/HttpAuthRef.md)[] | For this authentication option all the given auth have to be used together. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthenticationReference.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthenticationReference.md index 7a8c8105d..967fffcc9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthenticationReference.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthenticationReference.md @@ -6,5 +6,5 @@ title: "[I] AuthenticationReference" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `options` | `readonly` | [`AuthenticationOptionReference`](AuthenticationOptionReference.md)[] | Either one of those options can be used independently to authenticate. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthorizationCodeFlow.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthorizationCodeFlow.md index 7d329f34e..27aa20805 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthorizationCodeFlow.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/AuthorizationCodeFlow.md @@ -8,7 +8,7 @@ Authorization Code flow ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `authorizationUrl` | `string` | | `refreshUrl?` | `string` | | `scopes` | [`OAuth2Scope`](OAuth2Scope.md)[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/BasicAuth.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/BasicAuth.md index a23c30934..49e96ec00 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/BasicAuth.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/BasicAuth.md @@ -16,9 +16,10 @@ Authorization: Basic ZGVtbzpwQDU1dzByZA== ## Properties -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | -| `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | -| `scheme` | `"basic"` | - | - | -| `type` | `"http"` | - | - | +| Property | Modifier | Type | Description | Inherited from | +| ------ | ------ | ------ | ------ | ------ | +| `description?` | `public` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `id` | `public` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | +| `model` | `readonly` | `Model` | Model that defined the authentication | [`HttpAuthBase`](HttpAuthBase.md).`model` | +| `scheme` | `public` | `"basic"` | - | - | +| `type` | `public` | `"http"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/BearerAuth.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/BearerAuth.md index d4ff53a38..8045aa7c6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/BearerAuth.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/BearerAuth.md @@ -16,9 +16,10 @@ The client must send this token in the Authorization header when making requests ## Properties -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | -| `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | -| `scheme` | `"bearer"` | - | - | -| `type` | `"http"` | - | - | +| Property | Modifier | Type | Description | Inherited from | +| ------ | ------ | ------ | ------ | ------ | +| `description?` | `public` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `id` | `public` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | +| `model` | `readonly` | `Model` | Model that defined the authentication | [`HttpAuthBase`](HttpAuthBase.md).`model` | +| `scheme` | `public` | `"bearer"` | - | - | +| `type` | `public` | `"http"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ClientCredentialsFlow.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ClientCredentialsFlow.md index 3286f13e7..4bea420b3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ClientCredentialsFlow.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ClientCredentialsFlow.md @@ -8,7 +8,7 @@ Client credentials flow ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `refreshUrl?` | `string` | | `scopes` | [`OAuth2Scope`](OAuth2Scope.md)[] | | `tokenUrl` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HeaderFieldOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HeaderFieldOptions.md index 707dea0e8..771bc3677 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HeaderFieldOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HeaderFieldOptions.md @@ -6,7 +6,7 @@ title: "[I] HeaderFieldOptions" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | -| `format?` | \| `"form"` \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` |

The string format of the array. "csv" and "simple" are used interchangeably, as are

"multi" and "form".

| +| ------ | ------ | ------ | +| `format?` | \| `"form"` \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` | The string format of the array. "csv" and "simple" are used interchangeably, as are "multi" and "form". | | `name` | `string` | - | | `type` | `"header"` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpAuthBase.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpAuthBase.md index 9c552ef37..990f61706 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpAuthBase.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpAuthBase.md @@ -14,7 +14,8 @@ title: "[I] HttpAuthBase" ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `description?` | `string` | Optional description. | -| `id` | `string` | Id of the authentication scheme. | +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `description?` | `public` | `string` | Optional description. | +| `id` | `public` | `string` | Id of the authentication scheme. | +| `model` | `readonly` | `Model` | Model that defined the authentication | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpBody.md index 3df97b4d7..849d1562c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpBody.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpBody.md @@ -10,9 +10,9 @@ title: "[I] HttpBody" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `containsMetadataAnnotations` | `readonly` | `boolean` | If the body contains metadata annotations to ignore. For example `@header`. | | `isExplicit` | `readonly` | `boolean` | If the body was explicitly set with `@body`. | -| ~~`parameter?`~~ | `public` | `ModelProperty` |

**Deprecated**

use [property](HttpBody.md)

| +| ~~`parameter?`~~ | `public` | `ModelProperty` | **Deprecated** use [property](HttpBody.md) | | `property?` | `readonly` | `ModelProperty` | If the body was explicitly set as a property. Correspond to the property with `@body` or `@bodyRoot` | | `type` | `readonly` | `Type` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperation.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperation.md index 3c61736b6..3b8daa463 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperation.md @@ -6,7 +6,7 @@ title: "[I] HttpOperation" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `authentication?` | [`Authentication`](Authentication.md) | Operation authentication. Overrides HttpService authentication | | `container` | [`OperationContainer`](../type-aliases/OperationContainer.md) | Parent type being the interface, namespace or global namespace. | | `operation` | `Operation` | Operation type reference. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBody.md index 6939ee16f..fa0cbba3a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBody.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBody.md @@ -10,12 +10,12 @@ title: "[I] HttpOperationBody" ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `bodyKind` | `readonly` | `"single"` | - | - | | `containsMetadataAnnotations` | `readonly` | `boolean` | If the body contains metadata annotations to ignore. For example `@header`. | [`HttpBody`](HttpBody.md).`containsMetadataAnnotations` | | `contentTypeProperty?` | `readonly` | `ModelProperty` | Property used to set the content type if exists | [`HttpOperationBodyBase`](HttpOperationBodyBase.md).`contentTypeProperty` | | `contentTypes` | `readonly` | `string`[] | Content types. | [`HttpOperationBodyBase`](HttpOperationBodyBase.md).`contentTypes` | | `isExplicit` | `readonly` | `boolean` | If the body was explicitly set with `@body`. | [`HttpBody`](HttpBody.md).`isExplicit` | -| ~~`parameter?`~~ | `public` | `ModelProperty` |

**Deprecated**

use [property](HttpBody.md)

| [`HttpBody`](HttpBody.md).`parameter` | +| ~~`parameter?`~~ | `public` | `ModelProperty` | **Deprecated** use [property](HttpBody.md) | [`HttpBody`](HttpBody.md).`parameter` | | `property?` | `readonly` | `ModelProperty` | If the body was explicitly set as a property. Correspond to the property with `@body` or `@bodyRoot` | [`HttpBody`](HttpBody.md).`property` | | `type` | `readonly` | `Type` | - | [`HttpBody`](HttpBody.md).`type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBodyBase.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBodyBase.md index 4152b3a2b..20eacebca 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBodyBase.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBodyBase.md @@ -11,6 +11,6 @@ title: "[I] HttpOperationBodyBase" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `contentTypeProperty?` | `readonly` | `ModelProperty` | Property used to set the content type if exists | | `contentTypes` | `readonly` | `string`[] | Content types. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationMultipartBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationMultipartBody.md index ff2b28517..5c0162140 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationMultipartBody.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationMultipartBody.md @@ -12,7 +12,7 @@ Body marked with `@multipartBody` ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `bodyKind` | `readonly` | `"multipart"` | - | - | | `contentTypeProperty?` | `readonly` | `ModelProperty` | Property used to set the content type if exists | [`HttpOperationBodyBase`](HttpOperationBodyBase.md).`contentTypeProperty` | | `contentTypes` | `readonly` | `string`[] | Content types. | [`HttpOperationBodyBase`](HttpOperationBodyBase.md).`contentTypes` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationParameters.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationParameters.md index 0657abe95..9dc403173 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationParameters.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationParameters.md @@ -6,8 +6,8 @@ title: "[I] HttpOperationParameters" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `body?` | [`HttpOperationBody`](HttpOperationBody.md) \| [`HttpOperationMultipartBody`](HttpOperationMultipartBody.md) | - | -| ~~`bodyParameter?`~~ | `ModelProperty` |

**Deprecated**

use body.parameter

| -| ~~`bodyType?`~~ | `Type` |

**Deprecated**

use body.type

| +| ~~`bodyParameter?`~~ | `ModelProperty` | **Deprecated** use body.parameter | +| ~~`bodyType?`~~ | `Type` | **Deprecated** use body.type | | `parameters` | [`HttpOperationParameter`](../type-aliases/HttpOperationParameter.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationPart.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationPart.md index 60d123b08..7740a5dc6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationPart.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationPart.md @@ -8,7 +8,7 @@ Represent an part in a multipart body. ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `body` | `readonly` | [`HttpOperationBody`](HttpOperationBody.md) | Part body | | `filename?` | `readonly` | `ModelProperty` | If the Part is an HttpFile this is the property defining the filename | | `headers` | `readonly` | `HeaderProperty`[] | Part headers | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponse.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponse.md index 6faa83361..407e2d858 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponse.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponse.md @@ -6,9 +6,9 @@ title: "[I] HttpOperationResponse" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `description?` | `string` | Response description. | | `responses` | [`HttpOperationResponseContent`](HttpOperationResponseContent.md)[] | Responses contents. | -| ~~`statusCode`~~ | [`StatusCode`](../type-aliases/StatusCode.md) |

**Deprecated**

use [statusCodes](HttpOperationResponse.md)

| +| ~~`statusCode`~~ | [`StatusCode`](../type-aliases/StatusCode.md) | **Deprecated** use [statusCodes](HttpOperationResponse.md) | | `statusCodes` | `number` \| `"*"` \| [`HttpStatusCodeRange`](HttpStatusCodeRange.md) | Status code or range of status code for the response. | | `type` | `Type` | Response TypeSpec type. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponseContent.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponseContent.md index 6dca384fa..8eda6b012 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponseContent.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponseContent.md @@ -6,6 +6,6 @@ title: "[I] HttpOperationResponseContent" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `body?` | [`HttpOperationBody`](HttpOperationBody.md) \| [`HttpOperationMultipartBody`](HttpOperationMultipartBody.md) | | `headers?` | `Record`<`string`, `ModelProperty`\> | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpPart.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpPart.md new file mode 100644 index 000000000..491eeeba9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpPart.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] HttpPart" + +--- +## Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `options` | `readonly` | [`HttpPartOptions`](HttpPartOptions.md) | +| `type` | `readonly` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpPartOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpPartOptions.md new file mode 100644 index 000000000..5b15e4239 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpPartOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] HttpPartOptions" + +--- +## Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `name?` | `readonly` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpServer.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpServer.md index 4c61091ae..6cf117798 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpServer.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpServer.md @@ -6,7 +6,7 @@ title: "[I] HttpServer" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `description` | `string` | | `parameters` | `Map`<`string`, `ModelProperty`\> | | `url` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpService.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpService.md index 2a77d8f05..ee64830c5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpService.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpService.md @@ -6,7 +6,7 @@ title: "[I] HttpService" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `authentication?` | [`Authentication`](Authentication.md) | | `namespace` | `Namespace` | | `operations` | [`HttpOperation`](HttpOperation.md)[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpServiceAuthentication.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpServiceAuthentication.md index f18e068ff..e089fe23e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpServiceAuthentication.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpServiceAuthentication.md @@ -6,7 +6,7 @@ title: "[I] HttpServiceAuthentication" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `defaultAuth` | `readonly` | [`AuthenticationReference`](AuthenticationReference.md) | Default authentication for operations in this service. | | `operationsAuth` | `readonly` | `Map`<`Operation`, [`AuthenticationReference`](AuthenticationReference.md)\> | Authentication overrides for individual operations. | | `schemes` | `readonly` | [`HttpAuth`](../type-aliases/HttpAuth.md)[] | All the authentication schemes used in this service. Some might only be used in certain operations. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpStatusCodeRange.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpStatusCodeRange.md index 47ceb7b85..d5f66ea62 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpStatusCodeRange.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpStatusCodeRange.md @@ -6,6 +6,6 @@ title: "[I] HttpStatusCodeRange" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `end` | `number` | | `start` | `number` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ImplicitFlow.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ImplicitFlow.md index 0c980acbe..5a0775da6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ImplicitFlow.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ImplicitFlow.md @@ -8,7 +8,7 @@ Implicit flow ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `authorizationUrl` | `string` | | `refreshUrl?` | `string` | | `scopes` | [`OAuth2Scope`](OAuth2Scope.md)[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/MetadataInfo.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/MetadataInfo.md index 82336e193..eef6ec709 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/MetadataInfo.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/MetadataInfo.md @@ -22,7 +22,7 @@ same set of properties when non-payload properties are excluded. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | `Type` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | @@ -50,7 +50,7 @@ itself is also removed. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | `undefined` \| `Type` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | @@ -76,7 +76,7 @@ response payload for the given visibility. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `property` | `ModelProperty` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | @@ -102,7 +102,7 @@ filtered out by the given visibility. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `property` | `ModelProperty` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | | `inExplicitBody`? | `boolean` | @@ -126,7 +126,7 @@ metadata properties. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | `undefined` \| `Type` | | `visibility` | [`Visibility`](../enumerations/Visibility.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/MetadataInfoOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/MetadataInfoOptions.md index 4d1a9ccff..253033973 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/MetadataInfoOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/MetadataInfoOptions.md @@ -6,8 +6,8 @@ title: "[I] MetadataInfoOptions" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | -| `canonicalVisibility?` | [`Visibility`](../enumerations/Visibility.md) |

The visibility to be used as the baseline against which

[MetadataInfo.isEmptied](MetadataInfo.md#isemptied) and [MetadataInfo.isTransformed](MetadataInfo.md#istransformed) are computed. If not specified, [Visibility.None](../enumerations/Visibility.md) is used, which will consider that any model that has fields that are only visible to some visibilities as transformed.

| +| ------ | ------ | ------ | +| `canonicalVisibility?` | [`Visibility`](../enumerations/Visibility.md) | The visibility to be used as the baseline against which [MetadataInfo.isEmptied](MetadataInfo.md#isemptied) and [MetadataInfo.isTransformed](MetadataInfo.md#istransformed) are computed. If not specified, [Visibility.None](../enumerations/Visibility.md) is used, which will consider that any model that has fields that are only visible to some visibilities as transformed. | ## Methods @@ -27,7 +27,7 @@ creating a separate schema schema for [Visibility.Read](../enumerations/Visibili #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `property` | `ModelProperty` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/NoAuth.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/NoAuth.md index ade21c11f..3a949abfc 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/NoAuth.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/NoAuth.md @@ -12,8 +12,9 @@ It might be useful when overriding authentication on interface of operation leve ## Properties -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | -| `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | -| `type` | `"noAuth"` | - | - | +| Property | Modifier | Type | Description | Inherited from | +| ------ | ------ | ------ | ------ | ------ | +| `description?` | `public` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `id` | `public` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | +| `model` | `readonly` | `Model` | Model that defined the authentication | [`HttpAuthBase`](HttpAuthBase.md).`model` | +| `type` | `public` | `"noAuth"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/NoHttpAuthRef.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/NoHttpAuthRef.md index c02a65aa7..899e4f671 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/NoHttpAuthRef.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/NoHttpAuthRef.md @@ -6,6 +6,6 @@ title: "[I] NoHttpAuthRef" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `auth` | `readonly` | [`NoAuth`](NoAuth.md) | | `kind` | `readonly` | `"noAuth"` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OAuth2HttpAuthRef.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OAuth2HttpAuthRef.md index 2957f91d0..9c1990e63 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OAuth2HttpAuthRef.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OAuth2HttpAuthRef.md @@ -6,7 +6,7 @@ title: "[I] OAuth2HttpAuthRef" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `auth` | `readonly` | [`Oauth2Auth`](Oauth2Auth.md)<[`OAuth2Flow`](../type-aliases/OAuth2Flow.md)[]\> | | `kind` | `readonly` | `"oauth2"` | | `scopes` | `readonly` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OAuth2Scope.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OAuth2Scope.md index b3268d53a..379b097c3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OAuth2Scope.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OAuth2Scope.md @@ -6,6 +6,6 @@ title: "[I] OAuth2Scope" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `description?` | `string` | | `value` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/Oauth2Auth.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/Oauth2Auth.md index e04f59ad4..9616f76a8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/Oauth2Auth.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/Oauth2Auth.md @@ -12,17 +12,18 @@ For more information about OAuth 2.0, see oauth.net and RFC 6749. - [`HttpAuthBase`](HttpAuthBase.md) -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `TFlows` *extends* [`OAuth2Flow`](../type-aliases/OAuth2Flow.md)[] | ## Properties -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | -| `flows` | `TFlows` | - | - | -| `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | -| `type` | `"oauth2"` | - | - | +| Property | Modifier | Type | Description | Inherited from | +| ------ | ------ | ------ | ------ | ------ | +| `description?` | `public` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `flows` | `public` | `TFlows` | - | - | +| `id` | `public` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | +| `model` | `readonly` | `Model` | Model that defined the authentication | [`HttpAuthBase`](HttpAuthBase.md).`model` | +| `type` | `public` | `"oauth2"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OpenIDConnectAuth.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OpenIDConnectAuth.md index e849b673f..72989227e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OpenIDConnectAuth.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OpenIDConnectAuth.md @@ -18,9 +18,10 @@ https://server.com/.well-known/openid-configuration ## Properties -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | -| `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | -| `openIdConnectUrl` | `string` | - | - | -| `type` | `"openIdConnect"` | - | - | +| Property | Modifier | Type | Description | Inherited from | +| ------ | ------ | ------ | ------ | ------ | +| `description?` | `public` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `id` | `public` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | +| `model` | `readonly` | `Model` | Model that defined the authentication | [`HttpAuthBase`](HttpAuthBase.md).`model` | +| `openIdConnectUrl` | `public` | `string` | - | - | +| `type` | `public` | `"openIdConnect"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OperationParameterOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OperationParameterOptions.md index 0af2284bb..709fffc6b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OperationParameterOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/OperationParameterOptions.md @@ -6,5 +6,5 @@ title: "[I] OperationParameterOptions" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `verbSelector?` | [`OperationVerbSelector`](../type-aliases/OperationVerbSelector.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/PasswordFlow.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/PasswordFlow.md index 71c30aa83..849fba954 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/PasswordFlow.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/PasswordFlow.md @@ -8,7 +8,7 @@ Resource Owner Password flow ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `authorizationUrl` | `string` | | `refreshUrl?` | `string` | | `scopes` | [`OAuth2Scope`](OAuth2Scope.md)[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/PathParameterOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/PathParameterOptions.md index e1ff10ada..cfc25786c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/PathParameterOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/PathParameterOptions.md @@ -6,6 +6,6 @@ title: "[I] PathParameterOptions" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | | `type` | `"path"` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/QueryParameterOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/QueryParameterOptions.md index a6ddd6a50..8060b7cbf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/QueryParameterOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/QueryParameterOptions.md @@ -6,7 +6,7 @@ title: "[I] QueryParameterOptions" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | -| `format?` | \| `"form"` \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` |

The string format of the array. "csv" and "simple" are used interchangeably, as are

"multi" and "form".

| +| ------ | ------ | ------ | +| `format?` | \| `"form"` \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` | The string format of the array. "csv" and "simple" are used interchangeably, as are "multi" and "form". | | `name` | `string` | - | | `type` | `"query"` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RouteOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RouteOptions.md index d6239f3f3..cf5ae4173 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RouteOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RouteOptions.md @@ -14,5 +14,5 @@ title: "[I] RouteOptions" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `paramOptions?` | [`OperationParameterOptions`](OperationParameterOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RoutePath.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RoutePath.md index 9dab4e018..d1a47ce4e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RoutePath.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RoutePath.md @@ -6,6 +6,6 @@ title: "[I] RoutePath" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | | `shared` | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RouteProducerResult.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RouteProducerResult.md index 55c6f79ec..e4e75c82b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RouteProducerResult.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RouteProducerResult.md @@ -6,6 +6,6 @@ title: "[I] RouteProducerResult" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `parameters` | [`HttpOperationParameters`](HttpOperationParameters.md) | | `segments` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RouteResolutionOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RouteResolutionOptions.md index 871554187..e0ff82895 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RouteResolutionOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/RouteResolutionOptions.md @@ -10,6 +10,6 @@ title: "[I] RouteResolutionOptions" ## Properties | Property | Type | Inherited from | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `listOptions?` | `ListOperationOptions` | - | | `paramOptions?` | [`OperationParameterOptions`](OperationParameterOptions.md) | [`RouteOptions`](RouteOptions.md).`paramOptions` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationParameter.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationParameter.md index c930504ce..d34ab4a82 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationParameter.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationParameter.md @@ -9,6 +9,6 @@ type HttpOperationParameter: HeaderFieldOptions | QueryParameterOptions | PathPa ## Type declaration -| Member | Type | -| :------ | :------ | +| Name | Type | +| ------ | ------ | | `param` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/OperationVerbSelector.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/OperationVerbSelector.md index 5f383d560..56b157e32 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/OperationVerbSelector.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/OperationVerbSelector.md @@ -10,7 +10,7 @@ type OperationVerbSelector: (program, operation) => HttpVerb | undefined; ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/RouteProducer.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/RouteProducer.md index e2bdd52e5..defa2f57b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/RouteProducer.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/RouteProducer.md @@ -10,7 +10,7 @@ type RouteProducer: (program, operation, parentSegments, overloadBase, options) ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | | `parentSegments` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/variables/$lib.md index 4df8cc430..d73165cfb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/variables/$lib.md @@ -28,60 +28,58 @@ const $lib: TypeSpecLibrary, ## Type declaration -| Member | Type | Value | -| :------ | :------ | :------ | -| `content-type-ignored` | `object` | ... | +| Name | Type | Default value | +| ------ | ------ | ------ | +| `content-type-ignored` | `object` | - | | `content-type-ignored.default` | "\`Content-Type\` header ignored because there is no body." | "\`Content-Type\` header ignored because there is no body." | -| `content-type-string` | `object` | ... | +| `content-type-string` | `object` | - | | `content-type-string.default` | `"contentType parameter must be a string literal or union of string literals"` | "contentType parameter must be a string literal or union of string literals" | -| `duplicate-body` | `object` | ... | +| `duplicate-body` | `object` | - | | `duplicate-body.bodyAndUnannotated` | `"Operation has a @body and an unannotated parameter. There can only be one representing the body"` | "Operation has a @body and an unannotated parameter. There can only be one representing the body" | | `duplicate-body.default` | `"Operation has multiple @body parameters declared"` | "Operation has multiple @body parameters declared" | | `duplicate-body.duplicateUnannotated` | `"Operation has multiple unannotated parameters. There can only be one representing the body"` | "Operation has multiple unannotated parameters. There can only be one representing the body" | -| `duplicate-operation` | `object` | ... | -| `duplicate-operation.default` | `CallableMessage`<[`string`, `string`, `string`]\> | ... | -| `duplicate-route-decorator` | `object` | ... | +| `duplicate-operation` | `object` | - | +| `duplicate-operation.default` | `CallableMessage`<[`string`, `string`, `string`]\> | - | +| `duplicate-route-decorator` | `object` | - | | `duplicate-route-decorator.namespace` | `"@route was defined twice on this namespace and has different values."` | "@route was defined twice on this namespace and has different values." | -| `formdata-no-part-name` | `object` | ... | +| `formdata-no-part-name` | `object` | - | | `formdata-no-part-name.default` | `"Part used in multipart/form-data must have a name."` | "Part used in multipart/form-data must have a name." | -| `header-format-required` | `object` | ... | -| `header-format-required.default` | "A format must be specified for @header when type is an array. e.g. @header(\{format: \"csv\"\})" | ... | -| `http-file-extra-property` | `object` | ... | -| `http-file-extra-property.default` | `CallableMessage`<[`string`]\> | ... | -| `http-verb-duplicate` | `object` | ... | -| `http-verb-duplicate.default` | `CallableMessage`<[`string`]\> | ... | -| `http-verb-wrong-type` | `object` | ... | -| `http-verb-wrong-type.default` | `CallableMessage`<[`string`, `string`]\> | ... | -| `invalid-type-for-auth` | `object` | ... | -| `invalid-type-for-auth.default` | `CallableMessage`<[`string`]\> | ... | -| `metadata-ignored` | `object` | ... | -| `metadata-ignored.default` | `CallableMessage`<[`string`]\> | ... | -| `missing-path-param` | `object` | ... | -| `missing-path-param.default` | `CallableMessage`<[`string`]\> | ... | -| `missing-server-param` | `object` | ... | -| `missing-server-param.default` | `CallableMessage`<[`string`]\> | ... | -| `multipart-invalid-content-type` | `object` | ... | -| `multipart-invalid-content-type.default` | `CallableMessage`<[`string`, `string`]\> | ... | -| `multipart-model` | `object` | ... | +| `header-format-required` | `object` | - | +| `header-format-required.default` | "A format must be specified for @header when type is an array. e.g. @header(\{format: \"csv\"\})" | - | +| `http-file-extra-property` | `object` | - | +| `http-file-extra-property.default` | `CallableMessage`<[`string`]\> | - | +| `http-verb-duplicate` | `object` | - | +| `http-verb-duplicate.default` | `CallableMessage`<[`string`]\> | - | +| `invalid-type-for-auth` | `object` | - | +| `invalid-type-for-auth.default` | `CallableMessage`<[`string`]\> | - | +| `metadata-ignored` | `object` | - | +| `metadata-ignored.default` | `CallableMessage`<[`string`]\> | - | +| `missing-path-param` | `object` | - | +| `missing-path-param.default` | `CallableMessage`<[`string`]\> | - | +| `missing-server-param` | `object` | - | +| `missing-server-param.default` | `CallableMessage`<[`string`]\> | - | +| `multipart-invalid-content-type` | `object` | - | +| `multipart-invalid-content-type.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `multipart-model` | `object` | - | | `multipart-model.default` | `"Multipart request body must be a model."` | "Multipart request body must be a model." | -| `multipart-nested` | `object` | ... | +| `multipart-nested` | `object` | - | | `multipart-nested.default` | `"Cannot use @multipartBody inside of an HttpPart"` | "Cannot use @multipartBody inside of an HttpPart" | -| `multipart-part` | `object` | ... | +| `multipart-part` | `object` | - | | `multipart-part.default` | `"Expect item to be an HttpPart model."` | "Expect item to be an HttpPart model." | -| `multiple-status-codes` | `object` | ... | +| `multiple-status-codes` | `object` | - | | `multiple-status-codes.default` | "Multiple \`@statusCode\` decorators defined for this operation response." | "Multiple \`@statusCode\` decorators defined for this operation response." | -| `no-service-found` | `object` | ... | -| `no-service-found.default` | `CallableMessage`<[`string`]\> | ... | -| `operation-param-duplicate-type` | `object` | ... | -| `operation-param-duplicate-type.default` | `CallableMessage`<[`string`, `string`]\> | ... | -| `optional-path-param` | `object` | ... | -| `optional-path-param.default` | `CallableMessage`<[`string`]\> | ... | -| `query-format-required` | `object` | ... | -| `query-format-required.default` | "A format must be specified for @query when type is an array. e.g. @query(\{format: \"multi\"\})" | ... | -| `shared-inconsistency` | `object` | ... | -| `shared-inconsistency.default` | `CallableMessage`<[`string`, `string`]\> | ... | -| `status-code-invalid` | `object` | ... | +| `no-service-found` | `object` | - | +| `no-service-found.default` | `CallableMessage`<[`string`]\> | - | +| `operation-param-duplicate-type` | `object` | - | +| `operation-param-duplicate-type.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `optional-path-param` | `object` | - | +| `optional-path-param.default` | `CallableMessage`<[`string`]\> | - | +| `query-format-required` | `object` | - | +| `query-format-required.default` | "A format must be specified for @query when type is an array. e.g. @query(\{format: \"multi\"\})" | - | +| `shared-inconsistency` | `object` | - | +| `shared-inconsistency.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `status-code-invalid` | `object` | - | | `status-code-invalid.default` | `"statusCode value must be a numeric or string literal or union of numeric or string literals"` | "statusCode value must be a numeric or string literal or union of numeric or string literals" | | `status-code-invalid.value` | `"statusCode value must be a three digit code between 100 and 599"` | "statusCode value must be a three digit code between 100 and 599" | -| `write-visibility-not-supported` | `object` | ... | -| `write-visibility-not-supported.default` | "@visibility(\"write\") is not supported. Use @visibility(\"update\"), @visibility(\"create\") or @visibility(\"create\", \"update\") as appropriate." | ... | +| `write-visibility-not-supported` | `object` | - | +| `write-visibility-not-supported.default` | "@visibility(\"write\") is not supported. Use @visibility(\"update\"), @visibility(\"create\") or @visibility(\"create\", \"update\") as appropriate." | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$defaultResponse.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$defaultResponse.md index 607f358e2..d6e94bcc2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$defaultResponse.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$defaultResponse.md @@ -10,7 +10,7 @@ function $defaultResponse(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$extension.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$extension.md index 81a4882c3..90e0f4e1b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$extension.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$extension.md @@ -14,7 +14,7 @@ function $extension( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | `key` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$externalDocs.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$externalDocs.md index 18aa614f9..c1adaf1aa 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$externalDocs.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$externalDocs.md @@ -16,7 +16,7 @@ Allows referencing an external resource for extended 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. | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$info.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$info.md index 277f3a284..dde3608c1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$info.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$info.md @@ -13,7 +13,7 @@ function $info( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Namespace` | | `additionalInfo` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$operationId.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$operationId.md index 119a1bad8..96beec96b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$operationId.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$operationId.md @@ -15,7 +15,7 @@ Set a specific operation ID. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `context` | `DecoratorContext` | Decorator Context | | `target` | `Operation` | - | | `operationId` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/checkDuplicateTypeName.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/checkDuplicateTypeName.md index 2561829dd..2615530c4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/checkDuplicateTypeName.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/checkDuplicateTypeName.md @@ -14,7 +14,7 @@ function checkDuplicateTypeName( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `type` | `Type` | | `name` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExtensions.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExtensions.md index 426578b92..ead59bddf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExtensions.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExtensions.md @@ -10,7 +10,7 @@ function getExtensions(program, entity): ReadonlyMap ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExternalDocs.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExternalDocs.md index 5d139f364..ad354e96a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExternalDocs.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExternalDocs.md @@ -10,7 +10,7 @@ function getExternalDocs(program, entity): ExternalDocs | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getInfo.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getInfo.md index c27c2a6fe..e03199aef 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getInfo.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getInfo.md @@ -10,7 +10,7 @@ function getInfo(program, entity): AdditionalInfo | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Namespace` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOpenAPITypeName.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOpenAPITypeName.md index b96e2f656..8b0da1430 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOpenAPITypeName.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOpenAPITypeName.md @@ -23,7 +23,7 @@ namespace using the provided `TypeNameOptions`. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `type` | `Type` | | `options` | `TypeNameOptions` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOperationId.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOperationId.md index 8bce13c2c..0c38e3c4c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOperationId.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOperationId.md @@ -10,7 +10,7 @@ function getOperationId(program, entity): string | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getParameterKey.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getParameterKey.md index 980d31ecb..2c79d51c8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getParameterKey.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getParameterKey.md @@ -17,7 +17,7 @@ Gets the key that is used to define a parameter in OpenAPI. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `property` | `ModelProperty` | | `newParam` | `unknown` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isDefaultResponse.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isDefaultResponse.md index 07b1d1dfd..987ba5ec3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isDefaultResponse.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isDefaultResponse.md @@ -12,7 +12,7 @@ Check if the given model has been mark as a default response. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | TypeSpec Program | | `entity` | `Type` | Model to check. | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isReadonlyProperty.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isReadonlyProperty.md index 87c5bb38a..61691e963 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isReadonlyProperty.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isReadonlyProperty.md @@ -17,7 +17,7 @@ designate a read-only property. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `property` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveInfo.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveInfo.md index cbb22b903..c8edf14d5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveInfo.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveInfo.md @@ -12,7 +12,7 @@ Resolve the info entry by merging data specified with `@service`, `@summary` and ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Namespace` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveOperationId.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveOperationId.md index 9c5448c75..1db2dec7d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveOperationId.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveOperationId.md @@ -13,7 +13,7 @@ Resolve the OpenAPI operation ID for the given operation using the following log ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | TypeSpec Program | | `operation` | `Operation` | Operation | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/setExtension.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/setExtension.md index 5f7555006..d768a8979 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/setExtension.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/setExtension.md @@ -14,7 +14,7 @@ function setExtension( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | | `extensionName` | \`x-$\{string\}\` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/setInfo.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/setInfo.md new file mode 100644 index 000000000..6c1636e17 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/setInfo.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] setInfo" + +--- +```ts +function setInfo( + program, + entity, + data): void +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | `Program` | +| `entity` | `Namespace` | +| `data` | [`AdditionalInfo`](../interfaces/AdditionalInfo.md) & `Record`<\`x-$\{string\}\`, `unknown`\> | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/shouldInline.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/shouldInline.md index 5de3331ed..cfaaa1740 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/shouldInline.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/shouldInline.md @@ -20,7 +20,7 @@ decorator, or chosen by default in simple cases. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `type` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/index.md index 36d26dd74..380f7a2a2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/index.md @@ -37,4 +37,5 @@ title: "[P] JS API" - [resolveInfo](functions/resolveInfo.md) - [resolveOperationId](functions/resolveOperationId.md) - [setExtension](functions/setExtension.md) +- [setInfo](functions/setInfo.md) - [shouldInline](functions/shouldInline.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/AdditionalInfo.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/AdditionalInfo.md index 750745905..ae04939c0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/AdditionalInfo.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/AdditionalInfo.md @@ -8,7 +8,7 @@ OpenAPI additional information ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `contact?` | [`Contact`](Contact.md) | The contact information for the exposed API. | | `description?` | `string` | A description of the API. Overrides the `@doc` provided on the service namespace. | | `license?` | [`License`](License.md) | The license information for the exposed API. | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/Contact.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/Contact.md index c50d5c3de..9c8f10da1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/Contact.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/Contact.md @@ -6,7 +6,7 @@ title: "[I] Contact" ## Properties | 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. | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/ExternalDocs.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/ExternalDocs.md index f2096cdbb..dd5ad4d97 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/ExternalDocs.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/ExternalDocs.md @@ -6,6 +6,6 @@ title: "[I] ExternalDocs" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `description?` | `string` | | `url` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/License.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/License.md index 785a5aa31..3c006f8fb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/License.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/interfaces/License.md @@ -6,6 +6,6 @@ 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. | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$action.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$action.md index e48f79408..fc5526a6f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$action.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$action.md @@ -13,7 +13,7 @@ function $action( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | | `name`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSegment.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSegment.md index 26e065cab..29b30f44e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSegment.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSegment.md @@ -13,7 +13,7 @@ function $actionSegment( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | | `value` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSeparator.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSeparator.md index 62f3ac76c..afc456a0f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSeparator.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSeparator.md @@ -18,7 +18,7 @@ function $actionSeparator( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `entity` | `Model` \| `ModelProperty` \| `Operation` | | `separator` | `"/"` \| `":"` \| `"/:"` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$autoRoute.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$autoRoute.md index b25c7c9cf..be4f5edb6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$autoRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$autoRoute.md @@ -16,7 +16,7 @@ auto-generated routes. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Interface` \| `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$collectionAction.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$collectionAction.md index 6630aed58..5a890f686 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$collectionAction.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$collectionAction.md @@ -14,7 +14,7 @@ function $collectionAction( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$copyResourceKeyParameters.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$copyResourceKeyParameters.md index 0261fa666..028fcdaff 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$copyResourceKeyParameters.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$copyResourceKeyParameters.md @@ -13,7 +13,7 @@ function $copyResourceKeyParameters( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `entity` | `Model` | | `filter`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrReplacesResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrReplacesResource.md index be060b775..ec5064ceb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrReplacesResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrReplacesResource.md @@ -13,7 +13,7 @@ function $createsOrReplacesResource( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrUpdatesResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrUpdatesResource.md index 404cf69e4..73a3246c3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrUpdatesResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrUpdatesResource.md @@ -13,7 +13,7 @@ function $createsOrUpdatesResource( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsResource.md index 00fe8180a..6fceffc54 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsResource.md @@ -13,7 +13,7 @@ function $createsResource( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$deletesResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$deletesResource.md index 841aecd33..214ce2f8a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$deletesResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$deletesResource.md @@ -13,7 +13,7 @@ function $deletesResource( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$listsResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$listsResource.md index 7500bf938..dad19686e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$listsResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$listsResource.md @@ -13,7 +13,7 @@ function $listsResource( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$onValidate.md index 3b2236c14..42cb14e22 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$onValidate.md @@ -10,7 +10,7 @@ function $onValidate(program): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$parentResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$parentResource.md index 720a81062..31783e41c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$parentResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$parentResource.md @@ -21,7 +21,7 @@ the target type to show up in operations of the `Resource*` interfaces define ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Model` | | `parent` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$readsResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$readsResource.md index 406230d99..e6bde7ac0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$readsResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$readsResource.md @@ -13,7 +13,7 @@ function $readsResource( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resource.md index 71d5fe42d..801a042b4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resource.md @@ -21,7 +21,7 @@ name of `widgets`. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Model` | | `collectionName` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceLocation.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceLocation.md index 27357d8c4..d964a576d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceLocation.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceLocation.md @@ -13,7 +13,7 @@ function $resourceLocation( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Scalar` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceTypeForKeyParam.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceTypeForKeyParam.md index 6d1138c2e..5f0bc9d56 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceTypeForKeyParam.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceTypeForKeyParam.md @@ -13,7 +13,7 @@ function $resourceTypeForKeyParam( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `entity` | `Type` | | `resourceType` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segment.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segment.md index 3bd75f982..54063b8bb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segment.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segment.md @@ -20,7 +20,7 @@ path parameter's name field. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `entity` | `Model` \| `ModelProperty` \| `Operation` | | `name` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segmentOf.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segmentOf.md index 734909cfb..b73e9f1cb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segmentOf.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segmentOf.md @@ -13,7 +13,7 @@ function $segmentOf( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | | `type` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$updatesResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$updatesResource.md index c9fcee81d..9e79fd447 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$updatesResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$updatesResource.md @@ -13,7 +13,7 @@ function $updatesResource( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getAction.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getAction.md index cadb42849..4ab0da99b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getAction.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getAction.md @@ -10,7 +10,7 @@ function getAction(program, operation): string | null | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionDetails.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionDetails.md index f721124e4..f6f06da90 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionDetails.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionDetails.md @@ -12,7 +12,7 @@ Gets the ActionDetails for the specified operation if it has previously been mar ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSegment.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSegment.md index 11193928b..c4961e89d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSegment.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSegment.md @@ -10,7 +10,7 @@ function getActionSegment(program, entity): string | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSeparator.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSeparator.md index c86a7e6ee..7e2b329f5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSeparator.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSeparator.md @@ -10,7 +10,7 @@ function getActionSeparator(program, entity): string | undefined ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | the TypeSpec program | | `entity` | `Type` | the target entity | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionAction.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionAction.md index e8187b8be..51a10e190 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionAction.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionAction.md @@ -10,7 +10,7 @@ function getCollectionAction(program, operation): string | null | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionActionDetails.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionActionDetails.md index c1e40bbdb..89647d139 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionActionDetails.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionActionDetails.md @@ -12,7 +12,7 @@ Gets the ActionDetails for the specified operation if it has previously been mar ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `operation` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getParentResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getParentResource.md index d930349aa..72a8203c4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getParentResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getParentResource.md @@ -10,7 +10,7 @@ function getParentResource(program, resourceType): Model | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceLocationType.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceLocationType.md index 0b26ef5e8..76211fae7 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceLocationType.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceLocationType.md @@ -10,7 +10,7 @@ function getResourceLocationType(program, entity): Model | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Scalar` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceOperation.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceOperation.md index 18415e153..ebe887190 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceOperation.md @@ -10,7 +10,7 @@ function getResourceOperation(program, typespecOperation): ResourceOperation | u ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `typespecOperation` | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeForKeyParam.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeForKeyParam.md index f5cca459f..137459af4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeForKeyParam.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeForKeyParam.md @@ -10,7 +10,7 @@ function getResourceTypeForKeyParam(program, param): Model | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `param` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeKey.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeKey.md index be6bf69f7..574830291 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeKey.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeKey.md @@ -10,7 +10,7 @@ function getResourceTypeKey(program, resourceType): ResourceKey | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getSegment.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getSegment.md index eef7dc41e..c39ac7ee3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getSegment.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getSegment.md @@ -10,7 +10,7 @@ function getSegment(program, entity): string | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isAutoRoute.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isAutoRoute.md index 7fbc1ab5f..2310f1dd0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isAutoRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isAutoRoute.md @@ -10,7 +10,7 @@ function isAutoRoute(program, entity): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `entity` | `Interface` \| `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isListOperation.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isListOperation.md index c2e263c49..3577a0ee0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isListOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isListOperation.md @@ -12,7 +12,7 @@ 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 | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceOperation.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceOperation.md index 1f46905c3..0e121bfd0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceOperation.md @@ -14,7 +14,7 @@ function setResourceOperation( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceTypeKey.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceTypeKey.md index ef9ae9dc6..750cb14d4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceTypeKey.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceTypeKey.md @@ -13,7 +13,7 @@ function setResourceTypeKey( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `resourceType` | `Model` | | `keyProperty` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ActionDetails.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ActionDetails.md index 906b7fb44..71a6e3ebb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ActionDetails.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ActionDetails.md @@ -8,6 +8,6 @@ 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 | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/AutoRouteOptions.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/AutoRouteOptions.md index 8db023235..01bc3a7fd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/AutoRouteOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/AutoRouteOptions.md @@ -6,5 +6,5 @@ title: "[I] AutoRouteOptions" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `routeParamFilter?` | (`op`: `Operation`, `param`: `ModelProperty`) => `undefined` \| [`FilteredRouteParam`](FilteredRouteParam.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/FilteredRouteParam.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/FilteredRouteParam.md index 97e5da452..352f07c17 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/FilteredRouteParam.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/FilteredRouteParam.md @@ -6,6 +6,6 @@ title: "[I] FilteredRouteParam" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `excludeFromOperationParams?` | `boolean` | | `routeParamString?` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ResourceKey.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ResourceKey.md index a64a33665..b26166c54 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ResourceKey.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ResourceKey.md @@ -6,6 +6,6 @@ title: "[I] ResourceKey" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `keyProperty` | `ModelProperty` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ResourceOperation.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ResourceOperation.md index 8a4996623..2bdd60509 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ResourceOperation.md @@ -6,6 +6,6 @@ title: "[I] ResourceOperation" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `operation` | `string` | | `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/decorators.md index 42a25fac7..536aace65 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/decorators.md @@ -68,7 +68,7 @@ model Foo { name: string; @madeOptional(Versions.v2) - nickname: string; + nickname?: string; } ``` diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/classes/VersionMap.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/classes/VersionMap.md index bcc25aab4..5ba5a8563 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/classes/VersionMap.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/classes/VersionMap.md @@ -14,7 +14,7 @@ new VersionMap(namespace, enumType): VersionMap #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `namespace` | `Namespace` | | `enumType` | `Enum` | @@ -22,12 +22,6 @@ new VersionMap(namespace, enumType): VersionMap [`VersionMap`](VersionMap.md) -## Properties - -| Property | Modifier | Type | Default value | -| :------ | :------ | :------ | :------ | -| `map` | `private` | `Map`<`EnumMember`, [`Version`](../interfaces/Version.md)\> | `...` | - ## Accessors ### size @@ -51,7 +45,7 @@ getVersionForEnumMember(member): undefined | Version #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `member` | `EnumMember` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/enumerations/Availability.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/enumerations/Availability.md index 3cdddfe6e..cd6a0aaf3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/enumerations/Availability.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/enumerations/Availability.md @@ -6,7 +6,7 @@ title: "[E] Availability" ## Enumeration Members | Enumeration Member | Value | -| :------ | :------ | +| ------ | ------ | | `Added` | `"Added"` | | `Available` | `"Available"` | | `Removed` | `"Removed"` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$added.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$added.md index bcd6aaa86..e411588fd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$added.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$added.md @@ -13,9 +13,9 @@ function $added( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | -| `target` | \| `Enum` \| `EnumMember` \| `Interface` \| `Model` \| `ModelProperty` \| `Operation` \| `Scalar` \| `Union` \| `UnionVariant` | +| `target` | \| `Enum` \| `EnumMember` \| `Interface` \| `Model` \| `ModelProperty` \| `Operation` \| `Scalar` \| `Union` \| `UnionVariant` | | `version` | `EnumMember` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeOptional.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeOptional.md index 52adced9d..17fca5155 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeOptional.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeOptional.md @@ -13,7 +13,7 @@ function $madeOptional( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | | `version` | `EnumMember` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeRequired.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeRequired.md index 5e8a23f05..0e3632065 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeRequired.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeRequired.md @@ -13,7 +13,7 @@ function $madeRequired( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | | `version` | `EnumMember` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$onValidate.md index 3b2236c14..42cb14e22 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$onValidate.md @@ -10,7 +10,7 @@ function $onValidate(program): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$removed.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$removed.md index eb79ad607..5372be470 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$removed.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$removed.md @@ -13,9 +13,9 @@ function $removed( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | -| `t` | \| `Enum` \| `EnumMember` \| `Interface` \| `Model` \| `ModelProperty` \| `Operation` \| `Scalar` \| `Union` \| `UnionVariant` | +| `t` | \| `Enum` \| `EnumMember` \| `Interface` \| `Model` \| `ModelProperty` \| `Operation` \| `Scalar` \| `Union` \| `UnionVariant` | | `v` | `EnumMember` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$renamedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$renamedFrom.md index 2556f2749..97ef099e8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$renamedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$renamedFrom.md @@ -14,9 +14,9 @@ function $renamedFrom( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | -| `target` | \| `Enum` \| `EnumMember` \| `Interface` \| `Model` \| `ModelProperty` \| `Operation` \| `Scalar` \| `Union` \| `UnionVariant` | +| `target` | \| `Enum` \| `EnumMember` \| `Interface` \| `Model` \| `ModelProperty` \| `Operation` \| `Scalar` \| `Union` \| `UnionVariant` | | `version` | `EnumMember` | | `oldName` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$returnTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$returnTypeChangedFrom.md index 714fd6f19..73959d6eb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$returnTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$returnTypeChangedFrom.md @@ -14,7 +14,7 @@ function $returnTypeChangedFrom( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Operation` | | `version` | `EnumMember` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$typeChangedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$typeChangedFrom.md index 6683edc99..67a6e4d59 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$typeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$typeChangedFrom.md @@ -14,7 +14,7 @@ function $typeChangedFrom( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | | `version` | `EnumMember` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$useDependency.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$useDependency.md index be43d9ae5..66b248306 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$useDependency.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$useDependency.md @@ -13,7 +13,7 @@ function $useDependency( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Namespace` \| `EnumMember` | | ...`versionRecords` | `EnumMember`[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$versioned.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$versioned.md index 5d20fc5c5..fc39609d4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$versioned.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$versioned.md @@ -13,7 +13,7 @@ function $versioned( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Namespace` | | `versions` | `Enum` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/buildVersionProjections.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/buildVersionProjections.md index 5e9f8ca7d..54da2b672 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/buildVersionProjections.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/buildVersionProjections.md @@ -10,7 +10,7 @@ function buildVersionProjections(program, rootNs): VersionProjections[] ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `rootNs` | `Namespace` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/findVersionedNamespace.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/findVersionedNamespace.md index d59bc47cb..901c2d691 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/findVersionedNamespace.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/findVersionedNamespace.md @@ -10,7 +10,7 @@ function findVersionedNamespace(program, namespace): Namespace | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `namespace` | `Namespace` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAddedOnVersions.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAddedOnVersions.md index c22f7e763..6ec2bb752 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAddedOnVersions.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAddedOnVersions.md @@ -10,7 +10,7 @@ function getAddedOnVersions(p, t): Version[] | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `p` | `Program` | | `t` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMap.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMap.md index 9152ffc34..99d9ca302 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMap.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMap.md @@ -10,7 +10,7 @@ function getAvailabilityMap(program, type): Map | undefine ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `type` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md index 21b092217..d757691dd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md @@ -13,7 +13,7 @@ function getAvailabilityMapInTimeline( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `type` | `Type` | | `timeline` | `VersioningTimeline` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getMadeOptionalOn.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getMadeOptionalOn.md index 4155da45d..cc09ec9d2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getMadeOptionalOn.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getMadeOptionalOn.md @@ -10,7 +10,7 @@ function getMadeOptionalOn(p, t): Version | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `p` | `Program` | | `t` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRemovedOnVersions.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRemovedOnVersions.md index 48b0d5056..89e16db3c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRemovedOnVersions.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRemovedOnVersions.md @@ -10,7 +10,7 @@ function getRemovedOnVersions(p, t): Version[] | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `p` | `Program` | | `t` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFrom.md index 35c1f947a..dd5778249 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFrom.md @@ -10,7 +10,7 @@ function getRenamedFrom(p, t): RenamedFrom[] | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `p` | `Program` | | `t` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFromVersions.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFromVersions.md index 648245770..47858a2f2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFromVersions.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFromVersions.md @@ -10,7 +10,7 @@ function getRenamedFromVersions(p, t): Version[] | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `p` | `Program` | | `t` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md index 0b61ca1cf..2d08050b5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md @@ -12,7 +12,7 @@ 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 | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getTypeChangedFrom.md index fd20cc21a..4e6efc8a7 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getTypeChangedFrom.md @@ -12,7 +12,7 @@ Returns the mapping of versions to old type values, if applicable ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `p` | `Program` | TypeSpec program | | `t` | `Type` | type to query | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getUseDependencies.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getUseDependencies.md index 6a7748063..62749d851 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getUseDependencies.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getUseDependencies.md @@ -13,7 +13,7 @@ function getUseDependencies( ## Parameters | Parameter | Type | Default value | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | `undefined` | | `target` | `Namespace` \| `Enum` | `undefined` | | `searchEnum` | `boolean` | `true` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersion.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersion.md index 19c4115fe..1e1f0a6bf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersion.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersion.md @@ -12,7 +12,7 @@ Get the version map of the namespace. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `namespace` | `Namespace` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionDependencies.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionDependencies.md index 13c387f59..751e946f2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionDependencies.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionDependencies.md @@ -10,7 +10,7 @@ function getVersionDependencies(program, namespace): Map | Resolved version for all the referenced namespaces. | diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$attribute.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$attribute.md index af08cdeb1..986814e37 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$attribute.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$attribute.md @@ -10,7 +10,7 @@ function $attribute(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$name.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$name.md index 43b53c890..f64a17ad6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$name.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$name.md @@ -13,7 +13,7 @@ function $name( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | `name` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$ns.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$ns.md index bc571ef2a..b34e2979f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$ns.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$ns.md @@ -14,7 +14,7 @@ function $ns( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Type` | | `ns` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$nsDeclarations.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$nsDeclarations.md index cf1811e6f..dd5454783 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$nsDeclarations.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$nsDeclarations.md @@ -10,7 +10,7 @@ function $nsDeclarations(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `Enum` | diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$unwrapped.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$unwrapped.md index 5fcbb72e6..3ac43e922 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$unwrapped.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$unwrapped.md @@ -10,7 +10,7 @@ function $unwrapped(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | `DecoratorContext` | | `target` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getNs.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getNs.md index 2c9a6fc08..117271e7d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getNs.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getNs.md @@ -12,7 +12,7 @@ Get the namespace and prefix for the given type. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getXmlEncoding.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getXmlEncoding.md index 8a3917b0f..b0f2fa6e2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getXmlEncoding.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getXmlEncoding.md @@ -13,7 +13,7 @@ This will return the default encoding for each types.(e.g. TypeSpec.Xml.Encoding ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `Program` | | | `type` | `ModelProperty` \| `Scalar` | | diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isAttribute.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isAttribute.md index 38f4bf62d..f87d85286 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isAttribute.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isAttribute.md @@ -12,7 +12,7 @@ Check if the given property should be serialized as an attribute instead of a no ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isUnwrapped.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isUnwrapped.md index 068043f60..359bf9253 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isUnwrapped.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isUnwrapped.md @@ -12,7 +12,7 @@ Check if the given property should be unwrapped in the XML containing node. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | `Program` | | `target` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/interfaces/XmlEncodeData.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/interfaces/XmlEncodeData.md index d0bad15de..b52c84826 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/interfaces/XmlEncodeData.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/interfaces/XmlEncodeData.md @@ -10,6 +10,6 @@ title: "[I] XmlEncodeData" ## Properties | Property | Type | Overrides | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `encoding` | `string` | `EncodeData.encoding` | | `type` | `Scalar` | `EncodeData.type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/interfaces/XmlNamespace.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/interfaces/XmlNamespace.md index e5be646e1..62831a10a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/interfaces/XmlNamespace.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/interfaces/XmlNamespace.md @@ -6,6 +6,6 @@ title: "[I] XmlNamespace" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `namespace` | `readonly` | `string` | | `prefix` | `readonly` | `string` | diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2024-07-16.md b/packages/website/versioned_docs/version-latest/release-notes/release-2024-07-16.md new file mode 100644 index 000000000..71c7c0a43 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2024-07-16.md @@ -0,0 +1,166 @@ +--- +title: 0.58 - July 2024 +--- + +:::warning +This release contains breaking changes +::: + +## Examples in TypeSpec + +This release introduce a new `@example` and `@opExample` decorator. + +Those new decorators provide a way to specify some canonical examples for data types and operations. Each emitter is then able to serialize those examples in their own format. + +```tsp +@example(#{ + id: "some", + date: utcDateTime.fromISO("2020-01-01T00:00:00Z"), + timeout: duration.fromISO("PT1M"), +}) +model Foo { + id: string; + date: utcDateTime; + @encode("seconds", int32) timeout: duration; +} +``` + +```tsp +@opExample( + #{ + parameters: #{ pet: #{ id: "some", name: "Fluffy", dob: plainDate.fromISO("2020-01-01") } }, + returnType: #{ id: "some", name: "Fluffy", dob: plainDate.fromISO("2020-01-01") }, + }, + #{ title: "First", description: "Show creating a pet" } +) +op createPet(pet: Pet): Pet; +``` + +## Breaking Changes + +### @typespec/compiler + +- [#3793](https://github.com/microsoft/typespec/pull/3793) Do not carry over `@friendlyName` with `model is` or `op is` + + ```tsp + @friendlyName("Abc{T}", T) + model Foo {} + + model Bar is Foo; + + // This can be changed to + model Abcstring is Foo; + ``` + +- [#3659](https://github.com/microsoft/typespec/pull/3659) Disallows overriding a required inherited property with an optional property. + +In previous versions of TypeSpec, it was possible to override a required property with an optional property. This is no longer allowed. This change may result in errors in your code if you were relying on this bug, but specifications that used this behavior are likely to have been exposed to errors resulting from incoherent type checking behavior. + +The following example demonstrates the behavior that is no longer allowed: + +```tsp +model Base { + example: string; +} + +model Child extends Base { + example?: string; +} +``` + +In this example, the `Child` model overrides the `example` property from the `Base` model with an optional property. This is no longer allowed. + +### @typespec/http + +- [#3737](https://github.com/microsoft/typespec/pull/3737) Keep trailing slash when building http routes, this is breaking if you used to have `@route()` ending with `/`. + + | TypeSpec | Before | After | + | ---------------------------------------------------------------- | ----------------- | ------------------ | + | `@route("users/")` | `users` | `users/` | + | `@route("users")` | `users` | `users` | + | on interface `@route("users/")` and on op `@route("addresses/")` | `users/addresses` | `users/addresses/` | + | on interface `@route("users/")` and on op `@route("addresses")` | `users/addresses` | `users/addresses` | + +## Features + +### @typespec/compiler + +- [#3699](https://github.com/microsoft/typespec/pull/3699) Moved compiler dependencies to peer and dev for scaffolded projects. +- [59daf90](https://github.com/microsoft/typespec/commit/59daf9054c709d3657e498b5f6dbe77492c98210) Add new `@example` and `@opExample` decorator to provide examples on types and operations. + + ```tsp + @example(#{ + id: "some", + date: utcDateTime.fromISO("2020-01-01T00:00:00Z"), + timeout: duration.fromISO("PT1M"), + }) + model Foo { + id: string; + date: utcDateTime; + @encode("seconds", int32) timeout: duration; + } + ``` + + ```tsp + @opExample( + #{ + parameters: #{ pet: #{ id: "some", name: "Fluffy", dob: plainDate.fromISO("2020-01-01") } }, + returnType: #{ id: "some", name: "Fluffy", dob: plainDate.fromISO("2020-01-01") }, + }, + #{ title: "First", description: "Show creating a pet" } + ) + op createPet(pet: Pet): Pet; + ``` + +- [#3751](https://github.com/microsoft/typespec/pull/3751) Adds option to `tsp init` to generate .gitignore file + +### @typespec/http + +- [#3717](https://github.com/microsoft/typespec/pull/3717) Allow overriding base operation verb +- [#3676](https://github.com/microsoft/typespec/pull/3676) Expose `getHttpPart` and types functions +- [#3732](https://github.com/microsoft/typespec/pull/3732) Expose `model` property on `HttpAuth` to retrieve original type used to define security scheme + +### @typespec/openapi + +- [#3626](https://github.com/microsoft/typespec/pull/3626) Adds public function for setting info object + +### @typespec/openapi3 + +- [bd0b3df](https://github.com/microsoft/typespec/commit/bd0b3df225045a89d3d16c37828f24d84d154343) Add support for new `@example` and `@opExample` decorator +- [#3663](https://github.com/microsoft/typespec/pull/3663) Adds support for converting OpenAPI3 specs to TypeSpec via the new tsp-openapi3 CLI included in the `@typespec/openapi3` package. +- [#3732](https://github.com/microsoft/typespec/pull/3732) Apply openapi3 extension on Security schemes + +### @typespec/html-program-viewer + +- [#3713](https://github.com/microsoft/typespec/pull/3713) Complete new dynamic UI to navigate the TypeSpec type graph + +## Bug Fixes + +### @typespec/compiler + +- [#3623](https://github.com/microsoft/typespec/pull/3623) Fix crash of language server on firefox +- [#3516](https://github.com/microsoft/typespec/pull/3516) Deprecate getAssetEmitter and recommend calling `createAssetEmitter` directly +- [#3767](https://github.com/microsoft/typespec/pull/3767) Fix semantic highlighting of using of single namespace +- [#3824](https://github.com/microsoft/typespec/pull/3824) Do not cast model expression to object value if the constraint is allowing the type +- [#3577](https://github.com/microsoft/typespec/pull/3577) Fix formatting of object and array literal in decorator to hug parenthesis +- [#3823](https://github.com/microsoft/typespec/pull/3823) Fix formatting of scalar constructor called with no args +- [#3743](https://github.com/microsoft/typespec/pull/3743) Fix 'typespec vs install' command on windows +- [#3605](https://github.com/microsoft/typespec/pull/3605) Fix templates initialized on node 22 + +### @typespec/openapi3 + +- [#3516](https://github.com/microsoft/typespec/pull/3516) Fix issue that could result in invalid document generation when running `tsp compile` from another directory +- [#3794](https://github.com/microsoft/typespec/pull/3794) Updates tsp-openapi3 to always emit main.tsp when formatting encounters an error. +- [#3839](https://github.com/microsoft/typespec/pull/3839) Updates tsp-openapi3 doc line wrapping to only automatically create newlines when they are present in the original documentation. + +### @typespec/html-program-viewer + +- [#3585](https://github.com/microsoft/typespec/pull/3585) Fix crash in program viewer when trying to display new value type + +### @typespec/json-schema + +- [#3516](https://github.com/microsoft/typespec/pull/3516) Fix issue that could result in invalid document generation when running `tsp compile` from another directory + +``` + +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/built-in-data-types.md b/packages/website/versioned_docs/version-latest/standard-library/built-in-data-types.md index d058b9dbe..66ad5be3c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/built-in-data-types.md +++ b/packages/website/versioned_docs/version-latest/standard-library/built-in-data-types.md @@ -39,6 +39,20 @@ model DefaultKeyVisibility #### Properties None +### `ExampleOptions` {#ExampleOptions} + +Options for example decorators +```typespec +model ExampleOptions +``` + + +#### Properties +| Name | Type | Description | +|------|------|-------------| +| title? | [`string`](#string) | The title of the example | +| description? | [`string`](#string) | Description of the example | + ### `object` {#object} Represent a model @@ -83,6 +97,20 @@ model OmitProperties #### Properties None +### `OperationExample` {#OperationExample} + +Operation example configuration. +```typespec +model OperationExample +``` + + +#### Properties +| Name | Type | Description | +|------|------|-------------| +| parameters? | `unknown` | Example request body. | +| returnType? | `unknown` | Example response body. | + ### `OptionalProperties` {#OptionalProperties} Represents a collection of optional properties. 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 86336bf0c..d7413c603 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 @@ -192,7 +192,7 @@ model PetStoreError { ### `@errorsDoc` {#@errorsDoc} Attach a documentation string to describe the error return types of an operation. -If an operation returns a union of success and errors it only describe the errors. See `@errorsDoc` for success documentation. +If an operation returns a union of success and errors it only describes the errors. See `@returnsDoc` for success documentation. ```typespec @errorsDoc(doc: valueof string) ``` @@ -209,11 +209,39 @@ If an operation returns a union of success and errors it only describe the error #### Examples ```typespec -@errorsDoc("Returns doc") +@errorsDoc("Errors doc") op get(): Pet | NotFound; ``` +### `@example` {#@example} + +Provide an example value for a data type. +```typespec +@example(example: valueof unknown, options?: valueof ExampleOptions) +``` + +#### Target + +`Model | Enum | Scalar | Union | ModelProperty | UnionVariant` + +#### Parameters +| Name | Type | Description | +|------|------|-------------| +| example | `valueof unknown` | Example value. | +| options | [valueof `ExampleOptions`](./built-in-data-types.md#ExampleOptions) | Optional metadata for the example. | + +#### Examples + +```tsp +@example(#{name: "Fluffy", age: 2}) +model Pet { + name: string; + age: int32; +} +``` + + ### `@format` {#@format} Specify a known data format hint for this string type. For example `uuid`, `uri`, etc. @@ -570,6 +598,31 @@ scalar distance is float64; ``` +### `@opExample` {#@opExample} + +Provide example values for an operation's parameters and corresponding return type. +```typespec +@opExample(example: valueof OperationExample, options?: valueof ExampleOptions) +``` + +#### Target + +`Operation` + +#### Parameters +| Name | Type | Description | +|------|------|-------------| +| example | [valueof `OperationExample`](./built-in-data-types.md#OperationExample) | Example value. | +| options | [valueof `ExampleOptions`](./built-in-data-types.md#ExampleOptions) | Optional metadata for the example. | + +#### Examples + +```tsp +@example(#{parameters: #{name: "Fluffy", age: 2}, returnType: #{name: "Fluffy", age: 2, id: "abc"}) +op createPet(pet: Pet): Pet; +``` + + ### `@overload` {#@overload} Specify this operation is an overload of the given operation. @@ -679,7 +732,7 @@ model Certificate { ### `@returnsDoc` {#@returnsDoc} Attach a documentation string to describe the successful return types of an operation. -If an operation returns a union of success and errors it only describe the success. See `@errorsDoc` for error documentation. +If an operation returns a union of success and errors it only describes the success. See `@errorsDoc` for error documentation. ```typespec @returnsDoc(doc: valueof string) ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md index 1307f1548..baa149a44 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md @@ -5,10 +5,10 @@ title: "[C] DuplicateTracker" --- Helper class to track duplicate instance -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `K` | | `V` | @@ -24,12 +24,6 @@ new DuplicateTracker(): DuplicateTracker [`DuplicateTracker`](DuplicateTracker.md)<`K`, `V`\> -## Properties - -| Property | Modifier | Type | Default value | -| :------ | :------ | :------ | :------ | -| `#entries` | `private` | `Map`<`K`, `V`[]\> | `...` | - ## Methods ### entries() @@ -57,7 +51,7 @@ 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 | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md index 388006308..26ec668e1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md @@ -3,10 +3,10 @@ jsApi: true title: "[C] EventEmitter" --- -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* `object` | ## Constructors @@ -21,12 +21,6 @@ new EventEmitter(): EventEmitter [`EventEmitter`](EventEmitter.md)<`T`\> -## Properties - -| Property | Modifier | Type | Default value | -| :------ | :------ | :------ | :------ | -| `listeners` | `private` | `Map` `any`[]\> | `...` | - ## Methods ### emit() @@ -35,16 +29,16 @@ new EventEmitter(): EventEmitter emit(name, ...args): void ``` -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `K` *extends* `string` \| `number` \| `symbol` | #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `K` | | ...`args` | `Parameters`<`T`\[`K`\]\> | @@ -60,16 +54,16 @@ emit(name, ...args): void on(name, listener): void ``` -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `K` *extends* `string` \| `number` \| `symbol` | #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `K` | | `listener` | (...`args`) => `any` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md index a90ce7a8b..08413afc6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md @@ -20,7 +20,7 @@ new ProjectionError(message): ProjectionError #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `message` | `string` | #### Returns @@ -34,12 +34,12 @@ new ProjectionError(message): ProjectionError ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `cause?` | `public` | `unknown` | - | `Error.cause` | | `message` | `public` | `string` | - | `Error.message` | | `name` | `public` | `string` | - | `Error.name` | | `stack?` | `public` | `string` | - | `Error.stack` | -| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` |

Optional override for formatting stack traces

**See**

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

| `Error.prepareStackTrace` | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | | `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | ## Methods @@ -55,7 +55,7 @@ Create .stack property on a target object #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `targetObject` | `object` | | `constructorOpt`? | `Function` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md index 4f22f2b0e..054f1ab2e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md @@ -3,10 +3,10 @@ jsApi: true title: "[C] Queue" --- -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` | ## Constructors @@ -20,20 +20,13 @@ new Queue(elements?): Queue #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `elements`? | `T`[] | #### Returns [`Queue`](Queue.md)<`T`\> -## Properties - -| Property | Modifier | Type | Default value | -| :------ | :------ | :------ | :------ | -| `#elements` | `private` | `T`[] | `undefined` | -| `#headIndex` | `private` | `number` | `0` | - ## Methods ### dequeue() @@ -57,7 +50,7 @@ enqueue(...items): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | ...`items` | `T`[] | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md index 535e5d430..97f3d0672 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md @@ -18,7 +18,7 @@ new ResolveModuleError(code, message): ResolveModuleError #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `code` | `ResolveModuleErrorCode` | | `message` | `string` | @@ -33,13 +33,13 @@ new ResolveModuleError(code, message): ResolveModuleError ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `cause?` | `public` | `unknown` | - | `Error.cause` | | `code` | `public` | `ResolveModuleErrorCode` | - | - | | `message` | `public` | `string` | - | `Error.message` | | `name` | `public` | `string` | - | `Error.name` | | `stack?` | `public` | `string` | - | `Error.stack` | -| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` |

Optional override for formatting stack traces

**See**

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

| `Error.prepareStackTrace` | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | | `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | ## Methods @@ -55,7 +55,7 @@ Create .stack property on a target object #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `targetObject` | `object` | | `constructorOpt`? | `Function` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md index f3d2b91ff..5e6d437ff 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md @@ -6,7 +6,7 @@ title: "[E] IdentifierKind" ## Enumeration Members | Enumeration Member | Value | -| :------ | :------ | +| ------ | ------ | | `Declaration` | `5` | | `Decorator` | `2` | | `Function` | `3` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md index 428237836..974a1324e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md @@ -6,5 +6,5 @@ title: "[E] ListenerFlow" ## Enumeration Members | Enumeration 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/enumerations/ModifierFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md index cf0eb278a..ba7efd9dd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md @@ -6,6 +6,6 @@ title: "[E] ModifierFlags" ## Enumeration Members | Enumeration Member | Value | -| :------ | :------ | +| ------ | ------ | | `Extern` | `2` | | `None` | `0` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md index f691f8e9e..6245443bf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md @@ -6,9 +6,9 @@ title: "[E] NodeFlags" ## Enumeration Members | Enumeration 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.

| +| ------ | ------ | ------ | +| `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.

| +| `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/enumerations/SemanticTokenKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SemanticTokenKind.md index a75f25255..659512bd3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SemanticTokenKind.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SemanticTokenKind.md @@ -6,7 +6,7 @@ title: "[E] SemanticTokenKind" ## Enumeration Members | Enumeration Member | Value | -| :------ | :------ | +| ------ | ------ | | `Class` | `2` | | `Comment` | `16` | | `DocCommentTag` | `21` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SymbolFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SymbolFlags.md index 95a9e3e31..570aa646e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SymbolFlags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SymbolFlags.md @@ -6,7 +6,7 @@ title: "[E] SymbolFlags" ## Enumeration Members | Enumeration Member | Value | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `Alias` | `2048` | - | | `Const` | `16777216` | - | | `Declaration` | `4194304` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md index 716e2841e..941d6f06a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md @@ -8,14 +8,14 @@ AST types ## Enumeration Members | Enumeration Member | Value | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `AliasStatement` | `24` | - | | `ArrayExpression` | `31` | - | | `ArrayLiteral` | `97` | - | | `AugmentDecoratorStatement` | `4` | - | | `BlockComment` | `51` | - | | `BooleanLiteral` | `34` | - | -| `CadlScript` | `0` |

**Deprecated**

Use TypeSpecScript

| +| `CadlScript` | `0` | **Deprecated** Use TypeSpecScript | | `CallExpression` | `99` | - | | `ConstStatement` | `98` | - | | `DecoratorDeclarationStatement` | `25` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md index e57e8cd10..4e9d6a901 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md @@ -6,7 +6,7 @@ title: "[E] Token" ## Enumeration Members | Enumeration Member | Value | -| :------ | :------ | +| ------ | ------ | | `AliasKeyword` | `59` | | `Ampersand` | `30` | | `AmpsersandAmpersand` | `47` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/TokenFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/TokenFlags.md index 6efba971a..5a20fce80 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/TokenFlags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/TokenFlags.md @@ -6,7 +6,7 @@ title: "[E] TokenFlags" ## Enumeration Members | Enumeration Member | Value | -| :------ | :------ | +| ------ | ------ | | `Backticked` | `32` | | `DocComment` | `16` | | `Escaped` | `1` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md index 4e8a95842..f51e38234 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md @@ -6,7 +6,7 @@ title: "[E] UsageFlags" ## Enumeration Members | Enumeration Member | Value | -| :------ | :------ | +| ------ | ------ | | `Input` | `2` | | `None` | `0` | | `Output` | `4` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md index a725191bf..a8925cb0e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md @@ -15,7 +15,7 @@ Mark a type as deprecated ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | | `target` | [`Type`](../type-aliases/Type.md) | Decorator target | | `message` | `string` | Deprecation target. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md index aaab52289..690aa2190 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md @@ -13,7 +13,7 @@ function $discriminator( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md) | | `propertyName` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md index 0f1102210..e60d0b1d6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md @@ -14,7 +14,7 @@ function $doc( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `doc` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md index 8756de572..079de2d00 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md @@ -14,7 +14,7 @@ function $encode( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `encoding` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md index b3fb8d697..32c809b6f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md @@ -14,7 +14,7 @@ function $encodedName( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `mimeType` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md index a1ebf827d..226eaaad5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md @@ -13,7 +13,7 @@ function $error(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md index 112700090..a6a387b3d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md @@ -13,7 +13,7 @@ function $errorsDoc( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Operation`](../interfaces/Operation.md) | | `doc` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$example.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$example.md new file mode 100644 index 000000000..bc87a7c7f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$example.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $example" + +--- +```ts +function $example( + context, + target, + example, + options?): void +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | \| [`Enum`](../interfaces/Enum.md) \| [`Model`](../interfaces/Model.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) \| [`Union`](../interfaces/Union.md) \| [`UnionVariant`](../interfaces/UnionVariant.md) | +| `example` | `unknown` | +| `options`? | `unknown` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md index c08e80927..590df574e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md @@ -25,7 +25,7 @@ https://github.com/OAI/OpenAPI-Specification/blob/3.0.3/versions/3.0.3.md#dataTy ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `format` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md index 76c89ed3a..003fd21a6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md @@ -14,7 +14,7 @@ function $friendlyName( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `name` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md index 2b3348e16..1551ce06b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md @@ -13,7 +13,7 @@ function $inspectType( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `text` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md index 9065d9e96..b1164c499 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md @@ -13,7 +13,7 @@ function $inspectTypeName( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `text` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md index 62aaff926..7e2689f5f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md @@ -20,7 +20,7 @@ Otherwise, the name of the target property will be used. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) | | `altName`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md index ee7f754fc..959ceb2ea 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md @@ -20,7 +20,7 @@ type accepts. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | - | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | Decorator target. Must be a string. (model Foo extends string) | | `knownValues` | [`Enum`](../interfaces/Enum.md) | Must be an enum. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md index d71be9ead..691b8ab1b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md @@ -13,7 +13,7 @@ function $list( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Operation`](../interfaces/Operation.md) | | `listedType`? | [`Model`](../interfaces/Model.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md index 266e539df..d100f4242 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md @@ -13,7 +13,7 @@ function $maxItems( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `value` | [`Numeric`](../interfaces/Numeric.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md index 9b237d7e3..66579c968 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md @@ -13,7 +13,7 @@ function $maxLength( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `value` | [`Numeric`](../interfaces/Numeric.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md index 9d001e6f5..c27ce1cbc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md @@ -13,7 +13,7 @@ function $maxValue( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `value` | [`Numeric`](../interfaces/Numeric.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md index 840786780..28e58ee6c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md @@ -13,7 +13,7 @@ function $maxValueExclusive( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `value` | [`Numeric`](../interfaces/Numeric.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md index ea4a0f841..c3bd624b1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md @@ -13,7 +13,7 @@ function $minItems( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `value` | [`Numeric`](../interfaces/Numeric.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md index 19353213d..7f917e18d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md @@ -13,7 +13,7 @@ function $minLength( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `value` | [`Numeric`](../interfaces/Numeric.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md index c860e955e..7b3491565 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md @@ -13,7 +13,7 @@ function $minValue( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `value` | [`Numeric`](../interfaces/Numeric.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md index 6a0945c07..b60505715 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md @@ -13,7 +13,7 @@ function $minValueExclusive( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `value` | [`Numeric`](../interfaces/Numeric.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$opExample.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$opExample.md new file mode 100644 index 000000000..bd52af53f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$opExample.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $opExample" + +--- +```ts +function $opExample( + context, + target, + example, + options?): void +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | +| `example` | `unknown` | +| `options`? | `unknown` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md index 91956d7f7..e38794f95 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md @@ -15,7 +15,7 @@ function $overload( ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | | `target` | [`Operation`](../interfaces/Operation.md) | The specializing operation declaration | | `overloadbase` | [`Operation`](../interfaces/Operation.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md index cd4457272..9e079706f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md @@ -13,7 +13,7 @@ function $parameterVisibility( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Operation`](../interfaces/Operation.md) | | ...`visibilities` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md index fc989abe4..dc106ae7a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md @@ -14,7 +14,7 @@ function $pattern( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `pattern` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md index 6cf7d2484..2e2cca2aa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md @@ -16,7 +16,7 @@ function $projectedName( ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | | `target` | [`Type`](../type-aliases/Type.md) | The that should have a different name. | | `targetName` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md index 64a2afca0..afa18b3c0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md @@ -13,7 +13,7 @@ function $returnTypeVisibility( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Operation`](../interfaces/Operation.md) | | ...`visibilities` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md index b9412fcf6..356055337 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md @@ -13,7 +13,7 @@ function $returnsDoc( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Operation`](../interfaces/Operation.md) | | `doc` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md index 1f9d26907..68ce2d16f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md @@ -12,7 +12,7 @@ Mark a string as a secret value that should be treated carefully to avoid exposu ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | Decorator context | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | Decorator target, either a string model or a property with type string. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md index 5308f57e9..20686b020 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md @@ -13,7 +13,7 @@ function $service( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Namespace`](../interfaces/Namespace.md) | | `options`? | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md index 73d18a005..093aa32ca 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md @@ -13,7 +13,7 @@ function $summary( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `summary` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md index 681fed857..b4eb4cc1f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md @@ -13,7 +13,7 @@ function $tag( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Interface`](../interfaces/Interface.md) \| [`Namespace`](../interfaces/Namespace.md) \| [`Operation`](../interfaces/Operation.md) | | `tag` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md index 0b8e75767..8588a9537 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md @@ -13,7 +13,7 @@ function $visibility( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) | | ...`visibilities` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md index 2b4e6c816..97f2314d3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md @@ -13,7 +13,7 @@ function $withDefaultKeyVisibility( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | | `visibility` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md index 59f56917d..c27cada3e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md @@ -10,7 +10,7 @@ function $withOptionalProperties(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withPickedProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withPickedProperties.md index 616e7b834..9296e94b2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withPickedProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withPickedProperties.md @@ -13,7 +13,7 @@ function $withPickedProperties( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | | `pick` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md index ce061b22b..9e1ab6353 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md @@ -10,7 +10,7 @@ function $withUpdateableProperties(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md index 48b2b8f4f..86996c7fe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md @@ -13,7 +13,7 @@ function $withVisibility( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | | ...`visibilities` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md index d9a8d639e..e5d803796 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md @@ -10,7 +10,7 @@ function $withoutDefaultValues(context, target): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md index 6a3f1ec33..9696cee6b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md @@ -13,7 +13,7 @@ function $withoutOmittedProperties( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | | `omit` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/Numeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/Numeric.md index 038d5dd13..81ca4437c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/Numeric.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/Numeric.md @@ -12,7 +12,7 @@ Represent any possible numeric value ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `stringValue` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md index 415c603e4..a5b644dac 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md @@ -15,7 +15,7 @@ Mark the given namespace as a service. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | | `details` | [`ServiceDetails`](../interfaces/ServiceDetails.md) | Service details | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md index 4a93d6ae2..46b888da1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md @@ -12,40 +12,16 @@ function assertType( Assert that the input type has one of the kinds provided -## Type parameters +## Type Parameters -| Type parameter | -| :------ | -| `TKind` *extends* ( - \| `"Boolean"` - \| `"Decorator"` - \| `"Enum"` - \| `"EnumMember"` - \| `"FunctionParameter"` - \| `"Function"` - \| `"Interface"` - \| `"Intrinsic"` - \| `"Model"` - \| `"ModelProperty"` - \| `"Namespace"` - \| `"Number"` - \| `"Object"` - \| `"Operation"` - \| `"Projection"` - \| `"Scalar"` - \| `"ScalarConstructor"` - \| `"String"` - \| `"StringTemplate"` - \| `"StringTemplateSpan"` - \| `"TemplateParameter"` - \| `"Tuple"` - \| `"Union"` - \| `"UnionVariant"`)[] | +| Type Parameter | +| ------ | +| `TKind` *extends* ( \| `"Boolean"` \| `"Decorator"` \| `"Enum"` \| `"EnumMember"` \| `"FunctionParameter"` \| `"Function"` \| `"Interface"` \| `"Intrinsic"` \| `"Model"` \| `"ModelProperty"` \| `"Namespace"` \| `"Number"` \| `"Object"` \| `"Operation"` \| `"Projection"` \| `"Scalar"` \| `"ScalarConstructor"` \| `"String"` \| `"StringTemplate"` \| `"StringTemplateSpan"` \| `"TemplateParameter"` \| `"Tuple"` \| `"Union"` \| `"UnionVariant"`)[] | ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `typeDescription` | `string` | | `t` | [`Type`](../type-aliases/Type.md) | | ...`kinds` | `TKind` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md index 7a1ccff9d..1b7ebdf8f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md @@ -7,23 +7,22 @@ title: "[F] cadlTypeToJson" function cadlTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] ``` -## Type parameters +Convert a TypeSpec type to a serializable Json object. +Emits diagnostics if the given type is invalid -| Type parameter | -| :------ | +## Type Parameters + +| Type Parameter | +| ------ | | `T` | ## Parameters -| Parameter | Type | -| :------ | :------ | -| `typespecType` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | -| `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `typespecType` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | The type to convert to Json data | +| `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | The diagnostic target in case of errors. | ## Returns [`T` \| `undefined`, [`Diagnostic`](../interfaces/Diagnostic.md)[]] - -## Deprecated - -use typespecTypeToJson diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md index 90395ee27..98afdd606 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md @@ -7,10 +7,12 @@ title: "[F] checkFormatCadl" function checkFormatCadl(code, prettierConfig?): Promise ``` +Check the given is correctly formatted. + ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `code` | `string` | | `prettierConfig`? | `Options` | @@ -18,6 +20,4 @@ function checkFormatCadl(code, prettierConfig?): Promise `Promise`<`boolean`\> -## Deprecated - -use checkFormatTypeSpec +true if code is formatted correctly. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md index cc13d8aa9..0d4c41521 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md @@ -12,7 +12,7 @@ Check the given is correctly formatted. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `code` | `string` | | `prettierConfig`? | `Options` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md index 92ee6a7bd..b4308f7f9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md @@ -14,7 +14,7 @@ oldProgram?): Promise ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `host` | [`CompilerHost`](../interfaces/CompilerHost.md) | | `mainFile` | `string` | | `options` | [`CompilerOptions`](../interfaces/CompilerOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md index 3cc1923e2..7e997c11e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md @@ -16,10 +16,10 @@ being compiled. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `condition` | `any` | Throw if this is not true. | | `message` | `string` | Error message. | -| `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) |

Optional location in source code that might give a clue about

what got the compiler off track.

| +| `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | Optional location in source code that might give a clue about what got the compiler off track. | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md index 2c7819652..bbc443012 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md @@ -7,24 +7,41 @@ title: "[F] createCadlLibrary" function createCadlLibrary(lib): TypeSpecLibrary ``` -## Type parameters +Create a new TypeSpec library definition. -| Type parameter | Value | -| :------ | :------ | +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* `object` | - | | `E` *extends* `Record`<`string`, `any`\> | - | | `State` *extends* `string` | `never` | ## Parameters -| Parameter | Type | -| :------ | :------ | -| `lib` | `Readonly`<[`TypeSpecLibraryDef`](../interfaces/TypeSpecLibraryDef.md)<`T`, `E`, `State`\>\> | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `lib` | `Readonly`<[`TypeSpecLibraryDef`](../interfaces/TypeSpecLibraryDef.md)<`T`, `E`, `State`\>\> | Library definition. | ## Returns [`TypeSpecLibrary`](../interfaces/TypeSpecLibrary.md)<`T`, `E`, `State`\> -## Deprecated +Library with utility functions. -use createTypeSpecLibrary +## 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/functions/createChecker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md index 2f0f08317..18ed5fdef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md @@ -10,7 +10,7 @@ function createChecker(program): Checker ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md index a16bc33c8..a2a9ac7ee 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md @@ -7,10 +7,10 @@ title: "[F] createDecoratorDefinition" function createDecoratorDefinition(definition): DecoratorValidator ``` -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | | `P` *extends* readonly [`DecoratorParamDefinition`](../interfaces/DecoratorParamDefinition.md)<[`TypeKind`](../type-aliases/TypeKind.md)\>[] | | `S` *extends* `undefined` \| [`DecoratorParamDefinition`](../interfaces/DecoratorParamDefinition.md)<[`TypeKind`](../type-aliases/TypeKind.md)\> | @@ -18,7 +18,7 @@ function createDecoratorDefinition(definition): DecoratorValidator | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md index cd030131a..bf50d68f3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md @@ -12,7 +12,7 @@ Create an helper to manager project names. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `target` | `string` | Name of the projected name target(e.g. json, csharp, etc.) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md index 4be68f01f..621573f72 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md @@ -7,17 +7,17 @@ title: "[F] createRekeyableMap" function createRekeyableMap(entries?): RekeyableMap ``` -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `K` | | `V` | ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `entries`? | [`K`, `V`][] | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md index cbc62e709..99300663d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md @@ -9,17 +9,17 @@ function createRule(definition): LinterRuleDefinition Create a new linter rule. -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `N` *extends* `string` | | `T` *extends* [`DiagnosticMessages`](../interfaces/DiagnosticMessages.md) | ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `definition` | [`LinterRuleDefinition`](../interfaces/LinterRuleDefinition.md)<`N`, `T`\> | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md index 32df624cb..ff70a989e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md @@ -10,7 +10,7 @@ function createScanner(source, diagnosticHandler): Scanner ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `source` | `string` \| [`SourceFile`](../interfaces/SourceFile.md) | | `diagnosticHandler` | [`DiagnosticHandler`](../type-aliases/DiagnosticHandler.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md index 4ee717140..f8b7a4dd9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md @@ -10,7 +10,7 @@ function createServer(host): Server ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `host` | [`ServerHost`](../interfaces/ServerHost.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md index 3510e5c25..714ba9da1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md @@ -10,7 +10,7 @@ function createSourceFile(text, path): SourceFile ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `text` | `string` | | `path` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md index 1eb7d5aa1..71e6db9dd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md @@ -9,10 +9,10 @@ function createTypeSpecLibrary(lib): TypeSpecLibrary Create a new TypeSpec library definition. -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* `object` | - | | `E` *extends* `Record`<`string`, `any`\> | - | | `State` *extends* `string` | `never` | @@ -20,7 +20,7 @@ Create a new TypeSpec library definition. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `lib` | `Readonly`<[`TypeSpecLibraryDef`](../interfaces/TypeSpecLibraryDef.md)<`T`, `E`, `State`\>\> | Library definition. | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md index eaede79a3..136868c0e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md @@ -10,7 +10,7 @@ function defineCodeFix(fix): CodeFix ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `fix` | [`CodeFix`](../interfaces/CodeFix.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md index ae1aa53c4..5344550bd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md @@ -10,7 +10,7 @@ function defineLinter(def): LinterDefinition ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `def` | [`LinterDefinition`](../interfaces/LinterDefinition.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/definePackageFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/definePackageFlags.md index 1d7b0e70f..24d9299b9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/definePackageFlags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/definePackageFlags.md @@ -10,7 +10,7 @@ function definePackageFlags(flags): PackageFlags ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `flags` | [`PackageFlags`](../interfaces/PackageFlags.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md index c756a997a..82f2bfeaf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md @@ -12,7 +12,7 @@ Helper to emit a file. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | TypeSpec Program | | `options` | [`EmitFileOptions`](../interfaces/EmitFileOptions.md) | File Emitter options | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md index f5686ff14..e7cfdc910 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md @@ -10,7 +10,7 @@ function ensureTrailingDirectorySeparator(path): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/explainStringTemplateNotSerializable.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/explainStringTemplateNotSerializable.md index 41ff0e766..696f9ae0a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/explainStringTemplateNotSerializable.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/explainStringTemplateNotSerializable.md @@ -12,7 +12,7 @@ get a list of diagnostic explaining why this string template cannot be converted ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `stringTemplate` | [`StringTemplate`](../interfaces/StringTemplate.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md index e10b9cd96..3a79a172c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md @@ -10,7 +10,7 @@ function exprIsBareIdentifier(expr): expr is TypeReferenceNode & Object ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `expr` | [`Expression`](../type-aliases/Expression.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md index 6a5edd01f..35f1b6f13 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md @@ -17,7 +17,7 @@ a new anonymous model with only the filtered properties. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | - | | `model` | [`Model`](../interfaces/Model.md) | The input model to filter. | | `filter` | (`property`) => `boolean` | The filter to apply. Properties are kept when this returns true. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md index da2fbd9f0..f2e407f42 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md @@ -7,16 +7,16 @@ title: "[F] finishTypeForProgram" function finishTypeForProgram(program, typeDef): T ``` -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* [`Type`](../type-aliases/Type.md) | ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `typeDef` | `T` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md index 87f5dc4a9..1f1155d5d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md @@ -10,7 +10,7 @@ function formatDiagnostic(diagnostic): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `diagnostic` | [`Diagnostic`](../interfaces/Diagnostic.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md index c4a9549ae..070682dd1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md @@ -7,12 +7,23 @@ title: "[F] formatIdentifier" function formatIdentifier(sv): string ``` +Print a string as a TypeSpec identifier. If the string is a valid identifier, return it as is otherwise wrap it into backticks. + ## Parameters -| Parameter | Type | -| :------ | :------ | -| `sv` | `string` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sv` | `string` | Identifier string value. | ## Returns `string` + +Identifier string as it would be represented in a TypeSpec file. + +## Example + +```ts +printIdentifier("foo") // foo +printIdentifier("foo bar") // `foo bar` +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md index 0faafa3f2..8f3ad932c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md @@ -10,7 +10,7 @@ function formatTypeSpec(code, prettierConfig?): Promise ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `code` | `string` | | `prettierConfig`? | `Options` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md index 696e70645..57249f9a0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md @@ -10,7 +10,7 @@ function getAllTags(program, target): string[] | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Interface`](../interfaces/Interface.md) \| [`Namespace`](../interfaces/Namespace.md) \| [`Operation`](../interfaces/Operation.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md index db729975b..86878a43d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md @@ -20,7 +20,7 @@ getAnyExtensionFromPath("/path/to.ext/file") === "" ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md index 7a5f5fc43..f1d597f50 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md @@ -38,7 +38,7 @@ getBaseFileName("file://") === "" ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md index e6dd42af2..5b3ac0d1e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md @@ -12,7 +12,7 @@ Return the deprecated message or undefined if not deprecated ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `type` | [`Type`](../type-aliases/Type.md) | Type | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md index dfe3afbb1..10842f680 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md @@ -12,7 +12,7 @@ Returns complete deprecation details for the given type or node ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `typeOrNode` | [`Type`](../type-aliases/Type.md) \| [`Node`](../type-aliases/Node.md) | A Type or Node to check for deprecation | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md index c1bdae352..c94234bb0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md @@ -10,7 +10,7 @@ function getDirectoryPath(path): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md index 931bfb788..521247849 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md @@ -10,7 +10,7 @@ function getDiscriminatedTypes(program): [Model | Union, Discriminator][] ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md index f8fa1bede..acb979b50 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md @@ -10,7 +10,7 @@ function getDiscriminatedUnion(type, discriminator): [DiscriminatedUnion, readon ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md) | | `discriminator` | [`Discriminator`](../interfaces/Discriminator.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md index 7630d2496..0bf73a3ac 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md @@ -10,7 +10,7 @@ function getDiscriminator(program, entity): Discriminator | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `entity` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md index a6790e8eb..74b0c99b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md @@ -12,7 +12,7 @@ Get the documentation string for the given type. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `target` | [`Type`](../type-aliases/Type.md) | Type | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md index e46fc2a95..06d7e38a9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md @@ -12,7 +12,7 @@ Get the documentation information for the given type. In most cases you probably ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `target` | [`Type`](../type-aliases/Type.md) | Type | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md index 83eed9216..017a9d41b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md @@ -24,7 +24,7 @@ best name for the remaining properties is `SomeName`. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | - | | `model` | [`Model`](../interfaces/Model.md) | The input model | | `filter`? | (`property`) => `boolean` | An optional filter to apply to the input model's properties. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md index efd937feb..92e5aba31 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md @@ -10,7 +10,7 @@ function getEncode(program, target): EncodeData | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEntityName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEntityName.md index 02cf18417..7259a6ec7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEntityName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEntityName.md @@ -10,7 +10,7 @@ function getEntityName(entity, options?): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `entity` | [`Entity`](../type-aliases/Entity.md) | | `options`? | [`TypeNameOptions`](../interfaces/TypeNameOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md index 2f9281311..5ae0418c9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md @@ -12,7 +12,7 @@ Get the documentation string for the return errors types of an operation. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `target` | [`Operation`](../interfaces/Operation.md) | Type | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md index 58a2cf81d..94bd3c9d0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md @@ -12,7 +12,7 @@ Get the documentation information for the return errors types of an operation. I ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `target` | [`Operation`](../interfaces/Operation.md) | Type | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getExamples.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getExamples.md new file mode 100644 index 000000000..bc421f358 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getExamples.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getExamples" + +--- +```ts +function getExamples(program, target): readonly Example[] +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | \| [`Enum`](../interfaces/Enum.md) \| [`Model`](../interfaces/Model.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) \| [`Union`](../interfaces/Union.md) | + +## Returns + +readonly [`Example`](../interfaces/Example.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md index 45ebc5796..af3cfcd62 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md @@ -13,7 +13,7 @@ function getFirstAncestor( ## Parameters | Parameter | Type | Default value | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `node` | [`Node`](../type-aliases/Node.md) | `undefined` | | `test` | [`NodeCallback`](../type-aliases/NodeCallback.md)<`boolean`\> | `undefined` | | `includeSelf` | `boolean` | `false` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md index e44f59219..ef3b1fc08 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md @@ -10,7 +10,7 @@ function getFormat(program, target): string | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md index 80f41cb70..a4eb4c881 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md @@ -10,7 +10,7 @@ function getFriendlyName(program, target): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md index aa26f4ed2..5a7d14c90 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md @@ -10,7 +10,7 @@ function getFullyQualifiedSymbolName(sym, options?): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `sym` | `undefined` \| [`Sym`](../interfaces/Sym.md) | | `options`? | `object` | | `options.useGlobalPrefixAtTopLevel`? | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md index 703d580a5..2bf7cc003 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md @@ -10,7 +10,7 @@ function getIdentifierContext(id): IdentifierContext ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `id` | [`IdentifierNode`](../interfaces/IdentifierNode.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md index 25269d87b..ab907b95d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md @@ -10,7 +10,7 @@ function getKeyName(program, property): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md index 5b68d4b8b..054feb115 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md @@ -10,7 +10,7 @@ function getKnownValues(program, target): Enum | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md index 3619f11c9..493868a72 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md @@ -10,7 +10,7 @@ function getListOperationType(program, target): Model | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md index a42790b24..1cb2128f1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md @@ -10,7 +10,7 @@ function getLocationContext(program, type): LocationContext ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `type` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md index 92658b17d..c7d2f3348 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md @@ -10,7 +10,7 @@ function getMaxItems(program, target): number | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItemsAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItemsAsNumeric.md index ab5c7ede0..209d3b531 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItemsAsNumeric.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItemsAsNumeric.md @@ -10,7 +10,7 @@ function getMaxItemsAsNumeric(program, target): Numeric | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md index f61a5c404..705250a6f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md @@ -10,7 +10,7 @@ function getMaxLength(program, target): number | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLengthAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLengthAsNumeric.md index 5f46692eb..9b8be304f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLengthAsNumeric.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLengthAsNumeric.md @@ -12,7 +12,7 @@ Get the minimum length of a string type as a [Numeric](Numeric.md) value. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Current program | | `target` | [`Type`](../type-aliases/Type.md) | Type with the `@maxLength` decorator | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md index fd5bb3dac..4e0fd1ee7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md @@ -10,7 +10,7 @@ function getMaxValue(program, target): number | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueAsNumeric.md index e6341ea1a..55bab431a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueAsNumeric.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueAsNumeric.md @@ -10,7 +10,7 @@ function getMaxValueAsNumeric(program, target): Numeric | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md index 7db657f8f..71493c7fa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md @@ -10,7 +10,7 @@ function getMaxValueExclusive(program, target): number | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusiveAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusiveAsNumeric.md index 7a4623d75..7be6a9d78 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusiveAsNumeric.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusiveAsNumeric.md @@ -10,7 +10,7 @@ function getMaxValueExclusiveAsNumeric(program, target): Numeric | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md index 4d6eafafb..22d992f6c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md @@ -10,7 +10,7 @@ function getMinItems(program, target): number | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItemsAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItemsAsNumeric.md index ca98f8106..70ca2a8b0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItemsAsNumeric.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItemsAsNumeric.md @@ -10,7 +10,7 @@ function getMinItemsAsNumeric(program, target): Numeric | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md index b0e1ff6e0..f93ca4335 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md @@ -10,7 +10,7 @@ function getMinLength(program, target): number | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLengthAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLengthAsNumeric.md index 058bf7102..5d793494e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLengthAsNumeric.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLengthAsNumeric.md @@ -12,7 +12,7 @@ Get the minimum length of a string type as a [Numeric](Numeric.md) value. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Current program | | `target` | [`Type`](../type-aliases/Type.md) | Type with the `@minLength` decorator | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md index 094b9ae81..27f50c048 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md @@ -10,7 +10,7 @@ function getMinValue(program, target): number | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueAsNumeric.md index 250f06b4a..d550c5af4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueAsNumeric.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueAsNumeric.md @@ -10,7 +10,7 @@ function getMinValueAsNumeric(program, target): Numeric | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md index 586108ed9..650b0a7db 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md @@ -10,7 +10,7 @@ function getMinValueExclusive(program, target): number | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusiveAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusiveAsNumeric.md index a95985cbf..14ae7ddf9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusiveAsNumeric.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusiveAsNumeric.md @@ -10,7 +10,7 @@ function getMinValueExclusiveAsNumeric(program, target): Numeric | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md index bd73f8e81..9464104fd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md @@ -12,7 +12,7 @@ Return the full name of the namespace(e.g. "Foo.Bar") ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `type` | [`Namespace`](../interfaces/Namespace.md) | namespace type | | `options`? | [`TypeNameOptions`](../interfaces/TypeNameOptions.md) | | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md index eda4e5f6a..fe6dd065c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md @@ -17,7 +17,7 @@ Resolve the node in the syntax tree that that is at the given position. ### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | TypeSpec Script node | | `position` | `number` | Position | | `filter`? | (`node`) => `boolean` | Filter if wanting to return a parent containing node early. | @@ -35,16 +35,16 @@ function getNodeAtPosition( filter): T | undefined ``` -### Type parameters +### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* [`Node`](../type-aliases/Node.md) | ### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | | `position` | `number` | | `filter` | (`node`) => `node is T` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPositionDetail.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPositionDetail.md index af0b42036..a3431e720 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPositionDetail.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPositionDetail.md @@ -13,7 +13,7 @@ function getNodeAtPositionDetail( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | | `position` | `number` | | `filter` | (`node`, `flag`) => `boolean` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md index 2a5da5178..8e557a9f1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md @@ -10,7 +10,7 @@ function getNormalizedAbsolutePath(fileName, currentDirectory): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `fileName` | `string` | | `currentDirectory` | `undefined` \| `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md index fec204337..58dc97b73 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md @@ -10,7 +10,7 @@ function getNormalizedAbsolutePathWithoutRoot(fileName, currentDirectory): strin ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `fileName` | `string` | | `currentDirectory` | `undefined` \| `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md index 827f54bb9..b160944b2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md @@ -19,7 +19,7 @@ getNormalizedPathComponents("to/dir/../file.ext", "/path/") === ["/", "path", "t ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | | `currentDirectory` | `undefined` \| `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOpExamples.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOpExamples.md new file mode 100644 index 000000000..f778e05e9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOpExamples.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getOpExamples" + +--- +```ts +function getOpExamples(program, target): OpExample[] +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | + +## Returns + +[`OpExample`](../interfaces/OpExample.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md index f2e324530..552a59327 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md @@ -12,7 +12,7 @@ If the given operation overloads another operation, return that operation. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `operation` | [`Operation`](../interfaces/Operation.md) | The operation to check for an overload target. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md index ae1267531..6a301c2e9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md @@ -12,7 +12,7 @@ Get all operations that are marked as overloads of the given operation ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `operation` | [`Operation`](../interfaces/Operation.md) | Operation | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md index 2d5344c5f..8e97482e4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md @@ -13,7 +13,7 @@ given property, if any. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md index 7d21e463c..d35acc4ba 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md @@ -12,7 +12,7 @@ Returns the visibilities of the parameters of the given operation, if provided w ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `entity` | [`Operation`](../interfaces/Operation.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md index 4ac4e27aa..817d08925 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md @@ -12,7 +12,7 @@ Lookup and find the node ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `node` | [`Node`](../type-aliases/Node.md) | Node | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md index 29a3dfdc3..0e8d46501 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md @@ -40,7 +40,7 @@ getPathComponents("file://") === ["file://"] ## Parameters | Parameter | Type | Default value | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `path` | `string` | `undefined` | | `currentDirectory` | `string` | `""` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md index d9b96b688..ce90c7439 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md @@ -17,7 +17,7 @@ getPathFromPathComponents(["/", "path", "to", "file.ext"]) === "/path/to/file.ex ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `pathComponents` | readonly `string`[] | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md index 16b6c9b14..b7a154521 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md @@ -12,7 +12,7 @@ Gets the pattern regular expression associated with a given type, if one has bee ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | the Program containing the target Type | | `target` | [`Type`](../type-aliases/Type.md) | the type to get the pattern for | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md index bc7de4ca2..75f6df6b6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md @@ -13,7 +13,7 @@ has been set. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | the Program containing the target Type | | `target` | [`Type`](../type-aliases/Type.md) | the type to get the pattern data for | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md index 46de18bdb..1de23113f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md @@ -12,7 +12,7 @@ Adjust the given postion backwards before any trivia. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | | `pos` | `number` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md index 471dd9632..aa5c771f8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md @@ -15,7 +15,7 @@ Get the projected name of the given entity for the given projection. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `target` | [`Type`](../type-aliases/Type.md) | Target | | `projectionName` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md index a975852e6..a4a0c4dee 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md @@ -10,7 +10,7 @@ function getProjectedNames(program, target): ReadonlyMap | undef ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `target` | [`Type`](../type-aliases/Type.md) | Target | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md index 3da14e774..f08ad6a90 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md @@ -10,7 +10,7 @@ function getProperty(type, propertyName): ModelProperty | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Model`](../interfaces/Model.md) | | `propertyName` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md index b72a0dcaf..3c9629d10 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md @@ -12,7 +12,7 @@ Return the type of the property or the model itself. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md index 1f1210381..8e93bfcf5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md @@ -17,7 +17,7 @@ Gets a relative path that can be used to traverse between `from` and `to`. ### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `from` | `string` | | `to` | `string` | | `ignoreCase` | `boolean` | @@ -40,7 +40,7 @@ Gets a relative path that can be used to traverse between `from` and `to`. ### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `fromDirectory` | `string` | | `to` | `string` | | `getCanonicalFileName` | `GetCanonicalFileName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md index ca43fb690..e45612fd9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md @@ -12,7 +12,7 @@ Returns the visibilities of the return type of the given operation, if provided ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `entity` | [`Operation`](../interfaces/Operation.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md index 83dace9fb..23d889cf8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md @@ -12,7 +12,7 @@ Get the documentation string for the return success types of an operation. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `target` | [`Operation`](../interfaces/Operation.md) | Type | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md index 5990ac691..74014b2a7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md @@ -12,7 +12,7 @@ Get the documentation information for the return success types of an operation. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `target` | [`Operation`](../interfaces/Operation.md) | Type | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md index 572edfd5f..15fc2fb4f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md @@ -34,7 +34,7 @@ getRootLength("http://server/path") === 14 // "http://server/" ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md index 35d9003f7..befc7ff73 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md @@ -12,7 +12,7 @@ Get the service information for the given namespace. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `namespace` | [`Namespace`](../interfaces/Namespace.md) | Service namespace | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md index c5ee3bd52..1d224ae84 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md @@ -10,7 +10,7 @@ function getSourceFileKindFromExt(path): SourceFileKind | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md index 30cb67334..9cf62238a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md @@ -12,7 +12,7 @@ function getSourceLocation(target, options?): SourceLocation ### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | | `options`? | [`SourceLocationOptions`](../interfaces/SourceLocationOptions.md) | @@ -29,7 +29,7 @@ function getSourceLocation(target, options?): undefined ### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `target` | `undefined` \| *typeof* [`NoTarget`](../variables/NoTarget.md) | | `options`? | [`SourceLocationOptions`](../interfaces/SourceLocationOptions.md) | @@ -46,7 +46,7 @@ function getSourceLocation(target, options?): SourceLocation | undefined ### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `target` | `undefined` \| [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | | `options`? | [`SourceLocationOptions`](../interfaces/SourceLocationOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md index c6796052d..40a7262df 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md @@ -10,7 +10,7 @@ function getSummary(program, type): string | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `type` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md index 1c6f1a632..e62829240 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md @@ -10,7 +10,7 @@ function getTags(program, target): string[] ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md index 8378f0431..2a8f075b2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md @@ -10,7 +10,7 @@ function getTypeName(type, options?): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Type`](../type-aliases/Type.md) | | `options`? | [`TypeNameOptions`](../interfaces/TypeNameOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md index cc0a0d378..338d1f77f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md @@ -10,7 +10,7 @@ function getVisibility(program, target): string[] | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md index 6f8d34e8d..2c0ea29c3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md @@ -10,7 +10,7 @@ function hasParseError(node): number | true ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `node` | [`Node`](../type-aliases/Node.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md index e02f22520..3faf6cf55 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md @@ -15,7 +15,7 @@ Get the projected name of the given entity for the given projection. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `target` | [`Type`](../type-aliases/Type.md) | Target | | `projectionName` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md index c61f1cb26..6f3aab03f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md @@ -12,7 +12,7 @@ Determines whether a path has a trailing separator (`/` or `\\`). ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md index 400c61382..3c10a8c37 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md @@ -9,16 +9,16 @@ function ignoreDiagnostics(result): T Ignore the diagnostics emitted by the diagnostic accessor pattern and just return the actual result. -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` | ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `result` | [`DiagnosticResult`](../type-aliases/DiagnosticResult.md)<`T`\> | Accessor pattern tuple result including the actual result and the list of diagnostics. | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md index 8df4f5a1f..2c0c7d89d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md @@ -12,7 +12,7 @@ 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. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md index d58bd82f3..343acf8d1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md @@ -12,7 +12,7 @@ Determines whether a charCode corresponds to `/` or ``. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `charCode` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md index 901d4caf4..850a731e4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md @@ -10,7 +10,7 @@ function isArrayModelType(program, type): type is ArrayModelType ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | - | | `type` | [`Model`](../interfaces/Model.md) | Model type | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md index 82669edb1..b771122aa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md @@ -7,23 +7,23 @@ title: "[F] isCadlValueTypeOf" function isCadlValueTypeOf(target, expectedType): target is InferredTypeSpecValue ``` -## Type parameters +Check if the given target is of any of the TypeSpec types. -| Type parameter | -| :------ | +## Type Parameters + +| Type Parameter | +| ------ | | `K` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | ## Parameters -| Parameter | Type | -| :------ | :------ | -| `target` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | -| `expectedType` | `K` \| readonly `K`[] | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `target` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | Target to validate. | +| `expectedType` | `K` \| readonly `K`[] | One or multiple allowed TypeSpec types. | ## Returns `target is InferredTypeSpecValue` -## Deprecated - -use isTypeSpecValueTypeOf +boolean if the target is of one of the allowed types. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md index 8f644f595..7d76cb2a4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md @@ -10,7 +10,7 @@ function isComment(token): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `token` | [`Token`](../enumerations/Token.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md index d1223a851..f75bdabed 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md @@ -15,8 +15,8 @@ Check if the given type is declared in the specified namespace or, optionally, i ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | -| `type` | \| [`Enum`](../interfaces/Enum.md) \| [`Interface`](../interfaces/Interface.md) \| [`Model`](../interfaces/Model.md) \| [`Namespace`](../interfaces/Namespace.md) \| [`Operation`](../interfaces/Operation.md) | Type | +| ------ | ------ | ------ | +| `type` | \| [`Enum`](../interfaces/Enum.md) \| [`Interface`](../interfaces/Interface.md) \| [`Model`](../interfaces/Model.md) \| [`Namespace`](../interfaces/Namespace.md) \| [`Operation`](../interfaces/Operation.md) | Type | | `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | | `options` | `object` | - | | `options.recursive`? | `boolean` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md index f457a276f..3f4cb102a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md @@ -14,7 +14,7 @@ Check if the type is a declared type. This include: ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Type`](../type-aliases/Type.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md index 0409f08b2..4338b5566 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md @@ -12,7 +12,7 @@ Check if the given type is deprecated ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `type` | [`Type`](../type-aliases/Type.md) | Type | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md index e4acdd830..3bbdd7746 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md @@ -12,7 +12,7 @@ Check if the type is an error model or a descendant of an error model. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md index 08ee7caea..c40b119e2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md @@ -10,7 +10,7 @@ function isErrorType(type): type is ErrorType ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Entity`](../type-aliases/Entity.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md index 051f4d4c7..100ec38be 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md @@ -12,7 +12,7 @@ Check if the given namespace is the global namespace ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md index bbff894c8..aad01998f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md @@ -10,7 +10,7 @@ function isImportStatement(node): node is ImportStatementNode ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `node` | [`Node`](../type-aliases/Node.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md index c21ea5549..80d120dda 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md @@ -13,7 +13,7 @@ function isIntrinsicType( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `type` | [`Scalar`](../interfaces/Scalar.md) | | `kind` | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md index c93c8edaa..dddc4865c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md @@ -10,7 +10,7 @@ function isKey(program, property): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md index 6799df9a3..da03de31d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md @@ -10,7 +10,7 @@ function isKeyword(token): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `token` | [`Token`](../enumerations/Token.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md index e2da25347..d90af707b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md @@ -10,7 +10,7 @@ function isListOperation(program, target): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Operation`](../interfaces/Operation.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md index cb3765325..d1bd23f0e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md @@ -10,7 +10,7 @@ function isModifier(token): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `token` | [`Token`](../enumerations/Token.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md index d6a600458..f486956a5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md @@ -10,7 +10,7 @@ function isNeverType(type): type is NeverType ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Entity`](../type-aliases/Entity.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md index 6eb63cc84..c2cbce259 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md @@ -10,7 +10,7 @@ function isNullType(type): type is NullType ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Entity`](../type-aliases/Entity.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumeric.md index b82cdcc2b..d78aa19a6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumeric.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumeric.md @@ -12,7 +12,7 @@ Check if the given arg is a Numeric ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `arg` | `unknown` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md index 20586a42a..1448adaa6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md @@ -10,7 +10,7 @@ function isNumericType(program, target): target is Scalar ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md index ced9f6511..163fc7c15 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md @@ -10,7 +10,7 @@ function isPathAbsolute(path): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md index 50f8fbc75..bcc25477a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md @@ -10,7 +10,7 @@ function isProjectedProgram(program): program is ProjectedProgram ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md index b22d681c9..408da7104 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md @@ -10,7 +10,7 @@ function isPunctuation(token): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `token` | [`Token`](../enumerations/Token.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md index f778bb369..389805398 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md @@ -12,7 +12,7 @@ Check if a model is an array type. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | - | | `type` | [`Model`](../interfaces/Model.md) | Model type | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md index 54d2b1d43..7647ae8e2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md @@ -10,7 +10,7 @@ function isSecret(program, target): boolean | undefined ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md index e21fa6916..726c7fa6d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md @@ -12,7 +12,7 @@ Check if the namespace is defined as a service. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md index 9de4e0b44..a78c54b1b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md @@ -10,7 +10,7 @@ function isStatementKeyword(token): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `token` | [`Token`](../enumerations/Token.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md index a051e6e8b..929061164 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md @@ -10,7 +10,7 @@ function isStdNamespace(namespace): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `namespace` | [`Namespace`](../interfaces/Namespace.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md index 2886e1194..218a2e352 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md @@ -10,7 +10,7 @@ function isStringType(program, target): target is Scalar ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | | `target` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md index 493e3c5c2..b7c69e136 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md @@ -12,7 +12,7 @@ Resolve if the type is a template type declaration(Non initialized template type ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`TemplatedType`](../type-aliases/TemplatedType.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md index 2db06f844..744447c26 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md @@ -12,7 +12,7 @@ Resolve if the type was created from a template type or is a template type decla ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`TemplatedType`](../type-aliases/TemplatedType.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md index 3525c3149..0d8c2e869 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md @@ -12,7 +12,7 @@ Check the given type is a finished template instance. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Type`](../type-aliases/Type.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md index 4875a8e52..43352e50f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md @@ -10,7 +10,7 @@ function isTrivia(token): boolean ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `token` | [`Token`](../enumerations/Token.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isType.md index 3a896924d..8469dbaf6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isType.md @@ -10,7 +10,7 @@ function isType(entity): entity is Type ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `entity` | [`Entity`](../type-aliases/Entity.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md index d07d87a18..26ec7043b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md @@ -9,16 +9,16 @@ function isTypeSpecValueTypeOf(target, expectedType): target is InferredTypeS Check if the given target is of any of the TypeSpec types. -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `K` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `target` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | Target to validate. | | `expectedType` | `K` \| readonly `K`[] | One or multiple allowed TypeSpec types. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md index 381056158..24030896e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md @@ -10,7 +10,7 @@ function isUnknownType(type): type is UnknownType ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Entity`](../type-aliases/Entity.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md index d880610ea..8ac723af4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md @@ -12,7 +12,7 @@ Determines whether a path starts with a URL scheme (e.g. starts with `http://`, ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isValue.md index efb9515f7..9b69397ad 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isValue.md @@ -10,7 +10,7 @@ function isValue(entity): entity is Value ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `entity` | [`Entity`](../type-aliases/Entity.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md index 5a5bb4aad..aae20a2d1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md @@ -13,7 +13,7 @@ function isVisible( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | | `visibilities` | readonly `string`[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md index 3f101edaa..3c9dadabd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md @@ -10,7 +10,7 @@ function isVoidType(type): type is VoidType ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Entity`](../type-aliases/Entity.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md index 4ecc31a2e..d2d794b83 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md @@ -27,7 +27,7 @@ joinPaths("file:///path", "file:///to", "file.ext") === "file:///to/file.ext" ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | | ...`paths` | (`undefined` \| `string`)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md index 428f56880..2887afa13 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md @@ -12,7 +12,7 @@ List operations in the given container. Will list operation recursively by defau ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `container` | [`Interface`](../interfaces/Interface.md) \| [`Namespace`](../interfaces/Namespace.md) | Container. | | `options` | [`ListOperationOptions`](../interfaces/ListOperationOptions.md) | Options. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md index 16bbbb28d..a5f72c3fd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md @@ -12,7 +12,7 @@ List all the services defined in the TypeSpec program ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md index b72c0e88d..e9c139dd5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md @@ -10,7 +10,7 @@ function logDiagnostics(diagnostics, logger): void ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `diagnostics` | readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] | | `logger` | [`LogSink`](../interfaces/LogSink.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md index dc3b7a12f..15cce4876 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md @@ -18,7 +18,7 @@ when verbose output is disabled. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `messageOrCallback` | `string` \| (`log`) => `void` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md index dc66d211f..1134c2c7f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md @@ -12,7 +12,7 @@ Create a Semantic node listener from an event emitter. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `eventEmitter` | [`EventEmitter`](../classes/EventEmitter.md)<[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md)\> | Event emitter. | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md index a8718dc07..c91f6df69 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md @@ -15,7 +15,7 @@ Mark the given type as deprecated with the provided details. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `type` | [`Type`](../type-aliases/Type.md) | Type | | `details` | [`DeprecationDetails`](../interfaces/DeprecationDetails.md) | Details of the deprecation | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md index 85f794496..e43963867 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md @@ -15,7 +15,7 @@ Navigate all types in the program. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program to navigate. | | `listeners` | [`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) | Listener called when visiting types. | | `options` | [`NavigationOptions`](../interfaces/NavigationOptions.md) | Navigation options. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md index ecc4d5f7c..cb92fa21f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md @@ -15,7 +15,7 @@ Navigate the given type and all the types that are used in it. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `type` | [`Type`](../type-aliases/Type.md) | Type to navigate. | | `listeners` | [`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) | Listener for the types found. | | `options` | [`NavigationOptions`](../interfaces/NavigationOptions.md) | Navigation options | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md index 86249732e..244efa842 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md @@ -13,7 +13,7 @@ function navigateTypesInNamespace( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `namespace` | [`Namespace`](../interfaces/Namespace.md) | | `listeners` | `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` | | `options` | [`NamespaceNavigationOptions`](../interfaces/NamespaceNavigationOptions.md) & [`NavigationOptions`](../interfaces/NavigationOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md index dc2ae9deb..284dbd5f5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md @@ -10,7 +10,7 @@ function normalizePath(path): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md index eae45037c..6bed6a08c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md @@ -12,7 +12,7 @@ Normalize path separators, converting `\` into `/`. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md index ba5a2fd75..4b5d4c792 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md @@ -7,16 +7,16 @@ title: "[F] paramMessage" function paramMessage(strings, ...keys): CallableMessage ``` -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* `string`[] | ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `strings` | readonly `string`[] | | ...`keys` | `T` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md index 4be9ea71c..4e8de3d42 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md @@ -10,7 +10,7 @@ function parse(code, options): TypeSpecScriptNode ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `code` | `string` \| [`SourceFile`](../interfaces/SourceFile.md) | | `options` | [`ParseOptions`](../interfaces/ParseOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md index ba97e27a2..dec3d55ad 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md @@ -10,7 +10,7 @@ function parseStandaloneTypeReference(code): [TypeReferenceNode, readonly Diagno ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `code` | `string` \| [`SourceFile`](../interfaces/SourceFile.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/positionInRange.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/positionInRange.md index 179a20faa..a4e53cb3c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/positionInRange.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/positionInRange.md @@ -16,7 +16,7 @@ remark: if range.pos is -1 means no start point found, so return false ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `position` | `number` | | `range` | [`TextRange`](../interfaces/TextRange.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md index 7a1c0db09..d8a452572 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md @@ -13,7 +13,7 @@ function projectProgram( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `projections` | [`ProjectionApplication`](../interfaces/ProjectionApplication.md)[] | | `startNode`? | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md index 78e584526..cedef8563 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md @@ -13,7 +13,7 @@ Reduce an array of path components to a more simplified path by navigating any ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `components` | readonly `string`[] | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md index 2c53c2cbb..b19fd4221 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md @@ -17,7 +17,7 @@ removeTrailingDirectorySeparator("/path/to/file.ext/") === "/path/to/file.ext" ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md index f7e65b5d8..76779f294 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md @@ -15,7 +15,7 @@ Report a deprecated diagnostic. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | TypeSpec Program. | | `message` | `string` | Message describing the deprecation. | | `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | Target of the deprecation. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md index 5b382390b..6ae0bc99f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md @@ -12,7 +12,7 @@ Resolve the compiler options for the given entrypoint by resolving the tspconfig ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `host` | [`CompilerHost`](../interfaces/CompilerHost.md) | Compiler host | | `options` | [`ResolveCompilerOptionsOptions`](../interfaces/ResolveCompilerOptionsOptions.md) | | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md index f1f69a4b4..244b64924 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md @@ -16,7 +16,7 @@ If a specific value was provided by `@encodedName` decorator for that mime type ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | | `target` | [`Type`](../type-aliases/Type.md) & `object` | | `mimeType` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveLinterDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveLinterDefinition.md index 02a10a5f9..057ca6412 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveLinterDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveLinterDefinition.md @@ -12,7 +12,7 @@ Resolve the linter definition ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `libName` | `string` | | `linter` | [`LinterDefinition`](../interfaces/LinterDefinition.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md index fd7078459..ee764c29f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md @@ -15,7 +15,7 @@ Resolve a module ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `host` | [`ResolveModuleHost`](../interfaces/ResolveModuleHost.md) | | | `name` | `string` | | | `options` | [`ResolveModuleOptions`](../interfaces/ResolveModuleOptions.md) | | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md index 08308fb9e..7acc97f5f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md @@ -19,7 +19,7 @@ resolvePath("/path", "dir", "..", "to", "file.ext") === "path/to/file.ext" ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | | ...`paths` | (`undefined` \| `string`)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md index 5d6158949..bd6a4887c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md @@ -13,7 +13,7 @@ Will recursively scan all namespace, interfaces and operations contained inside ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `types` | [`OperationContainer`](../type-aliases/OperationContainer.md) \| [`OperationContainer`](../type-aliases/OperationContainer.md)[] | Entrypoint(s) namespace, interface or operations to get usage from. | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md index 6d4449d13..cb8bd9b66 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md @@ -12,16 +12,16 @@ function scopeNavigationToNamespace( Scope the current navigation to the given namespace. -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` | ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace the traversal shouldn't leave. | | `listeners` | `T` | Type listeners. | | `options` | [`NamespaceNavigationOptions`](../interfaces/NamespaceNavigationOptions.md) | Scope options | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/serializeValueAsJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/serializeValueAsJson.md new file mode 100644 index 000000000..19b74a65f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/serializeValueAsJson.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] serializeValueAsJson" + +--- +```ts +function serializeValueAsJson( + program, + value, + type, + encodeAs?): unknown +``` + +Serialize the given TypeSpec value as a JSON object using the given type and its encoding annotations. +The Value MUST be assignable to the given type. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `value` | [`Value`](../type-aliases/Value.md) | +| `type` | [`Type`](../type-aliases/Type.md) | +| `encodeAs`? | [`EncodeData`](../interfaces/EncodeData.md) | + +## Returns + +`unknown` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md index 616332b4f..62f175a44 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md @@ -7,17 +7,15 @@ title: "[F] setCadlNamespace" function setCadlNamespace(namespace, ...functions): void ``` +Set the TypeSpec namespace for that function. + ## Parameters -| Parameter | Type | -| :------ | :------ | -| `namespace` | `string` | -| ...`functions` | (...`args`) => `any`[] | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `namespace` | `string` | Namespace string (e.g. "Foo.Bar") | +| ...`functions` | (...`args`) => `any`[] | Functions | ## Returns `void` - -## Deprecated - -use setTypeSpecNamespace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md index 07a9edfd1..93f084c06 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md @@ -12,7 +12,7 @@ Set the TypeSpec namespace for that function. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `namespace` | `string` | Namespace string (e.g. "Foo.Bar") | | ...`functions` | (...`args`) => `any`[] | Functions | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipContinuousIdentifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipContinuousIdentifier.md index 7c00a1f1f..f8d752cc6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipContinuousIdentifier.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipContinuousIdentifier.md @@ -13,7 +13,7 @@ function skipContinuousIdentifier( ## Parameters | Parameter | Type | Default value | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `input` | `string` | `undefined` | | `position` | `number` | `undefined` | | `isBackward` | `boolean` | `false` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md index 25e217faf..50916124e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md @@ -13,7 +13,7 @@ function skipTrivia( ## Parameters | Parameter | Type | Default value | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `input` | `string` | `undefined` | | | `position` | `number` | `undefined` | | | `endPosition` | `number` | `input.length` | exclude | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTriviaBackward.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTriviaBackward.md index ad8615e09..e1dc046b6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTriviaBackward.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTriviaBackward.md @@ -13,7 +13,7 @@ function skipTriviaBackward( ## Parameters | Parameter | Type | Default value | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | `undefined` | | | `position` | `number` | `undefined` | | | `endPosition` | `number` | `-1` | exclude | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md index 5cef2cd6b..b8d7dab75 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md @@ -13,7 +13,7 @@ function skipWhiteSpace( ## Parameters | Parameter | Type | Default value | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `input` | `string` | `undefined` | | `position` | `number` | `undefined` | | `endPosition` | `number` | `input.length` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md index d821c2a5d..85865ba0b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md @@ -10,7 +10,7 @@ function stringTemplateToString(stringTemplate): [string, readonly Diagnostic[]] ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `stringTemplate` | [`StringTemplate`](../interfaces/StringTemplate.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md index a9bd6a4c1..2c51af6c8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md @@ -10,16 +10,16 @@ function 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 +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` | ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `typespecType` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | The type to convert to Json data | | `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | The diagnostic target in case of errors. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md index e79ce2117..fc7df2caf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md @@ -17,7 +17,7 @@ Useful to check for decorator usage that conflicts with another decorator. ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | Decorator context | | `type` | [`Type`](../type-aliases/Type.md) | The type to check | | `badDecorator` | [`DecoratorFunction`](../interfaces/DecoratorFunction.md) | The decorator we don't want present | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md index 21d861e35..40dc8bb32 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md @@ -14,7 +14,7 @@ function validateDecoratorParamCount( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `min` | `number` | | `max` | `undefined` \| `number` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md index 6d7022c3f..1f68e42ac 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md @@ -13,40 +13,16 @@ function validateDecoratorParamType( Validate a decorator parameter has the correct type. -## Type parameters +## Type Parameters -| Type parameter | -| :------ | -| `K` *extends* - \| `"Boolean"` - \| `"Decorator"` - \| `"Enum"` - \| `"EnumMember"` - \| `"FunctionParameter"` - \| `"Function"` - \| `"Interface"` - \| `"Intrinsic"` - \| `"Model"` - \| `"ModelProperty"` - \| `"Namespace"` - \| `"Number"` - \| `"Object"` - \| `"Operation"` - \| `"Projection"` - \| `"Scalar"` - \| `"ScalarConstructor"` - \| `"String"` - \| `"StringTemplate"` - \| `"StringTemplateSpan"` - \| `"TemplateParameter"` - \| `"Tuple"` - \| `"Union"` - \| `"UnionVariant"` | +| Type Parameter | +| ------ | +| `K` *extends* \| `"Boolean"` \| `"Decorator"` \| `"Enum"` \| `"EnumMember"` \| `"FunctionParameter"` \| `"Function"` \| `"Interface"` \| `"Intrinsic"` \| `"Model"` \| `"ModelProperty"` \| `"Namespace"` \| `"Number"` \| `"Object"` \| `"Operation"` \| `"Projection"` \| `"Scalar"` \| `"ScalarConstructor"` \| `"String"` \| `"StringTemplate"` \| `"StringTemplateSpan"` \| `"TemplateParameter"` \| `"Tuple"` \| `"Union"` \| `"UnionVariant"` | ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | Program | | `target` | [`Type`](../type-aliases/Type.md) | Decorator target | | `value` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | Value of the parameter. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md index aeaeca966..c952f3b4f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md @@ -13,16 +13,16 @@ function validateDecoratorTarget( Validate the decorator target is matching the expected value. -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `K` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | ## Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | | `target` | [`Type`](../type-aliases/Type.md) | | | `decoratorName` | `string` | | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md index 41b753da9..1defb17ad 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md @@ -14,7 +14,7 @@ function validateDecoratorTargetIntrinsic( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `decoratorName` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md index cdb59d96b..0f207c527 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md @@ -13,7 +13,7 @@ function validateDecoratorUniqueOnNode( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `type` | [`Type`](../type-aliases/Type.md) | | `decorator` | [`DecoratorFunction`](../interfaces/DecoratorFunction.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md index c40dfb2c2..ce8bba2ea 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md @@ -7,16 +7,16 @@ title: "[F] visitChildren" function visitChildren(node, cb): T | undefined ``` -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` | ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `node` | [`Node`](../type-aliases/Node.md) | | `cb` | [`NodeCallback`](../type-aliases/NodeCallback.md)<`T`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md index c29c3214d..cf6ac519b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md @@ -17,7 +17,7 @@ Properties that are overridden are not enumerated. ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `model` | [`Model`](../interfaces/Model.md) | ## Returns 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 index afb5be83a..2d3181313 100644 --- 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 @@ -3,6 +3,12 @@ jsApi: true title: "[P] JS API" --- +## References + +### printIdentifier + +Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) + ## Enumerations - [IdentifierKind](enumerations/IdentifierKind.md) @@ -93,6 +99,8 @@ title: "[P] JS API" - [EnumStatementNode](interfaces/EnumStatementNode.md) - [EnumValue](interfaces/EnumValue.md) - [ErrorType](interfaces/ErrorType.md) +- [Example](interfaces/Example.md) +- [ExampleOptions](interfaces/ExampleOptions.md) - [ExternKeywordNode](interfaces/ExternKeywordNode.md) - [FileLibraryMetadata](interfaces/FileLibraryMetadata.md) - [FilePos](interfaces/FilePos.md) @@ -155,6 +163,7 @@ title: "[P] JS API" - [ObjectType](interfaces/ObjectType.md) - [ObjectValue](interfaces/ObjectValue.md) - [ObjectValuePropertyDescriptor](interfaces/ObjectValuePropertyDescriptor.md) +- [OpExample](interfaces/OpExample.md) - [Operation](interfaces/Operation.md) - [OperationSignatureDeclarationNode](interfaces/OperationSignatureDeclarationNode.md) - [OperationSignatureReferenceNode](interfaces/OperationSignatureReferenceNode.md) @@ -387,6 +396,7 @@ title: "[P] JS API" - [$encodedName](functions/$encodedName.md) - [$error](functions/$error.md) - [$errorsDoc](functions/$errorsDoc.md) +- [$example](functions/$example.md) - [$format](functions/$format.md) - [$friendlyName](functions/$friendlyName.md) - [$inspectType](functions/$inspectType.md) @@ -402,6 +412,7 @@ title: "[P] JS API" - [$minLength](functions/$minLength.md) - [$minValue](functions/$minValue.md) - [$minValueExclusive](functions/$minValueExclusive.md) +- [$opExample](functions/$opExample.md) - [$overload](functions/$overload.md) - [$parameterVisibility](functions/$parameterVisibility.md) - [$pattern](functions/$pattern.md) @@ -467,6 +478,7 @@ title: "[P] JS API" - [getEntityName](functions/getEntityName.md) - [getErrorsDoc](functions/getErrorsDoc.md) - [getErrorsDocData](functions/getErrorsDocData.md) +- [getExamples](functions/getExamples.md) - [getFirstAncestor](functions/getFirstAncestor.md) - [getFormat](functions/getFormat.md) - [getFriendlyName](functions/getFriendlyName.md) @@ -498,6 +510,7 @@ title: "[P] JS API" - [getNormalizedAbsolutePath](functions/getNormalizedAbsolutePath.md) - [getNormalizedAbsolutePathWithoutRoot](functions/getNormalizedAbsolutePathWithoutRoot.md) - [getNormalizedPathComponents](functions/getNormalizedPathComponents.md) +- [getOpExamples](functions/getOpExamples.md) - [getOverloadedOperation](functions/getOverloadedOperation.md) - [getOverloads](functions/getOverloads.md) - [getOverriddenProperty](functions/getOverriddenProperty.md) @@ -596,6 +609,7 @@ title: "[P] JS API" - [resolvePath](functions/resolvePath.md) - [resolveUsages](functions/resolveUsages.md) - [scopeNavigationToNamespace](functions/scopeNavigationToNamespace.md) +- [serializeValueAsJson](functions/serializeValueAsJson.md) - [setCadlNamespace](functions/setCadlNamespace.md) - [setTypeSpecNamespace](functions/setTypeSpecNamespace.md) - [skipContinuousIdentifier](functions/skipContinuousIdentifier.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md index 330c31912..455a7e2d9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md @@ -10,17 +10,17 @@ title: "[I] AliasStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `AliasStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | -| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `AliasStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `locals?` | `readonly` | `SymbolTable` | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | | `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md index aca32333d..1926a7709 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md @@ -10,12 +10,12 @@ title: "[I] AnyKeywordNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `UnknownKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `UnknownKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md index 40416ef50..22d79ea86 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md @@ -10,13 +10,13 @@ title: "[I] ArrayExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | | `elementType` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ArrayExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ArrayExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayLiteralNode.md index 5d640900b..653e9fcc8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayLiteralNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayLiteralNode.md @@ -10,13 +10,13 @@ title: "[I] ArrayLiteralNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ArrayLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ArrayLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `values` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md index 952505395..c8af73440 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md @@ -10,29 +10,29 @@ title: "[I] ArrayModelType" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `baseModel?` | `public` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | [`Model`](Model.md).`baseModel` | [`Model`](Model.md).`baseModel` | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`Model`](Model.md).`decorators` | [`Model`](Model.md).`decorators` | -| `derivedModels` | `public` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](Model.md) | [`Model`](Model.md).`derivedModels` | [`Model`](Model.md).`derivedModels` | -| `entityKind` | `readonly` | `"Type"` | - | [`Model`](Model.md).`entityKind` | [`Model`](Model.md).`entityKind` | -| `indexer` | `public` | `object` | - | [`Model`](Model.md).`indexer` | [`Model`](Model.md).`indexer` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `baseModel?` | `public` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | - | [`Model`](Model.md).`baseModel` | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | - | [`Model`](Model.md).`decorators` | +| `derivedModels` | `public` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](Model.md) | - | [`Model`](Model.md).`derivedModels` | +| `entityKind` | `readonly` | `"Type"` | - | - | [`Model`](Model.md).`entityKind` | +| `indexer` | `public` | `object` | - | [`Model`](Model.md).`indexer` | - | | `indexer.key` | `public` | [`Scalar`](Scalar.md) | - | - | - | | `indexer.value` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`Model`](Model.md).`instantiationParameters` | [`Model`](Model.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`Model`](Model.md).`isFinished` | [`Model`](Model.md).`isFinished` | -| `kind` | `public` | `"Model"` | - | [`Model`](Model.md).`kind` | [`Model`](Model.md).`kind` | -| `name` | `public` | `string` | - | [`Model`](Model.md).`name` | [`Model`](Model.md).`name` | -| `namespace?` | `public` | [`Namespace`](Namespace.md) | - | [`Model`](Model.md).`namespace` | [`Model`](Model.md).`namespace` | -| `node?` | `public` | \| [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`ObjectLiteralNode`](ObjectLiteralNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`Model`](Model.md).`node` | [`Model`](Model.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionBase` | [`Model`](Model.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionSource` | [`Model`](Model.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`Model`](Model.md).`projector` | [`Model`](Model.md).`projector` | -| `properties` | `public` | `RekeyableMap`<`string`, [`ModelProperty`](ModelProperty.md)\> |

The properties of the model.

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

Properties inherited via `model extends` are not included. Use

[walkPropertiesInherited](../functions/walkPropertiesInherited.md) to enumerate all properties in the inheritance hierarchy.

| [`Model`](Model.md).`properties` | [`Model`](Model.md).`properties` | -| `sourceModel?` | `public` | [`Model`](Model.md) | The model that is referenced via `model is`. | [`Model`](Model.md).`sourceModel` | [`Model`](Model.md).`sourceModel` | -| `sourceModels` | `public` | [`SourceModel`](SourceModel.md)[] | Models that were used to build this model. This include any model referenced in `model is`, `...` or when intersecting models. | [`Model`](Model.md).`sourceModels` | [`Model`](Model.md).`sourceModels` | -| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] |

**Deprecated**

use templateMapper instead.

| [`Model`](Model.md).`templateArguments` | [`Model`](Model.md).`templateArguments` | -| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`Model`](Model.md).`templateMapper` | [`Model`](Model.md).`templateMapper` | -| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`Model`](Model.md).`templateNode` | [`Model`](Model.md).`templateNode` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`Model`](Model.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`Model`](Model.md).`isFinished` | +| `kind` | `public` | `"Model"` | - | - | [`Model`](Model.md).`kind` | +| `name` | `public` | `string` | - | - | [`Model`](Model.md).`name` | +| `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | [`Model`](Model.md).`namespace` | +| `node?` | `public` | \| [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`ObjectLiteralNode`](ObjectLiteralNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | - | [`Model`](Model.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`Model`](Model.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`Model`](Model.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`Model`](Model.md).`projector` | +| `properties` | `public` | `RekeyableMap`<`string`, [`ModelProperty`](ModelProperty.md)\> | The properties of the model. Properties are ordered in the order that they appear in source. Properties obtained via `model is` appear before properties defined in the model body. Properties obtained via `...` are inserted where the spread appears in source. Properties inherited via `model extends` are not included. Use [walkPropertiesInherited](../functions/walkPropertiesInherited.md) to enumerate all properties in the inheritance hierarchy. | - | [`Model`](Model.md).`properties` | +| `sourceModel?` | `public` | [`Model`](Model.md) | The model that is referenced via `model is`. | - | [`Model`](Model.md).`sourceModel` | +| `sourceModels` | `public` | [`SourceModel`](SourceModel.md)[] | Models that were used to build this model. This include any model referenced in `model is`, `...` or when intersecting models. | - | [`Model`](Model.md).`sourceModels` | +| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | **Deprecated** use templateMapper instead. | - | [`Model`](Model.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | - | [`Model`](Model.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`Model`](Model.md).`templateNode` | ## Accessors @@ -46,6 +46,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`Model`](Model.md).[`projections`](Model.md#projections) + ## Methods ### projectionsByName() @@ -57,7 +61,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayValue.md index b5fe7f413..a9cdbb088 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayValue.md @@ -10,9 +10,9 @@ title: "[I] ArrayValue" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Value"` | - | - | `BaseValue.entityKind` | | `node` | `public` | [`ArrayLiteralNode`](ArrayLiteralNode.md) | - | - | - | -| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

const a = "hello"; // Type here would be "hello"

const b: string = a; // Type here would be string

const c: string \| int32 = b; // Type here would be string \| int32

 | `BaseValue.type` | `BaseValue.type` | -| `valueKind` | `public` | `"ArrayValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) | Represent the storage type of a value. **Example** `const a = "hello"; // Type here would be "hello" const b: string = a; // Type here would be string const c: string | int32 = b; // Type here would be string | int32` | - | `BaseValue.type` | +| `valueKind` | `public` | `"ArrayValue"` | - | `BaseValue.valueKind` | - | | `values` | `public` | [`Value`](../type-aliases/Value.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md index bc54dc3a8..86932f09e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md @@ -10,15 +10,15 @@ title: "[I] AugmentDecoratorStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `arguments` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `AugmentDecoratorStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `AugmentDecoratorStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | | `targetType` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md index f6837fc6a..fe96b421a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md @@ -104,7 +104,7 @@ title: "[I] BaseNode" ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | | `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | | `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`TextRange`](TextRange.md).`end` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md index fb915a818..f4063ef80 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md @@ -34,10 +34,10 @@ title: "[I] BaseType" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `entityKind` | `readonly` | `"Type"` | - | | `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | -| `isFinished` | `public` | `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)
| +| `isFinished` | `public` | `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` | `public` | `string` | - | | `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | | `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | @@ -67,7 +67,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md index 630a54d75..86e33b3ab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md @@ -10,7 +10,7 @@ title: "[I] BlockComment" ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`TextRange`](TextRange.md).`end` | | `kind` | `readonly` | `BlockComment` | - | - | | `parsedAsDocs?` | `readonly` | `boolean` | If that comment was parsed as a doc comment. If parserOptions.docs=false this will always be false. | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md index 3b01934fc..5d55c5d5e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md @@ -10,15 +10,15 @@ title: "[I] BooleanLiteral" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Boolean"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node?` | `public` | [`BooleanLiteralNode`](BooleanLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Boolean"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `node?` | `public` | [`BooleanLiteralNode`](BooleanLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `value` | `public` | `boolean` | - | - | - | ## Accessors @@ -33,6 +33,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -44,7 +48,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md index 2f8ec848b..59da0d343 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md @@ -10,13 +10,13 @@ title: "[I] BooleanLiteralNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `BooleanLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `BooleanLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `value` | `readonly` | `boolean` | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanValue.md index 41784e7a5..215b5ab24 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanValue.md @@ -10,9 +10,9 @@ title: "[I] BooleanValue" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Value"` | - | - | `BaseValue.entityKind` | | `scalar` | `public` | `undefined` \| [`Scalar`](Scalar.md) | - | - | - | -| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

const a = "hello"; // Type here would be "hello"

const b: string = a; // Type here would be string

const c: string \| int32 = b; // Type here would be string \| int32

 | `BaseValue.type` | `BaseValue.type` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) | Represent the storage type of a value. **Example** `const a = "hello"; // Type here would be "hello" const b: string = a; // Type here would be string const c: string | int32 = b; // Type here would be string | int32` | - | `BaseValue.type` | | `value` | `public` | `boolean` | - | - | - | -| `valueKind` | `public` | `"BooleanValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | +| `valueKind` | `public` | `"BooleanValue"` | - | `BaseValue.valueKind` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallExpressionNode.md index 3c4b4058a..ec9f1d461 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallExpressionNode.md @@ -10,14 +10,14 @@ title: "[I] CallExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `arguments` | `readonly` | [`Expression`](../type-aliases/Expression.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `CallExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `CallExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md index 1ed513dcd..e2883be22 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md @@ -3,10 +3,10 @@ jsApi: true title: "[I] CallableMessage" --- -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* `string`[] | ```ts @@ -16,7 +16,7 @@ interface CallableMessage(dict): string ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `dict` | `Record`<`T`\[`number`\], `string`\> | ## Returns @@ -26,5 +26,5 @@ interface CallableMessage(dict): string ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `keys` | `T` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md index e2e74af75..fcbbd884f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md @@ -6,7 +6,7 @@ title: "[I] Checker" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `anyType` | `readonly` | [`UnknownType`](UnknownType.md) | | `errorType` | `readonly` | [`ErrorType`](ErrorType.md) | | `neverType` | `readonly` | [`NeverType`](NeverType.md) | @@ -37,7 +37,7 @@ checkSourceFile(file): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | #### Returns @@ -52,16 +52,16 @@ checkSourceFile(file): void cloneType(type, additionalProps?): T ``` -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* [`Type`](../type-aliases/Type.md) | #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | `T` | | `additionalProps`? | \{ \[P in string \| number \| symbol\]?: T\[P\] \} | @@ -77,16 +77,16 @@ cloneType(type, additionalProps?): T createAndFinishType(typeDef): T & TypePrototype ``` -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* [`CreateTypeProps`](../type-aliases/CreateTypeProps.md) | #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `typeDef` | `T` | #### Returns @@ -104,7 +104,7 @@ createFunctionType(fn): FunctionType #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `fn` | (...`args`) => [`Type`](../type-aliases/Type.md) | #### Returns @@ -124,7 +124,7 @@ createLiteralType(value, node?): StringLiteral ##### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `value` | `string` | | `node`? | [`StringLiteralNode`](StringLiteralNode.md) | @@ -141,7 +141,7 @@ createLiteralType(value, node?): NumericLiteral ##### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `value` | `number` | | `node`? | [`NumericLiteralNode`](NumericLiteralNode.md) | @@ -158,7 +158,7 @@ createLiteralType(value, node?): BooleanLiteral ##### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `value` | `boolean` | | `node`? | [`BooleanLiteralNode`](BooleanLiteralNode.md) | @@ -175,7 +175,7 @@ createLiteralType(value, node?): BooleanLiteral | NumericLiteral | StringLiteral ##### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `value` | `string` \| `number` \| `boolean` | | `node`? | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) \| [`BooleanLiteralNode`](BooleanLiteralNode.md) | @@ -192,7 +192,7 @@ createLiteralType(value, node?): BooleanLiteral | NumericLiteral | StringLiteral ##### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `value` | `string` \| `number` \| `boolean` | | `node`? | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) \| [`BooleanLiteralNode`](BooleanLiteralNode.md) | @@ -208,16 +208,16 @@ createLiteralType(value, node?): BooleanLiteral | NumericLiteral | StringLiteral createType(typeDef): T & TypePrototype & object ``` -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* [`CreateTypeProps`](../type-aliases/CreateTypeProps.md) | #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `typeDef` | `T` | #### Returns @@ -238,7 +238,7 @@ evalProjection( #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `node` | [`ProjectionNode`](ProjectionNode.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `args` | [`Type`](../type-aliases/Type.md)[] | @@ -255,16 +255,16 @@ evalProjection( finishType(typeDef): T ``` -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* [`Type`](../type-aliases/Type.md) | #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `typeDef` | `T` | #### Returns @@ -308,7 +308,7 @@ getLiteralType(node): StringLiteral ##### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `node` | [`StringLiteralNode`](StringLiteralNode.md) | ##### Returns @@ -324,7 +324,7 @@ getLiteralType(node): NumericLiteral ##### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `node` | [`NumericLiteralNode`](NumericLiteralNode.md) | ##### Returns @@ -340,7 +340,7 @@ getLiteralType(node): BooleanLiteral ##### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `node` | [`BooleanLiteralNode`](BooleanLiteralNode.md) | ##### Returns @@ -356,7 +356,7 @@ getLiteralType(node): LiteralType ##### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `node` | [`LiteralNode`](../type-aliases/LiteralNode.md) | ##### Returns @@ -374,7 +374,7 @@ getMergedSymbol(sym): undefined | Sym #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `sym` | `undefined` \| [`Sym`](Sym.md) | #### Returns @@ -392,7 +392,7 @@ getNamespaceString(type, options?): string #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | `undefined` \| [`Namespace`](Namespace.md) | | `options`? | [`TypeNameOptions`](TypeNameOptions.md) | @@ -414,16 +414,16 @@ getStdType(name): StdTypes[T] Std type -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* `"Array"` \| [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| `"Record"` | #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `name` | `T` | Name | #### Returns @@ -441,7 +441,7 @@ getTypeForNode(node): Type #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `node` | [`Node`](../type-aliases/Node.md) | #### Returns @@ -459,7 +459,7 @@ getTypeName(type, options?): string #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Type`](../type-aliases/Type.md) | | `options`? | [`TypeNameOptions`](TypeNameOptions.md) | @@ -473,6 +473,31 @@ use `import { getTypeName } from "@typespec/compiler";` *** +### getValueExactType() + +```ts +getValueExactType(value): undefined | Type +``` + +Return the exact type of a value. + +```tsp +const a: string = "hello"; +``` +calling `getValueExactType` on the value of a would give the string literal "hello". + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `value` | [`Value`](../type-aliases/Value.md) | | + +#### Returns + +`undefined` \| [`Type`](../type-aliases/Type.md) + +*** + ### isStdType() #### isStdType(type, stdType) @@ -486,7 +511,7 @@ Check if the given type is one of the built-in standard TypeSpec Types. ##### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `type` | [`Scalar`](Scalar.md) | Type to check | | `stdType`? | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) | If provided check is that standard type | @@ -503,7 +528,7 @@ isStdType(type, stdType?): type is Type & Object ##### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Type`](../type-aliases/Type.md) | | `stdType`? | `"Array"` \| [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| `"Record"` | @@ -527,7 +552,7 @@ Check if the source type can be assigned to the target type. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `source` | [`Entity`](../type-aliases/Entity.md) | Source type, should be assignable to the target. | | `target` | [`Entity`](../type-aliases/Entity.md) | Target type | | `diagnosticTarget` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | Target for the diagnostic, unless something better can be inferred. | @@ -549,7 +574,7 @@ mergeSourceFile(file): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`JsSourceFileNode`](JsSourceFileNode.md) | #### Returns @@ -570,7 +595,7 @@ project( #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `target` | [`Type`](../type-aliases/Type.md) | | `projection` | [`ProjectionNode`](ProjectionNode.md) | | `args`? | (`string` \| `number` \| `boolean` \| [`Type`](../type-aliases/Type.md))[] | @@ -590,7 +615,7 @@ resolveCompletions(node): Map #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `node` | [`IdentifierNode`](IdentifierNode.md) | #### Returns @@ -608,7 +633,7 @@ resolveIdentifier(node): undefined | Sym #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `node` | [`IdentifierNode`](IdentifierNode.md) | #### Returns @@ -628,7 +653,7 @@ Check and resolve a type for the given type reference node. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `node` | [`TypeReferenceNode`](TypeReferenceNode.md) | Node. | #### Returns @@ -648,7 +673,7 @@ setUsingsForFile(file): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFix.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFix.md index 378172203..78cc9b24a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFix.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFix.md @@ -6,7 +6,7 @@ title: "[I] CodeFix" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `fix` | `readonly` | (`fixContext`: [`CodeFixContext`](CodeFixContext.md)) => `void` \| `Promise`<`void`\> \| [`CodeFixEdit`](../type-aliases/CodeFixEdit.md) \| [`CodeFixEdit`](../type-aliases/CodeFixEdit.md)[] | | `id` | `readonly` | `string` | | `label` | `readonly` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFixContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFixContext.md index 0f07b09cd..2f770ce00 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFixContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFixContext.md @@ -6,7 +6,7 @@ title: "[I] CodeFixContext" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `appendText` | `readonly` | (`location`: [`SourceLocation`](SourceLocation.md) \| [`FilePos`](FilePos.md), `text`: `string`) => [`InsertTextCodeFixEdit`](InsertTextCodeFixEdit.md) | Add the given text after the range or pos given. | | `prependText` | `readonly` | (`location`: [`SourceLocation`](SourceLocation.md) \| [`FilePos`](FilePos.md), `text`: `string`) => [`InsertTextCodeFixEdit`](InsertTextCodeFixEdit.md) | Add the given text before the range or pos given. | | `replaceText` | `readonly` | (`location`: [`SourceLocation`](SourceLocation.md), `newText`: `string`) => [`ReplaceTextCodeFixEdit`](ReplaceTextCodeFixEdit.md) | Replace the text at the given range. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompileResult.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompileResult.md index b1a6aae82..fae52fbee 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompileResult.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompileResult.md @@ -6,7 +6,7 @@ title: "[I] CompileResult" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `document` | `readonly` | `TextDocument` | | `program` | `readonly` | [`Program`](Program.md) | | `script` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md index d9cbaeceb..016123341 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md @@ -6,7 +6,7 @@ title: "[I] CompilerHost" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `logSink` | [`LogSink`](LogSink.md) | - | | `parseCache?` | `WeakMap`<[`SourceFile`](SourceFile.md), [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | Optional cache to reuse the results of parsing and binding across programs. | @@ -21,7 +21,7 @@ fileURLToPath(url): string #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `url` | `string` | #### Returns @@ -51,7 +51,7 @@ getJsImport(path): Promise> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | #### Returns @@ -81,7 +81,7 @@ getSourceFileKind(path): undefined | SourceFileKind #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | #### Returns @@ -101,7 +101,7 @@ create directory recursively. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `path` | `string` | Path to the directory. | #### Returns @@ -119,7 +119,7 @@ pathToFileURL(path): string #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | #### Returns @@ -139,7 +139,7 @@ Read directory. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `path` | `string` | Path to the directory. | #### Returns @@ -161,7 +161,7 @@ read a utf-8 or utf-8 with bom encoded file #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | #### Returns @@ -181,7 +181,7 @@ read a file at the given url. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `url` | `string` | #### Returns @@ -199,7 +199,7 @@ realpath(path): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | #### Returns @@ -219,7 +219,7 @@ Deletes a directory or file. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `path` | `string` | Path to the directory or file. | | `options`? | [`RmOptions`](RmOptions.md) | - | @@ -238,15 +238,15 @@ stat(path): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | #### Returns `Promise`<`object`\> -| Member | Type | -| :------ | :------ | +| Name | Type | +| ------ | ------ | | `isDirectory` | `boolean` | | `isFile` | `boolean` | @@ -263,7 +263,7 @@ Write the file. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `path` | `string` | Path to the file. | | `content` | `string` | Content of the file. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md index de4f91701..33f278918 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md @@ -8,5 +8,5 @@ Built-in ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `type` | `readonly` | `"compiler"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md index 7e4750b12..117614eb2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md @@ -6,20 +6,20 @@ title: "[I] CompilerOptions" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `additionalImports?` | `string`[] | - | | `config?` | `string` | Path to config YAML file used, this is also where the project root should be. | | `designTimeBuild?` | `boolean` | When true, indicates that a compilation is being performed for live analysis in the language server. | | `emit?` | `string`[] | List or path to emitters to use. | -| ~~`emitters?`~~ | `Record`<`string`, `EmitterOptions`\> |

**Deprecated**

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

Will be removed in March 2022 sprint.

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

Default output directory used by emitters.

**Default**

./tsp-output | -| ~~`outputPath?`~~ | `string` |

**Deprecated**

use outputDir.

| +| `outputDir?` | `string` | Default output directory used by emitters. **Default** `./tsp-output` | +| ~~`outputPath?`~~ | `string` | **Deprecated** use outputDir. | | `parseOptions?` | [`ParseOptions`](ParseOptions.md) | - | | `trace?` | `string`[] | Trace area to enable. | | `warningAsError?` | `boolean` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ConstStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ConstStatementNode.md index 42af8d2e2..aed9c971e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ConstStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ConstStatementNode.md @@ -10,15 +10,15 @@ title: "[I] ConstStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `ConstStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `ConstStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `type?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | | `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md index 0f3773e91..ee4b3d240 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md @@ -27,5 +27,5 @@ title: "[I] DeclarationNode" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratedType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratedType.md index b1567ffc1..637a66831 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratedType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratedType.md @@ -19,5 +19,5 @@ title: "[I] DecoratedType" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md index 08bcd7335..cdec00d06 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md @@ -10,19 +10,19 @@ title: "[I] Decorator" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | | `implementation` | `public` | (...`args`: `unknown`[]) => `void` | - | - | - | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Decorator"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Decorator"` | - | [`BaseType`](BaseType.md).`kind` | - | | `name` | `public` | \`@$\{string\}\` | - | - | - | | `namespace` | `public` | [`Namespace`](Namespace.md) | - | - | - | -| `node` | `public` | [`DecoratorDeclarationStatementNode`](DecoratorDeclarationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `node` | `public` | [`DecoratorDeclarationStatementNode`](DecoratorDeclarationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | - | | `parameters` | `public` | [`MixedFunctionParameter`](MixedFunctionParameter.md)[] | - | - | - | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `target` | `public` | [`MixedFunctionParameter`](MixedFunctionParameter.md) | - | - | - | ## Accessors @@ -37,6 +37,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -48,7 +52,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md index 223e43baf..10e659271 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md @@ -6,7 +6,7 @@ title: "[I] DecoratorApplication" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `args` | [`DecoratorArgument`](DecoratorArgument.md)[] | | `decorator` | [`DecoratorFunction`](DecoratorFunction.md) | | `definition?` | [`Decorator`](Decorator.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md index ad6bdb06d..92c6b004b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md @@ -6,7 +6,7 @@ title: "[I] DecoratorArgument" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | -| `jsValue` | \| `null` \| `string` \| `number` \| `boolean` \| `unknown`[] \| [`Numeric`](Numeric.md) \| [`Type`](../type-aliases/Type.md) \| `Record`<`string`, `unknown`\> \| [`Value`](../type-aliases/Value.md) | Marshalled value for use in Javascript. | +| ------ | ------ | ------ | +| `jsValue` | \| `null` \| `string` \| `number` \| `boolean` \| `unknown`[] \| [`Numeric`](Numeric.md) \| [`Type`](../type-aliases/Type.md) \| `Record`<`string`, `unknown`\> \| [`Value`](../type-aliases/Value.md) | Marshalled value for use in Javascript. | | `node?` | [`Node`](../type-aliases/Node.md) | - | | `value` | [`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md index 6e77e12ba..9a2784356 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md @@ -6,7 +6,7 @@ title: "[I] DecoratorContext" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `decoratorTarget` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | Point to the decorator target | | `program` | [`Program`](Program.md) | - | @@ -23,10 +23,10 @@ call( Helper to call out to another decorator -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* [`Type`](../type-aliases/Type.md) | | `A` *extends* `any`[] | | `R` | @@ -34,7 +34,7 @@ Helper to call out to another decorator #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `decorator` | (`context`, `target`, ...`args`) => `R` | Other decorator function | | `target` | `T` | - | | ...`args` | `A` | Args to pass to other decorator function | @@ -56,7 +56,7 @@ Function that can be used to retrieve the target for a parameter at the given in #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `paramIndex` | `number` | Parameter index in the typespec | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md index c02dafc1e..908c6a285 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md @@ -18,17 +18,17 @@ extern dec doc(target: Type, value: valueof string); ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `DecoratorDeclarationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `DecoratorDeclarationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `modifierFlags` | `readonly` | [`ModifierFlags`](../enumerations/ModifierFlags.md) | - | - | - | | `modifiers` | `readonly` | readonly [`ExternKeywordNode`](ExternKeywordNode.md)[] | - | - | - | | `parameters` | `readonly` | [`FunctionParameterNode`](FunctionParameterNode.md)[] | Additional parameters | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`FunctionParameterNode`](FunctionParameterNode.md) | Decorator target. First parameter. | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md index 9a5a4aa87..9792b50d1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md @@ -3,10 +3,10 @@ jsApi: true title: "[I] DecoratorDefinition" --- -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | - | | `P` *extends* readonly [`DecoratorParamDefinition`](DecoratorParamDefinition.md)<[`TypeKind`](../type-aliases/TypeKind.md)\>[] | - | | `S` *extends* [`DecoratorParamDefinition`](DecoratorParamDefinition.md)<[`TypeKind`](../type-aliases/TypeKind.md)\> \| `undefined` | `undefined` | @@ -14,8 +14,8 @@ title: "[I] DecoratorDefinition" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `args` | `readonly` | `P` | List of positional arguments in the function. | | `name` | `readonly` | `string` | Name of the decorator. | -| `spreadArgs?` | `readonly` | `S` |

**Optional**

Type of the spread args at the end of the function if applicable.

| +| `spreadArgs?` | `readonly` | `S` | **Optional** Type of the spread args at the end of the function if applicable. | | `target` | `readonly` | `T` \| readonly `T`[] | Decorator target. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md index 4fd36fb75..7decb3e1c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md @@ -10,14 +10,14 @@ title: "[I] DecoratorExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `arguments` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `DecoratorExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `DecoratorExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md index 2e156753f..2130335ef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md @@ -13,7 +13,7 @@ interface DecoratorFunction( ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`DecoratorContext`](DecoratorContext.md) | | `target` | `any` | | ...`customArgs` | `any`[] | @@ -25,5 +25,5 @@ interface DecoratorFunction( ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `namespace?` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md index cefc0a69a..f3a46fd3f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md @@ -3,15 +3,15 @@ jsApi: true title: "[I] DecoratorParamDefinition" --- -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `K` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `kind` | `readonly` | `K` \| readonly `K`[] | Kind of the parameter | | `optional?` | `readonly` | `boolean` | Is the parameter optional. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md index 2c1b7f3d1..52d6ecef5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md @@ -3,10 +3,10 @@ jsApi: true title: "[I] DecoratorValidator" --- -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | - | | `P` *extends* readonly [`DecoratorParamDefinition`](DecoratorParamDefinition.md)<[`TypeKind`](../type-aliases/TypeKind.md)\>[] | - | | `S` *extends* [`DecoratorParamDefinition`](DecoratorParamDefinition.md)<[`TypeKind`](../type-aliases/TypeKind.md)\> \| `undefined` | `undefined` | @@ -25,7 +25,7 @@ validate( #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`DecoratorContext`](DecoratorContext.md) | | `target` | [`InferredTypeSpecValue`](../type-aliases/InferredTypeSpecValue.md)<`T`\> | | `parameters` | `InferParameters`<`P`, `S`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecatedDirective.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecatedDirective.md index af54a3f9b..b0c75d3e0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecatedDirective.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecatedDirective.md @@ -10,7 +10,7 @@ title: "[I] DeprecatedDirective" ## Properties | Property | Type | Inherited from | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `message` | `string` | - | | `name` | `"deprecated"` | - | | `node` | [`DirectiveExpressionNode`](DirectiveExpressionNode.md) | [`DirectiveBase`](DirectiveBase.md).`node` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md index b826f1f4c..402f48790 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md @@ -8,5 +8,5 @@ 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/interfaces/Diagnostic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md index a8a8d27f8..d91c386aa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md @@ -6,7 +6,7 @@ title: "[I] Diagnostic" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `code` | `public` | `string` | | `codefixes?` | `readonly` | readonly [`CodeFix`](CodeFix.md)[] | | `message` | `public` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md index 3eba871e1..c69a59782 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md @@ -8,7 +8,7 @@ Helper object to collect diagnostics from function following the diagnostics acc ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `diagnostics` | `readonly` | readonly [`Diagnostic`](Diagnostic.md)[] | ## Methods @@ -24,7 +24,7 @@ Add a diagnostic to the collection #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `diagnostic` | [`Diagnostic`](Diagnostic.md) | Diagnostic to add. | #### Returns @@ -41,16 +41,16 @@ pipe(result): T Unwrap the Diagnostic result, add all the diagnostics and return the data. -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` | #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `result` | [`DiagnosticResult`](../type-aliases/DiagnosticResult.md)<`T`\> | Accessor diagnostic result | #### Returns @@ -67,16 +67,16 @@ wrap(value): DiagnosticResult Wrap the given value in a tuple including the diagnostics following the TypeSpec accessor pattern. -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` | #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `value` | `T` | Accessor value to return | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md index 8f1d81e00..acaa3e175 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md @@ -3,16 +3,16 @@ jsApi: true title: "[I] DiagnosticCreator" --- -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* `object` | ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `diagnostics` | `readonly` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | | `type` | `readonly` | `T` | @@ -24,17 +24,17 @@ title: "[I] DiagnosticCreator" createDiagnostic(diag): Diagnostic ``` -#### Type parameters +#### Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `C` *extends* `string` \| `number` \| `symbol` | - | | `M` *extends* `string` \| `number` \| `symbol` | `"default"` | #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | #### Returns @@ -49,17 +49,17 @@ createDiagnostic(diag): Diagnostic reportDiagnostic(program, diag): void ``` -#### Type parameters +#### Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `C` *extends* `string` \| `number` \| `symbol` | - | | `M` *extends* `string` \| `number` \| `symbol` | `"default"` | #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](Program.md) | | `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md index 566044675..53fb59e6f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md @@ -3,15 +3,15 @@ jsApi: true title: "[I] DiagnosticDefinition" --- -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `M` *extends* [`DiagnosticMessages`](DiagnosticMessages.md) | ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `messages` | `readonly` | `M` | | `severity` | `readonly` | `"error"` \| `"warning"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveBase.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveBase.md index 246c953a0..0439b0274 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveBase.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveBase.md @@ -11,5 +11,5 @@ title: "[I] DirectiveBase" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `node` | [`DirectiveExpressionNode`](DirectiveExpressionNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md index b63abe9c8..ed0b90f14 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md @@ -10,14 +10,14 @@ title: "[I] DirectiveExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `arguments` | `readonly` | readonly [`DirectiveArgument`](../type-aliases/DirectiveArgument.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `DirectiveExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `DirectiveExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md index 907d0c961..6798a743e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md @@ -6,7 +6,7 @@ title: "[I] Dirent" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | ## Methods diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiscriminatedUnion.md index fd142f32e..ca6945154 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiscriminatedUnion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiscriminatedUnion.md @@ -6,6 +6,6 @@ title: "[I] DiscriminatedUnion" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `propertyName` | `string` | | `variants` | `Map`<`string`, [`Model`](Model.md)\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Discriminator.md index a8f1b0c5e..8f5736be6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Discriminator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Discriminator.md @@ -6,5 +6,5 @@ title: "[I] Discriminator" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `propertyName` | `readonly` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md index e4bdffb82..c28e775b9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md @@ -10,14 +10,14 @@ title: "[I] DocErrorsTagNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | -| `kind` | `readonly` | `DocErrorsTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | -| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `kind` | `readonly` | `DocErrorsTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md index f93cf3129..761c3199e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md @@ -10,14 +10,14 @@ title: "[I] DocNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `Doc` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `Doc` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `tags` | `readonly` | readonly [`DocTag`](../type-aliases/DocTag.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md index 07ee121f9..16ace524b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md @@ -10,15 +10,15 @@ title: "[I] DocParamTagNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | -| `kind` | `readonly` | `DocParamTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `kind` | `readonly` | `DocParamTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | - | | `paramName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | -| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocPropTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocPropTagNode.md index 60381d7a2..ddfef7f2a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocPropTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocPropTagNode.md @@ -10,15 +10,15 @@ title: "[I] DocPropTagNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | -| `kind` | `readonly` | `DocPropTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `kind` | `readonly` | `DocPropTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | | `propName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | -| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md index 9e707d65d..c1658f317 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md @@ -10,14 +10,14 @@ title: "[I] DocReturnsTagNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | -| `kind` | `readonly` | `DocReturnsTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | -| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `kind` | `readonly` | `DocReturnsTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md index fcf7fcd34..1f3642c14 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md @@ -19,7 +19,7 @@ title: "[I] DocTagBaseNode" ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | | `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md index dcd53f3be..b6383c254 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md @@ -10,15 +10,15 @@ title: "[I] DocTemplateTagNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | -| `kind` | `readonly` | `DocTemplateTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `kind` | `readonly` | `DocTemplateTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | - | | `paramName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | -| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md index a8af628fa..f4d74f97d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md @@ -10,13 +10,13 @@ title: "[I] DocTextNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `DocText` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `DocText` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `text` | `readonly` | `string` | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md index ac5e0bd47..072a8dcc0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md @@ -10,14 +10,14 @@ title: "[I] DocUnknownTagNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | -| `kind` | `readonly` | `DocUnknownTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | -| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `kind` | `readonly` | `DocUnknownTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md index e7dcc0a6d..fca28bd03 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md @@ -3,23 +3,23 @@ jsApi: true title: "[I] EmitContext" --- -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `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`](Program.md) | TypeSpec Program. | ## Methods -### getAssetEmitter() +### ~~getAssetEmitter()~~ ```ts getAssetEmitter(TypeEmitterClass): AssetEmitter @@ -27,18 +27,22 @@ getAssetEmitter(TypeEmitterClass): AssetEmitter Get an asset emitter to write emitted output to disk using a TypeEmitter -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` | #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `TypeEmitterClass` | *typeof* `TypeEmitter` | The TypeEmitter to construct your emitted output | #### Returns `AssetEmitter`<`T`, `TOptions`\> + +#### Deprecated + +call createAssetEmitter directly instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md index b0201dad0..d72c5376c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md @@ -6,7 +6,7 @@ title: "[I] EmitFileOptions" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `content` | `string` | | `newLine?` | [`NewLine`](../type-aliases/NewLine.md) | | `path` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md index fc9ff60ba..aca9a2962 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md @@ -10,12 +10,12 @@ title: "[I] EmptyStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `EmptyStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `EmptyStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EncodeData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EncodeData.md index 34e658d0d..100ab6225 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EncodeData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EncodeData.md @@ -6,6 +6,6 @@ title: "[I] EncodeData" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `encoding` | `string` | | `type` | [`Scalar`](Scalar.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md index 99b447442..ac8168026 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md @@ -10,19 +10,19 @@ title: "[I] Enum" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Enum"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `members` | `public` | `RekeyableMap`<`string`, [`EnumMember`](EnumMember.md)\> |

The members of the enum.

Members are ordered in the order that they appear in source. Members obtained via `...` are inserted where the spread appears in source.

| - | - | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Enum"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `members` | `public` | `RekeyableMap`<`string`, [`EnumMember`](EnumMember.md)\> | The members of the enum. Members are ordered in the order that they appear in source. Members obtained via `...` are inserted where the spread appears in source. | - | - | | `name` | `public` | `string` | - | - | - | | `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | -| `node` | `public` | [`EnumStatementNode`](EnumStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `node` | `public` | [`EnumStatementNode`](EnumStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | ## Accessors @@ -36,6 +36,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -47,7 +51,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md index c44756b0f..8efe6c847 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md @@ -10,18 +10,18 @@ title: "[I] EnumMember" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | | `enum` | `public` | [`Enum`](Enum.md) | - | - | - | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"EnumMember"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"EnumMember"` | - | [`BaseType`](BaseType.md).`kind` | - | | `name` | `public` | `string` | - | - | - | -| `node` | `public` | [`EnumMemberNode`](EnumMemberNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `node` | `public` | [`EnumMemberNode`](EnumMemberNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `sourceMember?` | `public` | [`EnumMember`](EnumMember.md) | when spread operators make new enum members, this tracks the enum member we copied from. | - | - | | `value?` | `public` | `string` \| `number` | - | - | - | @@ -37,6 +37,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -48,7 +52,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md index d6de42707..0d52b8d5d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md @@ -10,15 +10,15 @@ title: "[I] EnumMemberNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | | `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `EnumMember` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`EnumStatementNode`](EnumStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `kind` | `readonly` | `EnumMember` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`EnumStatementNode`](EnumStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `value?` | `readonly` | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md index f10bc5376..66a9af238 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md @@ -10,13 +10,13 @@ title: "[I] EnumSpreadMemberNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `EnumSpreadMember` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `EnumSpreadMember` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md index e90824466..15a22da57 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md @@ -10,15 +10,15 @@ title: "[I] EnumStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `EnumStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `EnumStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `members` | `readonly` | readonly ([`EnumMemberNode`](EnumMemberNode.md) \| [`EnumSpreadMemberNode`](EnumSpreadMemberNode.md))[] | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumValue.md index f15bc4070..a5a8556ef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumValue.md @@ -10,8 +10,8 @@ title: "[I] EnumValue" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | -| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

const a = "hello"; // Type here would be "hello"

const b: string = a; // Type here would be string

const c: string \| int32 = b; // Type here would be string \| int32

 | `BaseValue.type` | `BaseValue.type` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Value"` | - | - | `BaseValue.entityKind` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) | Represent the storage type of a value. **Example** `const a = "hello"; // Type here would be "hello" const b: string = a; // Type here would be string const c: string | int32 = b; // Type here would be string | int32` | - | `BaseValue.type` | | `value` | `public` | [`EnumMember`](EnumMember.md) | - | - | - | -| `valueKind` | `public` | `"EnumValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | +| `valueKind` | `public` | `"EnumValue"` | - | `BaseValue.valueKind` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md index 8e205cd69..6bd0c06cf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md @@ -10,16 +10,16 @@ title: "[I] ErrorType" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | [`IntrinsicType`](IntrinsicType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`IntrinsicType`](IntrinsicType.md).`isFinished` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | -| `kind` | `public` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | -| `name` | `public` | `"ErrorType"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`IntrinsicType`](IntrinsicType.md).`isFinished` | +| `kind` | `public` | `"Intrinsic"` | - | - | [`IntrinsicType`](IntrinsicType.md).`kind` | +| `name` | `public` | `"ErrorType"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | - | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projector` | ## Accessors @@ -33,6 +33,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`IntrinsicType`](IntrinsicType.md).[`projections`](IntrinsicType.md#projections) + ## Methods ### projectionsByName() @@ -44,7 +48,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Example.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Example.md new file mode 100644 index 000000000..c4af13d39 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Example.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] Example" + +--- +## Extends + +- [`ExampleOptions`](ExampleOptions.md) + +## Properties + +| Property | Modifier | Type | Inherited from | +| ------ | ------ | ------ | ------ | +| `description?` | `readonly` | `string` | [`ExampleOptions`](ExampleOptions.md).`description` | +| `title?` | `readonly` | `string` | [`ExampleOptions`](ExampleOptions.md).`title` | +| `value` | `readonly` | [`Value`](../type-aliases/Value.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExampleOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExampleOptions.md new file mode 100644 index 000000000..7c815707c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExampleOptions.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] ExampleOptions" + +--- +## Extended by + +- [`Example`](Example.md) +- [`OpExample`](OpExample.md) + +## Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `description?` | `readonly` | `string` | +| `title?` | `readonly` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md index 171e43452..9f500171a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md @@ -10,12 +10,12 @@ title: "[I] ExternKeywordNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ExternKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ExternKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md index 3da19853a..15e834107 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md @@ -10,7 +10,7 @@ title: "[I] FileLibraryMetadata" ## Properties | Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `bugs?` | `object` | - | `LibraryMetadataBase.bugs` | | `bugs.url?` | `string` | Url where to file bugs for this library. | - | | `homepage?` | `string` | Library homepage. | `LibraryMetadataBase.homepage` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FilePos.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FilePos.md index 602759b29..92dd4101f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FilePos.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FilePos.md @@ -6,6 +6,6 @@ title: "[I] FilePos" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `file` | `readonly` | [`SourceFile`](SourceFile.md) | | `pos` | `readonly` | `number` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md index f5845ab0d..876a976f2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md @@ -18,17 +18,17 @@ extern fn camelCase(value: StringLiteral): StringLiteral; ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `FunctionDeclarationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `FunctionDeclarationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `modifierFlags` | `readonly` | [`ModifierFlags`](../enumerations/ModifierFlags.md) | - | - | - | | `modifiers` | `readonly` | readonly [`ExternKeywordNode`](ExternKeywordNode.md)[] | - | - | - | | `parameters` | `readonly` | [`FunctionParameterNode`](FunctionParameterNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `returnType?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterBase.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterBase.md index 2064ffc4d..fe9992621 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterBase.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterBase.md @@ -15,17 +15,17 @@ title: "[I] FunctionParameterBase" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"FunctionParameter"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"FunctionParameter"` | - | [`BaseType`](BaseType.md).`kind` | - | | `name` | `public` | `string` | - | - | - | -| `node` | `public` | [`FunctionParameterNode`](FunctionParameterNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `node` | `public` | [`FunctionParameterNode`](FunctionParameterNode.md) | - | [`BaseType`](BaseType.md).`node` | - | | `optional` | `public` | `boolean` | - | - | - | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `rest` | `public` | `boolean` | - | - | - | ## Accessors @@ -40,6 +40,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -51,7 +55,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md index f776e5dcd..732df3d58 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md @@ -10,16 +10,16 @@ title: "[I] FunctionParameterNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | | `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `FunctionParameter` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `kind` | `readonly` | `FunctionParameter` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `optional` | `readonly` | `boolean` | Parameter defined with `?` | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `rest` | `readonly` | `boolean` | Parameter defined with `...` notation. | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `type?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md index 6cb650d8e..508a05715 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md @@ -10,19 +10,19 @@ title: "[I] FunctionType" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | | `implementation` | `public` | (...`args`: `unknown`[]) => `unknown` | - | - | - | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Function"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Function"` | - | [`BaseType`](BaseType.md).`kind` | - | | `name` | `public` | `string` | - | - | - | | `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | -| `node?` | `public` | [`FunctionDeclarationStatementNode`](FunctionDeclarationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `node?` | `public` | [`FunctionDeclarationStatementNode`](FunctionDeclarationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | - | | `parameters` | `public` | [`MixedFunctionParameter`](MixedFunctionParameter.md)[] | - | - | - | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `returnType` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | ## Accessors @@ -37,6 +37,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -48,7 +52,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierContext.md index 81f184c9c..b0ceb2f29 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierContext.md @@ -6,6 +6,6 @@ title: "[I] IdentifierContext" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `kind` | [`IdentifierKind`](../enumerations/IdentifierKind.md) | | `node` | [`Node`](../type-aliases/Node.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md index fcb2775bd..062cdd0ec 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md @@ -10,13 +10,13 @@ title: "[I] IdentifierNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `Identifier` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `Identifier` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `sv` | `readonly` | `string` | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md index 15f2a1b66..99da8a8a6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md @@ -10,13 +10,13 @@ title: "[I] ImportStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ImportStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ImportStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | | `path` | `readonly` | [`StringLiteralNode`](StringLiteralNode.md) | - | - | - | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IndeterminateEntity.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IndeterminateEntity.md index 6a395ba5f..5a9f9341b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IndeterminateEntity.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IndeterminateEntity.md @@ -8,6 +8,6 @@ When an entity that could be used as a type or value has not figured out if it i ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `entityKind` | `readonly` | `"Indeterminate"` | -| `type` | `readonly` | \| [`BooleanLiteral`](BooleanLiteral.md) \| [`EnumMember`](EnumMember.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`StringLiteral`](StringLiteral.md) \| [`StringTemplate`](StringTemplate.md) \| [`UnionVariant`](UnionVariant.md) \| [`NullType`](NullType.md) | +| `type` | `readonly` | \| [`BooleanLiteral`](BooleanLiteral.md) \| [`EnumMember`](EnumMember.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`StringLiteral`](StringLiteral.md) \| [`StringTemplate`](StringTemplate.md) \| [`UnionVariant`](UnionVariant.md) \| [`NullType`](NullType.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InsertTextCodeFixEdit.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InsertTextCodeFixEdit.md index ca2096448..3cb38f3f9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InsertTextCodeFixEdit.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InsertTextCodeFixEdit.md @@ -6,7 +6,7 @@ title: "[I] InsertTextCodeFixEdit" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `file` | `readonly` | [`SourceFile`](SourceFile.md) | | `kind` | `readonly` | `"insert-text"` | | `pos` | `readonly` | `number` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md index 688fafb8b..280a2a33b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md @@ -10,23 +10,23 @@ title: "[I] Interface" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Interface"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Interface"` | - | [`BaseType`](BaseType.md).`kind` | - | | `name` | `public` | `string` | - | - | - | | `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | -| `node` | `public` | [`InterfaceStatementNode`](InterfaceStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `operations` | `public` | `RekeyableMap`<`string`, [`Operation`](Operation.md)\> |

The operations of the interface.

Operations are ordered in the order that they appear in the source. Operations obtained via `interface extends` appear before operations declared in the interface body.

| - | - | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `sourceInterfaces` | `public` | [`Interface`](Interface.md)[] |

The interfaces that provide additional operations via `interface extends`.

Note that despite the same `extends` keyword in source form, this is a different semantic relationship than the one from [Model](Model.md) to

[Model.baseModel](Model.md). Operations from extended interfaces are copied into [Interface.operations](Interface.md).

| - | - | -| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] |

**Deprecated**

use templateMapper instead.

| [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | +| `node` | `public` | [`InterfaceStatementNode`](InterfaceStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `operations` | `public` | `RekeyableMap`<`string`, [`Operation`](Operation.md)\> | The operations of the interface. Operations are ordered in the order that they appear in the source. Operations obtained via `interface extends` appear before operations declared in the interface body. | - | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | +| `sourceInterfaces` | `public` | [`Interface`](Interface.md)[] | The interfaces that provide additional operations via `interface extends`. Note that despite the same `extends` keyword in source form, this is a different semantic relationship than the one from [Model](Model.md) to [Model.baseModel](Model.md). Operations from extended interfaces are copied into [Interface.operations](Interface.md). | - | - | +| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | **Deprecated** use templateMapper instead. | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | ## Accessors @@ -40,6 +40,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -51,7 +55,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md index 916826896..1b77b5cb1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md @@ -10,20 +10,20 @@ title: "[I] InterfaceStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `bodyRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | - | | `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | | `extends` | `readonly` | readonly [`TypeReferenceNode`](TypeReferenceNode.md)[] | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `InterfaceStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `InterfaceStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `locals?` | `readonly` | `SymbolTable` | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | | `operations` | `readonly` | readonly [`OperationStatementNode`](OperationStatementNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | -| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md index 8d2bec36a..c25d8a43b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md @@ -10,13 +10,13 @@ title: "[I] IntersectionExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `IntersectionExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `IntersectionExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `options` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md index 2ed0d199a..2256912e4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md @@ -18,16 +18,16 @@ title: "[I] IntrinsicType" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Intrinsic"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `name` | `public` | \| `"unknown"` \| `"never"` \| `"null"` \| `"ErrorType"` \| `"void"` | - | - | - | -| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Intrinsic"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `name` | `public` | \| `"unknown"` \| `"never"` \| `"null"` \| `"ErrorType"` \| `"void"` | - | - | - | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | ## Accessors @@ -41,6 +41,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -52,7 +56,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md index 370ca1e36..7bbd3fe54 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md @@ -10,13 +10,13 @@ title: "[I] InvalidStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `InvalidStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `InvalidStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md index bfc30cd89..18bdeb12e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md @@ -10,13 +10,13 @@ title: "[I] JsNamespaceDeclarationNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `JsNamespaceDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `JsNamespaceDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md index 19a0394b9..17778ce9e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md @@ -10,16 +10,16 @@ title: "[I] JsSourceFileNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | | `esmExports` | `readonly` | `any` | - | - | - | | `file` | `readonly` | [`SourceFile`](SourceFile.md) | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `JsSourceFile` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `JsSourceFile` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `namespaceSymbols` | `readonly` | [`Sym`](Sym.md)[] | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md index b13e6c72c..d7bd2bbae 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md @@ -6,7 +6,7 @@ title: "[I] LibraryInstance" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `definition?` | [`TypeSpecLibrary`](TypeSpecLibrary.md)<`any`, `Record`<`string`, `never`\>, `never`\> | | `entrypoint` | `undefined` \| [`JsSourceFileNode`](JsSourceFileNode.md) | | `linter` | [`LinterResolvedDefinition`](LinterResolvedDefinition.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md index 2f739d4c0..df6c8eecd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md @@ -8,7 +8,7 @@ Defined in a library. ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `flags?` | `readonly` | [`PackageFlags`](PackageFlags.md) | Module definition | | `metadata` | `readonly` | [`ModuleLibraryMetadata`](ModuleLibraryMetadata.md) | Library metadata | | `type` | `readonly` | `"library"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md index ca73a889b..73dbd82c8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md @@ -9,6 +9,6 @@ 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.

| +| ------ | ------ | ------ | +| `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/interfaces/LineComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md index 2fd85e4f2..860bc00ca 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md @@ -10,7 +10,7 @@ title: "[I] LineComment" ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`TextRange`](TextRange.md).`end` | | `kind` | `readonly` | `LineComment` | - | - | | `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md index 8074b6e31..a9a46ea5c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md @@ -6,6 +6,6 @@ title: "[I] LinterDefinition" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `ruleSets?` | `Record`<`string`, [`LinterRuleSet`](LinterRuleSet.md)\> | | `rules` | [`LinterRuleDefinition`](LinterRuleDefinition.md)<`string`, [`DiagnosticMessages`](DiagnosticMessages.md)\>[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterResolvedDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterResolvedDefinition.md index e370e6f07..3060bbed5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterResolvedDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterResolvedDefinition.md @@ -6,6 +6,6 @@ title: "[I] LinterResolvedDefinition" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `ruleSets` | `readonly` | `object` | | `rules` | `readonly` | [`LinterRule`](LinterRule.md)<`string`, [`DiagnosticMessages`](DiagnosticMessages.md)\>[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md index 58739acdc..9824d5f04 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md @@ -9,17 +9,17 @@ Resolved instance of a linter rule that will run. - [`LinterRuleDefinition`](LinterRuleDefinition.md)<`N`, `DM`\> -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `N` *extends* `string` | | `DM` *extends* [`DiagnosticMessages`](DiagnosticMessages.md) | ## Properties | Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `description` | `string` | Short description of the rule | [`LinterRuleDefinition`](LinterRuleDefinition.md).`description` | | `id` | `string` | Expanded rule id in format `:` | - | | `messages` | `DM` | Messages that can be reported with the diagnostic. | [`LinterRuleDefinition`](LinterRuleDefinition.md).`messages` | @@ -40,7 +40,7 @@ Creator #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`LinterRuleContext`](LinterRuleContext.md)<`DM`\> | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md index fb5525900..e0c15047a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md @@ -3,16 +3,16 @@ jsApi: true title: "[I] LinterRuleContext" --- -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `DM` *extends* [`DiagnosticMessages`](DiagnosticMessages.md) | ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `program` | `readonly` | [`Program`](Program.md) | ## Methods @@ -23,16 +23,16 @@ title: "[I] LinterRuleContext" reportDiagnostic(diag): void ``` -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `M` *extends* `string` \| `number` \| `symbol` | #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `diag` | [`LinterRuleDiagnosticReport`](../type-aliases/LinterRuleDiagnosticReport.md)<`DM`, `M`\> | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md index 750591acd..db6605746 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md @@ -7,17 +7,17 @@ title: "[I] LinterRuleDefinition" - [`LinterRule`](LinterRule.md) -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `N` *extends* `string` | | `DM` *extends* [`DiagnosticMessages`](DiagnosticMessages.md) | ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `description` | `string` | Short description of the rule | | `messages` | `DM` | Messages that can be reported with the diagnostic. | | `name` | `N` | Rule name (without the library name) | @@ -37,7 +37,7 @@ Creator #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`LinterRuleContext`](LinterRuleContext.md)<`DM`\> | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md index 3f2028a16..25da22768 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md @@ -6,7 +6,7 @@ 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/interfaces/ListOperationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md index a979bc00e..ac765ca70 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md @@ -6,5 +6,5 @@ title: "[I] ListOperationOptions" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | -| `recursive?` | `boolean` |

If the container is a namespace look for operation in sub namespaces.

**Default**

true | +| ------ | ------ | ------ | +| `recursive?` | `boolean` | If the container is a namespace look for operation in sub namespaces. **Default** `true` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md index dc568fc8f..1ae441158 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md @@ -6,7 +6,7 @@ title: "[I] LogInfo" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `code?` | `string` | | `level` | [`LogLevel`](../type-aliases/LogLevel.md) | | `message` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md index baf372d65..a22e4e953 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md @@ -14,7 +14,7 @@ log(log): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `log` | [`ProcessedLog`](ProcessedLog.md) | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md index f62b7a073..b43aff64d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md @@ -14,7 +14,7 @@ error(message): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `message` | `string` | #### Returns @@ -32,7 +32,7 @@ log(log): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `log` | [`LogInfo`](LogInfo.md) | #### Returns @@ -50,7 +50,7 @@ trace(message): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `message` | `string` | #### Returns @@ -68,7 +68,7 @@ warn(message): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `message` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md index 7c6dfca8c..d9e297d9b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md @@ -10,15 +10,15 @@ title: "[I] MemberExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `base` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | | `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `MemberExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `kind` | `readonly` | `MemberExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `selector` | `readonly` | `"."` \| `"::"` | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedFunctionParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedFunctionParameter.md index ab70b496e..4f0141e15 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedFunctionParameter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedFunctionParameter.md @@ -12,10 +12,10 @@ Represent a function parameter that could accept types or values in the TypeSpec ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `entityKind` | `readonly` | `"Type"` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`entityKind` | | `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`FunctionParameterBase`](FunctionParameterBase.md).`instantiationParameters` | -| `isFinished` | `public` | `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)
| [`FunctionParameterBase`](FunctionParameterBase.md).`isFinished` | +| `isFinished` | `public` | `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) | [`FunctionParameterBase`](FunctionParameterBase.md).`isFinished` | | `kind` | `public` | `"FunctionParameter"` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`kind` | | `mixed` | `public` | `true` | - | - | | `name` | `public` | `string` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`name` | @@ -39,6 +39,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`FunctionParameterBase`](FunctionParameterBase.md).[`projections`](FunctionParameterBase.md#projections) + ## Methods ### projectionsByName() @@ -50,7 +54,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedParameterConstraint.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedParameterConstraint.md index fb1ef97a3..f5debd905 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedParameterConstraint.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedParameterConstraint.md @@ -6,7 +6,7 @@ title: "[I] MixedParameterConstraint" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `entityKind` | `readonly` | `"MixedParameterConstraint"` | - | | `node?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | | `type?` | `readonly` | [`Type`](../type-aliases/Type.md) | Type constraints | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md index e2014613c..a4d15e1ce 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md @@ -15,27 +15,27 @@ title: "[I] Model" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `baseModel?` | `public` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | - | - | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | - | [`DecoratedType`](DecoratedType.md).`decorators` | | `derivedModels` | `public` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](Model.md) | - | - | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | | `indexer?` | `public` | [`ModelIndexer`](../type-aliases/ModelIndexer.md) | - | - | - | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Model"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Model"` | - | [`BaseType`](BaseType.md).`kind` | - | | `name` | `public` | `string` | - | - | - | | `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | -| `node?` | `public` | \| [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`ObjectLiteralNode`](ObjectLiteralNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `properties` | `public` | `RekeyableMap`<`string`, [`ModelProperty`](ModelProperty.md)\> |

The properties of the model.

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

Properties inherited via `model extends` are not included. Use

[walkPropertiesInherited](../functions/walkPropertiesInherited.md) to enumerate all properties in the inheritance hierarchy.

| - | - | +| `node?` | `public` | \| [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`ObjectLiteralNode`](ObjectLiteralNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | +| `properties` | `public` | `RekeyableMap`<`string`, [`ModelProperty`](ModelProperty.md)\> | The properties of the model. Properties are ordered in the order that they appear in source. Properties obtained via `model is` appear before properties defined in the model body. Properties obtained via `...` are inserted where the spread appears in source. Properties inherited via `model extends` are not included. Use [walkPropertiesInherited](../functions/walkPropertiesInherited.md) to enumerate all properties in the inheritance hierarchy. | - | - | | `sourceModel?` | `public` | [`Model`](Model.md) | The model that is referenced via `model is`. | - | - | | `sourceModels` | `public` | [`SourceModel`](SourceModel.md)[] | Models that were used to build this model. This include any model referenced in `model is`, `...` or when intersecting models. | - | - | -| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] |

**Deprecated**

use templateMapper instead.

| [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | +| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | **Deprecated** use templateMapper instead. | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | ## Accessors @@ -49,6 +49,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -60,7 +64,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md index 60f3a011c..e1f2f6628 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md @@ -10,14 +10,14 @@ title: "[I] ModelExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `bodyRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ModelExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ModelExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `properties` | `readonly` | ([`ModelPropertyNode`](ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md))[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md index ab8f5ef64..104bb8bd6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md @@ -10,21 +10,21 @@ title: "[I] ModelProperty" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| ~~`default?`~~ | `public` | [`Type`](../type-aliases/Type.md) |

**Deprecated**

use [defaultValue](ModelProperty.md) instead.

| - | - | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| ~~`default?`~~ | `public` | [`Type`](../type-aliases/Type.md) | **Deprecated** use [defaultValue](ModelProperty.md) instead. | - | - | | `defaultValue?` | `public` | [`Value`](../type-aliases/Value.md) | - | - | - | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"ModelProperty"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"ModelProperty"` | - | [`BaseType`](BaseType.md).`kind` | - | | `model?` | `public` | [`Model`](Model.md) | - | - | - | | `name` | `public` | `string` | - | - | - | -| `node` | `public` | \| [`ModelPropertyNode`](ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md) \| [`ProjectionModelPropertyNode`](ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](ProjectionModelSpreadPropertyNode.md) \| [`ObjectLiteralPropertyNode`](ObjectLiteralPropertyNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `node` | `public` | \| [`ModelPropertyNode`](ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md) \| [`ProjectionModelPropertyNode`](ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](ProjectionModelSpreadPropertyNode.md) \| [`ObjectLiteralPropertyNode`](ObjectLiteralPropertyNode.md) | - | [`BaseType`](BaseType.md).`node` | - | | `optional` | `public` | `boolean` | - | - | - | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `sourceProperty?` | `public` | [`ModelProperty`](ModelProperty.md) | - | - | - | | `type` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | @@ -40,6 +40,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -51,7 +55,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md index 5b80206bf..4f3a2abe7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md @@ -10,17 +10,17 @@ title: "[I] ModelPropertyNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | | `default?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | | `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `ModelProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `kind` | `readonly` | `ModelProperty` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `optional` | `readonly` | `boolean` | - | - | - | -| `parent?` | `readonly` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md index d8dc2254d..cd28cdf4d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md @@ -10,13 +10,13 @@ title: "[I] ModelSpreadPropertyNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ModelSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ModelSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md index 93527ecef..7ff84ad00 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md @@ -10,21 +10,21 @@ title: "[I] ModelStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `bodyRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | - | | `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | | `extends?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `is?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `kind` | `readonly` | `ModelStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `kind` | `readonly` | `ModelStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `locals?` | `readonly` | `SymbolTable` | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `properties` | `readonly` | readonly ([`ModelPropertyNode`](ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md))[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | -| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModuleLibraryMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModuleLibraryMetadata.md index 2f15167be..cc730e39c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModuleLibraryMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModuleLibraryMetadata.md @@ -12,10 +12,10 @@ Data for a library. Either loaded via a node_modules package or a standalone js ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `bugs?` | `public` | `object` | - | `LibraryMetadataBase.bugs` | | `bugs.url?` | `public` | `string` | Url where to file bugs for this library. | - | -| `homepage?` | `readonly` | `string` | Library homepage. | `LibraryMetadataBase.homepage` | +| `homepage?` | `public` | `string` | Library homepage. | `LibraryMetadataBase.homepage` | | `name` | `readonly` | `string` | Library name as specified in the package.json or in exported $lib. | - | -| `type` | `public` | `"module"` | - | - | +| `type` | `readonly` | `"module"` | - | - | | `version?` | `public` | `string` | Library version | `LibraryMetadataBase.version` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md index 2a8afb25c..34fcf8ef2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md @@ -10,27 +10,27 @@ title: "[I] Namespace" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decoratorDeclarations` | `public` | `Map`<`string`, [`Decorator`](Decorator.md)\> |

The decorators declared in the namespace.

Order is implementation-defined and may change.

| - | - | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `enums` | `public` | `Map`<`string`, [`Enum`](Enum.md)\> |

The enums in the namespace.

Order is implementation-defined and may change.

| - | - | -| `functionDeclarations` | `public` | `Map`<`string`, [`FunctionType`](FunctionType.md)\> |

The functions declared in the namespace.

Order is implementation-defined and may change.

| - | - | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `interfaces` | `public` | `Map`<`string`, [`Interface`](Interface.md)\> |

The interfaces in the namespace.

Order is implementation-defined and may change.

| - | - | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Namespace"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `models` | `public` | `Map`<`string`, [`Model`](Model.md)\> |

The models in the namespace.

Order is implementation-defined and may change.

| - | - | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `decoratorDeclarations` | `public` | `Map`<`string`, [`Decorator`](Decorator.md)\> | The decorators declared in the namespace. Order is implementation-defined and may change. | - | - | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `enums` | `public` | `Map`<`string`, [`Enum`](Enum.md)\> | The enums in the namespace. Order is implementation-defined and may change. | - | - | +| `functionDeclarations` | `public` | `Map`<`string`, [`FunctionType`](FunctionType.md)\> | The functions declared in the namespace. Order is implementation-defined and may change. | - | - | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `interfaces` | `public` | `Map`<`string`, [`Interface`](Interface.md)\> | The interfaces in the namespace. Order is implementation-defined and may change. | - | - | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Namespace"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `models` | `public` | `Map`<`string`, [`Model`](Model.md)\> | The models in the namespace. Order is implementation-defined and may change. | - | - | | `name` | `public` | `string` | - | - | - | | `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | -| `namespaces` | `public` | `Map`<`string`, [`Namespace`](Namespace.md)\> |

The sub-namespaces in the namespace.

Order is implementation-defined and may change.

| - | - | -| `node` | `public` | [`JsNamespaceDeclarationNode`](JsNamespaceDeclarationNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `operations` | `public` | `Map`<`string`, [`Operation`](Operation.md)\> |

The operations in the namespace.

Order is implementation-defined and may change.

| - | - | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `scalars` | `public` | `Map`<`string`, [`Scalar`](Scalar.md)\> |

The scalars in the namespace.

Order is implementation-defined and may change.

| - | - | -| `unions` | `public` | `Map`<`string`, [`Union`](Union.md)\> |

The unions in the namespace.

Order is implementation-defined and may change.

| - | - | +| `namespaces` | `public` | `Map`<`string`, [`Namespace`](Namespace.md)\> | The sub-namespaces in the namespace. Order is implementation-defined and may change. | - | - | +| `node` | `public` | [`JsNamespaceDeclarationNode`](JsNamespaceDeclarationNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `operations` | `public` | `Map`<`string`, [`Operation`](Operation.md)\> | The operations in the namespace. Order is implementation-defined and may change. | - | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | +| `scalars` | `public` | `Map`<`string`, [`Scalar`](Scalar.md)\> | The scalars in the namespace. Order is implementation-defined and may change. | - | - | +| `unions` | `public` | `Map`<`string`, [`Union`](Union.md)\> | The unions in the namespace. Order is implementation-defined and may change. | - | - | ## Accessors @@ -44,6 +44,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -55,7 +59,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md index 416c53c78..40e5845fd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md @@ -6,5 +6,5 @@ title: "[I] NamespaceNavigationOptions" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | -| `skipSubNamespaces?` | `boolean` |

Recursively navigate sub namespaces.

**Default**

false | +| ------ | ------ | ------ | +| `skipSubNamespaces?` | `boolean` | Recursively navigate sub namespaces. **Default** `false` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md index 739305e13..5d1711590 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md @@ -10,16 +10,16 @@ title: "[I] NamespaceStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `NamespaceStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `NamespaceStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `locals?` | `readonly` | `SymbolTable` | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `statements?` | `readonly` | [`NamespaceStatementNode`](NamespaceStatementNode.md) \| readonly [`Statement`](../type-aliases/Statement.md)[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md index f41933be2..c8ed889bd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md @@ -6,5 +6,5 @@ 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/interfaces/NeverKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md index 2e7769195..a0bb6e537 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md @@ -10,12 +10,12 @@ title: "[I] NeverKeywordNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `NeverKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `NeverKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md index 042829448..451e1e1f1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md @@ -10,16 +10,16 @@ title: "[I] NeverType" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | [`IntrinsicType`](IntrinsicType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`IntrinsicType`](IntrinsicType.md).`isFinished` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | -| `kind` | `public` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | -| `name` | `public` | `"never"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`IntrinsicType`](IntrinsicType.md).`isFinished` | +| `kind` | `public` | `"Intrinsic"` | - | - | [`IntrinsicType`](IntrinsicType.md).`kind` | +| `name` | `public` | `"never"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | - | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projector` | ## Accessors @@ -33,6 +33,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`IntrinsicType`](IntrinsicType.md).[`projections`](IntrinsicType.md#projections) + ## Methods ### projectionsByName() @@ -44,7 +48,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md index 89743a77d..01fc31cf1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md @@ -8,7 +8,7 @@ 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` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md index 50b8c022f..c7d15abef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md @@ -10,16 +10,16 @@ title: "[I] NullType" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | [`IntrinsicType`](IntrinsicType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`IntrinsicType`](IntrinsicType.md).`isFinished` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | -| `kind` | `public` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | -| `name` | `public` | `"null"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`IntrinsicType`](IntrinsicType.md).`isFinished` | +| `kind` | `public` | `"Intrinsic"` | - | - | [`IntrinsicType`](IntrinsicType.md).`kind` | +| `name` | `public` | `"null"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | - | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projector` | ## Accessors @@ -33,6 +33,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`IntrinsicType`](IntrinsicType.md).[`projections`](IntrinsicType.md#projections) + ## Methods ### projectionsByName() @@ -44,7 +48,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullValue.md index c30784c06..1aa1a0aa0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullValue.md @@ -10,8 +10,8 @@ title: "[I] NullValue" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | -| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

const a = "hello"; // Type here would be "hello"

const b: string = a; // Type here would be string

const c: string \| int32 = b; // Type here would be string \| int32

 | `BaseValue.type` | `BaseValue.type` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Value"` | - | - | `BaseValue.entityKind` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) | Represent the storage type of a value. **Example** `const a = "hello"; // Type here would be "hello" const b: string = a; // Type here would be string const c: string | int32 = b; // Type here would be string | int32` | - | `BaseValue.type` | | `value` | `public` | `null` | - | - | - | -| `valueKind` | `public` | `"NullValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | +| `valueKind` | `public` | `"NullValue"` | - | `BaseValue.valueKind` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Numeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Numeric.md index 0dbe9eb31..f13d1f405 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Numeric.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Numeric.md @@ -8,7 +8,7 @@ title: "[I] Numeric" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `isInteger` | `readonly` | `boolean` | ## Methods @@ -48,7 +48,7 @@ equals(value): boolean #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `value` | [`Numeric`](Numeric.md) | #### Returns @@ -66,7 +66,7 @@ gt(value): boolean #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `value` | [`Numeric`](Numeric.md) | #### Returns @@ -84,7 +84,7 @@ gte(value): boolean #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `value` | [`Numeric`](Numeric.md) | #### Returns @@ -102,7 +102,7 @@ lt(value): boolean #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `value` | [`Numeric`](Numeric.md) | #### Returns @@ -120,7 +120,7 @@ lte(value): boolean #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `value` | [`Numeric`](Numeric.md) | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md index 7e17af5c5..4ea49e88c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md @@ -10,16 +10,16 @@ title: "[I] NumericLiteral" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Number"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node?` | `public` | [`NumericLiteralNode`](NumericLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Number"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `node?` | `public` | [`NumericLiteralNode`](NumericLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | - | | `numericValue` | `public` | [`Numeric`](Numeric.md) | - | - | - | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `value` | `public` | `number` | - | - | - | | `valueAsString` | `public` | `string` | - | - | - | @@ -35,6 +35,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -46,7 +50,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md index 802bc7bf0..3a2293549 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md @@ -10,14 +10,14 @@ title: "[I] NumericLiteralNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `NumericLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `NumericLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `value` | `readonly` | `number` | - | - | - | | `valueAsString` | `readonly` | `string` | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericValue.md index b641c2c85..4ba5f8201 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericValue.md @@ -10,9 +10,9 @@ title: "[I] NumericValue" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Value"` | - | - | `BaseValue.entityKind` | | `scalar` | `public` | `undefined` \| [`Scalar`](Scalar.md) | - | - | - | -| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

const a = "hello"; // Type here would be "hello"

const b: string = a; // Type here would be string

const c: string \| int32 = b; // Type here would be string \| int32

 | `BaseValue.type` | `BaseValue.type` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) | Represent the storage type of a value. **Example** `const a = "hello"; // Type here would be "hello" const b: string = a; // Type here would be string const c: string | int32 = b; // Type here would be string | int32` | - | `BaseValue.type` | | `value` | `public` | [`Numeric`](Numeric.md) | - | - | - | -| `valueKind` | `public` | `"NumericValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | +| `valueKind` | `public` | `"NumericValue"` | - | `BaseValue.valueKind` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralNode.md index 0673dc47b..55d36fa5e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralNode.md @@ -10,14 +10,14 @@ title: "[I] ObjectLiteralNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `bodyRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ObjectLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ObjectLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `properties` | `readonly` | ([`ObjectLiteralPropertyNode`](ObjectLiteralPropertyNode.md) \| [`ObjectLiteralSpreadPropertyNode`](ObjectLiteralSpreadPropertyNode.md))[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralPropertyNode.md index 44ff6c491..b1e3ae3d0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralPropertyNode.md @@ -10,14 +10,14 @@ title: "[I] ObjectLiteralPropertyNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | | `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `ObjectLiteralProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`ObjectLiteralNode`](ObjectLiteralNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `kind` | `readonly` | `ObjectLiteralProperty` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`ObjectLiteralNode`](ObjectLiteralNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralSpreadPropertyNode.md index 4b48f6a4d..0219a66b9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralSpreadPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralSpreadPropertyNode.md @@ -10,13 +10,13 @@ title: "[I] ObjectLiteralSpreadPropertyNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ObjectLiteralSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`ObjectLiteralNode`](ObjectLiteralNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ObjectLiteralSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`ObjectLiteralNode`](ObjectLiteralNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md index d39584abd..be66b14ed 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md @@ -10,15 +10,15 @@ title: "[I] ObjectType" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Object"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Object"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `properties` | `public` | `Record`<`string`, [`Type`](../type-aliases/Type.md)\> | - | - | - | ## Accessors @@ -33,6 +33,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -44,7 +48,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValue.md index 2516734bc..6fea0ba49 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValue.md @@ -10,9 +10,9 @@ title: "[I] ObjectValue" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Value"` | - | - | `BaseValue.entityKind` | | `node` | `public` | [`ObjectLiteralNode`](ObjectLiteralNode.md) | - | - | - | | `properties` | `public` | `Map`<`string`, [`ObjectValuePropertyDescriptor`](ObjectValuePropertyDescriptor.md)\> | - | - | - | -| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

const a = "hello"; // Type here would be "hello"

const b: string = a; // Type here would be string

const c: string \| int32 = b; // Type here would be string \| int32

 | `BaseValue.type` | `BaseValue.type` | -| `valueKind` | `public` | `"ObjectValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) | Represent the storage type of a value. **Example** `const a = "hello"; // Type here would be "hello" const b: string = a; // Type here would be string const c: string | int32 = b; // Type here would be string | int32` | - | `BaseValue.type` | +| `valueKind` | `public` | `"ObjectValue"` | - | `BaseValue.valueKind` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValuePropertyDescriptor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValuePropertyDescriptor.md index 8ee7f9bd1..71b50412a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValuePropertyDescriptor.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValuePropertyDescriptor.md @@ -6,7 +6,7 @@ title: "[I] ObjectValuePropertyDescriptor" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | | `node` | [`ObjectLiteralPropertyNode`](ObjectLiteralPropertyNode.md) | | `value` | [`Value`](../type-aliases/Value.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OpExample.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OpExample.md new file mode 100644 index 000000000..c1d8f52a2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OpExample.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] OpExample" + +--- +## Extends + +- [`ExampleOptions`](ExampleOptions.md) + +## Properties + +| Property | Modifier | Type | Inherited from | +| ------ | ------ | ------ | ------ | +| `description?` | `readonly` | `string` | [`ExampleOptions`](ExampleOptions.md).`description` | +| `parameters?` | `readonly` | [`Value`](../type-aliases/Value.md) | - | +| `returnType?` | `readonly` | [`Value`](../type-aliases/Value.md) | - | +| `title?` | `readonly` | `string` | [`ExampleOptions`](ExampleOptions.md).`title` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md index c39046334..4532c23cd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md @@ -10,25 +10,25 @@ title: "[I] Operation" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `interface?` | `public` | [`Interface`](Interface.md) | - | - | - | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Operation"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Operation"` | - | [`BaseType`](BaseType.md).`kind` | - | | `name` | `public` | `string` | - | - | - | | `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | -| `node` | `public` | [`OperationStatementNode`](OperationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `node` | `public` | [`OperationStatementNode`](OperationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | - | | `parameters` | `public` | [`Model`](Model.md) | - | - | - | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `returnType` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | | `sourceOperation?` | `public` | [`Operation`](Operation.md) | The operation that is referenced via `op is`. | - | - | -| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] |

**Deprecated**

use templateMapper instead.

| [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | +| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | **Deprecated** use templateMapper instead. | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | ## Accessors @@ -42,6 +42,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -53,7 +57,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md index 1dca2600e..6d4da6cfb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md @@ -10,14 +10,14 @@ title: "[I] OperationSignatureDeclarationNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `OperationSignatureDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `OperationSignatureDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `parameters` | `readonly` | [`ModelExpressionNode`](ModelExpressionNode.md) | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `returnType` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md index e5eb7641b..b4eaffb9d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md @@ -10,13 +10,13 @@ title: "[I] OperationSignatureReferenceNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `baseOperation` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `OperationSignatureReference` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `OperationSignatureReference` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md index ea4fceb8e..8ebb6e7f0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md @@ -10,18 +10,18 @@ title: "[I] OperationStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `OperationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) \| [`InterfaceStatementNode`](InterfaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `OperationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `locals?` | `readonly` | `SymbolTable` | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) \| [`InterfaceStatementNode`](InterfaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `signature` | `readonly` | [`OperationSignature`](../type-aliases/OperationSignature.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | -| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageFlags.md index 06b88bf17..c97438670 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageFlags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageFlags.md @@ -6,5 +6,5 @@ title: "[I] PackageFlags" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `decoratorArgMarshalling?` | `readonly` | `"new"` \| `"legacy"` |

Decorator arg marshalling algorithm. Specify how TypeSpec values are marshalled to decorator arguments.

  • `lossless` - New recommended behavior
  • string value -> `string`
  • numeric value -> `number` if the constraint can be represented as a JS number, Numeric otherwise(e.g. for types int64, decimal128, numeric, etc.)
  • boolean value -> `boolean`
  • null value -> `null`
  • `legacy` Behavior before version 0.56.0.
  • string value -> `string`
  • numeric value -> `number`
  • boolean value -> `boolean`
  • null value -> `NullType`

**Default**

legacy | +| ------ | ------ | ------ | ------ | +| `decoratorArgMarshalling?` | `readonly` | `"new"` \| `"legacy"` | Decorator arg marshalling algorithm. Specify how TypeSpec values are marshalled to decorator arguments. - `lossless` - New recommended behavior - string value -> `string` - numeric value -> `number` if the constraint can be represented as a JS number, Numeric otherwise(e.g. for types int64, decimal128, numeric, etc.) - boolean value -> `boolean` - null value -> `null` - `legacy` Behavior before version 0.56.0. - string value -> `string` - numeric value -> `number` - boolean value -> `boolean` - null value -> `NullType` **Default** `legacy` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md index 54b58fbf5..00f33d80b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md @@ -6,6 +6,6 @@ title: "[I] ParseOptions" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `comments?` | `readonly` | `boolean` | When true, collect comment ranges in [TypeSpecScriptNode.comments](TypeSpecScriptNode.md). | | `docs?` | `readonly` | `boolean` | When true, parse doc comments into [Node.docs](BaseNode.md). | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PatternData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PatternData.md index 9cf3124d2..ebcfc06cc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PatternData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PatternData.md @@ -6,6 +6,6 @@ title: "[I] PatternData" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `pattern` | `readonly` | `string` | | `validationMessage?` | `readonly` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PositionDetail.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PositionDetail.md index a584105f1..483372e22 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PositionDetail.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PositionDetail.md @@ -8,7 +8,7 @@ owner node and other related information according to the position ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `char` | `readonly` | `number` | - | | `getPositionDetailAfterTrivia` | `readonly` | () => [`PositionDetail`](PositionDetail.md) | get the PositionDetail of positionAfterTrivia | | `getPositionDetailBeforeTrivia` | `readonly` | () => [`PositionDetail`](PositionDetail.md) | get the PositionDetail of positionBeforeTrivia | @@ -17,5 +17,5 @@ owner node and other related information according to the position | `node` | `readonly` | `undefined` \| [`Node`](../type-aliases/Node.md) | - | | `position` | `readonly` | `number` | - | | `preChar` | `readonly` | `number` | - | -| `triviaEndPosition` | `readonly` | `number` |

if the position is in a trivia, return the end position (exclude as other 'end' means) of the trivia containing the position if the position is not a trivia, return the end position (exclude as other 'end' means) of the trivia after the node containing the position

Please be aware that this may not be the next node in the tree because some non-trivia char is ignored in the tree but will considered here

also comments are considered as trivia

| -| `triviaStartPosition` | `readonly` | `number` |

if the position is in a trivia, return the start position of the trivia containing the position if the position is not a trivia, return the start position of the trivia before the text(identifier code) containing the position

Please be aware that this may not be the pre node in the tree because some non-trivia char is ignored in the tree but will counted here

also comments are considered as trivia

| +| `triviaEndPosition` | `readonly` | `number` | if the position is in a trivia, return the end position (exclude as other 'end' means) of the trivia containing the position if the position is not a trivia, return the end position (exclude as other 'end' means) of the trivia after the node containing the position Please be aware that this may not be the next node in the tree because some non-trivia char is ignored in the tree but will considered here also comments are considered as trivia | +| `triviaStartPosition` | `readonly` | `number` | if the position is in a trivia, return the start position of the trivia containing the position if the position is not a trivia, return the start position of the trivia before the text(identifier code) containing the position Please be aware that this may not be the pre node in the tree because some non-trivia char is ignored in the tree but will counted here also comments are considered as trivia | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md index 205d34f9e..3d6f20397 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md @@ -6,7 +6,7 @@ title: "[I] ProcessedLog" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `code?` | `string` | | `level` | [`LogLevel`](../type-aliases/LogLevel.md) | | `message` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md index 8ffe2e660..7962fa952 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md @@ -10,7 +10,7 @@ title: "[I] Program" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `checker` | `public` | [`Checker`](Checker.md) | - | | `compilerOptions` | `public` | [`CompilerOptions`](CompilerOptions.md) | - | | `diagnostics` | `readonly` | readonly [`Diagnostic`](Diagnostic.md)[] | - | @@ -48,7 +48,7 @@ getOption(key): undefined | string #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `key` | `string` | #### Returns @@ -68,7 +68,7 @@ Return location context of the given source file. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `sourceFile` | [`SourceFile`](SourceFile.md) | #### Returns @@ -98,7 +98,7 @@ loadTypeSpecScript(typespecScript): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `typespecScript` | [`SourceFile`](SourceFile.md) | #### Returns @@ -116,7 +116,7 @@ onValidate(cb, LibraryMetadata): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `cb` | (`program`) => `void` \| `Promise`<`void`\> | | `LibraryMetadata` | [`LibraryMetadata`](../type-aliases/LibraryMetadata.md) | @@ -135,7 +135,7 @@ reportDiagnostic(diagnostic): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `diagnostic` | [`Diagnostic`](Diagnostic.md) | #### Returns @@ -153,7 +153,7 @@ reportDiagnostics(diagnostics): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `diagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | #### Returns @@ -171,7 +171,7 @@ reportDuplicateSymbols(symbols): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `symbols` | `undefined` \| `SymbolTable` | #### Returns @@ -189,7 +189,7 @@ resolveTypeReference(reference): [undefined | Type, readonly Diagnostic[]] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `reference` | `string` | #### Returns @@ -207,7 +207,7 @@ stateMap(key): Map #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `key` | `symbol` | #### Returns @@ -225,7 +225,7 @@ stateSet(key): Set #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `key` | `symbol` | #### Returns @@ -243,7 +243,7 @@ trace(area, message): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `area` | `string` | | `message` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md index 8937430ee..86625d2b9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md @@ -8,6 +8,6 @@ Defined in the user project. ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `flags?` | `readonly` | [`PackageFlags`](PackageFlags.md) | | `type` | `readonly` | `"project"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md index ff84e67f1..5dd8dc7cc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md @@ -6,7 +6,7 @@ title: "[I] ProjectedNameView" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`ProjectedProgram`](ProjectedProgram.md) | ## Methods @@ -23,7 +23,7 @@ If there is a projected name it returns that one otherwise return the original n #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `target` | [`Type`](../type-aliases/Type.md) & `object` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md index a34884711..7f1c831f5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md @@ -10,7 +10,7 @@ title: "[I] ProjectedProgram" ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `checker` | `public` | [`Checker`](Checker.md) | - | [`Program`](Program.md).`checker` | | `compilerOptions` | `public` | [`CompilerOptions`](CompilerOptions.md) | - | [`Program`](Program.md).`compilerOptions` | | `diagnostics` | `readonly` | readonly [`Diagnostic`](Diagnostic.md)[] | - | [`Program`](Program.md).`diagnostics` | @@ -53,7 +53,7 @@ getOption(key): undefined | string #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `key` | `string` | #### Returns @@ -77,7 +77,7 @@ Return location context of the given source file. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `sourceFile` | [`SourceFile`](SourceFile.md) | #### Returns @@ -115,7 +115,7 @@ loadTypeSpecScript(typespecScript): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `typespecScript` | [`SourceFile`](SourceFile.md) | #### Returns @@ -137,7 +137,7 @@ onValidate(cb, LibraryMetadata): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `cb` | (`program`) => `void` \| `Promise`<`void`\> | | `LibraryMetadata` | [`LibraryMetadata`](../type-aliases/LibraryMetadata.md) | @@ -160,7 +160,7 @@ reportDiagnostic(diagnostic): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `diagnostic` | [`Diagnostic`](Diagnostic.md) | #### Returns @@ -182,7 +182,7 @@ reportDiagnostics(diagnostics): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `diagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | #### Returns @@ -204,7 +204,7 @@ reportDuplicateSymbols(symbols): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `symbols` | `undefined` \| `SymbolTable` | #### Returns @@ -226,7 +226,7 @@ resolveTypeReference(reference): [undefined | Type, readonly Diagnostic[]] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `reference` | `string` | #### Returns @@ -248,7 +248,7 @@ stateMap(key): Map #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `key` | `symbol` | #### Returns @@ -270,7 +270,7 @@ stateSet(key): Set #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `key` | `symbol` | #### Returns @@ -292,7 +292,7 @@ trace(area, message): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `area` | `string` | | `message` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md index 1be376e9e..182d0e155 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md @@ -10,17 +10,17 @@ title: "[I] Projection" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Projection"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node` | `public` | `undefined` | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Projection"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `node` | `public` | `undefined` | - | [`BaseType`](BaseType.md).`node` | - | | `nodeByKind` | `public` | `Map`<`string`, [`ProjectionStatementNode`](ProjectionStatementNode.md)\> | - | - | - | | `nodeByType` | `public` | `Map`<[`Type`](../type-aliases/Type.md), [`ProjectionStatementNode`](ProjectionStatementNode.md)\> | - | - | - | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | ## Accessors @@ -34,6 +34,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -45,7 +49,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md index 9e2fdd7d7..700a535b7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md @@ -6,7 +6,7 @@ title: "[I] ProjectionApplication" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `arguments` | [`DecoratorArgumentValue`](../type-aliases/DecoratorArgumentValue.md)[] | | `direction?` | `"to"` \| `"from"` | | `projectionName` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md index 761bd7f3d..84f8e6cf2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md @@ -10,15 +10,15 @@ title: "[I] ProjectionArithmeticExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionArithmeticExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionArithmeticExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | | `op` | `readonly` | `"-"` \| `"/"` \| `"+"` \| `"*"` | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md index bbdd2f026..b310dc549 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md @@ -10,13 +10,13 @@ title: "[I] ProjectionBlockExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionBlockExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionBlockExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `statements` | `readonly` | [`ProjectionExpressionStatementNode`](ProjectionExpressionStatementNode.md)[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md index ffd2450b6..e76035b0d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md @@ -10,15 +10,15 @@ title: "[I] ProjectionCallExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `arguments` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md)[] | - | - | - | | `callKind` | `readonly` | `"template"` \| `"method"` | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionCallExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionCallExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md index e5de9f0f9..6ef36e69d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md @@ -10,13 +10,13 @@ title: "[I] ProjectionDecoratorReferenceExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionDecoratorReferenceExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionDecoratorReferenceExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md index c81e1ae31..e913bc6d5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md @@ -10,12 +10,12 @@ title: "[I] ProjectionEnumMemberSelectorNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionEnumMemberSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionEnumMemberSelector` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md index 1b7f510b3..9364189a0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md @@ -10,12 +10,12 @@ title: "[I] ProjectionEnumSelectorNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionEnumSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionEnumSelector` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md index 59692aa29..080581183 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md @@ -10,15 +10,15 @@ title: "[I] ProjectionEqualityExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionEqualityExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionEqualityExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | | `op` | `readonly` | `"=="` \| `"!="` | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md index 979a244e8..c2b2aab54 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md @@ -10,13 +10,13 @@ title: "[I] ProjectionExpressionStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | | `expr` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionExpressionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionExpressionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md index c5a8804c0..6f25767ee 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md @@ -10,15 +10,15 @@ title: "[I] ProjectionIfExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `alternate?` | `readonly` | [`ProjectionIfExpressionNode`](ProjectionIfExpressionNode.md) \| [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | - | | `consequent` | `readonly` | [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionIfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionIfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `test` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md index 9b6aceea9..61aa005e8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md @@ -10,12 +10,12 @@ title: "[I] ProjectionInterfaceSelectorNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionInterfaceSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionInterfaceSelector` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md index a37a984ae..c743a6fbd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md @@ -10,15 +10,15 @@ title: "[I] ProjectionLambdaExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `body` | `readonly` | [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionLambdaExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionLambdaExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `locals?` | `readonly` | `SymbolTable` | - | - | - | | `parameters` | `readonly` | readonly [`ProjectionLambdaParameterDeclarationNode`](ProjectionLambdaParameterDeclarationNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md index bb4ef9050..213cea615 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md @@ -10,13 +10,13 @@ title: "[I] ProjectionLambdaParameterDeclarationNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `ProjectionLambdaParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `ProjectionLambdaParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md index d4405dda1..fa613d2f4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md @@ -10,15 +10,15 @@ title: "[I] ProjectionLogicalExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionLogicalExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionLogicalExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | | `op` | `readonly` | "\|\|" \| `"&&"` | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md index 5fb330f96..ad072452e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md @@ -10,15 +10,15 @@ title: "[I] ProjectionMemberExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `base` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | | `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `ProjectionMemberExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `kind` | `readonly` | `ProjectionMemberExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `selector` | `readonly` | `"."` \| `"::"` | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md index 1fba7bdc1..e84d81646 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md @@ -10,13 +10,13 @@ title: "[I] ProjectionModelExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionModelExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionModelExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `properties` | `readonly` | ([`ProjectionModelPropertyNode`](ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](ProjectionModelSpreadPropertyNode.md))[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md index 7e45d475f..adf069f67 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md @@ -10,17 +10,17 @@ title: "[I] ProjectionModelPropertyNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | | `default?` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | | `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `ProjectionModelProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `kind` | `readonly` | `ProjectionModelProperty` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `optional` | `readonly` | `boolean` | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `value` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md index 884f03bae..2f6ffd72f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md @@ -10,12 +10,12 @@ title: "[I] ProjectionModelPropertySelectorNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionModelPropertySelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionModelPropertySelector` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md index 5254bb2d5..3350eaf6c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md @@ -10,12 +10,12 @@ title: "[I] ProjectionModelSelectorNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionModelSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionModelSelector` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md index 3add21a13..eee1b921c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md @@ -10,13 +10,13 @@ title: "[I] ProjectionModelSpreadPropertyNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionModelSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionModelSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md index 3421ce4f2..bd60393f3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md @@ -10,18 +10,18 @@ title: "[I] ProjectionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `body` | `readonly` | readonly [`ProjectionExpressionStatementNode`](ProjectionExpressionStatementNode.md)[] | - | - | - | -| `direction` | `readonly` | \| `"to"` \| `"from"` \| `"pre_to"` \| `"pre_from"` \| `""` | - | - | - | +| `direction` | `readonly` | \| `"to"` \| `"from"` \| `"pre_to"` \| `"pre_from"` \| `""` | - | - | - | | `directionId` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `Projection` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `Projection` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `locals?` | `readonly` | `SymbolTable` | - | - | - | | `modifierIds` | `readonly` | readonly [`IdentifierNode`](IdentifierNode.md)[] | - | - | - | | `parameters` | `readonly` | [`ProjectionParameterDeclarationNode`](ProjectionParameterDeclarationNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md index 74e935721..a6b907f6b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md @@ -10,12 +10,12 @@ title: "[I] ProjectionOperationSelectorNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionOperationSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionOperationSelector` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md index 13ca83ed9..c8a107bb2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md @@ -10,13 +10,13 @@ title: "[I] ProjectionParameterDeclarationNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `ProjectionParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `ProjectionParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md index 43a3b47bf..44b5d50ef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md @@ -10,14 +10,14 @@ title: "[I] ProjectionReferenceNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `arguments` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionReference` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionReference` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md index 8fbb0a7a8..395763ece 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md @@ -10,15 +10,15 @@ title: "[I] ProjectionRelationalExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionRelationalExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionRelationalExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | | `op` | `readonly` | `"<="` \| `">="` \| `"<"` \| `">"` | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md index b93e0b832..3097917d6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md @@ -10,12 +10,12 @@ title: "[I] ProjectionScalarSelectorNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionScalarSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionScalarSelector` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md index 2d47c3937..ed294647a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md @@ -10,19 +10,19 @@ title: "[I] ProjectionStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | | `from?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `ProjectionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `ProjectionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `preFrom?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | | `preTo?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | | `projections` | `readonly` | readonly [`ProjectionNode`](ProjectionNode.md)[] | - | - | - | -| `selector` | `readonly` | \| [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) \| [`ProjectionModelSelectorNode`](ProjectionModelSelectorNode.md) \| [`ProjectionModelPropertySelectorNode`](ProjectionModelPropertySelectorNode.md) \| [`ProjectionScalarSelectorNode`](ProjectionScalarSelectorNode.md) \| [`ProjectionInterfaceSelectorNode`](ProjectionInterfaceSelectorNode.md) \| [`ProjectionOperationSelectorNode`](ProjectionOperationSelectorNode.md) \| [`ProjectionEnumSelectorNode`](ProjectionEnumSelectorNode.md) \| [`ProjectionEnumMemberSelectorNode`](ProjectionEnumMemberSelectorNode.md) \| [`ProjectionUnionSelectorNode`](ProjectionUnionSelectorNode.md) \| [`ProjectionUnionVariantSelectorNode`](ProjectionUnionVariantSelectorNode.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `selector` | `readonly` | \| [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) \| [`ProjectionModelSelectorNode`](ProjectionModelSelectorNode.md) \| [`ProjectionModelPropertySelectorNode`](ProjectionModelPropertySelectorNode.md) \| [`ProjectionScalarSelectorNode`](ProjectionScalarSelectorNode.md) \| [`ProjectionInterfaceSelectorNode`](ProjectionInterfaceSelectorNode.md) \| [`ProjectionOperationSelectorNode`](ProjectionOperationSelectorNode.md) \| [`ProjectionEnumSelectorNode`](ProjectionEnumSelectorNode.md) \| [`ProjectionEnumMemberSelectorNode`](ProjectionEnumMemberSelectorNode.md) \| [`ProjectionUnionSelectorNode`](ProjectionUnionSelectorNode.md) \| [`ProjectionUnionVariantSelectorNode`](ProjectionUnionVariantSelectorNode.md) | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `to?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md index 8b689cb99..5eb78d07d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md @@ -10,13 +10,13 @@ title: "[I] ProjectionTupleExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionTupleExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionTupleExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `values` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md index 4d8026e04..566c15820 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md @@ -10,14 +10,14 @@ title: "[I] ProjectionUnaryExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionUnaryExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionUnaryExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `op` | `readonly` | `"!"` | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md index 29ba0e4fd..45bd1a708 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md @@ -10,12 +10,12 @@ title: "[I] ProjectionUnionSelectorNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionUnionSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionUnionSelector` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md index b7569f210..3dbbb1fd8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md @@ -10,12 +10,12 @@ title: "[I] ProjectionUnionVariantSelectorNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionUnionVariantSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionUnionVariantSelector` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md index 814cc63b7..d137414a1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md @@ -6,7 +6,7 @@ title: "[I] Projector" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `parentProjector?` | [`Projector`](Projector.md) | | `projectedGlobalNamespace?` | [`Namespace`](Namespace.md) | | `projectedStartNode?` | [`Type`](../type-aliases/Type.md) | @@ -24,7 +24,7 @@ projectType(type): Type | Value #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md index e73fe72a1..5a488290b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md @@ -10,29 +10,29 @@ title: "[I] RecordModelType" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `baseModel?` | `public` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | [`Model`](Model.md).`baseModel` | [`Model`](Model.md).`baseModel` | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`Model`](Model.md).`decorators` | [`Model`](Model.md).`decorators` | -| `derivedModels` | `public` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](Model.md) | [`Model`](Model.md).`derivedModels` | [`Model`](Model.md).`derivedModels` | -| `entityKind` | `readonly` | `"Type"` | - | [`Model`](Model.md).`entityKind` | [`Model`](Model.md).`entityKind` | -| `indexer` | `public` | `object` | - | [`Model`](Model.md).`indexer` | [`Model`](Model.md).`indexer` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `baseModel?` | `public` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | - | [`Model`](Model.md).`baseModel` | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | - | [`Model`](Model.md).`decorators` | +| `derivedModels` | `public` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](Model.md) | - | [`Model`](Model.md).`derivedModels` | +| `entityKind` | `readonly` | `"Type"` | - | - | [`Model`](Model.md).`entityKind` | +| `indexer` | `public` | `object` | - | [`Model`](Model.md).`indexer` | - | | `indexer.key` | `public` | [`Scalar`](Scalar.md) | - | - | - | | `indexer.value` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`Model`](Model.md).`instantiationParameters` | [`Model`](Model.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`Model`](Model.md).`isFinished` | [`Model`](Model.md).`isFinished` | -| `kind` | `public` | `"Model"` | - | [`Model`](Model.md).`kind` | [`Model`](Model.md).`kind` | -| `name` | `public` | `string` | - | [`Model`](Model.md).`name` | [`Model`](Model.md).`name` | -| `namespace?` | `public` | [`Namespace`](Namespace.md) | - | [`Model`](Model.md).`namespace` | [`Model`](Model.md).`namespace` | -| `node?` | `public` | \| [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`ObjectLiteralNode`](ObjectLiteralNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`Model`](Model.md).`node` | [`Model`](Model.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionBase` | [`Model`](Model.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionSource` | [`Model`](Model.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`Model`](Model.md).`projector` | [`Model`](Model.md).`projector` | -| `properties` | `public` | `RekeyableMap`<`string`, [`ModelProperty`](ModelProperty.md)\> |

The properties of the model.

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

Properties inherited via `model extends` are not included. Use

[walkPropertiesInherited](../functions/walkPropertiesInherited.md) to enumerate all properties in the inheritance hierarchy.

| [`Model`](Model.md).`properties` | [`Model`](Model.md).`properties` | -| `sourceModel?` | `public` | [`Model`](Model.md) | The model that is referenced via `model is`. | [`Model`](Model.md).`sourceModel` | [`Model`](Model.md).`sourceModel` | -| `sourceModels` | `public` | [`SourceModel`](SourceModel.md)[] | Models that were used to build this model. This include any model referenced in `model is`, `...` or when intersecting models. | [`Model`](Model.md).`sourceModels` | [`Model`](Model.md).`sourceModels` | -| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] |

**Deprecated**

use templateMapper instead.

| [`Model`](Model.md).`templateArguments` | [`Model`](Model.md).`templateArguments` | -| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`Model`](Model.md).`templateMapper` | [`Model`](Model.md).`templateMapper` | -| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`Model`](Model.md).`templateNode` | [`Model`](Model.md).`templateNode` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`Model`](Model.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`Model`](Model.md).`isFinished` | +| `kind` | `public` | `"Model"` | - | - | [`Model`](Model.md).`kind` | +| `name` | `public` | `string` | - | - | [`Model`](Model.md).`name` | +| `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | [`Model`](Model.md).`namespace` | +| `node?` | `public` | \| [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`ObjectLiteralNode`](ObjectLiteralNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | - | [`Model`](Model.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`Model`](Model.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`Model`](Model.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`Model`](Model.md).`projector` | +| `properties` | `public` | `RekeyableMap`<`string`, [`ModelProperty`](ModelProperty.md)\> | The properties of the model. Properties are ordered in the order that they appear in source. Properties obtained via `model is` appear before properties defined in the model body. Properties obtained via `...` are inserted where the spread appears in source. Properties inherited via `model extends` are not included. Use [walkPropertiesInherited](../functions/walkPropertiesInherited.md) to enumerate all properties in the inheritance hierarchy. | - | [`Model`](Model.md).`properties` | +| `sourceModel?` | `public` | [`Model`](Model.md) | The model that is referenced via `model is`. | - | [`Model`](Model.md).`sourceModel` | +| `sourceModels` | `public` | [`SourceModel`](SourceModel.md)[] | Models that were used to build this model. This include any model referenced in `model is`, `...` or when intersecting models. | - | [`Model`](Model.md).`sourceModels` | +| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | **Deprecated** use templateMapper instead. | - | [`Model`](Model.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | - | [`Model`](Model.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`Model`](Model.md).`templateNode` | ## Accessors @@ -46,6 +46,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`Model`](Model.md).[`projections`](Model.md#projections) + ## Methods ### projectionsByName() @@ -57,7 +61,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md index a647bd00e..835dd4bb0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md @@ -10,7 +10,7 @@ title: "[I] ReplaceTextCodeFixEdit" ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`TextRange`](TextRange.md).`end` | | `file` | `readonly` | [`SourceFile`](SourceFile.md) | - | - | | `kind` | `readonly` | `"replace-text"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md index 92f81ef4d..c2f8eb161 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md @@ -10,7 +10,7 @@ title: "[I] ResolveCompilerOptionsOptions" ## Properties | Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `args?` | `Record`<`string`, `string`\> | Any arguments to interpolate the config. | `ConfigToOptionsOptions.args` | | `configPath?` | `string` | Explicit config path. | - | | `cwd` | `string` | Current working directory. This will be used to interpolate `{cwd}` in the config. | `ConfigToOptionsOptions.cwd` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md index 7bb7f4514..39559f1ab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md @@ -16,7 +16,7 @@ Read a utf-8 encoded file. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | #### Returns @@ -36,7 +36,7 @@ Resolve the real path for the current host. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | #### Returns @@ -56,14 +56,14 @@ Get information about the given path #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | #### Returns `Promise`<`object`\> -| Member | Type | -| :------ | :------ | +| Name | Type | +| ------ | ------ | | `isDirectory` | `boolean` | | `isFile` | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md index b8261b73c..39592094d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md @@ -6,7 +6,7 @@ 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`: `any`) => `string` |

When resolution reach package.json returns the path to the file relative to it.

**Default**

pkg.main | +| `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`: `any`) => `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/interfaces/ResolvedFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedFile.md index 23b4709d7..dc5778294 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedFile.md @@ -6,6 +6,6 @@ title: "[I] ResolvedFile" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `path` | `string` | | `type` | `"file"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md index 15f57df7a..a8c9fb0a7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md @@ -6,7 +6,7 @@ title: "[I] ResolvedModule" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `mainFile` | `string` | Resolved main file for the module. | | `manifest` | [`NodePackage`](NodePackage.md) | Value of package.json. | | `path` | `string` | Root of the package. (Same level as package.json) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md index e4ea2b1ec..bcd421e6d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md @@ -10,13 +10,13 @@ title: "[I] ReturnExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `Return` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `Return` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `value` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md index 4d562ad90..c4ce36f12 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md @@ -6,6 +6,6 @@ title: "[I] ReturnRecord" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `kind` | `"Return"` | | `value` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md index 56d73f5c0..44cb4a53a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md @@ -6,5 +6,5 @@ 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 | +| ------ | ------ | ------ | +| `recursive?` | `boolean` | If `true`, perform a recursive directory removal. In recursive mode, errors are not reported if `path` does not exist, and operations are retried on failure. **Default** `false` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md index bcfbbc874..a0b370310 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md @@ -10,24 +10,24 @@ title: "[I] Scalar" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `baseScalar?` | `public` | [`Scalar`](Scalar.md) | Scalar this scalar extends. | - | - | | `constructors` | `public` | `Map`<`string`, [`ScalarConstructor`](ScalarConstructor.md)\> | - | - | - | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `derivedScalars` | `public` | [`Scalar`](Scalar.md)[] |

Direct children. This is the reverse relation of

**See**

baseScalar

| - | - | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Scalar"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| `derivedScalars` | `public` | [`Scalar`](Scalar.md)[] | Direct children. This is the reverse relation of **See** baseScalar | - | - | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Scalar"` | - | [`BaseType`](BaseType.md).`kind` | - | | `name` | `public` | `string` | - | - | - | | `namespace?` | `public` | [`Namespace`](Namespace.md) | Namespace the scalar was defined in. | - | - | -| `node` | `public` | [`ScalarStatementNode`](ScalarStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] |

**Deprecated**

use templateMapper instead.

| [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | +| `node` | `public` | [`ScalarStatementNode`](ScalarStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | +| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | **Deprecated** use templateMapper instead. | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | ## Accessors @@ -41,6 +41,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -52,7 +56,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructor.md index fbeaa0e2d..ccc3759f0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructor.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructor.md @@ -10,17 +10,17 @@ title: "[I] ScalarConstructor" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"ScalarConstructor"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"ScalarConstructor"` | - | [`BaseType`](BaseType.md).`kind` | - | | `name` | `public` | `string` | - | - | - | -| `node` | `public` | [`ScalarConstructorNode`](ScalarConstructorNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `node` | `public` | [`ScalarConstructorNode`](ScalarConstructorNode.md) | - | [`BaseType`](BaseType.md).`node` | - | | `parameters` | `public` | [`SignatureFunctionParameter`](SignatureFunctionParameter.md)[] | - | - | - | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `scalar` | `public` | [`Scalar`](Scalar.md) | - | - | - | ## Accessors @@ -35,6 +35,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -46,7 +50,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructorNode.md index 870249796..69e8c8f82 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructorNode.md @@ -10,14 +10,14 @@ title: "[I] ScalarConstructorNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | | `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `ScalarConstructor` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `kind` | `readonly` | `ScalarConstructor` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `parameters` | `readonly` | [`FunctionParameterNode`](FunctionParameterNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`ScalarStatementNode`](ScalarStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`ScalarStatementNode`](ScalarStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md index f4fd7c6a6..9772f4b65 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md @@ -10,20 +10,20 @@ title: "[I] ScalarStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `bodyRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | - | | `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | | `extends?` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `ScalarStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `ScalarStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `locals?` | `readonly` | `SymbolTable` | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | | `members` | `readonly` | readonly [`ScalarConstructorNode`](ScalarConstructorNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | -| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarValue.md index 30cba84bb..841c5e02d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarValue.md @@ -10,11 +10,11 @@ title: "[I] ScalarValue" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Value"` | - | - | `BaseValue.entityKind` | | `scalar` | `public` | [`Scalar`](Scalar.md) | - | - | - | -| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

const a = "hello"; // Type here would be "hello"

const b: string = a; // Type here would be string

const c: string \| int32 = b; // Type here would be string \| int32

 | `BaseValue.type` | `BaseValue.type` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) | Represent the storage type of a value. **Example** `const a = "hello"; // Type here would be "hello" const b: string = a; // Type here would be string const c: string | int32 = b; // Type here would be string | int32` | - | `BaseValue.type` | | `value` | `public` | `object` | - | - | - | | `value.args` | `public` | [`Value`](../type-aliases/Value.md)[] | - | - | - | | `value.name` | `public` | `string` | - | - | - | -| `valueKind` | `public` | `"ScalarValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | +| `valueKind` | `public` | `"ScalarValue"` | - | `BaseValue.valueKind` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md index 33019f046..177cf046b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md @@ -6,7 +6,7 @@ title: "[I] Scanner" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `file` | `readonly` | [`SourceFile`](SourceFile.md) | The source code being scanned. | | `position` | `readonly` | `number` | The offset in UTF-16 code units to the current position at the start of the next token. | | `token` | `readonly` | [`Token`](../enumerations/Token.md) | The current token | @@ -40,7 +40,7 @@ Finds the indent for the given triple quoted string. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `start` | `number` | | | `end` | `number` | | @@ -93,7 +93,7 @@ Unconditionally back up and scan a template expression portion. #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `tokenFlags` | [`TokenFlags`](../enumerations/TokenFlags.md) | Token Flags for head StringTemplateToken | #### Returns @@ -138,16 +138,16 @@ scanRange(range, callback): T Reset the scanner to the given start and end positions, invoke the callback, and then restore scanner state. -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` | #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `range` | [`TextRange`](TextRange.md) | | `callback` | () => `T` | @@ -174,7 +174,7 @@ Unindent and unescape the triple quoted string rawText #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `start` | `number` | | `end` | `number` | | `indentationStart` | `number` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SemanticToken.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SemanticToken.md index e138fcc5e..dc91e7247 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SemanticToken.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SemanticToken.md @@ -6,7 +6,7 @@ title: "[I] SemanticToken" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `end` | `number` | | `kind` | [`SemanticTokenKind`](../enumerations/SemanticTokenKind.md) | | `pos` | `number` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md index 13ac80516..71ecd8f53 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md @@ -6,7 +6,7 @@ title: "[I] Server" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `pendingMessages` | `readonly` | readonly [`ServerLog`](ServerLog.md)[] | | `workspaceFolders` | `readonly` | readonly [`ServerWorkspaceFolder`](ServerWorkspaceFolder.md)[] | @@ -21,7 +21,7 @@ buildSemanticTokens(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `SemanticTokensParams` | #### Returns @@ -39,7 +39,7 @@ checkChange(change): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `change` | `TextDocumentChangeEvent`<`TextDocument`\> | #### Returns @@ -57,7 +57,7 @@ compile(document): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `document` | `TextDocument` \| `TextDocumentIdentifier` | #### Returns @@ -75,7 +75,7 @@ complete(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `CompletionParams` | #### Returns @@ -93,7 +93,7 @@ documentClosed(change): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `change` | `TextDocumentChangeEvent`<`TextDocument`\> | #### Returns @@ -111,7 +111,7 @@ executeCommand(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `ExecuteCommandParams` | #### Returns @@ -129,7 +129,7 @@ findDocumentHighlight(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `DocumentHighlightParams` | #### Returns @@ -147,7 +147,7 @@ findReferences(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `ReferenceParams` | #### Returns @@ -165,7 +165,7 @@ formatDocument(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `DocumentFormattingParams` | #### Returns @@ -183,7 +183,7 @@ getCodeActions(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `CodeActionParams` | #### Returns @@ -201,7 +201,7 @@ getDocumentSymbols(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `DocumentSymbolParams` | #### Returns @@ -219,7 +219,7 @@ getFoldingRanges(getFoldingRanges): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `getFoldingRanges` | `FoldingRangeParams` | #### Returns @@ -237,7 +237,7 @@ getHover(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `HoverParams` | #### Returns @@ -255,7 +255,7 @@ getSemanticTokens(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `SemanticTokensParams` | #### Returns @@ -273,7 +273,7 @@ getSignatureHelp(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `SignatureHelpParams` | #### Returns @@ -291,7 +291,7 @@ gotoDefinition(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `DefinitionParams` | #### Returns @@ -309,7 +309,7 @@ initialize(params): Promise> #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `InitializeParams` | #### Returns @@ -327,7 +327,7 @@ initialized(params): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `InitializedParams` | #### Returns @@ -345,7 +345,7 @@ log(log): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `log` | [`ServerLog`](ServerLog.md) | #### Returns @@ -363,7 +363,7 @@ prepareRename(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `PrepareRenameParams` | #### Returns @@ -381,7 +381,7 @@ rename(params): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `RenameParams` | #### Returns @@ -399,7 +399,7 @@ watchedFilesChanged(params): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `params` | `DidChangeWatchedFilesParams` | #### Returns @@ -417,7 +417,7 @@ workspaceFoldersChanged(e): Promise #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `e` | `WorkspaceFoldersChangeEvent` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md index 0ee0da2fa..66b42af1b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md @@ -6,7 +6,7 @@ title: "[I] ServerHost" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `applyEdit` | `readonly` | (`paramOrEdit`: `WorkspaceEdit` \| `ApplyWorkspaceEditParams`) => `Promise`<`ApplyWorkspaceEditResult`\> | | `compilerHost` | `readonly` | [`CompilerHost`](CompilerHost.md) | | `getOpenDocumentByURL` | `readonly` | (`url`: `string`) => `undefined` \| `TextDocument` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerLog.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerLog.md index 9fc1806b8..cffa8f2ec 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerLog.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerLog.md @@ -6,7 +6,7 @@ title: "[I] ServerLog" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `detail?` | `unknown` | | `level` | [`ServerLogLevel`](../type-aliases/ServerLogLevel.md) | | `message` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md index 4fa14fb06..03429c93b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md @@ -10,9 +10,9 @@ title: "[I] ServerSourceFile" ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `document?` | `readonly` | `TextDocument` | - | - | -| `path` | `readonly` | `string` |

The source file path.

This is used only for diagnostics. The command line compiler will populate it with the actual path from which the file was read, but it can actually be an arbitrary name for other scenarios.

| [`SourceFile`](SourceFile.md).`path` | +| `path` | `readonly` | `string` | The source file path. This is used only for diagnostics. The command line compiler will populate it with the actual path from which the file was read, but it can actually be an arbitrary name for other scenarios. | [`SourceFile`](SourceFile.md).`path` | | `text` | `readonly` | `string` | The source code text. | [`SourceFile`](SourceFile.md).`text` | ## Methods @@ -29,7 +29,7 @@ code units) to line number and offset from line start. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `position` | `number` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md index d68e4b2a4..79e291baf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md @@ -10,7 +10,7 @@ title: "[I] ServerWorkspaceFolder" ## Properties | Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `name` | `string` | The name of the workspace folder. Used to refer to this workspace folder in the user interface. | `WorkspaceFolder.name` | | `path` | `string` | - | - | | `uri` | `string` | The associated URI for this workspace folder. | `WorkspaceFolder.uri` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md index 6e164000d..d7eb8cb3a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md @@ -10,7 +10,7 @@ title: "[I] Service" ## Properties | Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `title?` | `string` | - | [`ServiceDetails`](ServiceDetails.md).`title` | | `type` | [`Namespace`](Namespace.md) | - | - | -| ~~`version?`~~ | `string` |

**Deprecated**

Service version is deprecated. If wanting to describe a service versioning you can use the `@typespec/versioning` library. If wanting to describe the project version you can use the package.json version

| [`ServiceDetails`](ServiceDetails.md).`version` | +| ~~`version?`~~ | `string` | **Deprecated** Service version is deprecated. If wanting to describe a service versioning you can use the `@typespec/versioning` library. If wanting to describe the project version you can use the package.json version | [`ServiceDetails`](ServiceDetails.md).`version` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md index cf14e4e62..0ded42435 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md @@ -10,6 +10,6 @@ title: "[I] ServiceDetails" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `title?` | `string` | - | -| ~~`version?`~~ | `string` |

**Deprecated**

Service version is deprecated. If wanting to describe a service versioning you can use the `@typespec/versioning` library. If wanting to describe the project version you can use the package.json version

| +| ~~`version?`~~ | `string` | **Deprecated** Service version is deprecated. If wanting to describe a service versioning you can use the `@typespec/versioning` library. If wanting to describe the project version you can use the package.json version | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SignatureFunctionParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SignatureFunctionParameter.md index f4b8325d8..cc3cdb972 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SignatureFunctionParameter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SignatureFunctionParameter.md @@ -12,10 +12,10 @@ Represent a function parameter that represent the parameter signature(i.e the ty ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `entityKind` | `readonly` | `"Type"` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`entityKind` | | `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`FunctionParameterBase`](FunctionParameterBase.md).`instantiationParameters` | -| `isFinished` | `public` | `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)
| [`FunctionParameterBase`](FunctionParameterBase.md).`isFinished` | +| `isFinished` | `public` | `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) | [`FunctionParameterBase`](FunctionParameterBase.md).`isFinished` | | `kind` | `public` | `"FunctionParameter"` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`kind` | | `mixed` | `public` | `false` | - | - | | `name` | `public` | `string` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`name` | @@ -39,6 +39,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`FunctionParameterBase`](FunctionParameterBase.md).[`projections`](FunctionParameterBase.md#projections) + ## Methods ### projectionsByName() @@ -50,7 +54,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md index 8fb0d5951..e67cae7df 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md @@ -10,8 +10,8 @@ title: "[I] SourceFile" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `path` | `readonly` | `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.

| +| ------ | ------ | ------ | ------ | +| `path` | `readonly` | `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. | | `text` | `readonly` | `string` | The source code text. | ## Methods @@ -28,7 +28,7 @@ code units) to line number and offset from line start. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `position` | `number` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md index f875ee721..7abc57e31 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md @@ -10,7 +10,7 @@ title: "[I] SourceLocation" ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`TextRange`](TextRange.md).`end` | | `file` | `public` | [`SourceFile`](SourceFile.md) | - | - | | `isSynthetic?` | `public` | `boolean` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md index 5360bcea7..5bf5f9776 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md @@ -6,5 +6,5 @@ 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/interfaces/SourceModel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md index ebe8d7459..7a88fb140 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md @@ -6,6 +6,6 @@ title: "[I] SourceModel" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `model` | `readonly` | [`Model`](Model.md) | Source model | -| `usage` | `readonly` | `"is"` \| `"spread"` \| `"intersection"` |

How was this model used.

  • is: `model A is B`
  • spread: `model A {...B}`
  • intersection: `alias A = B & C`
| +| `usage` | `readonly` | `"is"` \| `"spread"` \| `"intersection"` | How was this model used. - is: `model A is B` - spread: `model A {...B}` - intersection: `alias A = B & C` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StateDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StateDef.md index c44b13cc7..18cdbabb8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StateDef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StateDef.md @@ -6,5 +6,5 @@ title: "[I] StateDef" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `description?` | `readonly` | `string` | Description for this state. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md index 038f66917..3280d02ae 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md @@ -10,15 +10,15 @@ title: "[I] StringLiteral" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"String"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node?` | `public` | [`StringLiteralNode`](StringLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"String"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `node?` | `public` | [`StringLiteralNode`](StringLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `value` | `public` | `string` | - | - | - | ## Accessors @@ -33,6 +33,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -44,7 +48,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md index 7f9649961..ff632acc2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md @@ -10,13 +10,13 @@ title: "[I] StringLiteralNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `StringLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `StringLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `value` | `readonly` | `string` | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md index 19e0f66a5..6d92b58c3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md @@ -10,15 +10,15 @@ title: "[I] StringTemplate" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"StringTemplate"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node` | `public` | [`StringTemplateExpressionNode`](StringTemplateExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"StringTemplate"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `node` | `public` | [`StringTemplateExpressionNode`](StringTemplateExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `spans` | `public` | [`StringTemplateSpan`](../type-aliases/StringTemplateSpan.md)[] | - | - | - | | `stringValue?` | `public` | `string` | If the template can be render as as string this is the string value | - | - | @@ -34,6 +34,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -45,7 +49,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md index eb9a19a7d..d85c009d4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md @@ -10,14 +10,14 @@ title: "[I] StringTemplateExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | | `head` | `readonly` | [`StringTemplateHeadNode`](StringTemplateHeadNode.md) | - | - | - | -| `kind` | `readonly` | `StringTemplateExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `kind` | `readonly` | `StringTemplateExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `spans` | `readonly` | readonly [`StringTemplateSpanNode`](StringTemplateSpanNode.md)[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md index 735f12f01..9d9bcdc16 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md @@ -10,13 +10,13 @@ title: "[I] StringTemplateHeadNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | -| `kind` | `readonly` | `StringTemplateHead` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | -| `value` | `readonly` | `string` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | +| `kind` | `readonly` | `StringTemplateHead` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | +| `value` | `readonly` | `string` | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md index dc7de2af7..584639543 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md @@ -16,7 +16,7 @@ title: "[I] StringTemplateLiteralLikeNode" ## Properties | Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | | `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | | `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md index ecdeda446..411ac1e4d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md @@ -10,13 +10,13 @@ title: "[I] StringTemplateMiddleNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | -| `kind` | `readonly` | `StringTemplateMiddle` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | -| `value` | `readonly` | `string` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | +| `kind` | `readonly` | `StringTemplateMiddle` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | +| `value` | `readonly` | `string` | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md index afd859158..44e9fdb9c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md @@ -10,16 +10,16 @@ title: "[I] StringTemplateSpanLiteral" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | | `isInterpolated` | `public` | `false` | - | - | - | -| `kind` | `public` | `"StringTemplateSpan"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node` | `public` | [`StringTemplateHeadNode`](StringTemplateHeadNode.md) \| [`StringTemplateMiddleNode`](StringTemplateMiddleNode.md) \| [`StringTemplateTailNode`](StringTemplateTailNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `kind` | `public` | `"StringTemplateSpan"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `node` | `public` | [`StringTemplateHeadNode`](StringTemplateHeadNode.md) \| [`StringTemplateMiddleNode`](StringTemplateMiddleNode.md) \| [`StringTemplateTailNode`](StringTemplateTailNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `type` | `public` | [`StringLiteral`](StringLiteral.md) | - | - | - | ## Accessors @@ -34,6 +34,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -45,7 +49,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md index b03f7f274..538d1811c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md @@ -10,14 +10,14 @@ title: "[I] StringTemplateSpanNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | | `expression` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `StringTemplateSpan` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `StringTemplateSpan` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `literal` | `readonly` | [`StringTemplateMiddleNode`](StringTemplateMiddleNode.md) \| [`StringTemplateTailNode`](StringTemplateTailNode.md) | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md index 4d7c5ddb3..9c42defcf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md @@ -10,16 +10,16 @@ title: "[I] StringTemplateSpanValue" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | | `isInterpolated` | `public` | `true` | - | - | - | -| `kind` | `public` | `"StringTemplateSpan"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node` | `public` | [`Expression`](../type-aliases/Expression.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `kind` | `public` | `"StringTemplateSpan"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `node` | `public` | [`Expression`](../type-aliases/Expression.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `type` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | ## Accessors @@ -34,6 +34,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -45,7 +49,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md index 1baf165c8..afdc5218f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md @@ -10,13 +10,13 @@ title: "[I] StringTemplateTailNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | -| `kind` | `readonly` | `StringTemplateTail` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | -| `value` | `readonly` | `string` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | +| `kind` | `readonly` | `StringTemplateTail` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | +| `value` | `readonly` | `string` | - | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringValue.md index 7c4932bcd..1a4cbd117 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringValue.md @@ -10,9 +10,9 @@ title: "[I] StringValue" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Value"` | - | - | `BaseValue.entityKind` | | `scalar` | `public` | `undefined` \| [`Scalar`](Scalar.md) | - | - | - | -| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

const a = "hello"; // Type here would be "hello"

const b: string = a; // Type here would be string

const c: string \| int32 = b; // Type here would be string \| int32

 | `BaseValue.type` | `BaseValue.type` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) | Represent the storage type of a value. **Example** `const a = "hello"; // Type here would be "hello" const b: string = a; // Type here would be string const c: string | int32 = b; // Type here would be string | int32` | - | `BaseValue.type` | | `value` | `public` | `string` | - | - | - | -| `valueKind` | `public` | `"StringValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | +| `valueKind` | `public` | `"StringValue"` | - | `BaseValue.valueKind` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SuppressDirective.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SuppressDirective.md index b3a5b1d52..49cb168bd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SuppressDirective.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SuppressDirective.md @@ -10,7 +10,7 @@ title: "[I] SuppressDirective" ## Properties | Property | Type | Inherited from | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `code` | `string` | - | | `message` | `string` | - | | `name` | `"suppress"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md index 956cbc24a..0ff7df844 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md @@ -6,7 +6,7 @@ title: "[I] Sym" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `declarations` | `readonly` | readonly [`Node`](../type-aliases/Node.md)[] | Nodes which contribute to this declaration | | `exports?` | `readonly` | `SymbolTable` | Externally visible symbols contained inside this symbol. E.g. all declarations in a namespace, or members of an enum. | | `flags` | `readonly` | [`SymbolFlags`](../enumerations/SymbolFlags.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md index aac93be56..1e825f7a0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md @@ -6,7 +6,7 @@ title: "[I] SymbolLinks" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `declaredType?` | [`Type`](../type-aliases/Type.md) | For types that can be instanitated this is the type of the declaration | | `instantiations?` | [`TypeInstantiationMap`](TypeInstantiationMap.md) | For types that can be instanitated those are the types per instantiation | | `type?` | [`Type`](../type-aliases/Type.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md index a0c66d47a..810661157 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md @@ -8,5 +8,5 @@ Refer to a type that was not declared in a file ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `type` | `readonly` | `"synthetic"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md index 46f339f01..a9fcfc49a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md @@ -10,14 +10,14 @@ title: "[I] TemplateArgumentNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `argument` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `TemplateArgument` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `TemplateArgument` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `name?` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md index 463e2870d..d4c279f73 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md @@ -15,7 +15,7 @@ title: "[I] TemplateDeclarationNode" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `locals?` | `readonly` | `SymbolTable` | | `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | | `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md index a64d9d5fb..73b7942a0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md @@ -10,17 +10,17 @@ title: "[I] TemplateParameter" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `constraint?` | `public` | [`MixedParameterConstraint`](MixedParameterConstraint.md) | - | - | - | | `default?` | `public` | [`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md) | - | - | - | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"TemplateParameter"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node` | `public` | [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"TemplateParameter"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `node` | `public` | [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | ## Accessors @@ -34,6 +34,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -45,7 +49,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md index 246168ebb..72672e9ea 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md @@ -10,15 +10,15 @@ title: "[I] TemplateParameterDeclarationNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `constraint?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | | `default?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `TemplateParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`TemplateableNode`](../type-aliases/TemplateableNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `TemplateParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`TemplateableNode`](../type-aliases/TemplateableNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md index 93bfea11c..1c80a8654 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md @@ -14,7 +14,7 @@ title: "[I] TemplatedTypeBase" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | -| ~~`templateArguments?`~~ | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] |

**Deprecated**

use templateMapper instead.

| +| ------ | ------ | ------ | +| ~~`templateArguments?`~~ | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | **Deprecated** use templateMapper instead. | | `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | | `templateNode?` | [`Node`](../type-aliases/Node.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md index b4eab27ef..fe9a99817 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md @@ -14,6 +14,6 @@ title: "[I] TextRange" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | | `pos` | `readonly` | `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/interfaces/Tracer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md index 8b534aaa9..aeb3a541b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md @@ -14,7 +14,7 @@ sub(subarea): Tracer #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `subarea` | `string` | | #### Returns @@ -37,7 +37,7 @@ Trace #### Parameters | Parameter | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `area` | `string` | | | `message` | `string` | | | `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md index c494ca07e..4714c03c2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md @@ -6,5 +6,5 @@ title: "[I] TracerOptions" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `filter?` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md index a58713e87..5ee929c79 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md @@ -10,15 +10,15 @@ title: "[I] Tuple" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Tuple"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node` | `public` | [`ArrayLiteralNode`](ArrayLiteralNode.md) \| [`TupleExpressionNode`](TupleExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Tuple"` | - | [`BaseType`](BaseType.md).`kind` | - | +| `node` | `public` | [`ArrayLiteralNode`](ArrayLiteralNode.md) \| [`TupleExpressionNode`](TupleExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `values` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | - | ## Accessors @@ -33,6 +33,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -44,7 +48,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md index c115a127e..01a15e84a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md @@ -10,13 +10,13 @@ title: "[I] TupleExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `TupleExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `TupleExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `values` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md index 8246154d2..100aeb29c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md @@ -16,7 +16,7 @@ get(args): undefined | Type #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `args` | readonly ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | #### Returns @@ -34,7 +34,7 @@ set(args, type): void #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `args` | readonly ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | | `type` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md index 1d4ce346c..82433abb5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md @@ -6,7 +6,7 @@ title: "[I] TypeMapper" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `args` | readonly ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | | `partial` | `boolean` | @@ -21,7 +21,7 @@ getMappedType(type): Type | Value | IndeterminateEntity #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`TemplateParameter`](TemplateParameter.md) | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md index c89bb8d3d..631944e71 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md @@ -6,6 +6,6 @@ title: "[I] TypeNameOptions" ## Properties | Property | Type | -| :------ | :------ | +| ------ | ------ | | `namespaceFilter?` | (`ns`: [`Namespace`](Namespace.md)) => `boolean` | | `printable?` | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeOfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeOfExpressionNode.md index 5ac489c6f..98aae38e1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeOfExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeOfExpressionNode.md @@ -10,13 +10,13 @@ title: "[I] TypeOfExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `TypeOfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `TypeOfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md index 1f93afb33..199a888cf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md @@ -10,14 +10,14 @@ title: "[I] TypeReferenceNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `arguments` | `readonly` | readonly [`TemplateArgumentNode`](TemplateArgumentNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `TypeReference` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `TypeReference` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md index 06c5b7f97..3dd55b998 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md @@ -6,7 +6,7 @@ title: "[I] TypeSpecCompletionItem" ## Properties | Property | Type | Description | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `label?` | `string` | Optional label if different from the text to complete. | | `suffix?` | `string` | Optional text to be appended to the completion if accepted. | | `sym` | [`Sym`](Sym.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md index cf523aa69..573891c0f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md @@ -7,10 +7,10 @@ title: "[I] TypeSpecLibrary" - [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md)<`T`, `E`, `State`\> -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* `object` | - | | `E` *extends* `Record`<`string`, `any`\> | `Record`<`string`, `never`\> | | `State` *extends* `string` | `never` | @@ -18,15 +18,15 @@ title: "[I] TypeSpecLibrary" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `diagnostics` | `readonly` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`diagnostics` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`diagnostics` | -| `emitter?` | `readonly` | `object` | Emitter configuration if library is an emitter. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`emitter` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`emitter` | -| `emitter.options?` | `readonly` | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | - | - | -| ~~`linter?`~~ | `readonly` | [`LinterDefinition`](LinterDefinition.md) |

Configuration if library is providing linting rules/rulesets.

**Deprecated**

Use `export const $linter` instead. This will cause circular reference with linters.

| [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`linter` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`linter` | -| `name` | `readonly` | `string` | Library name | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`name` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`name` | -| `requireImports?` | `readonly` | readonly `string`[] | List of other library that should be imported when this is used as an emitter. Compiler will emit an error if the libraries are not explicitly imported. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`requireImports` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`requireImports` | -| `state?` | `readonly` | `Record`<`State`, [`StateDef`](StateDef.md)\> | - | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`state` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`state` | -| `stateKeys` | `public` | `Record`<`State`, `symbol`\> | - | - | - | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `diagnostics` | `readonly` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | - | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`diagnostics` | +| `emitter?` | `readonly` | `object` | Emitter configuration if library is an emitter. | - | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`emitter` | +| `emitter.options?` | `public` | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | - | - | +| ~~`linter?`~~ | `readonly` | [`LinterDefinition`](LinterDefinition.md) | Configuration if library is providing linting rules/rulesets. **Deprecated** Use `export const $linter` instead. This will cause circular reference with linters. | - | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`linter` | +| `name` | `readonly` | `string` | Library name | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`name` | - | +| `requireImports?` | `readonly` | readonly `string`[] | List of other library that should be imported when this is used as an emitter. Compiler will emit an error if the libraries are not explicitly imported. | - | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`requireImports` | +| `state?` | `readonly` | `Record`<`State`, [`StateDef`](StateDef.md)\> | - | - | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`state` | +| `stateKeys` | `readonly` | `Record`<`State`, `symbol`\> | - | - | - | ## Methods @@ -36,17 +36,17 @@ title: "[I] TypeSpecLibrary" createDiagnostic(diag): Diagnostic ``` -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `C` *extends* `string` \| `number` \| `symbol` | | `M` *extends* `string` \| `number` \| `symbol` | #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | #### Returns @@ -66,7 +66,7 @@ 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 @@ -87,7 +87,7 @@ All trace area logged via this tracer will be prefixed with the library name. #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](Program.md) | #### Returns @@ -102,17 +102,17 @@ All trace area logged via this tracer will be prefixed with the library name. reportDiagnostic(program, diag): void ``` -#### Type parameters +#### Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `C` *extends* `string` \| `number` \| `symbol` | | `M` *extends* `string` \| `number` \| `symbol` | #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `program` | [`Program`](Program.md) | | `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md index ada1776ba..51d71c0ec 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md @@ -7,10 +7,10 @@ title: "[I] TypeSpecLibraryDef" - [`TypeSpecLibrary`](TypeSpecLibrary.md) -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* `object` | - | | `E` *extends* `Record`<`string`, `any`\> | `Record`<`string`, `never`\> | | `State` *extends* `string` | `never` | @@ -18,11 +18,11 @@ title: "[I] TypeSpecLibraryDef" ## Properties | Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | | `diagnostics` | `readonly` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | | `emitter?` | `readonly` | `object` | Emitter configuration if library is an emitter. | -| `emitter.options?` | `readonly` | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | -| ~~`linter?`~~ | `readonly` | [`LinterDefinition`](LinterDefinition.md) |

Configuration if library is providing linting rules/rulesets.

**Deprecated**

Use `export const $linter` instead. This will cause circular reference with linters.

| +| `emitter.options?` | `public` | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | +| ~~`linter?`~~ | `readonly` | [`LinterDefinition`](LinterDefinition.md) | Configuration if library is providing linting rules/rulesets. **Deprecated** Use `export const $linter` instead. This will cause circular reference with linters. | | `name` | `readonly` | `string` | Library name. MUST match package.json name. | | `requireImports?` | `readonly` | 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. | -| `state?` | `public` | `Record`<`State`, [`StateDef`](StateDef.md)\> | - | +| `state?` | `readonly` | `Record`<`State`, [`StateDef`](StateDef.md)\> | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md index 67130a08b..a2c26f94a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md @@ -6,7 +6,7 @@ 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/interfaces/TypeSpecScriptNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md index 22c0342f1..d161c0340 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md @@ -10,23 +10,23 @@ title: "[I] TypeSpecScriptNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `comments` | `readonly` | readonly [`Comment`](../type-aliases/Comment.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | | `file` | `readonly` | [`SourceFile`](SourceFile.md) | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | | `inScopeNamespaces` | `readonly` | readonly [`NamespaceStatementNode`](NamespaceStatementNode.md)[] | - | - | - | -| `kind` | `readonly` | `TypeSpecScript` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `kind` | `readonly` | `TypeSpecScript` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `locals` | `readonly` | `SymbolTable` | - | - | - | | `namespaces` | `readonly` | [`NamespaceStatementNode`](NamespaceStatementNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | | `parseDiagnostics` | `readonly` | readonly [`Diagnostic`](Diagnostic.md)[] | - | - | - | | `parseOptions` | `readonly` | [`ParseOptions`](ParseOptions.md) | - | - | - | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `printable` | `readonly` | `boolean` | - | - | - | | `statements` | `readonly` | readonly [`Statement`](../type-aliases/Statement.md)[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `usings` | `readonly` | readonly [`UsingStatementNode`](UsingStatementNode.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md index 06bfddd9c..8fc62b4fe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md @@ -10,24 +10,24 @@ title: "[I] Union" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | | `expression` | `public` | `boolean` | - | - | - | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Union"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Union"` | - | [`BaseType`](BaseType.md).`kind` | - | | `name?` | `public` | `string` | - | - | - | | `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | -| `node` | `public` | [`UnionStatementNode`](UnionStatementNode.md) \| [`UnionExpressionNode`](UnionExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| ~~`options`~~ | `readonly` | [`Type`](../type-aliases/Type.md)[] |

**Deprecated**

use variants

| - | - | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] |

**Deprecated**

use templateMapper instead.

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

The variants of the union.

Variants are ordered in order that they appear in source.

| - | - | +| `node` | `public` | [`UnionStatementNode`](UnionStatementNode.md) \| [`UnionExpressionNode`](UnionExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| ~~`options`~~ | `readonly` | [`Type`](../type-aliases/Type.md)[] | **Deprecated** use variants | - | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | +| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | **Deprecated** use templateMapper instead. | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | +| `variants` | `public` | `RekeyableMap`<`string` \| `symbol`, [`UnionVariant`](UnionVariant.md)\> | The variants of the union. Variants are ordered in order that they appear in source. | - | - | ## Accessors @@ -41,6 +41,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -52,7 +56,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md index 6105306b3..cb1de0420 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md @@ -10,13 +10,13 @@ title: "[I] UnionExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `UnionExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `UnionExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `options` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md index 94d6c1a6f..5488f27f7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md @@ -10,18 +10,18 @@ title: "[I] UnionStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `UnionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `UnionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `locals?` | `readonly` | `SymbolTable` | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | | `options` | `readonly` | readonly [`UnionVariantNode`](UnionVariantNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | -| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md index a7bb33284..6d7730b8b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md @@ -10,17 +10,17 @@ title: "[I] UnionVariant" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"UnionVariant"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | - | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"UnionVariant"` | - | [`BaseType`](BaseType.md).`kind` | - | | `name` | `public` | `string` \| `symbol` | - | - | - | -| `node` | `public` | `undefined` \| [`UnionVariantNode`](UnionVariantNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `node` | `public` | `undefined` \| [`UnionVariantNode`](UnionVariantNode.md) | - | [`BaseType`](BaseType.md).`node` | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`BaseType`](BaseType.md).`projector` | | `type` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | | `union` | `public` | [`Union`](Union.md) | - | - | - | @@ -36,6 +36,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`BaseType`](BaseType.md).[`projections`](BaseType.md#projections) + ## Methods ### projectionsByName() @@ -47,7 +51,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md index 7b56e0452..2b1567ad9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md @@ -10,15 +10,15 @@ title: "[I] UnionVariantNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | +| ------ | ------ | ------ | ------ | ------ | ------ | | `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | | `id?` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `UnionVariant` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`UnionStatementNode`](UnionStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `kind` | `readonly` | `UnionVariant` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`UnionStatementNode`](UnionStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md index eddee13ea..0ce5b993d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md @@ -10,16 +10,16 @@ title: "[I] UnknownType" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | [`IntrinsicType`](IntrinsicType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`IntrinsicType`](IntrinsicType.md).`isFinished` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | -| `kind` | `public` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | -| `name` | `public` | `"unknown"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`IntrinsicType`](IntrinsicType.md).`isFinished` | +| `kind` | `public` | `"Intrinsic"` | - | - | [`IntrinsicType`](IntrinsicType.md).`kind` | +| `name` | `public` | `"unknown"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | - | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projector` | ## Accessors @@ -33,6 +33,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`IntrinsicType`](IntrinsicType.md).[`projections`](IntrinsicType.md#projections) + ## Methods ### projectionsByName() @@ -44,7 +48,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md index 35e25dbd1..044d5c9a1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md @@ -6,7 +6,7 @@ title: "[I] UsageTracker" ## Properties | Property | Modifier | Type | -| :------ | :------ | :------ | +| ------ | ------ | ------ | | `types` | `readonly` | readonly [`TrackableType`](../type-aliases/TrackableType.md)[] | ## Methods @@ -20,7 +20,7 @@ isUsedAs(type, usage): boolean #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `type` | [`TrackableType`](../type-aliases/TrackableType.md) | | `usage` | [`UsageFlags`](../enumerations/UsageFlags.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md index e2c2feeb8..c16f62283 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md @@ -10,13 +10,13 @@ title: "[I] UsingStatementNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `UsingStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `UsingStatement` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `name` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md index 859ca1fff..ccc796c3a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md @@ -10,13 +10,13 @@ title: "[I] ValueOfExpressionNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ValueOfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ValueOfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | | `target` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md index 424d1be3c..5d8991203 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md @@ -10,12 +10,12 @@ title: "[I] VoidKeywordNode" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `VoidKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | - | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `VoidKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md index 875097424..7ffad5a3f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md @@ -10,16 +10,16 @@ title: "[I] VoidType" ## Properties | Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `entityKind` | `readonly` | `"Type"` | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | [`IntrinsicType`](IntrinsicType.md).`entityKind` | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` |

Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished:

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`IntrinsicType`](IntrinsicType.md).`isFinished` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | -| `kind` | `public` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | -| `name` | `public` | `"void"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `entityKind` | `readonly` | `"Type"` | - | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`IntrinsicType`](IntrinsicType.md).`isFinished` | +| `kind` | `public` | `"Intrinsic"` | - | - | [`IntrinsicType`](IntrinsicType.md).`kind` | +| `name` | `public` | `"void"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | - | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | - | [`IntrinsicType`](IntrinsicType.md).`projector` | ## Accessors @@ -33,6 +33,10 @@ get projections(): ProjectionStatementNode[] [`ProjectionStatementNode`](ProjectionStatementNode.md)[] +#### Inherited from + +[`IntrinsicType`](IntrinsicType.md).[`projections`](IntrinsicType.md#projections) + ## Methods ### projectionsByName() @@ -44,7 +48,7 @@ projectionsByName(name): ProjectionStatementNode[] #### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `name` | `string` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibrary.md index 8c297cb5d..27edc2fdf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibrary.md @@ -11,9 +11,9 @@ type CadlLibrary: TypeSpecLibrary; Use TypeSpecLibrary -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* `object` | - | | `E` *extends* `Record`<`string`, `any`\> | `Record`<`string`, `never`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibraryDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibraryDef.md index 4be661aec..2543af68f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibraryDef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibraryDef.md @@ -11,9 +11,9 @@ type CadlLibraryDef: TypeSpecLibraryDef; Use TypeSpecLibraryDef -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* `object` | - | | `E` *extends* `Record`<`string`, `any`\> | `Record`<`string`, `never`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md index d3bac7729..485050533 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md @@ -7,10 +7,10 @@ title: "[T] DiagnosticFormat" type DiagnosticFormat: T[C][M] extends CallableMessage ? object : Record; ``` -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* `object` | - | | `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-aliases/DiagnosticHandler.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticHandler.md index 41fc2cbe6..218bac17e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticHandler.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticHandler.md @@ -10,7 +10,7 @@ type DiagnosticHandler: (diagnostic) => void; ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `diagnostic` | [`Diagnostic`](../interfaces/Diagnostic.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticMap.md index ec1bc61be..90bccd364 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticMap.md @@ -7,8 +7,8 @@ title: "[T] DiagnosticMap" type DiagnosticMap: { readonly [code in keyof T]: DiagnosticDefinition }; ``` -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* `object` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReport.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReport.md index 008f8188f..1cb22dbf8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReport.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReport.md @@ -9,14 +9,14 @@ type DiagnosticReport: DiagnosticReportWithoutTarget & object; ## Type declaration -| Member | Type | -| :------ | :------ | +| Name | Type | +| ------ | ------ | | `target` | [`DiagnosticTarget`](DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* `object` | - | | `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-aliases/DiagnosticReportWithoutTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md index 46c3023cd..39c45e7ab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md @@ -9,16 +9,16 @@ type DiagnosticReportWithoutTarget: object & DiagnosticFormat; ## Type declaration -| Member | Type | -| :------ | :------ | +| Name | Type | +| ------ | ------ | | `code` | `C` | | `codefixes` | readonly [`CodeFix`](../interfaces/CodeFix.md)[] | | `messageId` | `M` | -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* `object` | - | | `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-aliases/DiagnosticResult.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticResult.md index 0be36c9a2..31a28db4e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticResult.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticResult.md @@ -12,8 +12,8 @@ Tuple composed of: - 0: Actual result of an accessor function - 1: List of diagnostics that were emitted while retrieving the data. -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitOptionsFor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitOptionsFor.md index 6e24042b7..03e207df5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitOptionsFor.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitOptionsFor.md @@ -9,8 +9,8 @@ type EmitOptionsFor: C extends TypeSpecLibrary ? E : never Get the options for the onEmit of this library. -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `C` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitterFunc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitterFunc.md index 90afd7f8a..dda9b1f22 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitterFunc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitterFunc.md @@ -10,7 +10,7 @@ type EmitterFunc: (context) => Promise | void; ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `context` | [`EmitContext`](../interfaces/EmitContext.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredCadlValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredCadlValue.md index 24220b3ad..f3a694f93 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredCadlValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredCadlValue.md @@ -11,8 +11,8 @@ type InferredCadlValue: InferredTypeSpecValue; Use InferredTypeSpecValue -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `K` *extends* [`TypeKind`](TypeKind.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredTypeSpecValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredTypeSpecValue.md index 97d745c57..04215af44 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredTypeSpecValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredTypeSpecValue.md @@ -7,8 +7,8 @@ title: "[T] InferredTypeSpecValue" type InferredTypeSpecValue: K extends "Any" ? TypeSpecValue : K extends infer T[] ? InferredTypeSpecValue : K extends "String" ? string : K extends "Number" ? number : K extends "Boolean" ? boolean : Type & object; ``` -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `K` *extends* [`TypeKind`](TypeKind.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/JSONSchemaType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/JSONSchemaType.md index 19b7ac43b..eb87144ed 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/JSONSchemaType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/JSONSchemaType.md @@ -7,8 +7,8 @@ title: "[T] JSONSchemaType" type JSONSchemaType: AjvJSONSchemaType; ``` -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md index 03ff1eefd..d9ccc2306 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md @@ -7,9 +7,9 @@ title: "[T] LinterRuleDiagnosticFormat" type LinterRuleDiagnosticFormat: T[M] extends CallableMessage ? object : Record; ``` -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* [`DiagnosticMessages`](../interfaces/DiagnosticMessages.md) | - | | `M` *extends* keyof `T` | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReport.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReport.md index 357031fd1..782587008 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReport.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReport.md @@ -9,13 +9,13 @@ type LinterRuleDiagnosticReport: LinterRuleDiagnosticReportWithoutTarget: object & LinterRuleDiagnosti ## Type declaration -| Member | Type | -| :------ | :------ | +| Name | Type | +| ------ | ------ | | `codefixes` | [`CodeFix`](../interfaces/CodeFix.md)[] | | `messageId` | `M` | -## Type parameters +## Type Parameters -| Type parameter | Value | -| :------ | :------ | +| Type Parameter | Default type | +| ------ | ------ | | `T` *extends* [`DiagnosticMessages`](../interfaces/DiagnosticMessages.md) | - | | `M` *extends* keyof `T` | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MarshalledValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MarshalledValue.md index a34c5fd4a..94fc5b969 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MarshalledValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MarshalledValue.md @@ -7,8 +7,8 @@ title: "[T] MarshalledValue" type MarshalledValue: Value extends StringValue ? string : Value extends NumericValue ? number | Numeric : Value extends BooleanValue ? boolean : Value extends ObjectValue ? Record : Value extends ArrayValue ? unknown[] : Value extends EnumValue ? EnumMember : Value extends NullValue ? null : Value extends ScalarValue ? Value : Value; ``` -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `Value` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModelIndexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModelIndexer.md index 2697efea7..4bb59daef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModelIndexer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModelIndexer.md @@ -9,7 +9,7 @@ type ModelIndexer: object; ## Type declaration -| Member | Type | -| :------ | :------ | +| Name | Type | +| ------ | ------ | | `key` | [`Scalar`](../interfaces/Scalar.md) | | `value` | [`Type`](Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NeverIndexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NeverIndexer.md index 7a1d39e0f..a75f0bb69 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NeverIndexer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NeverIndexer.md @@ -9,7 +9,7 @@ type NeverIndexer: object; ## Type declaration -| Member | Type | -| :------ | :------ | +| Name | Type | +| ------ | ------ | | `key` | [`NeverType`](../interfaces/NeverType.md) | | `value` | `undefined` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NodeCallback.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NodeCallback.md index cab2be130..f04efb975 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NodeCallback.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NodeCallback.md @@ -7,16 +7,16 @@ title: "[T] NodeCallback" type NodeCallback: (c) => T; ``` -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` | ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `c` | [`Node`](Node.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md index 79fba3a44..89b52ea9d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md @@ -9,6 +9,6 @@ type SemanticNodeListener: object & TypeListeners; ## Type declaration -| Member | Type | -| :------ | :------ | +| Name | Type | +| ------ | ------ | | `root` | (`context`) => `void` \| `undefined` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypes.md index 75028ec6a..8b5d946c4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypes.md @@ -9,7 +9,7 @@ type StdTypes: object & Record; ## Type declaration -| Member | Type | -| :------ | :------ | +| Name | Type | +| ------ | ------ | | `Array` | [`Model`](../interfaces/Model.md) | | `Record` | [`Model`](../interfaces/Model.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOfDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOfDiagnostics.md index 94d83e07f..976b80f37 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOfDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOfDiagnostics.md @@ -7,8 +7,8 @@ title: "[T] TypeOfDiagnostics" type TypeOfDiagnostics: T extends DiagnosticMap ? D : never; ``` -## Type parameters +## Type Parameters -| Type parameter | -| :------ | +| Type Parameter | +| ------ | | `T` *extends* [`DiagnosticMap`](DiagnosticMap.md)<`any`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/WriteLine.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/WriteLine.md index b7ee72c97..f658fb02c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/WriteLine.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/WriteLine.md @@ -10,7 +10,7 @@ type WriteLine: (text?) => void; ## Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `text`? | `string` | ## Returns diff --git a/packages/website/versioned_sidebars/version-latest-sidebars.json b/packages/website/versioned_sidebars/version-latest-sidebars.json index ab8c2b378..77946a3da 100644 --- a/packages/website/versioned_sidebars/version-latest-sidebars.json +++ b/packages/website/versioned_sidebars/version-latest-sidebars.json @@ -19,8 +19,20 @@ "type": "category", "label": "Guides", "items": [ - "getting-started/getting-started", - "getting-started/getting-started-http", + { + "type": "category", + "label": "TypeSpec for HTTP", + "link": { + "type": "doc", + "id": "getting-started/getting-started-http/index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "getting-started/getting-started-http" + } + ] + }, "getting-started/typespec-for-openapi-dev" ] }, @@ -50,6 +62,7 @@ "items": [ "language-basics/overview", "language-basics/built-in-types", + "language-basics/identifiers", "language-basics/imports", "language-basics/namespaces", "language-basics/decorators", @@ -209,6 +222,7 @@ "dirName": "emitters/openapi3/reference" }, "emitters/openapi3/openapi", + "emitters/openapi3/cli", "emitters/openapi3/diagnostics" ] }, diff --git a/packages/xml/CHANGELOG.md b/packages/xml/CHANGELOG.md index 00eaedb95..cde952f58 100644 --- a/packages/xml/CHANGELOG.md +++ b/packages/xml/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog - @typespec/xml +## 0.58.0 + +### Bump dependencies + +- [#3718](https://github.com/microsoft/typespec/pull/3718) Dependency updates July 2024 + + ## 0.57.0 ### Bump dependencies diff --git a/packages/xml/package.json b/packages/xml/package.json index c12168581..8e680f449 100644 --- a/packages/xml/package.json +++ b/packages/xml/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/xml", - "version": "0.57.0", + "version": "0.58.0", "author": "Microsoft Corporation", "description": "TypeSpec library providing xml bindings", "homepage": "https://typespec.io",