From 9dd081f54bae9e8b9e4cf99f024c15ef87134ef6 Mon Sep 17 00:00:00 2001 From: Mark Cowlishaw Date: Wed, 11 Oct 2023 16:42:41 -0700 Subject: [PATCH] Prepare typespec publish --- .../2390-param-hyphen_2023-09-10-15-37.json | 10 - .../always-never_2023-09-12-16-32.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - ...imestampErrorMessage_2023-09-20-18-05.json | 10 - ...onstraint-allow-null_2023-09-12-15-51.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...ture-op-returns-docs_2023-09-19-16-32.json | 10 - ...x-comment-tmlanguage_2023-09-25-20-36.json | 10 - ...rective-parens-crash_2023-09-12-17-22.json | 10 - ...fix-float64-negative_2023-09-12-17-33.json | 10 - ...fix-format-exit-code_2023-09-20-15-44.json | 10 - .../fix-format-union_2023-09-19-19-07.json | 15 - ...atting-doc-directive_2023-09-19-17-39.json | 10 - .../fix-init-config_2023-09-28-18-02.json | 15 - ...-issue-with-tsp-init_2023-10-10-20-42.json | 10 - ...reading-whole-config_2023-10-02-19-28.json | 10 - .../fix-null-default_2023-09-11-22-42.json | 10 - .../fix-playground-lsp_2023-10-03-15-56.json | 10 - ...ng-typespec-implicit_2023-09-28-21-17.json | 10 - ...o-double-deprecation_2023-09-25-12-54.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...te-perf-improvements_2023-09-28-20-21.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - .../http/fake-changelog_2023-10-10-22-08.json | 10 - ...ture-op-returns-docs_2023-09-19-16-32.json | 10 - ...e-status-code-ranges_2023-09-25-23-04.json | 10 - ...enapi3-DuplicateRefs_2023-09-27-19-57.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...e-playground-release_2023-09-25-17-57.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - ...onstraint-allow-null_2023-09-22-22-38.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...ringify-max-line-len_2023-09-19-18-13.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - .../lint/fake-changelog_2023-10-10-22-08.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...1-rest-http-peer-dep_2023-09-19-00-29.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...e-status-code-ranges_2023-09-25-23-04.json | 10 - ...openApi-FixNamespace_2023-09-19-19-48.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...1-rest-http-peer-dep_2023-09-19-00-29.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - ...onstraint-allow-null_2023-09-22-22-38.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...ture-op-returns-docs_2023-09-19-16-32.json | 10 - ...e-status-code-ranges_2023-09-25-23-04.json | 10 - ...ping-wrongly-mutated_2023-09-15-00-39.json | 10 - ...ion-default-openapi3_2023-09-11-23-13.json | 10 - ...enapi3-header-format_2023-09-20-17-20.json | 10 - ...penapi3-null-default_2023-09-20-01-06.json | 10 - .../oneof-model-prop_2023-09-22-20-29.json | 10 - ...openApi-FixNamespace_2023-09-19-17-16.json | 10 - ...enapi3-DuplicateRefs_2023-09-27-19-57.json | 10 - ...penapi3-FixCsvFormat_2023-09-19-21-04.json | 10 - ...pi3-statusCodeShared_2023-10-10-20-29.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...ringify-max-line-len_2023-09-19-18-13.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - .../fix-format-union_2023-09-20-20-26.json | 10 - ...uf-emit-doc-comments_2023-08-10-18-18.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...1-rest-http-peer-dep_2023-09-19-00-29.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - .../rest/fake-changelog_2023-10-10-22-08.json | 10 - .../fixResourceLogic_2023-09-29-18-58.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - ...oning-RenamedFromBug_2023-09-27-22-20.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...backmerge-2023-09-19_2023-09-19-21-02.json | 10 - .../fake-changelog_2023-10-10-22-08.json | 10 - ...2488-pkgjson-cleanup_2023-10-10-17-47.json | 10 - ...pgrade-deps-sep-2023_2023-09-20-20-41.json | 10 - common/config/rush/pnpm-lock.yaml | 214 +- common/config/rush/version-policies.json | 2 +- packages/best-practices/package.json | 8 +- packages/bundler/package.json | 6 +- packages/compiler/CHANGELOG.json | 74 + packages/compiler/CHANGELOG.md | 28 +- packages/compiler/package.json | 8 +- .../eslint-config-typespec/CHANGELOG.json | 12 + packages/eslint-config-typespec/CHANGELOG.md | 9 +- packages/eslint-config-typespec/package.json | 2 +- .../eslint-plugin-typespec/CHANGELOG.json | 12 + packages/eslint-plugin-typespec/CHANGELOG.md | 9 +- packages/eslint-plugin-typespec/package.json | 4 +- packages/html-program-viewer/CHANGELOG.json | 12 + packages/html-program-viewer/CHANGELOG.md | 9 +- packages/html-program-viewer/package.json | 8 +- packages/http/CHANGELOG.json | 21 + packages/http/CHANGELOG.md | 12 +- packages/http/package.json | 12 +- packages/internal-build-utils/CHANGELOG.json | 15 + packages/internal-build-utils/CHANGELOG.md | 10 +- packages/internal-build-utils/package.json | 4 +- packages/json-schema/CHANGELOG.json | 15 + packages/json-schema/CHANGELOG.md | 10 +- packages/json-schema/package.json | 14 +- packages/library-linter/CHANGELOG.json | 12 + packages/library-linter/CHANGELOG.md | 9 +- packages/library-linter/package.json | 8 +- packages/lint/CHANGELOG.json | 12 + packages/lint/CHANGELOG.md | 9 +- packages/lint/package.json | 10 +- packages/migrate/CHANGELOG.json | 12 + packages/migrate/CHANGELOG.md | 9 +- packages/migrate/package.json | 10 +- packages/openapi/CHANGELOG.json | 21 + packages/openapi/CHANGELOG.md | 12 +- packages/openapi/package.json | 18 +- packages/openapi3/CHANGELOG.json | 51 + packages/openapi3/CHANGELOG.md | 22 +- packages/openapi3/package.json | 26 +- packages/playground-website/package.json | 22 +- packages/playground/package.json | 22 +- .../prettier-plugin-typespec/CHANGELOG.json | 12 + .../prettier-plugin-typespec/CHANGELOG.md | 9 +- .../prettier-plugin-typespec/package.json | 6 +- packages/protobuf/CHANGELOG.json | 15 + packages/protobuf/CHANGELOG.md | 10 +- packages/protobuf/package.json | 10 +- packages/rest/CHANGELOG.json | 18 + packages/rest/CHANGELOG.md | 11 +- packages/rest/package.json | 16 +- packages/samples/package.json | 20 +- packages/spec/package.json | 2 +- packages/tmlanguage-generator/CHANGELOG.json | 17 + packages/tmlanguage-generator/CHANGELOG.md | 7 +- packages/tmlanguage-generator/package.json | 4 +- packages/tspd/package.json | 8 +- packages/typespec-vs/CHANGELOG.json | 6 + packages/typespec-vs/CHANGELOG.md | 7 +- packages/typespec-vs/package.json | 6 +- packages/typespec-vscode/CHANGELOG.json | 12 + packages/typespec-vscode/CHANGELOG.md | 9 +- packages/typespec-vscode/package.json | 8 +- packages/versioning/CHANGELOG.json | 15 + packages/versioning/CHANGELOG.md | 10 +- packages/versioning/package.json | 12 +- packages/website/package.json | 18 +- .../reference/js-api/Function.$onEmit.md | 2 +- .../reference/js-api/Function.getTracer.md | 21 + .../js-api/Function.reportDiagnostic.md | 26 + .../Interface.CSharpServiceEmitterOptions.md | 10 + .../reference/js-api/Variable.$lib.md | 8 + .../reference/js-api/_category_.json | 1 + .../reference/js-api/index.md | 18 + .../extending-typespec/basics.md | 18 +- .../extending-typespec/diagnostics.md | 4 +- .../emitter-metadata-handling.md | 14 +- .../extending-typespec/linters.md | 10 +- .../getting-started/getting-started-http.md | 259 +++ .../getting-started/getting-started.md | 200 +- .../configuration/configuration.md | 6 +- .../version-latest/introduction/editor/vs.md | 4 +- .../introduction/editor/vscode.md | 4 +- .../introduction/reproducibility.md | 4 +- .../release-notes/cadl-typespec-migration.md | 4 +- .../release-notes/release-2023-10-11.md | 100 + .../standard-library/built-in-data-types.md | 410 +++- .../standard-library/built-in-decorators.md | 52 + .../standard-library/discriminated-types.md | 4 +- .../standard-library/http/content-types.md | 4 +- .../standard-library/http/encoding.md | 4 +- .../js-api/Enumeration.Visibility.md | 21 - .../js-api/Function.DefaultRouteProducer.md | 27 - .../js-api/Function.getHttpService.md | 23 - .../js-api/Function.getOperationParameters.md | 27 - .../Function.getStatusCodeDescription.md | 18 - .../js-api/Function.listHttpOperationsIn.md | 25 - .../Function.resolvePathAndParameters.md | 25 - .../reference/js-api/Interface.ApiKeyAuth.md | 44 - .../js-api/Interface.AuthenticationOption.md | 10 - .../js-api/Interface.AuthorizationCodeFlow.md | 16 - .../js-api/Interface.ClientCredentialsFlow.md | 15 - .../js-api/Interface.HeaderFieldOptions.md | 12 - .../js-api/Interface.HttpAuthBase.md | 18 - .../js-api/Interface.HttpOperation.md | 18 - .../Interface.HttpOperationParameters.md | 14 - .../Interface.HttpOperationRequestBody.md | 22 - .../js-api/Interface.HttpOperationResponse.md | 13 - .../Interface.HttpOperationResponseContent.md | 11 - .../reference/js-api/Interface.HttpServer.md | 12 - .../reference/js-api/Interface.HttpService.md | 11 - .../js-api/Interface.ImplicitFlow.md | 15 - .../js-api/Interface.MetadataInfoOptions.md | 35 - .../reference/js-api/Interface.OAuth2Scope.md | 11 - .../Interface.OperationParameterOptions.md | 10 - .../js-api/Interface.PasswordFlow.md | 15 - .../js-api/Interface.PathParameterOptions.md | 11 - .../js-api/Interface.QueryParameterOptions.md | 12 - .../js-api/Interface.RouteOptions.md | 18 - .../reference/js-api/Interface.RoutePath.md | 11 - .../js-api/Interface.RouteProducerResult.md | 11 - .../Interface.RouteResolutionOptions.md | 15 - .../js-api/Interface.ServiceAuthentication.md | 10 - .../http/reference/js-api/Type.HttpAuth.md | 8 - .../js-api/Type.HttpOperationParameter.md | 12 - .../http/reference/js-api/Type.HttpVerb.md | 8 - .../http/reference/js-api/Type.OAuth2Flow.md | 8 - .../reference/js-api/Type.RouteProducer.md | 22 - .../http/reference/js-api/Type.StatusCode.md | 8 - .../http/reference/js-api/Variable.$lib.md | 8 - .../js-api/enumerations/Visibility.md | 21 + .../{Function.$body.md => functions/$body.md} | 4 - .../$delete.md} | 4 - .../{Function.$get.md => functions/$get.md} | 4 - .../{Function.$head.md => functions/$head.md} | 4 - .../$header.md} | 10 +- .../$includeInapplicableMetadataInPayload.md} | 8 +- .../js-api/functions/$onValidate.md} | 4 - .../$patch.md} | 4 - .../{Function.$path.md => functions/$path.md} | 10 +- .../$plainData.md} | 4 - .../{Function.$post.md => functions/$post.md} | 4 - .../{Function.$put.md => functions/$put.md} | 4 - .../$query.md} | 10 +- .../$route.md} | 12 +- .../$server.md} | 12 +- .../$sharedRoute.md} | 4 - .../$statusCode.md} | 4 - .../$useAuth.md} | 10 +- .../js-api/functions/DefaultRouteProducer.md | 23 + .../createMetadataInfo.md} | 6 +- .../gatherMetadata.md} | 20 +- .../getAllHttpServices.md} | 6 +- .../getAllRoutes.md} | 4 +- .../getAuthentication.md} | 4 - .../getContentTypes.md} | 2 - .../getHeaderFieldName.md} | 4 - .../getHeaderFieldOptions.md} | 4 - .../getHttpOperation.md} | 12 +- .../js-api/functions/getHttpService.md | 19 + .../functions/getOperationParameters.md | 23 + .../getOperationVerb.md} | 4 - .../getPathParamName.md} | 4 - .../getPathParamOptions.md} | 4 - .../getQueryParamName.md} | 4 - .../getQueryParamOptions.md} | 4 - .../getRequestVisibility.md} | 4 +- .../getResponsesForOperation.md} | 4 - .../getRouteOptionsForNamespace.md} | 4 - .../getRoutePath.md} | 4 - .../getRouteProducer.md} | 4 - .../getServers.md} | 4 - .../functions/getStatusCodeDescription.md | 33 + .../getStatusCodes.md} | 8 +- .../getStatusCodesWithDiagnostics.md | 15 + .../getVisibilitySuffix.md} | 10 +- .../includeInapplicableMetadataInPayload.md} | 2 - .../includeInterfaceRoutesInNamespace.md} | 8 +- .../isApplicableMetadata.md} | 14 +- .../isApplicableMetadataOrBody.md} | 14 +- .../isBody.md} | 4 - .../isContentTypeHeader.md} | 2 - .../isHeader.md} | 4 - .../isMetadata.md} | 4 - .../isOverloadSameEndpoint.md} | 6 +- .../isPathParam.md} | 4 - .../isQueryParam.md} | 4 - .../isSharedRoute.md} | 4 - .../isStatusCode.md} | 4 - .../isVisible.md} | 12 +- .../js-api/functions/listHttpOperationsIn.md | 23 + .../reportIfNoRoutes.md} | 6 +- .../functions/resolvePathAndParameters.md | 21 + .../resolveRequestVisibility.md} | 10 +- .../setAuthentication.md} | 12 +- .../setRoute.md} | 12 +- .../setRouteOptionsForNamespace.md} | 12 +- .../setRouteProducer.md} | 12 +- .../setSharedRoute.md} | 4 - .../setStatusCode.md} | 10 +- .../validateRouteUnique.md} | 12 +- .../http/reference/js-api/index.md | 230 +- .../reference/js-api/interfaces/ApiKeyAuth.md | 44 + .../js-api/interfaces/AuthenticationOption.md | 10 + .../interfaces/AuthorizationCodeFlow.md | 16 + .../BasicAuth.md} | 14 +- .../BearerAuth.md} | 14 +- .../interfaces/ClientCredentialsFlow.md | 15 + .../js-api/interfaces/HeaderFieldOptions.md | 12 + .../js-api/interfaces/HttpAuthBase.md | 18 + .../js-api/interfaces/HttpOperation.md | 18 + .../HttpOperationBody.md} | 2 +- .../interfaces/HttpOperationParameters.md | 13 + .../interfaces/HttpOperationRequestBody.md | 22 + .../interfaces/HttpOperationResponse.md | 14 + .../HttpOperationResponseContent.md | 11 + .../reference/js-api/interfaces/HttpServer.md | 12 + .../js-api/interfaces/HttpService.md | 11 + .../js-api/interfaces/HttpStatusCodeRange.md | 11 + .../js-api/interfaces/ImplicitFlow.md | 15 + .../MetadataInfo.md} | 42 +- .../js-api/interfaces/MetadataInfoOptions.md | 31 + .../js-api/interfaces/OAuth2Scope.md | 11 + .../Oauth2Auth.md} | 16 +- .../interfaces/OperationParameterOptions.md | 10 + .../js-api/interfaces/PasswordFlow.md | 15 + .../js-api/interfaces/PathParameterOptions.md | 11 + .../interfaces/QueryParameterOptions.md | 12 + .../js-api/interfaces/RouteOptions.md | 18 + .../reference/js-api/interfaces/RoutePath.md | 11 + .../js-api/interfaces/RouteProducerResult.md | 11 + .../interfaces/RouteResolutionOptions.md | 15 + .../interfaces/ServiceAuthentication.md | 10 + .../reference/js-api/type-aliases/HttpAuth.md | 8 + .../type-aliases/HttpOperationParameter.md | 14 + .../js-api/type-aliases/HttpStatusCodes.md | 8 + .../type-aliases/HttpStatusCodesEntry.md | 8 + .../reference/js-api/type-aliases/HttpVerb.md | 14 + .../js-api/type-aliases/OAuth2Flow.md | 8 + .../OAuth2FlowType.md} | 2 +- .../OperationContainer.md} | 2 +- .../OperationDetails.md} | 2 +- .../OperationVerbSelector.md} | 6 +- .../js-api/type-aliases/RouteProducer.md | 18 + .../js-api/type-aliases/StatusCode.md | 12 + .../http/reference/js-api/variables/$lib.md | 8 + .../reference/js-api/variables/namespace.md} | 2 +- .../js-api/Interface.ExtensionRecord.md | 11 - .../reference/js-api/Variable.$lib.md | 8 - .../js-api/Variable.EmitterOptionsSchema.md | 8 - .../reference/js-api/Variable.namespace.md | 8 - .../JsonSchemaEmitter.md} | 715 ++----- .../$baseUri.md} | 10 +- .../$contains.md} | 10 +- .../$contentEncoding.md} | 10 +- .../$contentMediaType.md} | 10 +- .../$contentSchema.md} | 10 +- .../$extension.md} | 12 +- .../{Function.$id.md => functions/$id.md} | 10 +- .../$jsonSchema.md} | 12 +- .../$maxContains.md} | 10 +- .../$maxProperties.md} | 10 +- .../$minContains.md} | 10 +- .../$minProperties.md} | 10 +- .../$multipleOf.md} | 10 +- .../reference/js-api/functions/$onEmit.md | 14 + .../$prefixItems.md} | 10 +- .../$uniqueItems.md} | 4 - .../$validatesRawJson.md} | 10 +- .../findBaseUri.md} | 6 +- .../getBaseUri.md} | 4 - .../getContains.md} | 4 - .../getContentEncoding.md} | 4 - .../getContentMediaType.md} | 4 - .../getContentSchema.md} | 4 - .../getExtensions.md} | 4 - .../{Function.getId.md => functions/getId.md} | 4 - .../getJsonSchema.md} | 4 - .../getJsonSchemaTypes.md} | 4 - .../getMaxContains.md} | 4 - .../getMaxProperties.md} | 4 - .../getMinContains.md} | 4 - .../getMinProperties.md} | 4 - .../getMultipleOf.md} | 4 - .../getPrefixItems.md} | 4 - .../getUniqueItems.md} | 4 - .../isJsonSchemaDeclaration.md} | 6 +- .../json-schema/reference/js-api/index.md | 88 +- .../js-api/interfaces/ExtensionRecord.md | 11 + .../JSONSchemaEmitterOptions.md} | 10 +- .../$validatesRawJson/index.md} | 2 +- .../$validatesRawJson/variables/namespace.md} | 2 +- .../JsonSchemaDeclaration.md} | 2 +- .../reference/js-api/variables/$lib.md | 8 + .../js-api/variables/EmitterOptionsSchema.md | 8 + .../reference/js-api/variables/namespace.md | 8 + .../openapi/reference/data-types.md | 14 +- .../openapi/reference/decorators.md | 28 +- .../openapi/reference/index.md | 18 +- .../js-api/Function.getExtensions.md | 19 - .../js-api/Interface.AdditionalInfo.md | 14 - .../js-api/Interface.ExternalDocs.md | 11 - .../$defaultResponse.md} | 4 - .../$extension.md} | 12 +- .../$externalDocs.md} | 10 +- .../{Function.$info.md => functions/$info.md} | 10 +- .../$operationId.md} | 10 +- .../checkDuplicateTypeName.md} | 14 +- .../js-api/functions/getExtensions.md | 15 + .../getExternalDocs.md} | 4 - .../getInfo.md} | 4 - .../getOpenAPITypeName.md} | 14 +- .../getOperationId.md} | 2 - .../getParameterKey.md} | 16 +- .../isDefaultResponse.md} | 2 - .../isReadonlyProperty.md} | 4 - .../resolveOperationId.md} | 2 - .../setExtension.md} | 14 +- .../shouldInline.md} | 4 - .../openapi/reference/js-api/index.md | 48 +- .../js-api/interfaces/AdditionalInfo.md | 14 + .../Contact.md} | 6 +- .../js-api/interfaces/ExternalDocs.md | 11 + .../License.md} | 2 +- .../ExtensionKey.md} | 2 +- .../reference/js-api/variables/namespace.md | 8 + .../openapi3/reference/decorators.md | 12 +- .../openapi3/reference/index.md | 6 +- .../reference/js-api/Function.$onEmit.md | 18 - ...nterface.ResolvedOpenAPI3EmitterOptions.md | 14 - .../reference/js-api/Variable.$lib.md | 8 - .../reference/js-api/functions/$onEmit.md | 14 + .../$oneOf.md} | 6 +- .../$useRef.md} | 10 +- .../getOneOf.md} | 4 - .../getRef.md} | 4 - .../resolveOptions.md} | 6 +- .../openapi3/reference/js-api/index.md | 20 +- .../ResolvedOpenAPI3EmitterOptions.md | 14 + .../reference/js-api/variables/$lib.md | 8 + .../reference/js-api/variables/namespace.md | 8 + .../reference/js-api/Function.$_map.md | 21 - .../js-api/Interface.PackageDetails.md | 10 - .../reference/js-api/Type.Reservation.md | 8 - .../reference/js-api/Variable.$lib.md | 8 - .../reference/js-api/Variable.namespace.md | 8 - .../$externRef.md} | 12 +- .../$field.md} | 8 +- .../$message.md} | 4 - .../$onEmit.md} | 8 +- .../$onValidate.md} | 6 +- .../$package.md} | 10 +- .../$reserve.md} | 12 +- .../$service.md} | 4 - .../$stream.md} | 10 +- .../{Function.isMap.md => functions/isMap.md} | 2 - .../protobuf/reference/js-api/index.md | 33 +- .../js-api/interfaces/PackageDetails.md | 10 + .../js-api/type-aliases/Reservation.md | 8 + .../reference/js-api/variables/$lib.md | 8 + .../PROTO_FULL_IDENT.md} | 2 +- .../reference/js-api/variables/namespace.md | 8 + .../js-api/Enumeration.IdentifierKind.md | 15 - .../js-api/Enumeration.KeywordLimit.md | 12 - .../reference/js-api/Enumeration.NodeFlags.md | 14 - .../js-api/Enumeration.SemanticTokenKind.md | 31 - .../js-api/Enumeration.SymbolFlags.md | 37 - .../js-api/Enumeration.SyntaxKind.md | 96 - .../reference/js-api/Enumeration.Token.md | 94 - .../js-api/Enumeration.TokenFlags.md | 16 - .../reference/js-api/Function.assertType.md | 31 - .../reference/js-api/Function.compile.md | 25 - .../js-api/Function.createCadlLibrary.md | 29 - .../Function.createDecoratorDefinition.md | 30 - .../reference/js-api/Function.createRule.md | 27 - .../js-api/Function.createScanner.md | 19 - .../js-api/Function.createStateAccessors.md | 26 - .../reference/js-api/Function.emitFile.md | 21 - .../Function.ensurePathIsNonModuleName.md | 28 - .../Function.getCompletionNodeAtPosition.md | 26 - .../js-api/Function.getDiscriminatedUnion.md | 19 - .../js-api/Function.getSourceLocation.md | 49 - .../reference/js-api/Function.getTypeName.md | 19 - .../js-api/Function.isIntrinsicType.md | 23 - .../js-api/Function.listOperationsIn.md | 21 - .../js-api/Function.markDeprecated.md | 25 - .../js-api/Function.navigateProgram.md | 25 - .../reference/js-api/Function.navigateType.md | 25 - .../Function.navigateTypesInNamespace.md | 23 - .../reference/js-api/Function.paramMessage.md | 25 - .../reference/js-api/Function.parse.md | 19 - .../js-api/Function.projectProgram.md | 23 - .../js-api/Function.reportDeprecated.md | 25 - .../js-api/Function.resolveCompilerOptions.md | 21 - .../js-api/Function.resolveModule.md | 25 - .../Function.scopeNavigationToNamespace.md | 33 - .../Function.validateDecoratorNotOnType.md | 30 - .../Function.validateDecoratorParamType.md | 43 - .../Function.validateDecoratorTarget.md | 33 - ...nction.validateDecoratorTargetIntrinsic.md | 25 - .../Function.validateDecoratorUniqueOnNode.md | 23 - .../js-api/Interface.AliasStatementNode.md | 25 - .../js-api/Interface.AnyKeywordNode.md | 21 - .../js-api/Interface.ArrayExpressionNode.md | 22 - .../js-api/Interface.ArrayModelType.md | 68 - ...Interface.AugmentDecoratorStatementNode.md | 24 - .../reference/js-api/Interface.BaseNode.md | 21 - .../reference/js-api/Interface.BaseType.md | 66 - .../js-api/Interface.BlockComment.md | 17 - .../js-api/Interface.BooleanLiteral.md | 55 - .../js-api/Interface.BooleanLiteralNode.md | 22 - .../reference/js-api/Interface.Checker.md | 633 ------ .../Interface.CompilerLocationContext.md | 12 - .../js-api/Interface.CompilerOptions.md | 25 - .../js-api/Interface.DeclarationNode.md | 30 - .../js-api/Interface.DecoratedType.md | 23 - .../reference/js-api/Interface.Decorator.md | 59 - .../js-api/Interface.DecoratorApplication.md | 13 - .../js-api/Interface.DecoratorArgument.md | 12 - ...rface.DecoratorDeclarationStatementNode.md | 34 - .../js-api/Interface.DecoratorDefinition.md | 21 - .../Interface.DecoratorExpressionNode.md | 23 - .../Interface.DecoratorParamDefinition.md | 17 - .../js-api/Interface.DecoratorValidator.md | 35 - .../js-api/Interface.DeprecatedDirective.md | 16 - .../reference/js-api/Interface.Diagnostic.md | 13 - .../js-api/Interface.DiagnosticCreator.md | 68 - .../js-api/Interface.DiagnosticDefinition.md | 17 - .../js-api/Interface.DiagnosticMessages.md | 8 - .../js-api/Interface.DirectiveBase.md | 15 - .../Interface.DirectiveExpressionNode.md | 23 - .../reference/js-api/Interface.Dirent.md | 34 - .../js-api/Interface.DiscriminatedUnion.md | 11 - .../reference/js-api/Interface.DocNode.md | 23 - .../js-api/Interface.DocParamTagNode.md | 24 - .../js-api/Interface.DocReturnsTagNode.md | 23 - .../js-api/Interface.DocTagBaseNode.md | 23 - .../js-api/Interface.DocTemplateTagNode.md | 24 - .../reference/js-api/Interface.DocTextNode.md | 22 - .../js-api/Interface.DocUnknownTagNode.md | 23 - .../js-api/Interface.EmitFileOptions.md | 12 - .../js-api/Interface.EmptyStatementNode.md | 21 - .../reference/js-api/Interface.Enum.md | 58 - .../reference/js-api/Interface.EnumMember.md | 59 - .../js-api/Interface.EnumMemberNode.md | 24 - .../js-api/Interface.EnumSpreadMemberNode.md | 22 - .../js-api/Interface.EnumStatementNode.md | 24 - .../reference/js-api/Interface.ErrorType.md | 55 - .../js-api/Interface.ExternKeywordNode.md | 21 - .../js-api/Interface.FileLibraryMetadata.md | 19 - ...erface.FunctionDeclarationStatementNode.md | 34 - .../js-api/Interface.FunctionParameter.md | 58 - .../js-api/Interface.FunctionParameterNode.md | 25 - .../js-api/Interface.FunctionType.md | 59 - .../js-api/Interface.IdentifierContext.md | 11 - .../js-api/Interface.IdentifierNode.md | 22 - .../js-api/Interface.ImportStatementNode.md | 22 - .../reference/js-api/Interface.Interface.md | 63 - .../Interface.InterfaceStatementNode.md | 27 - .../Interface.IntersectionExpressionNode.md | 22 - .../js-api/Interface.IntrinsicType.md | 55 - .../js-api/Interface.InvalidStatementNode.md | 22 - .../Interface.JsNamespaceDeclarationNode.md | 22 - .../js-api/Interface.JsSourceFileNode.md | 25 - .../js-api/Interface.LibraryInstance.md | 13 - .../Interface.LibraryLocationContext.md | 13 - .../reference/js-api/Interface.LineComment.md | 16 - .../js-api/Interface.LinterDefinition.md | 11 - .../reference/js-api/Interface.LinterRule.md | 49 - .../js-api/Interface.LinterRuleContext.md | 40 - .../js-api/Interface.LinterRuleDefinition.md | 42 - .../js-api/Interface.LinterRuleSet.md | 12 - .../reference/js-api/Interface.LogInfo.md | 13 - .../js-api/Interface.MemberExpressionNode.md | 24 - .../reference/js-api/Interface.Model.md | 66 - .../js-api/Interface.ModelExpressionNode.md | 22 - .../js-api/Interface.ModelProperty.md | 61 - .../js-api/Interface.ModelPropertyNode.md | 26 - .../Interface.ModelSpreadPropertyNode.md | 22 - .../js-api/Interface.ModelStatementNode.md | 28 - .../js-api/Interface.ModuleLibraryMetadata.md | 21 - .../reference/js-api/Interface.Namespace.md | 66 - .../Interface.NamespaceStatementNode.md | 25 - .../js-api/Interface.NeverKeywordNode.md | 21 - .../reference/js-api/Interface.NeverType.md | 55 - .../reference/js-api/Interface.NodePackage.md | 25 - .../reference/js-api/Interface.NullType.md | 55 - .../js-api/Interface.NumericLiteral.md | 56 - .../js-api/Interface.NumericLiteralNode.md | 23 - .../reference/js-api/Interface.ObjectType.md | 55 - .../reference/js-api/Interface.Operation.md | 64 - ...rface.OperationSignatureDeclarationNode.md | 23 - ...terface.OperationSignatureReferenceNode.md | 22 - .../Interface.OperationStatementNode.md | 26 - .../js-api/Interface.ParseOptions.md | 11 - .../js-api/Interface.ProcessedLog.md | 13 - .../reference/js-api/Interface.Program.md | 252 --- .../js-api/Interface.ProjectedProgram.md | 305 --- .../reference/js-api/Interface.Projection.md | 56 - .../js-api/Interface.ProjectionApplication.md | 13 - ...face.ProjectionArithmeticExpressionNode.md | 24 - ...Interface.ProjectionBlockExpressionNode.md | 22 - .../Interface.ProjectionCallExpressionNode.md | 24 - ...jectionDecoratorReferenceExpressionNode.md | 22 - ...erface.ProjectionEnumMemberSelectorNode.md | 21 - .../Interface.ProjectionEnumSelectorNode.md | 21 - ...erface.ProjectionEqualityExpressionNode.md | 24 - ...rface.ProjectionExpressionStatementNode.md | 22 - .../Interface.ProjectionIfExpressionNode.md | 24 - ...terface.ProjectionInterfaceSelectorNode.md | 21 - ...nterface.ProjectionLambdaExpressionNode.md | 24 - ...rojectionLambdaParameterDeclarationNode.md | 22 - ...terface.ProjectionLogicalExpressionNode.md | 24 - ...nterface.ProjectionMemberExpressionNode.md | 24 - ...Interface.ProjectionModelExpressionNode.md | 22 - .../Interface.ProjectionModelPropertyNode.md | 26 - ...ace.ProjectionModelPropertySelectorNode.md | 21 - .../Interface.ProjectionModelSelectorNode.md | 21 - ...rface.ProjectionModelSpreadPropertyNode.md | 22 - .../js-api/Interface.ProjectionNode.md | 27 - ...terface.ProjectionOperationSelectorNode.md | 21 - ...face.ProjectionParameterDeclarationNode.md | 22 - .../Interface.ProjectionReferenceNode.md | 23 - ...face.ProjectionRelationalExpressionNode.md | 24 - .../Interface.ProjectionStatementNode.md | 28 - ...Interface.ProjectionTupleExpressionNode.md | 22 - ...Interface.ProjectionUnaryExpressionNode.md | 23 - .../Interface.ProjectionUnionSelectorNode.md | 21 - ...face.ProjectionUnionVariantSelectorNode.md | 21 - .../reference/js-api/Interface.Projector.md | 32 - .../js-api/Interface.RecordModelType.md | 68 - ...Interface.ResolveCompilerOptionsOptions.md | 15 - .../js-api/Interface.ResolvedFile.md | 11 - .../js-api/Interface.ReturnExpressionNode.md | 22 - .../js-api/Interface.ReturnRecord.md | 11 - .../reference/js-api/Interface.Scalar.md | 63 - .../js-api/Interface.ScalarStatementNode.md | 26 - .../reference/js-api/Interface.Scanner.md | 115 - .../js-api/Interface.SemanticToken.md | 12 - .../js-api/Interface.ServerSourceFile.md | 61 - .../js-api/Interface.SourceLocation.md | 17 - .../js-api/Interface.StringLiteral.md | 55 - .../js-api/Interface.StringLiteralNode.md | 22 - .../js-api/Interface.SuppressDirective.md | 17 - .../reference/js-api/Interface.Sym.md | 20 - .../reference/js-api/Interface.SymbolLinks.md | 12 - .../Interface.TemplateDeclarationNode.md | 20 - .../js-api/Interface.TemplateParameter.md | 56 - ...erface.TemplateParameterDeclarationNode.md | 24 - .../js-api/Interface.TemplatedTypeBase.md | 20 - .../reference/js-api/Interface.TextRange.md | 18 - .../js-api/Interface.TracerOptions.md | 10 - .../reference/js-api/Interface.Tuple.md | 55 - .../js-api/Interface.TupleExpressionNode.md | 22 - .../reference/js-api/Interface.TypeMapper.md | 30 - .../js-api/Interface.TypeNameOptions.md | 11 - .../js-api/Interface.TypeReferenceNode.md | 23 - .../js-api/Interface.TypeSpecLibrary.md | 121 -- .../js-api/Interface.TypeSpecLibraryDef.md | 28 - .../js-api/Interface.TypeSpecScriptNode.md | 32 - .../reference/js-api/Interface.Union.md | 64 - .../js-api/Interface.UnionExpressionNode.md | 22 - .../js-api/Interface.UnionStatementNode.md | 26 - .../js-api/Interface.UnionVariant.md | 58 - .../js-api/Interface.UnionVariantNode.md | 24 - .../reference/js-api/Interface.UnknownType.md | 55 - .../js-api/Interface.UsageTracker.md | 29 - .../js-api/Interface.UsingStatementNode.md | 22 - .../js-api/Interface.ValueOfExpressionNode.md | 22 - .../reference/js-api/Interface.ValueType.md | 11 - .../js-api/Interface.VoidKeywordNode.md | 21 - .../reference/js-api/Interface.VoidType.md | 55 - ...pace.decorators.Function.$discriminator.md | 23 - ...ace.decorators.Function.$docFromComment.md | 25 - .../Namespace.decorators.Function.$encode.md | 25 - ...space.decorators.Function.$friendlyName.md | 25 - .../Namespace.decorators.Function.$indexer.md | 25 - .../Namespace.decorators.Function.$list.md | 27 - ...Namespace.decorators.Function.$maxItems.md | 23 - ...amespace.decorators.Function.$maxLength.md | 23 - ...Namespace.decorators.Function.$maxValue.md | 23 - ....decorators.Function.$maxValueExclusive.md | 23 - ...Namespace.decorators.Function.$minItems.md | 23 - ...amespace.decorators.Function.$minLength.md | 23 - ...Namespace.decorators.Function.$minValue.md | 23 - ....decorators.Function.$minValueExclusive.md | 23 - ...Namespace.decorators.Function.$overload.md | 25 - ...ecorators.Function.$parameterVisibility.md | 23 - .../Namespace.decorators.Function.$pattern.md | 23 - ...corators.Function.$returnTypeVisibility.md | 23 - .../Namespace.decorators.Function.$secret.md | 21 - .../Namespace.decorators.Function.$service.md | 23 - .../Namespace.decorators.Function.$tag.md | 23 - ...mespace.decorators.Function.$visibility.md | 23 - ...ace.decorators.Function.$withVisibility.md | 23 - ...tors.Function.$withoutOmittedProperties.md | 23 - ...amespace.decorators.Function.addService.md | 25 - ...amespace.decorators.Function.getAllTags.md | 19 - ...corators.Function.getDiscriminatedTypes.md | 18 - ...ce.decorators.Function.getDiscriminator.md | 19 - ...Namespace.decorators.Function.getEncode.md | 19 - ...pace.decorators.Function.getKnownValues.md | 19 - ...e.decorators.Function.getProjectedNames.md | 21 - ...space.decorators.Function.isNumericType.md | 19 - ...espace.decorators.Function.isStringType.md | 19 - ...Namespace.decorators.Function.isVisible.md | 23 - ...pace.decorators.Interface.Discriminator.md | 10 - .../Namespace.decorators.Interface.DocData.md | 11 - ...mespace.decorators.Interface.EncodeData.md | 11 - .../Namespace.decorators.Interface.Service.md | 16 - ...ace.decorators.Interface.ServiceDetails.md | 15 - ...e.decorators.Type.DateTimeKnownEncoding.md | 8 - ...Namespace.decorators.Variable.namespace.md | 8 - .../reference/js-api/Namespace.decorators.md | 111 - .../reference/js-api/Type.CreateTypeProps.md | 8 - .../reference/js-api/Type.Declaration.md | 8 - .../reference/js-api/Type.DiagnosticFormat.md | 16 - .../reference/js-api/Type.DiagnosticMap.md | 14 - .../reference/js-api/Type.DiagnosticReport.md | 20 - .../Type.DiagnosticReportWithoutTarget.md | 21 - .../reference/js-api/Type.DiagnosticTarget.md | 8 - .../reference/js-api/Type.Directive.md | 8 - .../reference/js-api/Type.DocTag.md | 8 - .../reference/js-api/Type.DocToken.md | 8 - .../reference/js-api/Type.EmitterFunc.md | 18 - .../reference/js-api/Type.Expression.md | 8 - .../js-api/Type.InferredTypeSpecValue.md | 14 - .../js-api/Type.IntrinsicScalarName.md | 8 - .../reference/js-api/Type.LibraryMetadata.md | 8 - .../js-api/Type.LinterRuleDiagnosticFormat.md | 15 - .../js-api/Type.LinterRuleDiagnosticReport.md | 19 - ...LinterRuleDiagnosticReportWithoutTarget.md | 19 - .../reference/js-api/Type.LiteralNode.md | 8 - .../reference/js-api/Type.LiteralType.md | 8 - .../reference/js-api/Type.MarshalledValue.md | 14 - .../js-api/Type.MemberContainerNode.md | 10 - .../reference/js-api/Type.MemberNode.md | 8 - .../reference/js-api/Type.ModelIndexer.md | 15 - .../reference/js-api/Type.NeverIndexer.md | 15 - .../reference/js-api/Type.Node.md | 8 - .../js-api/Type.OperationSignature.md | 8 - .../js-api/Type.ProjectionExpression.md | 8 - .../js-api/Type.ReferenceExpression.md | 8 - .../reference/js-api/Type.ScopeNode.md | 8 - .../js-api/Type.SemanticNodeListener.md | 12 - .../reference/js-api/Type.Statement.md | 8 - .../reference/js-api/Type.StdTypes.md | 13 - .../reference/js-api/Type.TemplateableNode.md | 10 - .../reference/js-api/Type.Type.md | 8 - .../reference/js-api/Type.TypeListeners.md | 8 - .../js-api/Type.TypeOfDiagnostics.md | 14 - .../reference/js-api/Variable.Keywords.md | 8 - .../reference/js-api/Variable.TokenDisplay.md | 8 - .../DuplicateTracker.md} | 38 +- .../EventEmitter.md} | 44 +- .../InvalidEncodingError.md} | 26 +- .../ProjectionError.md} | 26 +- .../{Class.Queue.md => classes/Queue.md} | 46 +- .../ResolveModuleError.md} | 28 +- .../js-api/enumerations/IdentifierKind.md | 15 + .../ListenerFlow.md} | 2 +- .../ModifierFlags.md} | 4 +- .../js-api/enumerations/NodeFlags.md | 14 + .../js-api/enumerations/SemanticTokenKind.md | 31 + .../js-api/enumerations/SymbolFlags.md | 37 + .../js-api/enumerations/SyntaxKind.md | 97 + .../reference/js-api/enumerations/Token.md | 81 + .../js-api/enumerations/TokenFlags.md | 16 + .../UsageFlags.md} | 6 +- .../$deprecated.md} | 12 +- .../js-api/functions/$discriminator.md | 19 + .../$doc.md} | 16 +- .../reference/js-api/functions/$encode.md | 21 + .../$error.md} | 8 +- .../reference/js-api/functions/$errorsDoc.md | 19 + .../$format.md} | 14 +- .../js-api/functions/$friendlyName.md | 21 + .../reference/js-api/functions/$indexer.md | 21 + .../$inspectType.md} | 14 +- .../$inspectTypeName.md} | 14 +- .../$key.md} | 14 +- .../$knownValues.md} | 16 +- .../reference/js-api/functions/$list.md | 25 + .../reference/js-api/functions/$maxItems.md | 19 + .../reference/js-api/functions/$maxLength.md | 19 + .../reference/js-api/functions/$maxValue.md | 19 + .../js-api/functions/$maxValueExclusive.md | 19 + .../reference/js-api/functions/$minItems.md | 19 + .../reference/js-api/functions/$minLength.md | 19 + .../reference/js-api/functions/$minValue.md | 19 + .../js-api/functions/$minValueExclusive.md | 19 + .../reference/js-api/functions/$overload.md | 21 + .../js-api/functions/$parameterVisibility.md | 19 + .../reference/js-api/functions/$pattern.md | 19 + .../$projectedName.md} | 16 +- .../js-api/functions/$returnTypeVisibility.md | 19 + .../reference/js-api/functions/$returnsDoc.md | 19 + .../reference/js-api/functions/$secret.md | 17 + .../reference/js-api/functions/$service.md | 19 + .../$summary.md} | 16 +- .../reference/js-api/functions/$tag.md | 19 + .../reference/js-api/functions/$visibility.md | 19 + .../$withDefaultKeyVisibility.md} | 14 +- .../$withOptionalProperties.md} | 8 +- .../$withUpdateableProperties.md} | 8 +- .../js-api/functions/$withVisibility.md | 19 + .../$withoutDefaultValues.md} | 8 +- .../functions/$withoutOmittedProperties.md | 19 + .../reference/js-api/functions/addService.md | 21 + .../reference/js-api/functions/assertType.md | 48 + .../cadlTypeToJson.md} | 6 +- .../checkFormatCadl.md} | 4 +- .../checkFormatTypeSpec.md} | 4 +- .../reference/js-api/functions/compile.md | 21 + .../compilerAssert.md} | 12 +- .../js-api/functions/createCadlLibrary.md | 27 + .../createChecker.md} | 6 +- .../functions/createDecoratorDefinition.md | 28 + .../createDiagnosticCollector.md} | 2 - .../createDiagnosticCreator.md} | 8 +- .../createProjectedNameProgram.md} | 4 +- .../createRekeyableMap.md} | 6 +- .../reference/js-api/functions/createRule.md | 23 + .../js-api/functions/createScanner.md | 15 + .../createServer.md} | 6 +- .../createSourceFile.md} | 4 - .../js-api/functions/createStateAccessors.md | 27 + .../createTypeSpecLibrary.md} | 10 +- .../reference/js-api/functions/emitFile.md | 17 + .../ensureTrailingDirectorySeparator.md} | 4 - .../filterModelProperties.md} | 14 +- .../finishTypeForProgram.md} | 8 +- .../formatDiagnostic.md} | 6 +- .../formatIdentifier.md} | 4 - .../formatTypeSpec.md} | 6 +- .../reference/js-api/functions/getAllTags.md | 15 + .../getAnyExtensionFromPath.md} | 4 - .../getBaseFileName.md} | 4 - .../getDeprecated.md} | 8 +- .../getDeprecationDetails.md} | 8 +- .../getDirectoryPath.md} | 4 - .../js-api/functions/getDiscriminatedTypes.md | 14 + .../js-api/functions/getDiscriminatedUnion.md | 15 + .../js-api/functions/getDiscriminator.md | 15 + .../getDoc.md} | 6 +- .../getDocData.md} | 8 +- .../js-api/functions/getDocDataInternal.md | 25 + .../getEffectiveModelType.md} | 14 +- .../reference/js-api/functions/getEncode.md | 15 + .../js-api/functions/getErrorsDoc.md | 21 + .../js-api/functions/getErrorsDocData.md | 21 + .../getFirstAncestor.md} | 8 +- .../getFormat.md} | 8 +- .../getFriendlyName.md} | 8 +- .../getFullyQualifiedSymbolName.md} | 6 +- .../getIdentifierContext.md} | 6 +- .../getIndexer.md} | 8 +- .../getKeyName.md} | 8 +- .../js-api/functions/getKnownValues.md | 15 + .../getListOperationType.md} | 6 +- .../getLocationContext.md} | 8 +- .../getMaxItems.md} | 8 +- .../getMaxLength.md} | 8 +- .../getMaxValue.md} | 8 +- .../getMaxValueExclusive.md} | 8 +- .../getMinItems.md} | 8 +- .../getMinLength.md} | 8 +- .../getMinValue.md} | 8 +- .../getMinValueExclusive.md} | 8 +- .../getNamespaceFullName.md} | 6 +- .../getNodeAtPosition.md} | 34 +- .../getNormalizedAbsolutePath.md} | 4 - .../getNormalizedAbsolutePathWithoutRoot.md} | 4 - .../getNormalizedPathComponents.md} | 4 - .../getOverloadedOperation.md} | 6 +- .../getOverloads.md} | 6 +- .../getOverriddenProperty.md} | 6 +- .../getParameterVisibility.md} | 8 +- .../getParentTemplateNode.md} | 4 +- .../getPathComponents.md} | 6 +- .../getPathFromPathComponents.md} | 6 +- .../getPattern.md} | 8 +- .../getProjectedName.md} | 12 +- .../js-api/functions/getProjectedNames.md | 19 + .../getProperty.md} | 6 +- .../getPropertyType.md} | 6 +- .../getRelativePathFromDirectory.md} | 26 +- .../getReturnTypeVisibility.md} | 8 +- .../js-api/functions/getReturnsDoc.md | 21 + .../js-api/functions/getReturnsDocData.md | 21 + .../getRootLength.md} | 4 - .../getService.md} | 6 +- .../getSourceFileKindFromExt.md} | 4 - .../js-api/functions/getSourceLocation.md | 43 + .../getSummary.md} | 8 +- .../getTags.md} | 8 +- .../reference/js-api/functions/getTypeName.md | 15 + .../getVisibility.md} | 8 +- .../hasParseError.md} | 6 +- .../hasProjectedName.md} | 12 +- .../hasTrailingDirectorySeparator.md} | 4 - .../ignoreDiagnostics.md} | 4 +- .../interpolatePath.md} | 4 +- .../isAnyDirectorySeparator.md} | 4 - .../isArrayModelType.md} | 10 +- .../isCadlValueTypeOf.md} | 8 +- .../isComment.md} | 6 +- .../isDeclaredInNamespace.md} | 12 +- .../isDeclaredType.md} | 6 +- .../isDeprecated.md} | 8 +- .../isErrorModel.md} | 8 +- .../isErrorType.md} | 6 +- .../isGlobalNamespace.md} | 6 +- .../isImportStatement.md} | 6 +- .../js-api/functions/isIntrinsicType.md | 19 + .../isKey.md} | 8 +- .../isKeyword.md} | 6 +- .../isListOperation.md} | 6 +- .../isModifier.md} | 6 +- .../isNeverType.md} | 6 +- .../isNullType.md} | 6 +- .../js-api/functions/isNumericType.md | 15 + .../isPathAbsolute.md} | 4 - .../isProjectedProgram.md} | 6 +- .../isPunctuation.md} | 6 +- .../isRecordModelType.md} | 8 +- .../isSecret.md} | 8 +- .../isService.md} | 6 +- .../isStatementKeyword.md} | 6 +- .../isStdNamespace.md} | 6 +- .../js-api/functions/isStringType.md | 15 + .../isTemplateDeclaration.md} | 6 +- .../isTemplateDeclarationOrInstance.md} | 6 +- .../isTemplateInstance.md} | 6 +- .../isTrivia.md} | 6 +- .../isTypeSpecValueTypeOf.md} | 8 +- .../isUnknownType.md} | 6 +- .../{Function.isUrl.md => functions/isUrl.md} | 4 - .../reference/js-api/functions/isVisible.md | 19 + .../isVoidType.md} | 6 +- .../joinPaths.md} | 4 - .../js-api/functions/listOperationsIn.md | 17 + .../listServices.md} | 4 +- .../logDiagnostics.md} | 8 +- .../logVerboseTestOutput.md} | 4 - .../mapEventEmitterToNodeListener.md} | 4 +- .../js-api/functions/markDeprecated.md | 21 + .../js-api/functions/navigateProgram.md | 21 + .../js-api/functions/navigateType.md | 21 + .../functions/navigateTypesInNamespace.md | 19 + .../normalizePath.md} | 4 - .../normalizeSlashes.md} | 4 - .../js-api/functions/paramMessage.md | 21 + .../reference/js-api/functions/parse.md | 15 + .../parseStandaloneTypeReference.md} | 6 +- .../js-api/functions/projectProgram.md | 19 + .../reducePathComponents.md} | 6 +- .../removeTrailingDirectorySeparator.md} | 4 - .../js-api/functions/reportDeprecated.md | 21 + .../functions/resolveCompilerOptions.md | 17 + .../js-api/functions/resolveModule.md | 23 + .../resolvePath.md} | 4 - .../resolveUsages.md} | 4 +- .../functions/scopeNavigationToNamespace.md | 31 + .../setCadlNamespace.md} | 2 - .../setTypeSpecNamespace.md} | 4 - .../skipTrivia.md} | 10 +- .../skipWhiteSpace.md} | 10 +- .../typespecTypeToJson.md} | 8 +- .../functions/validateDecoratorNotOnType.md | 28 + .../validateDecoratorParamCount.md} | 14 +- .../functions/validateDecoratorParamType.md | 62 + .../functions/validateDecoratorTarget.md | 31 + .../validateDecoratorTargetIntrinsic.md | 27 + .../validateDecoratorUniqueOnNode.md | 19 + .../visitChildren.md} | 8 +- .../walkPropertiesInherited.md} | 8 +- .../reference/js-api/index.md | 1875 +++++------------ .../js-api/interfaces/AliasStatementNode.md | 25 + .../js-api/interfaces/AnyKeywordNode.md | 21 + .../js-api/interfaces/ArrayExpressionNode.md | 22 + .../js-api/interfaces/ArrayModelType.md | 59 + .../AugmentDecoratorStatementNode.md | 24 + .../reference/js-api/interfaces/BaseNode.md | 21 + .../reference/js-api/interfaces/BaseType.md | 62 + .../js-api/interfaces/BlockComment.md | 17 + .../js-api/interfaces/BooleanLiteral.md | 47 + .../js-api/interfaces/BooleanLiteralNode.md | 22 + .../CallableMessage.md} | 14 +- .../reference/js-api/interfaces/Checker.md | 531 +++++ .../CompilerHost.md} | 106 +- .../interfaces/CompilerLocationContext.md | 12 + .../js-api/interfaces/CompilerOptions.md | 25 + .../js-api/interfaces/DeclarationNode.md | 30 + .../js-api/interfaces/DecoratedType.md | 23 + .../reference/js-api/interfaces/Decorator.md | 51 + .../js-api/interfaces/DecoratorApplication.md | 13 + .../js-api/interfaces/DecoratorArgument.md | 12 + .../DecoratorContext.md} | 24 +- .../DecoratorDeclarationStatementNode.md | 34 + .../js-api/interfaces/DecoratorDefinition.md | 21 + .../interfaces/DecoratorExpressionNode.md | 23 + .../DecoratorFunction.md} | 18 +- .../interfaces/DecoratorParamDefinition.md | 17 + .../js-api/interfaces/DecoratorValidator.md | 31 + .../js-api/interfaces/DeprecatedDirective.md | 16 + .../DeprecationDetails.md} | 0 .../reference/js-api/interfaces/Diagnostic.md | 13 + .../DiagnosticCollector.md} | 28 +- .../js-api/interfaces/DiagnosticCreator.md | 60 + .../js-api/interfaces/DiagnosticDefinition.md | 17 + .../js-api/interfaces/DiagnosticMessages.md | 8 + .../js-api/interfaces/DirectiveBase.md | 15 + .../interfaces/DirectiveExpressionNode.md | 23 + .../reference/js-api/interfaces/Dirent.md | 26 + .../js-api/interfaces/DiscriminatedUnion.md | 11 + .../js-api/interfaces/Discriminator.md | 10 + .../reference/js-api/interfaces/DocData.md | 11 + .../js-api/interfaces/DocErrorsTagNode.md | 23 + .../reference/js-api/interfaces/DocNode.md | 23 + .../js-api/interfaces/DocParamTagNode.md | 24 + .../js-api/interfaces/DocReturnsTagNode.md | 23 + .../js-api/interfaces/DocTagBaseNode.md | 23 + .../js-api/interfaces/DocTemplateTagNode.md | 24 + .../js-api/interfaces/DocTextNode.md | 22 + .../js-api/interfaces/DocUnknownTagNode.md | 23 + .../EmitContext.md} | 12 +- .../js-api/interfaces/EmitFileOptions.md | 12 + .../js-api/interfaces/EmptyStatementNode.md | 21 + .../reference/js-api/interfaces/EncodeData.md | 11 + .../reference/js-api/interfaces/Enum.md | 50 + .../reference/js-api/interfaces/EnumMember.md | 51 + .../js-api/interfaces/EnumMemberNode.md | 24 + .../js-api/interfaces/EnumSpreadMemberNode.md | 22 + .../js-api/interfaces/EnumStatementNode.md | 24 + .../reference/js-api/interfaces/ErrorType.md | 47 + .../js-api/interfaces/ExternKeywordNode.md | 21 + .../js-api/interfaces/FileLibraryMetadata.md | 19 + .../FunctionDeclarationStatementNode.md | 34 + .../js-api/interfaces/FunctionParameter.md | 50 + .../interfaces/FunctionParameterNode.md | 25 + .../js-api/interfaces/FunctionType.md | 51 + .../js-api/interfaces/IdentifierContext.md | 11 + .../js-api/interfaces/IdentifierNode.md | 22 + .../js-api/interfaces/ImportStatementNode.md | 22 + .../reference/js-api/interfaces/Interface.md | 54 + .../interfaces/InterfaceStatementNode.md | 27 + .../interfaces/IntersectionExpressionNode.md | 22 + .../js-api/interfaces/IntrinsicType.md | 47 + .../js-api/interfaces/InvalidStatementNode.md | 22 + .../JSONSchemaValidator.md} | 6 +- .../interfaces/JsNamespaceDeclarationNode.md | 22 + .../js-api/interfaces/JsSourceFileNode.md | 25 + .../js-api/interfaces/LibraryInstance.md | 13 + .../interfaces/LibraryLocationContext.md | 13 + .../LineAndCharacter.md} | 0 .../js-api/interfaces/LineComment.md | 16 + .../js-api/interfaces/LinterDefinition.md | 11 + .../reference/js-api/interfaces/LinterRule.md | 45 + .../js-api/interfaces/LinterRuleContext.md | 36 + .../js-api/interfaces/LinterRuleDefinition.md | 38 + .../js-api/interfaces/LinterRuleSet.md | 12 + .../ListOperationOptions.md} | 2 +- .../reference/js-api/interfaces/LogInfo.md | 13 + .../LogSink.md} | 8 +- .../Logger.md} | 26 +- .../js-api/interfaces/MemberExpressionNode.md | 24 + .../reference/js-api/interfaces/Model.md | 57 + .../js-api/interfaces/ModelExpressionNode.md | 22 + .../js-api/interfaces/ModelProperty.md | 53 + .../js-api/interfaces/ModelPropertyNode.md | 26 + .../interfaces/ModelSpreadPropertyNode.md | 22 + .../js-api/interfaces/ModelStatementNode.md | 28 + .../interfaces/ModuleLibraryMetadata.md | 21 + .../reference/js-api/interfaces/Namespace.md | 58 + .../NamespaceNavigationOptions.md} | 2 +- .../interfaces/NamespaceStatementNode.md | 25 + .../NavigationOptions.md} | 2 +- .../js-api/interfaces/NeverKeywordNode.md | 21 + .../reference/js-api/interfaces/NeverType.md | 47 + .../js-api/interfaces/NodePackage.md | 25 + .../reference/js-api/interfaces/NullType.md | 47 + .../js-api/interfaces/NumericLiteral.md | 48 + .../js-api/interfaces/NumericLiteralNode.md | 23 + .../reference/js-api/interfaces/ObjectType.md | 47 + .../reference/js-api/interfaces/Operation.md | 56 + .../OperationSignatureDeclarationNode.md | 23 + .../OperationSignatureReferenceNode.md | 22 + .../interfaces/OperationStatementNode.md | 26 + .../js-api/interfaces/ParseOptions.md | 11 + .../js-api/interfaces/ProcessedLog.md | 13 + .../reference/js-api/interfaces/Program.md | 200 ++ .../ProjectLocationContext.md} | 6 +- .../ProjectedNameView.md} | 12 +- .../js-api/interfaces/ProjectedProgram.md | 253 +++ .../reference/js-api/interfaces/Projection.md | 48 + .../interfaces/ProjectionApplication.md | 13 + .../ProjectionArithmeticExpressionNode.md | 24 + .../ProjectionBlockExpressionNode.md | 22 + .../ProjectionCallExpressionNode.md | 24 + ...jectionDecoratorReferenceExpressionNode.md | 22 + .../ProjectionEnumMemberSelectorNode.md | 21 + .../interfaces/ProjectionEnumSelectorNode.md | 21 + .../ProjectionEqualityExpressionNode.md | 24 + .../ProjectionExpressionStatementNode.md | 22 + .../interfaces/ProjectionIfExpressionNode.md | 24 + .../ProjectionInterfaceSelectorNode.md | 21 + .../ProjectionLambdaExpressionNode.md | 24 + ...rojectionLambdaParameterDeclarationNode.md | 22 + .../ProjectionLogicalExpressionNode.md | 24 + .../ProjectionMemberExpressionNode.md | 24 + .../ProjectionModelExpressionNode.md | 22 + .../interfaces/ProjectionModelPropertyNode.md | 26 + .../ProjectionModelPropertySelectorNode.md | 21 + .../interfaces/ProjectionModelSelectorNode.md | 21 + .../ProjectionModelSpreadPropertyNode.md | 22 + .../js-api/interfaces/ProjectionNode.md | 27 + .../ProjectionOperationSelectorNode.md | 21 + .../ProjectionParameterDeclarationNode.md | 22 + .../interfaces/ProjectionReferenceNode.md | 23 + .../ProjectionRelationalExpressionNode.md | 24 + .../interfaces/ProjectionStatementNode.md | 28 + .../ProjectionTupleExpressionNode.md | 22 + .../ProjectionUnaryExpressionNode.md | 23 + .../interfaces/ProjectionUnionSelectorNode.md | 21 + .../ProjectionUnionVariantSelectorNode.md | 21 + .../reference/js-api/interfaces/Projector.md | 28 + .../js-api/interfaces/RecordModelType.md | 59 + .../ResolveCompilerOptionsOptions.md | 19 + .../ResolveModuleHost.md} | 24 +- .../ResolveModuleOptions.md} | 4 +- .../js-api/interfaces/ResolvedFile.md | 11 + .../ResolvedModule.md} | 2 +- .../js-api/interfaces/ReturnExpressionNode.md | 22 + .../js-api/interfaces/ReturnRecord.md | 11 + .../RmOptions.md} | 2 +- .../reference/js-api/interfaces/Scalar.md | 54 + .../js-api/interfaces/ScalarStatementNode.md | 26 + .../reference/js-api/interfaces/Scanner.md | 91 + .../js-api/interfaces/SemanticToken.md | 12 + .../Server.md} | 172 +- .../ServerHost.md} | 26 +- .../js-api/interfaces/ServerSourceFile.md | 53 + .../ServerWorkspaceFolder.md} | 10 +- .../reference/js-api/interfaces/Service.md | 16 + .../js-api/interfaces/ServiceDetails.md | 15 + .../SourceFile.md} | 22 +- .../js-api/interfaces/SourceLocation.md | 17 + .../SourceLocationOptions.md} | 2 +- .../js-api/interfaces/StringLiteral.md | 47 + .../js-api/interfaces/StringLiteralNode.md | 22 + .../js-api/interfaces/SuppressDirective.md | 17 + .../reference/js-api/interfaces/Sym.md | 20 + .../js-api/interfaces/SymbolLinks.md | 12 + .../SyntheticLocationContext.md} | 6 +- .../interfaces/TemplateDeclarationNode.md | 20 + .../js-api/interfaces/TemplateParameter.md | 48 + .../TemplateParameterDeclarationNode.md | 24 + .../js-api/interfaces/TemplatedTypeBase.md | 20 + .../reference/js-api/interfaces/TextRange.md | 18 + .../Tracer.md} | 20 +- .../js-api/interfaces/TracerOptions.md | 10 + .../reference/js-api/interfaces/Tuple.md | 47 + .../js-api/interfaces/TupleExpressionNode.md | 22 + .../TypeInstantiationMap.md} | 18 +- .../reference/js-api/interfaces/TypeMapper.md | 25 + .../js-api/interfaces/TypeNameOptions.md | 11 + .../js-api/interfaces/TypeReferenceNode.md | 23 + .../TypeSpecCompletionItem.md} | 4 +- .../js-api/interfaces/TypeSpecLibrary.md | 105 + .../js-api/interfaces/TypeSpecLibraryDef.md | 28 + .../TypeSpecManifest.md} | 2 +- .../js-api/interfaces/TypeSpecScriptNode.md | 32 + .../reference/js-api/interfaces/Union.md | 55 + .../js-api/interfaces/UnionExpressionNode.md | 22 + .../js-api/interfaces/UnionStatementNode.md | 26 + .../js-api/interfaces/UnionVariant.md | 50 + .../js-api/interfaces/UnionVariantNode.md | 24 + .../js-api/interfaces/UnknownType.md | 47 + .../js-api/interfaces/UsageTracker.md | 25 + .../js-api/interfaces/UsingStatementNode.md | 22 + .../interfaces/ValueOfExpressionNode.md | 22 + .../reference/js-api/interfaces/ValueType.md | 11 + .../js-api/interfaces/VoidKeywordNode.md | 21 + .../reference/js-api/interfaces/VoidType.md | 47 + .../BytesKnownEncoding.md} | 2 +- .../CadlCompletionItem.md} | 2 +- .../CadlLibrary.md} | 6 +- .../CadlLibraryDef.md} | 6 +- .../CadlManifest.md} | 2 +- .../CadlScriptNode.md} | 2 +- .../CadlValue.md} | 2 +- .../Comment.md} | 2 +- .../js-api/type-aliases/CreateTypeProps.md | 8 + .../type-aliases/DateTimeKnownEncoding.md | 8 + .../js-api/type-aliases/Declaration.md | 22 + .../DecoratorArgumentValue.md} | 2 +- .../js-api/type-aliases/DiagnosticFormat.md | 16 + .../DiagnosticHandler.md} | 8 +- .../js-api/type-aliases/DiagnosticMap.md | 14 + .../js-api/type-aliases/DiagnosticReport.md | 22 + .../DiagnosticReportWithoutTarget.md | 23 + .../DiagnosticResult.md} | 2 +- .../DiagnosticSeverity.md} | 2 +- .../js-api/type-aliases/DiagnosticTarget.md | 8 + .../js-api/type-aliases/Directive.md | 8 + .../DirectiveArgument.md} | 2 +- .../DocContent.md} | 2 +- .../reference/js-api/type-aliases/DocTag.md | 13 + .../reference/js-api/type-aliases/DocToken.md | 20 + .../DurationKnownEncoding.md} | 2 +- .../EmitOptionsFor.md} | 2 +- .../js-api/type-aliases/EmitterFunc.md | 14 + .../js-api/type-aliases/Expression.md | 23 + .../InferredCadlValue.md} | 4 +- .../type-aliases/InferredTypeSpecValue.md | 14 + .../type-aliases/IntrinsicScalarName.md | 33 + .../JSONSchemaType.md} | 2 +- .../js-api/type-aliases/LibraryMetadata.md | 8 + .../LinterRuleDiagnosticFormat.md | 15 + .../LinterRuleDiagnosticReport.md | 21 + ...LinterRuleDiagnosticReportWithoutTarget.md | 21 + .../js-api/type-aliases/LiteralNode.md | 8 + .../js-api/type-aliases/LiteralType.md | 8 + .../LocationContext.md} | 2 +- .../LogLevel.md} | 2 +- .../js-api/type-aliases/MarshalledValue.md | 14 + .../type-aliases/MemberContainerNode.md | 15 + .../MemberContainerType.md} | 2 +- .../js-api/type-aliases/MemberNode.md | 8 + .../MemberType.md} | 2 +- .../js-api/type-aliases/ModelIndexer.md | 15 + .../Modifier.md} | 2 +- .../ModuleResolutionResult.md} | 2 +- .../js-api/type-aliases/NeverIndexer.md | 15 + .../NewLine.md} | 2 +- .../reference/js-api/type-aliases/Node.md | 45 + .../NodeCallback.md} | 8 +- .../OperationContainer.md} | 2 +- .../js-api/type-aliases/OperationSignature.md | 8 + .../type-aliases/ProjectionExpression.md | 29 + .../ProjectionStatementItem.md} | 2 +- .../type-aliases/ReferenceExpression.md | 13 + .../RuleRef.md} | 2 +- .../js-api/type-aliases/ScopeNode.md | 16 + .../type-aliases/SemanticNodeListener.md | 14 + .../SourceFileKind.md} | 2 +- .../js-api/type-aliases/Statement.md | 24 + .../StdTypeName.md} | 2 +- .../reference/js-api/type-aliases/StdTypes.md | 15 + .../js-api/type-aliases/TemplateableNode.md | 16 + .../TemplatedType.md} | 2 +- .../TrackableType.md} | 2 +- .../reference/js-api/type-aliases/Type.md | 29 + .../TypeKind.md} | 2 +- .../js-api/type-aliases/TypeListeners.md | 8 + .../js-api/type-aliases/TypeOfDiagnostics.md | 14 + .../TypeOrReturnRecord.md} | 2 +- .../TypeSpecDiagnosticTarget.md} | 2 +- .../TypeSpecValue.md} | 2 +- .../WriteLine.md} | 6 +- .../CadlPrettierPlugin.md} | 2 +- .../MANIFEST.md} | 2 +- .../NoTarget.md} | 2 +- .../NodeHost.md} | 2 +- .../TypeSpecPrettierPlugin.md} | 2 +- .../altDirectorySeparator.md} | 2 +- .../cadlVersion.md} | 2 +- .../directorySeparator.md} | 2 +- .../js-api/variables/namespace.md} | 2 +- .../typespecVersion.md} | 2 +- .../js-api/Interface.AutoRouteOptions.md | 10 - .../js-api/Interface.FilteredRouteParam.md | 11 - .../reference/js-api/Interface.ResourceKey.md | 11 - .../js-api/Interface.ResourceOperation.md | 11 - .../js-api/Type.ResourceOperations.md | 8 - .../reference/js-api/Variable.namespace.md | 8 - .../$action.md} | 10 +- .../$actionSegment.md} | 10 +- .../$actionSeparator.md} | 10 +- .../$autoRoute.md} | 4 - .../$collectionAction.md} | 12 +- .../$copyResourceKeyParameters.md} | 10 +- .../$createsOrReplacesResource.md} | 10 +- .../$createsOrUpdatesResource.md} | 10 +- .../$createsResource.md} | 10 +- .../$deletesResource.md} | 10 +- .../$listsResource.md} | 10 +- .../js-api/functions/$onValidate.md} | 4 - .../$parentResource.md} | 10 +- .../$readsResource.md} | 10 +- .../$resource.md} | 10 +- .../$resourceLocation.md} | 10 +- .../$resourceTypeForKeyParam.md} | 10 +- .../$segment.md} | 10 +- .../$segmentOf.md} | 10 +- .../$updatesResource.md} | 10 +- .../getAction.md} | 2 - .../getActionDetails.md} | 4 - .../getActionSegment.md} | 4 - .../getActionSeparator.md} | 2 - .../getCollectionAction.md} | 2 - .../getCollectionActionDetails.md} | 4 - .../getParentResource.md} | 4 - .../getResourceLocationType.md} | 4 - .../getResourceOperation.md} | 4 - .../getResourceTypeForKeyParam.md} | 4 - .../getResourceTypeKey.md} | 4 - .../getSegment.md} | 4 - .../isAutoRoute.md} | 4 - .../isListOperation.md} | 4 - .../setResourceOperation.md} | 14 +- .../setResourceTypeKey.md} | 10 +- .../rest/reference/js-api/index.md | 88 +- .../ActionDetails.md} | 0 .../js-api/interfaces/AutoRouteOptions.md | 10 + .../js-api/interfaces/FilteredRouteParam.md | 11 + .../js-api/interfaces/ResourceKey.md | 11 + .../js-api/interfaces/ResourceOperation.md | 11 + .../js-api/type-aliases/ResourceOperations.md | 15 + .../reference/js-api/variables/namespace.md} | 2 +- .../standard-library/rest/resource-routing.md | 2 +- .../js-api/Enumeration.Availability.md | 13 - .../js-api/Function.getAvailabilityMap.md | 19 - .../js-api/Function.getVersionDependencies.md | 19 - .../js-api/Function.indexTimeline.md | 23 - .../reference/js-api/Interface.Version.md | 14 - .../js-api/Interface.VersionResolution.md | 11 - .../reference/js-api/Variable.namespace.md | 8 - .../VersionMap.md} | 24 +- .../js-api/enumerations/Availability.md | 13 + .../$added.md} | 10 +- .../$madeOptional.md} | 10 +- .../js-api/functions/$onValidate.md} | 4 - .../$removed.md} | 10 +- .../$renamedFrom.md} | 12 +- .../$returnTypeChangedFrom.md} | 12 +- .../$typeChangedFrom.md} | 12 +- .../$useDependency.md} | 10 +- .../$versioned.md} | 10 +- .../buildVersionProjections.md} | 4 - .../existsAtVersion.md} | 10 +- .../findVersionedNamespace.md} | 4 - .../getAddedOnVersions.md} | 4 - .../js-api/functions/getAvailabilityMap.md | 15 + .../getAvailabilityMapInTimeline.md} | 10 +- .../getMadeOptionalOn.md} | 2 - .../getNameAtVersion.md} | 8 +- .../getRemovedOnVersions.md} | 4 - .../js-api/functions/getRenamedFrom.md | 19 + .../getRenamedFromVersions.md} | 2 - .../getReturnTypeBeforeVersion.md} | 8 +- .../getReturnTypeChangedFrom.md} | 4 +- .../getTypeBeforeVersion.md} | 8 +- .../getTypeChangedFrom.md} | 4 +- .../getUseDependencies.md} | 10 +- .../getVersion.md} | 4 - .../functions/getVersionDependencies.md | 15 + .../getVersionForEnumMember.md} | 4 - .../getVersions.md} | 4 - .../getVersionsForEnum.md} | 4 - .../hasDifferentNameAtVersion.md} | 10 +- .../hasDifferentReturnTypeAtVersion.md} | 10 +- .../hasDifferentTypeAtVersion.md} | 10 +- .../madeOptionalAfter.md} | 10 +- .../resolveVersions.md} | 4 - .../versioning/reference/js-api/index.md | 82 +- .../reference/js-api/interfaces/Version.md | 14 + .../js-api/interfaces/VersionResolution.md | 11 + .../reference/js-api/variables/namespace.md | 8 + .../version-latest-sidebars.json | 1 + 1383 files changed, 12890 insertions(+), 16089 deletions(-) delete mode 100644 common/changes/@typespec/compiler/2390-param-hyphen_2023-09-10-15-37.json delete mode 100644 common/changes/@typespec/compiler/always-never_2023-09-12-16-32.json delete mode 100644 common/changes/@typespec/compiler/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/compiler/compiler-UnixTimestampErrorMessage_2023-09-20-18-05.json delete mode 100644 common/changes/@typespec/compiler/constraint-allow-null_2023-09-12-15-51.json delete mode 100644 common/changes/@typespec/compiler/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/compiler/feature-op-returns-docs_2023-09-19-16-32.json delete mode 100644 common/changes/@typespec/compiler/fix-comment-tmlanguage_2023-09-25-20-36.json delete mode 100644 common/changes/@typespec/compiler/fix-directive-parens-crash_2023-09-12-17-22.json delete mode 100644 common/changes/@typespec/compiler/fix-float64-negative_2023-09-12-17-33.json delete mode 100644 common/changes/@typespec/compiler/fix-format-exit-code_2023-09-20-15-44.json delete mode 100644 common/changes/@typespec/compiler/fix-format-union_2023-09-19-19-07.json delete mode 100644 common/changes/@typespec/compiler/fix-formatting-doc-directive_2023-09-19-17-39.json delete mode 100644 common/changes/@typespec/compiler/fix-init-config_2023-09-28-18-02.json delete mode 100644 common/changes/@typespec/compiler/fix-issue-with-tsp-init_2023-10-10-20-42.json delete mode 100644 common/changes/@typespec/compiler/fix-lsp-not-reading-whole-config_2023-10-02-19-28.json delete mode 100644 common/changes/@typespec/compiler/fix-null-default_2023-09-11-22-42.json delete mode 100644 common/changes/@typespec/compiler/fix-playground-lsp_2023-10-03-15-56.json delete mode 100644 common/changes/@typespec/compiler/fix-using-typespec-implicit_2023-09-28-21-17.json delete mode 100644 common/changes/@typespec/compiler/no-double-deprecation_2023-09-25-12-54.json delete mode 100644 common/changes/@typespec/compiler/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/@typespec/compiler/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/compiler/website-perf-improvements_2023-09-28-20-21.json delete mode 100644 common/changes/@typespec/eslint-config-typespec/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/eslint-config-typespec/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/eslint-plugin/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/eslint-plugin/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/html-program-viewer/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/html-program-viewer/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/html-program-viewer/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/@typespec/html-program-viewer/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/http/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/http/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/http/feature-op-returns-docs_2023-09-19-16-32.json delete mode 100644 common/changes/@typespec/http/feature-status-code-ranges_2023-09-25-23-04.json delete mode 100644 common/changes/@typespec/http/openapi3-DuplicateRefs_2023-09-27-19-57.json delete mode 100644 common/changes/@typespec/http/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/@typespec/http/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/internal-build-utils/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/internal-build-utils/prepare-playground-release_2023-09-25-17-57.json delete mode 100644 common/changes/@typespec/internal-build-utils/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/@typespec/internal-build-utils/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/json-schema/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/json-schema/constraint-allow-null_2023-09-22-22-38.json delete mode 100644 common/changes/@typespec/json-schema/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/json-schema/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/@typespec/json-schema/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/json-schema/yaml-stringify-max-line-len_2023-09-19-18-13.json delete mode 100644 common/changes/@typespec/library-linter/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/library-linter/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/library-linter/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/@typespec/library-linter/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/lint/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/lint/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/lint/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/@typespec/lint/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/migrate/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/migrate/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/migrate/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/openapi/2391-rest-http-peer-dep_2023-09-19-00-29.json delete mode 100644 common/changes/@typespec/openapi/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/openapi/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/openapi/feature-status-code-ranges_2023-09-25-23-04.json delete mode 100644 common/changes/@typespec/openapi/openApi-FixNamespace_2023-09-19-19-48.json delete mode 100644 common/changes/@typespec/openapi/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/@typespec/openapi/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/openapi3/2391-rest-http-peer-dep_2023-09-19-00-29.json delete mode 100644 common/changes/@typespec/openapi3/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/openapi3/constraint-allow-null_2023-09-22-22-38.json delete mode 100644 common/changes/@typespec/openapi3/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/openapi3/feature-op-returns-docs_2023-09-19-16-32.json delete mode 100644 common/changes/@typespec/openapi3/feature-status-code-ranges_2023-09-25-23-04.json delete mode 100644 common/changes/@typespec/openapi3/fix-discriminated-union-mapping-wrongly-mutated_2023-09-15-00-39.json delete mode 100644 common/changes/@typespec/openapi3/fix-numeric-union-default-openapi3_2023-09-11-23-13.json delete mode 100644 common/changes/@typespec/openapi3/fix-openapi3-header-format_2023-09-20-17-20.json delete mode 100644 common/changes/@typespec/openapi3/fix-openapi3-null-default_2023-09-20-01-06.json delete mode 100644 common/changes/@typespec/openapi3/oneof-model-prop_2023-09-22-20-29.json delete mode 100644 common/changes/@typespec/openapi3/openApi-FixNamespace_2023-09-19-17-16.json delete mode 100644 common/changes/@typespec/openapi3/openapi3-DuplicateRefs_2023-09-27-19-57.json delete mode 100644 common/changes/@typespec/openapi3/openapi3-FixCsvFormat_2023-09-19-21-04.json delete mode 100644 common/changes/@typespec/openapi3/openapi3-statusCodeShared_2023-10-10-20-29.json delete mode 100644 common/changes/@typespec/openapi3/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/@typespec/openapi3/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/openapi3/yaml-stringify-max-line-len_2023-09-19-18-13.json delete mode 100644 common/changes/@typespec/prettier-plugin-typespec/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/prettier-plugin-typespec/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/prettier-plugin-typespec/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/protobuf/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/protobuf/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/protobuf/fix-format-union_2023-09-20-20-26.json delete mode 100644 common/changes/@typespec/protobuf/protobuf-emit-doc-comments_2023-08-10-18-18.json delete mode 100644 common/changes/@typespec/protobuf/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/rest/2391-rest-http-peer-dep_2023-09-19-00-29.json delete mode 100644 common/changes/@typespec/rest/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/rest/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/rest/fixResourceLogic_2023-09-29-18-58.json delete mode 100644 common/changes/@typespec/rest/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/@typespec/rest/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/versioning/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/@typespec/versioning/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/@typespec/versioning/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/@typespec/versioning/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/@typespec/versioning/versioning-RenamedFromBug_2023-09-27-22-20.json delete mode 100644 common/changes/tmlanguage-generator/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/tmlanguage-generator/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/tmlanguage-generator/upgrade-deps-sep-2023_2023-09-20-20-41.json delete mode 100644 common/changes/typespec-vs/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/typespec-vs/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/typespec-vscode/backmerge-2023-09-19_2023-09-19-21-02.json delete mode 100644 common/changes/typespec-vscode/fake-changelog_2023-10-10-22-08.json delete mode 100644 common/changes/typespec-vscode/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json delete mode 100644 common/changes/typespec-vscode/upgrade-deps-sep-2023_2023-09-20-20-41.json rename packages/website/versioned_docs/version-latest/{standard-library/json-schema => emitters/service-generator-csharp}/reference/js-api/Function.$onEmit.md (62%) create mode 100644 packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.getTracer.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.reportDiagnostic.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Interface.CSharpServiceEmitterOptions.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Variable.$lib.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/_category_.json create mode 100644 packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/index.md create mode 100644 packages/website/versioned_docs/version-latest/getting-started/getting-started-http.md create mode 100644 packages/website/versioned_docs/version-latest/release-notes/release-2023-10-11.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Enumeration.Visibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.DefaultRouteProducer.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpService.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationParameters.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodeDescription.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.listHttpOperationsIn.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolvePathAndParameters.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ApiKeyAuth.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthenticationOption.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthorizationCodeFlow.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ClientCredentialsFlow.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HeaderFieldOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpAuthBase.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperation.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationParameters.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationRequestBody.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponse.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponseContent.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpServer.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpService.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ImplicitFlow.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfoOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OAuth2Scope.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OperationParameterOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PasswordFlow.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PathParameterOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.QueryParameterOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RoutePath.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteProducerResult.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteResolutionOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ServiceAuthentication.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpAuth.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpOperationParameter.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpVerb.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2Flow.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.RouteProducer.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.StatusCode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.$lib.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/enumerations/Visibility.md rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$body.md => functions/$body.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$delete.md => functions/$delete.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$get.md => functions/$get.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$head.md => functions/$head.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$header.md => functions/$header.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$includeInapplicableMetadataInPayload.md => functions/$includeInapplicableMetadataInPayload.md} (95%) rename packages/website/versioned_docs/version-latest/standard-library/{versioning/reference/js-api/Function.$onValidate.md => http/reference/js-api/functions/$onValidate.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$patch.md => functions/$patch.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$path.md => functions/$path.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$plainData.md => functions/$plainData.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$post.md => functions/$post.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$put.md => functions/$put.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$query.md => functions/$query.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$route.md => functions/$route.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$server.md => functions/$server.md} (87%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$sharedRoute.md => functions/$sharedRoute.md} (96%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$statusCode.md => functions/$statusCode.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.$useAuth.md => functions/$useAuth.md} (77%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/DefaultRouteProducer.md rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.createMetadataInfo.md => functions/createMetadataInfo.md} (60%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.gatherMetadata.md => functions/gatherMetadata.md} (54%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getAllHttpServices.md => functions/getAllHttpServices.md} (60%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getAllRoutes.md => functions/getAllRoutes.md} (63%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getAuthentication.md => functions/getAuthentication.md} (73%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getContentTypes.md => functions/getContentTypes.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getHeaderFieldName.md => functions/getHeaderFieldName.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getHeaderFieldOptions.md => functions/getHeaderFieldOptions.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getHttpOperation.md => functions/getHttpOperation.md} (50%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpService.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationParameters.md rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getOperationVerb.md => functions/getOperationVerb.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getPathParamName.md => functions/getPathParamName.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getPathParamOptions.md => functions/getPathParamOptions.md} (75%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getQueryParamName.md => functions/getQueryParamName.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getQueryParamOptions.md => functions/getQueryParamOptions.md} (75%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getRequestVisibility.md => functions/getRequestVisibility.md} (83%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getResponsesForOperation.md => functions/getResponsesForOperation.md} (75%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getRouteOptionsForNamespace.md => functions/getRouteOptionsForNamespace.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getRoutePath.md => functions/getRoutePath.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getRouteProducer.md => functions/getRouteProducer.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getServers.md => functions/getServers.md} (75%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodeDescription.md rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getStatusCodes.md => functions/getStatusCodes.md} (62%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.getVisibilitySuffix.md => functions/getVisibilitySuffix.md} (72%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.includeInapplicableMetadataInPayload.md => functions/includeInapplicableMetadataInPayload.md} (97%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.includeInterfaceRoutesInNamespace.md => functions/includeInterfaceRoutesInNamespace.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.isApplicableMetadata.md => functions/isApplicableMetadata.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.isApplicableMetadataOrBody.md => functions/isApplicableMetadataOrBody.md} (71%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.isBody.md => functions/isBody.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.isContentTypeHeader.md => functions/isContentTypeHeader.md} (97%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.isHeader.md => functions/isHeader.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.isMetadata.md => functions/isMetadata.md} (93%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.isOverloadSameEndpoint.md => functions/isOverloadSameEndpoint.md} (52%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.isPathParam.md => functions/isPathParam.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.isQueryParam.md => functions/isQueryParam.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.isSharedRoute.md => functions/isSharedRoute.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.isStatusCode.md => functions/isStatusCode.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.isVisible.md => functions/isVisible.md} (66%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/listHttpOperationsIn.md rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.reportIfNoRoutes.md => functions/reportIfNoRoutes.md} (69%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolvePathAndParameters.md rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.resolveRequestVisibility.md => functions/resolveRequestVisibility.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.setAuthentication.md => functions/setAuthentication.md} (59%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.setRoute.md => functions/setRoute.md} (61%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.setRouteOptionsForNamespace.md => functions/setRouteOptionsForNamespace.md} (64%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.setRouteProducer.md => functions/setRouteProducer.md} (59%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.setSharedRoute.md => functions/setSharedRoute.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.setStatusCode.md => functions/setStatusCode.md} (72%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Function.validateRouteUnique.md => functions/validateRouteUnique.md} (61%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ApiKeyAuth.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/AuthenticationOption.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/AuthorizationCodeFlow.md rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Interface.BasicAuth.md => interfaces/BasicAuth.md} (52%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Interface.BearerAuth.md => interfaces/BearerAuth.md} (59%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ClientCredentialsFlow.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HeaderFieldOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpAuthBase.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperation.md rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Interface.HttpOperationBody.md => interfaces/HttpOperationBody.md} (78%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationParameters.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationRequestBody.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponse.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponseContent.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpServer.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpService.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpStatusCodeRange.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ImplicitFlow.md rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Interface.MetadataInfo.md => interfaces/MetadataInfo.md} (75%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfoOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OAuth2Scope.md rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Interface.Oauth2Auth.md => interfaces/Oauth2Auth.md} (58%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OperationParameterOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/PasswordFlow.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/PathParameterOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/QueryParameterOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RoutePath.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteProducerResult.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteResolutionOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ServiceAuthentication.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpAuth.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpOperationParameter.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpStatusCodes.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpStatusCodesEntry.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpVerb.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OAuth2Flow.md rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Type.OAuth2FlowType.md => type-aliases/OAuth2FlowType.md} (59%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Type.OperationContainer.md => type-aliases/OperationContainer.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Type.OperationDetails.md => type-aliases/OperationDetails.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/{Type.OperationVerbSelector.md => type-aliases/OperationVerbSelector.md} (58%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/RouteProducer.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/StatusCode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/variables/$lib.md rename packages/website/versioned_docs/version-latest/standard-library/{openapi/reference/js-api/Variable.namespace.md => http/reference/js-api/variables/namespace.md} (50%) delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.ExtensionRecord.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.$lib.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.EmitterOptionsSchema.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.namespace.md rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Class.JsonSchemaEmitter.md => classes/JsonSchemaEmitter.md} (66%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$baseUri.md => functions/$baseUri.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$contains.md => functions/$contains.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$contentEncoding.md => functions/$contentEncoding.md} (81%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$contentMediaType.md => functions/$contentMediaType.md} (81%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$contentSchema.md => functions/$contentSchema.md} (81%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$extension.md => functions/$extension.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$id.md => functions/$id.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$jsonSchema.md => functions/$jsonSchema.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$maxContains.md => functions/$maxContains.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$maxProperties.md => functions/$maxProperties.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$minContains.md => functions/$minContains.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$minProperties.md => functions/$minProperties.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$multipleOf.md => functions/$multipleOf.md} (78%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$onEmit.md rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$prefixItems.md => functions/$prefixItems.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$uniqueItems.md => functions/$uniqueItems.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.$validatesRawJson.md => functions/$validatesRawJson.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.findBaseUri.md => functions/findBaseUri.md} (60%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getBaseUri.md => functions/getBaseUri.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getContains.md => functions/getContains.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getContentEncoding.md => functions/getContentEncoding.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getContentMediaType.md => functions/getContentMediaType.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getContentSchema.md => functions/getContentSchema.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getExtensions.md => functions/getExtensions.md} (76%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getId.md => functions/getId.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getJsonSchema.md => functions/getJsonSchema.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getJsonSchemaTypes.md => functions/getJsonSchemaTypes.md} (83%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getMaxContains.md => functions/getMaxContains.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getMaxProperties.md => functions/getMaxProperties.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getMinContains.md => functions/getMinContains.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getMinProperties.md => functions/getMinProperties.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getMultipleOf.md => functions/getMultipleOf.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getPrefixItems.md => functions/getPrefixItems.md} (85%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.getUniqueItems.md => functions/getUniqueItems.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Function.isJsonSchemaDeclaration.md => functions/isJsonSchemaDeclaration.md} (68%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/interfaces/ExtensionRecord.md rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Interface.JSONSchemaEmitterOptions.md => interfaces/JSONSchemaEmitterOptions.md} (72%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Namespace.$validatesRawJson.md => namespaces/$validatesRawJson/index.md} (54%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Namespace.$validatesRawJson.Variable.namespace.md => namespaces/$validatesRawJson/variables/namespace.md} (71%) rename packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/{Type.JsonSchemaDeclaration.md => type-aliases/JsonSchemaDeclaration.md} (52%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/variables/$lib.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/variables/EmitterOptionsSchema.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/variables/namespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExtensions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.AdditionalInfo.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.ExternalDocs.md rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.$defaultResponse.md => functions/$defaultResponse.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.$extension.md => functions/$extension.md} (76%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.$externalDocs.md => functions/$externalDocs.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.$info.md => functions/$info.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.$operationId.md => functions/$operationId.md} (85%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.checkDuplicateTypeName.md => functions/checkDuplicateTypeName.md} (62%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExtensions.md rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.getExternalDocs.md => functions/getExternalDocs.md} (75%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.getInfo.md => functions/getInfo.md} (74%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.getOpenAPITypeName.md => functions/getOpenAPITypeName.md} (82%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.getOperationId.md => functions/getOperationId.md} (92%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.getParameterKey.md => functions/getParameterKey.md} (67%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.isDefaultResponse.md => functions/isDefaultResponse.md} (97%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.isReadonlyProperty.md => functions/isReadonlyProperty.md} (95%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.resolveOperationId.md => functions/resolveOperationId.md} (98%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.setExtension.md => functions/setExtension.md} (64%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Function.shouldInline.md => functions/shouldInline.md} (96%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/AdditionalInfo.md rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Interface.Contact.md => interfaces/Contact.md} (55%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/ExternalDocs.md rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Interface.License.md => interfaces/License.md} (76%) rename packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/{Type.ExtensionKey.md => type-aliases/ExtensionKey.md} (62%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/variables/namespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$onEmit.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Interface.ResolvedOpenAPI3EmitterOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.$lib.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$onEmit.md rename packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/{Function.$oneOf.md => functions/$oneOf.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/{Function.$useRef.md => functions/$useRef.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/{Function.getOneOf.md => functions/getOneOf.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/{Function.getRef.md => functions/getRef.md} (84%) rename packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/{Function.resolveOptions.md => functions/resolveOptions.md} (53%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/interfaces/ResolvedOpenAPI3EmitterOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/variables/$lib.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/variables/namespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$_map.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Interface.PackageDetails.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Type.Reservation.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.$lib.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.namespace.md rename packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/{Function.$externRef.md => functions/$externRef.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/{Function.$field.md => functions/$field.md} (88%) rename packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/{Function.$message.md => functions/$message.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/{Function.$onEmit.md => functions/$onEmit.md} (53%) rename packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/{Function.$onValidate.md => functions/$onValidate.md} (69%) rename packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/{Function.$package.md => functions/$package.md} (84%) rename packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/{Function.$reserve.md => functions/$reserve.md} (57%) rename packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/{Function.$service.md => functions/$service.md} (94%) rename packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/{Function.$stream.md => functions/$stream.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/{Function.isMap.md => functions/isMap.md} (97%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/interfaces/PackageDetails.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/type-aliases/Reservation.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/variables/$lib.md rename packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/{Variable.PROTO_FULL_IDENT.md => variables/PROTO_FULL_IDENT.md} (89%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/variables/namespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.IdentifierKind.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.KeywordLimit.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.NodeFlags.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.SemanticTokenKind.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.SymbolFlags.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.SyntaxKind.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.Token.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.TokenFlags.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.assertType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compile.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createCadlLibrary.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDecoratorDefinition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRule.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createScanner.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createStateAccessors.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.emitFile.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ensurePathIsNonModuleName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getCompletionNodeAtPosition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDiscriminatedUnion.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceLocation.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getTypeName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isIntrinsicType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.listOperationsIn.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.markDeprecated.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateProgram.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateTypesInNamespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.paramMessage.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.parse.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.projectProgram.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.reportDeprecated.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveCompilerOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveModule.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.scopeNavigationToNamespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorNotOnType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTarget.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTargetIntrinsic.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorUniqueOnNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AliasStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AnyKeywordNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ArrayExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ArrayModelType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AugmentDecoratorStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BlockComment.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteral.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteralNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Checker.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerLocationContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratedType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Decorator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorApplication.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorArgument.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDeclarationStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDefinition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorParamDefinition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorValidator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeprecatedDirective.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Diagnostic.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCreator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticDefinition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticMessages.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveBase.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Dirent.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiscriminatedUnion.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocParamTagNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocReturnsTagNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTagBaseNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTemplateTagNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTextNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocUnknownTagNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmitFileOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmptyStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Enum.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMember.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMemberNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumSpreadMemberNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ErrorType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ExternKeywordNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FileLibraryMetadata.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionDeclarationStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameter.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameterNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ImportStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Interface.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InterfaceStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntersectionExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntrinsicType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InvalidStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsNamespaceDeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsSourceFileNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryInstance.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryLocationContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LineComment.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterDefinition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRule.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleDefinition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleSet.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LogInfo.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.MemberExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Model.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelProperty.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelPropertyNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelSpreadPropertyNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModuleLibraryMetadata.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Namespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NamespaceStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverKeywordNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NodePackage.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NullType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteral.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteralNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ObjectType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Operation.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureDeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureReferenceNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ParseOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProcessedLog.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Program.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedProgram.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projection.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionApplication.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionArithmeticExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionBlockExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionCallExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionDecoratorReferenceExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumMemberSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEqualityExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionExpressionStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionIfExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionInterfaceSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLambdaExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLambdaParameterDeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLogicalExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionMemberExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertyNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertySelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelSpreadPropertyNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionOperationSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionParameterDeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionReferenceNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionRelationalExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionTupleExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnaryExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionVariantSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projector.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RecordModelType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveCompilerOptionsOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedFile.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnRecord.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scalar.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ScalarStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scanner.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SemanticToken.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerSourceFile.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceLocation.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteral.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteralNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SuppressDirective.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Sym.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SymbolLinks.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateDeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameter.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameterDeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplatedTypeBase.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TextRange.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TracerOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tuple.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TupleExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeMapper.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeNameOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeReferenceNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibrary.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibraryDef.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecScriptNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Union.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariant.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariantNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnknownType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsageTracker.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsingStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueOfExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidKeywordNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$discriminator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$docFromComment.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$encode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$friendlyName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$indexer.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$list.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxItems.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxLength.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValue.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValueExclusive.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minItems.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minLength.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValue.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValueExclusive.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$overload.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$parameterVisibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$pattern.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$returnTypeVisibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$secret.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$service.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$tag.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$visibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withVisibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withoutOmittedProperties.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.addService.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getAllTags.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminatedTypes.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getEncode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getKnownValues.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getProjectedNames.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isNumericType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isStringType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isVisible.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Discriminator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.DocData.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.EncodeData.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Service.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.ServiceDetails.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DateTimeKnownEncoding.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Variable.namespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CreateTypeProps.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Declaration.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticFormat.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticMap.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReport.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReportWithoutTarget.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticTarget.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Directive.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocTag.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocToken.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitterFunc.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Expression.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredTypeSpecValue.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.IntrinsicScalarName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LibraryMetadata.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticFormat.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReport.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReportWithoutTarget.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MarshalledValue.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModelIndexer.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NeverIndexer.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Node.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationSignature.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionExpression.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ReferenceExpression.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ScopeNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SemanticNodeListener.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Statement.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypes.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplateableNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Type.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeListeners.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOfDiagnostics.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.Keywords.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TokenDisplay.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Class.DuplicateTracker.md => classes/DuplicateTracker.md} (55%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Class.EventEmitter.md => classes/EventEmitter.md} (51%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Class.InvalidEncodingError.md => classes/InvalidEncodingError.md} (54%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Class.ProjectionError.md => classes/ProjectionError.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Class.Queue.md => classes/Queue.md} (54%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Class.ResolveModuleError.md => classes/ResolveModuleError.md} (53%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Enumeration.ListenerFlow.md => enumerations/ListenerFlow.md} (63%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Enumeration.ModifierFlags.md => enumerations/ModifierFlags.md} (73%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SemanticTokenKind.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SymbolFlags.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/TokenFlags.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Enumeration.UsageFlags.md => enumerations/UsageFlags.md} (64%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$deprecated.md => functions/$deprecated.md} (61%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$doc.md => functions/$doc.md} (69%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$error.md => functions/$error.md} (63%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$format.md => functions/$format.md} (76%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$indexer.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$inspectType.md => functions/$inspectType.md} (51%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$inspectTypeName.md => functions/$inspectTypeName.md} (52%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$key.md => functions/$key.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$knownValues.md => functions/$knownValues.md} (53%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$projectedName.md => functions/$projectedName.md} (64%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$summary.md => functions/$summary.md} (73%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$withDefaultKeyVisibility.md => functions/$withDefaultKeyVisibility.md} (51%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$withOptionalProperties.md => functions/$withOptionalProperties.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$withUpdateableProperties.md => functions/$withUpdateableProperties.md} (58%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.$withoutDefaultValues.md => functions/$withoutDefaultValues.md} (56%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.cadlTypeToJson.md => functions/cadlTypeToJson.md} (60%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.checkFormatCadl.md => functions/checkFormatCadl.md} (72%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.checkFormatTypeSpec.md => functions/checkFormatTypeSpec.md} (75%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.compilerAssert.md => functions/compilerAssert.md} (56%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.createChecker.md => functions/createChecker.md} (60%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.createDiagnosticCollector.md => functions/createDiagnosticCollector.md} (76%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.createDiagnosticCreator.md => functions/createDiagnosticCreator.md} (67%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.createProjectedNameProgram.md => functions/createProjectedNameProgram.md} (76%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.createRekeyableMap.md => functions/createRekeyableMap.md} (68%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.createServer.md => functions/createServer.md} (59%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.createSourceFile.md => functions/createSourceFile.md} (79%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.createTypeSpecLibrary.md => functions/createTypeSpecLibrary.md} (64%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.ensureTrailingDirectorySeparator.md => functions/ensureTrailingDirectorySeparator.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.filterModelProperties.md => functions/filterModelProperties.md} (64%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.finishTypeForProgram.md => functions/finishTypeForProgram.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.formatDiagnostic.md => functions/formatDiagnostic.md} (65%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.formatIdentifier.md => functions/formatIdentifier.md} (88%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.formatTypeSpec.md => functions/formatTypeSpec.md} (65%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getAnyExtensionFromPath.md => functions/getAnyExtensionFromPath.md} (95%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getBaseFileName.md => functions/getBaseFileName.md} (98%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getDeprecated.md => functions/getDeprecated.md} (64%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getDeprecationDetails.md => functions/getDeprecationDetails.md} (53%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getDirectoryPath.md => functions/getDirectoryPath.md} (88%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getDoc.md => functions/getDoc.md} (66%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getDocData.md => functions/getDocData.md} (53%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getEffectiveModelType.md => functions/getEffectiveModelType.md} (81%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getFirstAncestor.md => functions/getFirstAncestor.md} (52%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getFormat.md => functions/getFormat.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getFriendlyName.md => functions/getFriendlyName.md} (59%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getFullyQualifiedSymbolName.md => functions/getFullyQualifiedSymbolName.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getIdentifierContext.md => functions/getIdentifierContext.md} (57%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getIndexer.md => functions/getIndexer.md} (52%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getKeyName.md => functions/getKeyName.md} (52%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getListOperationType.md => functions/getListOperationType.md} (67%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getLocationContext.md => functions/getLocationContext.md} (50%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getMaxItems.md => functions/getMaxItems.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getMaxLength.md => functions/getMaxLength.md} (57%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getMaxValue.md => functions/getMaxValue.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getMaxValueExclusive.md => functions/getMaxValueExclusive.md} (59%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getMinItems.md => functions/getMinItems.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getMinLength.md => functions/getMinLength.md} (57%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getMinValue.md => functions/getMinValue.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getMinValueExclusive.md => functions/getMinValueExclusive.md} (59%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getNamespaceFullName.md => functions/getNamespaceFullName.md} (63%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getNodeAtPosition.md => functions/getNodeAtPosition.md} (52%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getNormalizedAbsolutePath.md => functions/getNormalizedAbsolutePath.md} (92%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getNormalizedAbsolutePathWithoutRoot.md => functions/getNormalizedAbsolutePathWithoutRoot.md} (92%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getNormalizedPathComponents.md => functions/getNormalizedPathComponents.md} (96%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getOverloadedOperation.md => functions/getOverloadedOperation.md} (61%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getOverloads.md => functions/getOverloads.md} (64%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getOverriddenProperty.md => functions/getOverriddenProperty.md} (67%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getParameterVisibility.md => functions/getParameterVisibility.md} (60%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getParentTemplateNode.md => functions/getParentTemplateNode.md} (66%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getPathComponents.md => functions/getPathComponents.md} (95%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getPathFromPathComponents.md => functions/getPathFromPathComponents.md} (85%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getPattern.md => functions/getPattern.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getProjectedName.md => functions/getProjectedName.md} (62%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getProperty.md => functions/getProperty.md} (63%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getPropertyType.md => functions/getPropertyType.md} (60%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getRelativePathFromDirectory.md => functions/getRelativePathFromDirectory.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getReturnTypeVisibility.md => functions/getReturnTypeVisibility.md} (60%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getRootLength.md => functions/getRootLength.md} (98%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getService.md => functions/getService.md} (61%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.getSourceFileKindFromExt.md => functions/getSourceFileKindFromExt.md} (74%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getSummary.md => functions/getSummary.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getTags.md => functions/getTags.md} (56%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.getVisibility.md => functions/getVisibility.md} (57%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.hasParseError.md => functions/hasParseError.md} (69%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.hasProjectedName.md => functions/hasProjectedName.md} (64%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.hasTrailingDirectorySeparator.md => functions/hasTrailingDirectorySeparator.md} (92%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.ignoreDiagnostics.md => functions/ignoreDiagnostics.md} (81%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.interpolatePath.md => functions/interpolatePath.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isAnyDirectorySeparator.md => functions/isAnyDirectorySeparator.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.isArrayModelType.md => functions/isArrayModelType.md} (52%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isCadlValueTypeOf.md => functions/isCadlValueTypeOf.md} (61%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isComment.md => functions/isComment.md} (66%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isDeclaredInNamespace.md => functions/isDeclaredInNamespace.md} (50%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isDeclaredType.md => functions/isDeclaredType.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isDeprecated.md => functions/isDeprecated.md} (63%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.isErrorModel.md => functions/isErrorModel.md} (58%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isErrorType.md => functions/isErrorType.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isGlobalNamespace.md => functions/isGlobalNamespace.md} (63%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isImportStatement.md => functions/isImportStatement.md} (68%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.isKey.md => functions/isKey.md} (51%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isKeyword.md => functions/isKeyword.md} (66%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.isListOperation.md => functions/isListOperation.md} (67%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isModifier.md => functions/isModifier.md} (67%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isNeverType.md => functions/isNeverType.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isNullType.md => functions/isNullType.md} (68%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isPathAbsolute.md => functions/isPathAbsolute.md} (88%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isProjectedProgram.md => functions/isProjectedProgram.md} (54%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isPunctuation.md => functions/isPunctuation.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.isRecordModelType.md => functions/isRecordModelType.md} (61%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.isSecret.md => functions/isSecret.md} (55%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.isService.md => functions/isService.md} (63%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isStatementKeyword.md => functions/isStatementKeyword.md} (69%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isStdNamespace.md => functions/isStdNamespace.md} (65%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isTemplateDeclaration.md => functions/isTemplateDeclaration.md} (75%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isTemplateDeclarationOrInstance.md => functions/isTemplateDeclarationOrInstance.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isTemplateInstance.md => functions/isTemplateInstance.md} (76%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isTrivia.md => functions/isTrivia.md} (66%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isTypeSpecValueTypeOf.md => functions/isTypeSpecValueTypeOf.md} (61%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isUnknownType.md => functions/isUnknownType.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isUrl.md => functions/isUrl.md} (91%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.isVoidType.md => functions/isVoidType.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.joinPaths.md => functions/joinPaths.md} (97%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Function.listServices.md => functions/listServices.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.logDiagnostics.md => functions/logDiagnostics.md} (52%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.logVerboseTestOutput.md => functions/logVerboseTestOutput.md} (96%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.mapEventEmitterToNodeListener.md => functions/mapEventEmitterToNodeListener.md} (62%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.normalizePath.md => functions/normalizePath.md} (88%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.normalizeSlashes.md => functions/normalizeSlashes.md} (91%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.parseStandaloneTypeReference.md => functions/parseStandaloneTypeReference.md} (52%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.reducePathComponents.md => functions/reducePathComponents.md} (81%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.removeTrailingDirectorySeparator.md => functions/removeTrailingDirectorySeparator.md} (95%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.resolvePath.md => functions/resolvePath.md} (96%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.resolveUsages.md => functions/resolveUsages.md} (62%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.setCadlNamespace.md => functions/setCadlNamespace.md} (97%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.setTypeSpecNamespace.md => functions/setTypeSpecNamespace.md} (94%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.skipTrivia.md => functions/skipTrivia.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.skipWhiteSpace.md => functions/skipWhiteSpace.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.typespecTypeToJson.md => functions/typespecTypeToJson.md} (57%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.validateDecoratorParamCount.md => functions/validateDecoratorParamCount.md} (64%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.visitChildren.md => functions/visitChildren.md} (62%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Function.walkPropertiesInherited.md => functions/walkPropertiesInherited.md} (62%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.CallableMessage.md => interfaces/CallableMessage.md} (56%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.CompilerHost.md => interfaces/CompilerHost.md} (56%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratedType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.DecoratorContext.md => interfaces/DecoratorContext.md} (73%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.DecoratorFunction.md => interfaces/DecoratorFunction.md} (50%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecatedDirective.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.DeprecationDetails.md => interfaces/DeprecationDetails.md} (100%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.DiagnosticCollector.md => interfaces/DiagnosticCollector.md} (67%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticMessages.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveBase.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiscriminatedUnion.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Discriminator.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocData.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.EmitContext.md => interfaces/EmitContext.md} (73%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EncodeData.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameter.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierContext.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.JSONSchemaValidator.md => interfaces/JSONSchemaValidator.md} (63%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.LineAndCharacter.md => interfaces/LineAndCharacter.md} (100%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.ListOperationOptions.md => interfaces/ListOperationOptions.md} (77%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.LogSink.md => interfaces/LogSink.md} (62%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.Logger.md => interfaces/Logger.md} (74%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModuleLibraryMetadata.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.NamespaceNavigationOptions.md => interfaces/NamespaceNavigationOptions.md} (75%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.NavigationOptions.md => interfaces/NavigationOptions.md} (70%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.ProjectLocationContext.md => interfaces/ProjectLocationContext.md} (51%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.ProjectedNameView.md => interfaces/ProjectedNameView.md} (68%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.ResolveModuleHost.md => interfaces/ResolveModuleHost.md} (61%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.ResolveModuleOptions.md => interfaces/ResolveModuleOptions.md} (56%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedFile.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.ResolvedModule.md => interfaces/ResolvedModule.md} (77%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.RmOptions.md => interfaces/RmOptions.md} (82%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SemanticToken.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.Server.md => interfaces/Server.md} (50%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.ServerHost.md => interfaces/ServerHost.md} (62%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.ServerWorkspaceFolder.md => interfaces/ServerWorkspaceFolder.md} (50%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.SourceFile.md => interfaces/SourceFile.md} (51%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.SourceLocationOptions.md => interfaces/SourceLocationOptions.md} (82%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SuppressDirective.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.SyntheticLocationContext.md => interfaces/SyntheticLocationContext.md} (55%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.Tracer.md => interfaces/Tracer.md} (64%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.TypeInstantiationMap.md => interfaces/TypeInstantiationMap.md} (57%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.TypeSpecCompletionItem.md => interfaces/TypeSpecCompletionItem.md} (59%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Interface.TypeSpecManifest.md => interfaces/TypeSpecManifest.md} (80%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Type.BytesKnownEncoding.md => type-aliases/BytesKnownEncoding.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.CadlCompletionItem.md => type-aliases/CadlCompletionItem.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.CadlLibrary.md => type-aliases/CadlLibrary.md} (51%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.CadlLibraryDef.md => type-aliases/CadlLibraryDef.md} (51%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.CadlManifest.md => type-aliases/CadlManifest.md} (71%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.CadlScriptNode.md => type-aliases/CadlScriptNode.md} (70%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.CadlValue.md => type-aliases/CadlValue.md} (73%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.Comment.md => type-aliases/Comment.md} (55%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CreateTypeProps.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DateTimeKnownEncoding.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Declaration.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.DecoratorArgumentValue.md => type-aliases/DecoratorArgumentValue.md} (57%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.DiagnosticHandler.md => type-aliases/DiagnosticHandler.md} (50%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticMap.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReport.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.DiagnosticResult.md => type-aliases/DiagnosticResult.md} (84%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.DiagnosticSeverity.md => type-aliases/DiagnosticSeverity.md} (57%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticTarget.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Directive.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.DirectiveArgument.md => type-aliases/DirectiveArgument.md} (50%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.DocContent.md => type-aliases/DocContent.md} (64%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DocTag.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DocToken.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Namespace.decorators.Type.DurationKnownEncoding.md => type-aliases/DurationKnownEncoding.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.EmitOptionsFor.md => type-aliases/EmitOptionsFor.md} (66%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitterFunc.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Expression.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.InferredCadlValue.md => type-aliases/InferredCadlValue.md} (60%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredTypeSpecValue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/IntrinsicScalarName.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.JSONSchemaType.md => type-aliases/JSONSchemaType.md} (71%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LibraryMetadata.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReport.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReportWithoutTarget.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LiteralNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LiteralType.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.LocationContext.md => type-aliases/LocationContext.md} (62%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.LogLevel.md => type-aliases/LogLevel.md} (53%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MarshalledValue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerNode.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.MemberContainerType.md => type-aliases/MemberContainerType.md} (51%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberNode.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.MemberType.md => type-aliases/MemberType.md} (60%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModelIndexer.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.Modifier.md => type-aliases/Modifier.md} (60%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.ModuleResolutionResult.md => type-aliases/ModuleResolutionResult.md} (52%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NeverIndexer.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.NewLine.md => type-aliases/NewLine.md} (64%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Node.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.NodeCallback.md => type-aliases/NodeCallback.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.OperationContainer.md => type-aliases/OperationContainer.md} (51%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/OperationSignature.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ProjectionExpression.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.ProjectionStatementItem.md => type-aliases/ProjectionStatementItem.md} (51%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ReferenceExpression.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.RuleRef.md => type-aliases/RuleRef.md} (77%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ScopeNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.SourceFileKind.md => type-aliases/SourceFileKind.md} (74%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Statement.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.StdTypeName.md => type-aliases/StdTypeName.md} (62%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypes.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TemplateableNode.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.TemplatedType.md => type-aliases/TemplatedType.md} (66%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.TrackableType.md => type-aliases/TrackableType.md} (53%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Type.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.TypeKind.md => type-aliases/TypeKind.md} (58%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeListeners.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOfDiagnostics.md rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.TypeOrReturnRecord.md => type-aliases/TypeOrReturnRecord.md} (57%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.TypeSpecDiagnosticTarget.md => type-aliases/TypeSpecDiagnosticTarget.md} (73%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.TypeSpecValue.md => type-aliases/TypeSpecValue.md} (51%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Type.WriteLine.md => type-aliases/WriteLine.md} (74%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Variable.CadlPrettierPlugin.md => variables/CadlPrettierPlugin.md} (63%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Variable.MANIFEST.md => variables/MANIFEST.md} (54%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Variable.NoTarget.md => variables/NoTarget.md} (76%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Variable.NodeHost.md => variables/NodeHost.md} (85%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Variable.TypeSpecPrettierPlugin.md => variables/TypeSpecPrettierPlugin.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Variable.altDirectorySeparator.md => variables/altDirectorySeparator.md} (61%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Variable.cadlVersion.md => variables/cadlVersion.md} (68%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Variable.directorySeparator.md => variables/directorySeparator.md} (88%) rename packages/website/versioned_docs/version-latest/standard-library/{openapi3/reference/js-api/Variable.namespace.md => reference/js-api/variables/namespace.md} (56%) rename packages/website/versioned_docs/version-latest/standard-library/reference/js-api/{Variable.typespecVersion.md => variables/typespecVersion.md} (56%) delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.AutoRouteOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.FilteredRouteParam.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceKey.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceOperation.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Type.ResourceOperations.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Variable.namespace.md rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$action.md => functions/$action.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$actionSegment.md => functions/$actionSegment.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$actionSeparator.md => functions/$actionSeparator.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$autoRoute.md => functions/$autoRoute.md} (96%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$collectionAction.md => functions/$collectionAction.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$copyResourceKeyParameters.md => functions/$copyResourceKeyParameters.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$createsOrReplacesResource.md => functions/$createsOrReplacesResource.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$createsOrUpdatesResource.md => functions/$createsOrUpdatesResource.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$createsResource.md => functions/$createsResource.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$deletesResource.md => functions/$deletesResource.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$listsResource.md => functions/$listsResource.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/{http/reference/js-api/Function.$onValidate.md => rest/reference/js-api/functions/$onValidate.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$parentResource.md => functions/$parentResource.md} (91%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$readsResource.md => functions/$readsResource.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$resource.md => functions/$resource.md} (87%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$resourceLocation.md => functions/$resourceLocation.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$resourceTypeForKeyParam.md => functions/$resourceTypeForKeyParam.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$segment.md => functions/$segment.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$segmentOf.md => functions/$segmentOf.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.$updatesResource.md => functions/$updatesResource.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.getAction.md => functions/getAction.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.getActionDetails.md => functions/getActionDetails.md} (82%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.getActionSegment.md => functions/getActionSegment.md} (85%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.getActionSeparator.md => functions/getActionSeparator.md} (93%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.getCollectionAction.md => functions/getCollectionAction.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.getCollectionActionDetails.md => functions/getCollectionActionDetails.md} (83%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.getParentResource.md => functions/getParentResource.md} (86%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.getResourceLocationType.md => functions/getResourceLocationType.md} (86%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.getResourceOperation.md => functions/getResourceOperation.md} (76%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.getResourceTypeForKeyParam.md => functions/getResourceTypeForKeyParam.md} (87%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.getResourceTypeKey.md => functions/getResourceTypeKey.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.getSegment.md => functions/getSegment.md} (85%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.isAutoRoute.md => functions/isAutoRoute.md} (90%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.isListOperation.md => functions/isListOperation.md} (93%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.setResourceOperation.md => functions/setResourceOperation.md} (62%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Function.setResourceTypeKey.md => functions/setResourceTypeKey.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/{Interface.ActionDetails.md => interfaces/ActionDetails.md} (100%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/AutoRouteOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/FilteredRouteParam.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/ResourceKey.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/ResourceOperation.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/type-aliases/ResourceOperations.md rename packages/website/versioned_docs/version-latest/standard-library/{http/reference/js-api/Variable.namespace.md => rest/reference/js-api/variables/namespace.md} (50%) delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Enumeration.Availability.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMap.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionDependencies.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.indexTimeline.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.Version.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.VersionResolution.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Variable.namespace.md rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Class.VersionMap.md => classes/VersionMap.md} (59%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/enumerations/Availability.md rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.$added.md => functions/$added.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.$madeOptional.md => functions/$madeOptional.md} (82%) rename packages/website/versioned_docs/version-latest/standard-library/{rest/reference/js-api/Function.$onValidate.md => versioning/reference/js-api/functions/$onValidate.md} (89%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.$removed.md => functions/$removed.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.$renamedFrom.md => functions/$renamedFrom.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.$returnTypeChangedFrom.md => functions/$returnTypeChangedFrom.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.$typeChangedFrom.md => functions/$typeChangedFrom.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.$useDependency.md => functions/$useDependency.md} (78%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.$versioned.md => functions/$versioned.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.buildVersionProjections.md => functions/buildVersionProjections.md} (87%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.existsAtVersion.md => functions/existsAtVersion.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.findVersionedNamespace.md => functions/findVersionedNamespace.md} (86%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getAddedOnVersions.md => functions/getAddedOnVersions.md} (76%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMap.md rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getAvailabilityMapInTimeline.md => functions/getAvailabilityMapInTimeline.md} (57%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getMadeOptionalOn.md => functions/getMadeOptionalOn.md} (84%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getNameAtVersion.md => functions/getNameAtVersion.md} (85%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getRemovedOnVersions.md => functions/getRemovedOnVersions.md} (76%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFrom.md rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getRenamedFromVersions.md => functions/getRenamedFromVersions.md} (84%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getReturnTypeBeforeVersion.md => functions/getReturnTypeBeforeVersion.md} (88%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getReturnTypeChangedFrom.md => functions/getReturnTypeChangedFrom.md} (72%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getTypeBeforeVersion.md => functions/getTypeBeforeVersion.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getTypeChangedFrom.md => functions/getTypeChangedFrom.md} (72%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getUseDependencies.md => functions/getUseDependencies.md} (52%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getVersion.md => functions/getVersion.md} (80%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionDependencies.md rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getVersionForEnumMember.md => functions/getVersionForEnumMember.md} (79%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getVersions.md => functions/getVersions.md} (74%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.getVersionsForEnum.md => functions/getVersionsForEnum.md} (76%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.hasDifferentNameAtVersion.md => functions/hasDifferentNameAtVersion.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.hasDifferentReturnTypeAtVersion.md => functions/hasDifferentReturnTypeAtVersion.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.hasDifferentTypeAtVersion.md => functions/hasDifferentTypeAtVersion.md} (80%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.madeOptionalAfter.md => functions/madeOptionalAfter.md} (77%) rename packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/{Function.resolveVersions.md => functions/resolveVersions.md} (83%) create mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/interfaces/Version.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/interfaces/VersionResolution.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/variables/namespace.md diff --git a/common/changes/@typespec/compiler/2390-param-hyphen_2023-09-10-15-37.json b/common/changes/@typespec/compiler/2390-param-hyphen_2023-09-10-15-37.json deleted file mode 100644 index b885fb0fd0..0000000000 --- a/common/changes/@typespec/compiler/2390-param-hyphen_2023-09-10-15-37.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Handle hyphen in @param doc comment", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/always-never_2023-09-12-16-32.json b/common/changes/@typespec/compiler/always-never_2023-09-12-16-32.json deleted file mode 100644 index c715f1f42e..0000000000 --- a/common/changes/@typespec/compiler/always-never_2023-09-12-16-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "The `never` type is now assignable to all types", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/compiler/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/compiler/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index 5945164bd2..0000000000 --- a/common/changes/@typespec/compiler/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/compiler-UnixTimestampErrorMessage_2023-09-20-18-05.json b/common/changes/@typespec/compiler/compiler-UnixTimestampErrorMessage_2023-09-20-18-05.json deleted file mode 100644 index 5945164bd2..0000000000 --- a/common/changes/@typespec/compiler/compiler-UnixTimestampErrorMessage_2023-09-20-18-05.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/constraint-allow-null_2023-09-12-15-51.json b/common/changes/@typespec/compiler/constraint-allow-null_2023-09-12-15-51.json deleted file mode 100644 index 4b4065cb2b..0000000000 --- a/common/changes/@typespec/compiler/constraint-allow-null_2023-09-12-15-51.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Allow nullable types for constraint decorators(min/max value, length, etc)", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/compiler/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index 5945164bd2..0000000000 --- a/common/changes/@typespec/compiler/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/feature-op-returns-docs_2023-09-19-16-32.json b/common/changes/@typespec/compiler/feature-op-returns-docs_2023-09-19-16-32.json deleted file mode 100644 index 18268f1f6c..0000000000 --- a/common/changes/@typespec/compiler/feature-op-returns-docs_2023-09-19-16-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Add support for `@returns` and `@errors` doc comment tags. `@returns`(or `@returnsDoc` decorator) can be used to describe the success return types of an operation. `@errors`(or `@errorsDoc` decorator) can be used to describe the error return types of an operation.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/compiler/fix-comment-tmlanguage_2023-09-25-20-36.json b/common/changes/@typespec/compiler/fix-comment-tmlanguage_2023-09-25-20-36.json deleted file mode 100644 index 1828762628..0000000000 --- a/common/changes/@typespec/compiler/fix-comment-tmlanguage_2023-09-25-20-36.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix: Colorization of line comment was bleeding over to the next line(s).", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-directive-parens-crash_2023-09-12-17-22.json b/common/changes/@typespec/compiler/fix-directive-parens-crash_2023-09-12-17-22.json deleted file mode 100644 index 62a91e70f8..0000000000 --- a/common/changes/@typespec/compiler/fix-directive-parens-crash_2023-09-12-17-22.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix crash when using parenthesis on directives", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-float64-negative_2023-09-12-17-33.json b/common/changes/@typespec/compiler/fix-float64-negative_2023-09-12-17-33.json deleted file mode 100644 index 5f7a07d3b6..0000000000 --- a/common/changes/@typespec/compiler/fix-float64-negative_2023-09-12-17-33.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix: Assigning negative and 0 to float64", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-format-exit-code_2023-09-20-15-44.json b/common/changes/@typespec/compiler/fix-format-exit-code_2023-09-20-15-44.json deleted file mode 100644 index 93a0a7768e..0000000000 --- a/common/changes/@typespec/compiler/fix-format-exit-code_2023-09-20-15-44.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "`tsp format` now returns a non-zero exit code when it fails to format a file", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-format-union_2023-09-19-19-07.json b/common/changes/@typespec/compiler/fix-format-union_2023-09-19-19-07.json deleted file mode 100644 index bb467b4c76..0000000000 --- a/common/changes/@typespec/compiler/fix-format-union_2023-09-19-19-07.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix: Anonymous union variants were formatted with an extra leading `:`", - "type": "none" - }, - { - "packageName": "@typespec/compiler", - "comment": "Formatter: Unions and Enums members are now formatted following the same rules as model properties. An extra line will be added between members if the member is annotated with a decorator, directive or doc comment.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/compiler/fix-formatting-doc-directive_2023-09-19-17-39.json b/common/changes/@typespec/compiler/fix-formatting-doc-directive_2023-09-19-17-39.json deleted file mode 100644 index d910948f64..0000000000 --- a/common/changes/@typespec/compiler/fix-formatting-doc-directive_2023-09-19-17-39.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix: Correct formatting of comments between a directive or doc and its node", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-init-config_2023-09-28-18-02.json b/common/changes/@typespec/compiler/fix-init-config_2023-09-28-18-02.json deleted file mode 100644 index 12f3f241d5..0000000000 --- a/common/changes/@typespec/compiler/fix-init-config_2023-09-28-18-02.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix: `tsp init` was not creating the `tspconfig.yaml` file for templates that specified it", - "type": "none" - }, - { - "packageName": "@typespec/compiler", - "comment": "Fix: `tsp init` will create a placeholder `tspconfig.yaml` file for templates that don't specify an explicit one.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/compiler/fix-issue-with-tsp-init_2023-10-10-20-42.json b/common/changes/@typespec/compiler/fix-issue-with-tsp-init_2023-10-10-20-42.json deleted file mode 100644 index 3f4f042bd4..0000000000 --- a/common/changes/@typespec/compiler/fix-issue-with-tsp-init_2023-10-10-20-42.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix `tsp init` was ignoring the `files` specified in an init template", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-lsp-not-reading-whole-config_2023-10-02-19-28.json b/common/changes/@typespec/compiler/fix-lsp-not-reading-whole-config_2023-10-02-19-28.json deleted file mode 100644 index d4a3d44188..0000000000 --- a/common/changes/@typespec/compiler/fix-lsp-not-reading-whole-config_2023-10-02-19-28.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix: Language Server wasn't loading the `tspconfig.yaml` correctly resulting in some options being dropped like the linter configuration.", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/compiler/fix-null-default_2023-09-11-22-42.json b/common/changes/@typespec/compiler/fix-null-default_2023-09-11-22-42.json deleted file mode 100644 index 2393600245..0000000000 --- a/common/changes/@typespec/compiler/fix-null-default_2023-09-11-22-42.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix: Allow `null` to be assigned as a default value", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-playground-lsp_2023-10-03-15-56.json b/common/changes/@typespec/compiler/fix-playground-lsp_2023-10-03-15-56.json deleted file mode 100644 index 5945164bd2..0000000000 --- a/common/changes/@typespec/compiler/fix-playground-lsp_2023-10-03-15-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/fix-using-typespec-implicit_2023-09-28-21-17.json b/common/changes/@typespec/compiler/fix-using-typespec-implicit_2023-09-28-21-17.json deleted file mode 100644 index 96361b9c7f..0000000000 --- a/common/changes/@typespec/compiler/fix-using-typespec-implicit_2023-09-28-21-17.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Fix: Using `TypeSpec.Xyz` namespace shouldn't require the `TypeSpec Prefix`", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/no-double-deprecation_2023-09-25-12-54.json b/common/changes/@typespec/compiler/no-double-deprecation_2023-09-25-12-54.json deleted file mode 100644 index 457d45927b..0000000000 --- a/common/changes/@typespec/compiler/no-double-deprecation_2023-09-25-12-54.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Skip emit of `deprecated` diagnostic for a type reference that is used in a deprecated declaration statement", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/@typespec/compiler/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index 5945164bd2..0000000000 --- a/common/changes/@typespec/compiler/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} \ No newline at end of file diff --git a/common/changes/@typespec/compiler/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/compiler/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index a284649fbf..0000000000 --- a/common/changes/@typespec/compiler/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/compiler/website-perf-improvements_2023-09-28-20-21.json b/common/changes/@typespec/compiler/website-perf-improvements_2023-09-28-20-21.json deleted file mode 100644 index c748686257..0000000000 --- a/common/changes/@typespec/compiler/website-perf-improvements_2023-09-28-20-21.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/compiler", - "comment": "Remove `decorators` export, import decorators individually", - "type": "none" - } - ], - "packageName": "@typespec/compiler" -} diff --git a/common/changes/@typespec/eslint-config-typespec/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/eslint-config-typespec/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index c81a47c2f4..0000000000 --- a/common/changes/@typespec/eslint-config-typespec/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/eslint-config-typespec", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/eslint-config-typespec" -} \ No newline at end of file diff --git a/common/changes/@typespec/eslint-config-typespec/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/eslint-config-typespec/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index cfbcb4d76d..0000000000 --- a/common/changes/@typespec/eslint-config-typespec/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/eslint-config-typespec", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/eslint-config-typespec" -} diff --git a/common/changes/@typespec/eslint-plugin/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/eslint-plugin/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index fff4fcaf90..0000000000 --- a/common/changes/@typespec/eslint-plugin/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/eslint-plugin", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/eslint-plugin" -} \ No newline at end of file diff --git a/common/changes/@typespec/eslint-plugin/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/eslint-plugin/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index 686e793bda..0000000000 --- a/common/changes/@typespec/eslint-plugin/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/eslint-plugin", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/eslint-plugin" -} diff --git a/common/changes/@typespec/html-program-viewer/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/html-program-viewer/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index ba2766951c..0000000000 --- a/common/changes/@typespec/html-program-viewer/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/html-program-viewer", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/html-program-viewer" -} \ No newline at end of file diff --git a/common/changes/@typespec/html-program-viewer/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/html-program-viewer/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index ba2766951c..0000000000 --- a/common/changes/@typespec/html-program-viewer/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/html-program-viewer", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/html-program-viewer" -} \ No newline at end of file diff --git a/common/changes/@typespec/html-program-viewer/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/@typespec/html-program-viewer/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index ba2766951c..0000000000 --- a/common/changes/@typespec/html-program-viewer/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/html-program-viewer", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/html-program-viewer" -} \ No newline at end of file diff --git a/common/changes/@typespec/html-program-viewer/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/html-program-viewer/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index b13e31365f..0000000000 --- a/common/changes/@typespec/html-program-viewer/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/html-program-viewer", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/html-program-viewer" -} diff --git a/common/changes/@typespec/http/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/http/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index e59b9bb12e..0000000000 --- a/common/changes/@typespec/http/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/http" -} \ No newline at end of file diff --git a/common/changes/@typespec/http/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/http/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index e59b9bb12e..0000000000 --- a/common/changes/@typespec/http/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/http" -} \ No newline at end of file diff --git a/common/changes/@typespec/http/feature-op-returns-docs_2023-09-19-16-32.json b/common/changes/@typespec/http/feature-op-returns-docs_2023-09-19-16-32.json deleted file mode 100644 index 931a1d2bb5..0000000000 --- a/common/changes/@typespec/http/feature-op-returns-docs_2023-09-19-16-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "Add support for `@returns` and `@errors` doc comment tags.", - "type": "none" - } - ], - "packageName": "@typespec/http" -} \ No newline at end of file diff --git a/common/changes/@typespec/http/feature-status-code-ranges_2023-09-25-23-04.json b/common/changes/@typespec/http/feature-status-code-ranges_2023-09-25-23-04.json deleted file mode 100644 index efc2a554c8..0000000000 --- a/common/changes/@typespec/http/feature-status-code-ranges_2023-09-25-23-04.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "Add support for status code ranges for http responses. **Change to API** Http responses can now also return a `HttpStatusCodeRange` object for their status codes", - "type": "none" - } - ], - "packageName": "@typespec/http" -} \ No newline at end of file diff --git a/common/changes/@typespec/http/openapi3-DuplicateRefs_2023-09-27-19-57.json b/common/changes/@typespec/http/openapi3-DuplicateRefs_2023-09-27-19-57.json deleted file mode 100644 index b7216caf1f..0000000000 --- a/common/changes/@typespec/http/openapi3-DuplicateRefs_2023-09-27-19-57.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "Emit error when multiple properties on a response model have the `@statusCode` decorator.", - "type": "none" - } - ], - "packageName": "@typespec/http" -} \ No newline at end of file diff --git a/common/changes/@typespec/http/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/@typespec/http/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index e59b9bb12e..0000000000 --- a/common/changes/@typespec/http/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/http" -} \ No newline at end of file diff --git a/common/changes/@typespec/http/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/http/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index bb22e608aa..0000000000 --- a/common/changes/@typespec/http/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/http", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/http" -} diff --git a/common/changes/@typespec/internal-build-utils/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/internal-build-utils/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index 09d59b43a0..0000000000 --- a/common/changes/@typespec/internal-build-utils/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/internal-build-utils", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/internal-build-utils" -} \ No newline at end of file diff --git a/common/changes/@typespec/internal-build-utils/prepare-playground-release_2023-09-25-17-57.json b/common/changes/@typespec/internal-build-utils/prepare-playground-release_2023-09-25-17-57.json deleted file mode 100644 index 75572fc853..0000000000 --- a/common/changes/@typespec/internal-build-utils/prepare-playground-release_2023-09-25-17-57.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/internal-build-utils", - "comment": "Handle bumping version of prerelease packages", - "type": "none" - } - ], - "packageName": "@typespec/internal-build-utils" -} \ No newline at end of file diff --git a/common/changes/@typespec/internal-build-utils/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/@typespec/internal-build-utils/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index 09d59b43a0..0000000000 --- a/common/changes/@typespec/internal-build-utils/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/internal-build-utils", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/internal-build-utils" -} \ No newline at end of file diff --git a/common/changes/@typespec/internal-build-utils/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/internal-build-utils/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index 0b68eb7527..0000000000 --- a/common/changes/@typespec/internal-build-utils/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/internal-build-utils", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/internal-build-utils" -} diff --git a/common/changes/@typespec/json-schema/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/json-schema/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index c15d89290f..0000000000 --- a/common/changes/@typespec/json-schema/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/json-schema", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/json-schema" -} \ No newline at end of file diff --git a/common/changes/@typespec/json-schema/constraint-allow-null_2023-09-22-22-38.json b/common/changes/@typespec/json-schema/constraint-allow-null_2023-09-22-22-38.json deleted file mode 100644 index c15d89290f..0000000000 --- a/common/changes/@typespec/json-schema/constraint-allow-null_2023-09-22-22-38.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/json-schema", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/json-schema" -} \ No newline at end of file diff --git a/common/changes/@typespec/json-schema/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/json-schema/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index c15d89290f..0000000000 --- a/common/changes/@typespec/json-schema/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/json-schema", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/json-schema" -} \ No newline at end of file diff --git a/common/changes/@typespec/json-schema/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/@typespec/json-schema/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index c15d89290f..0000000000 --- a/common/changes/@typespec/json-schema/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/json-schema", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/json-schema" -} \ No newline at end of file diff --git a/common/changes/@typespec/json-schema/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/json-schema/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index 37338a4496..0000000000 --- a/common/changes/@typespec/json-schema/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/json-schema", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/json-schema" -} diff --git a/common/changes/@typespec/json-schema/yaml-stringify-max-line-len_2023-09-19-18-13.json b/common/changes/@typespec/json-schema/yaml-stringify-max-line-len_2023-09-19-18-13.json deleted file mode 100644 index 372ff17ce0..0000000000 --- a/common/changes/@typespec/json-schema/yaml-stringify-max-line-len_2023-09-19-18-13.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/json-schema", - "comment": "Disable folding of serialized yaml if line is above 80 characters", - "type": "none" - } - ], - "packageName": "@typespec/json-schema" -} diff --git a/common/changes/@typespec/library-linter/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/library-linter/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index f311c1375c..0000000000 --- a/common/changes/@typespec/library-linter/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/library-linter", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/library-linter" -} \ No newline at end of file diff --git a/common/changes/@typespec/library-linter/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/library-linter/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index f311c1375c..0000000000 --- a/common/changes/@typespec/library-linter/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/library-linter", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/library-linter" -} \ No newline at end of file diff --git a/common/changes/@typespec/library-linter/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/@typespec/library-linter/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index f311c1375c..0000000000 --- a/common/changes/@typespec/library-linter/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/library-linter", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/library-linter" -} \ No newline at end of file diff --git a/common/changes/@typespec/library-linter/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/library-linter/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index af476b3e6f..0000000000 --- a/common/changes/@typespec/library-linter/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/library-linter", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/library-linter" -} diff --git a/common/changes/@typespec/lint/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/lint/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index 7ca05a5a8d..0000000000 --- a/common/changes/@typespec/lint/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/lint", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/lint" -} \ No newline at end of file diff --git a/common/changes/@typespec/lint/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/lint/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index 7ca05a5a8d..0000000000 --- a/common/changes/@typespec/lint/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/lint", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/lint" -} \ No newline at end of file diff --git a/common/changes/@typespec/lint/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/@typespec/lint/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index 7ca05a5a8d..0000000000 --- a/common/changes/@typespec/lint/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/lint", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/lint" -} \ No newline at end of file diff --git a/common/changes/@typespec/lint/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/lint/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index 7eee96896b..0000000000 --- a/common/changes/@typespec/lint/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/lint", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/lint" -} diff --git a/common/changes/@typespec/migrate/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/migrate/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index 1dc1455f96..0000000000 --- a/common/changes/@typespec/migrate/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/migrate", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/migrate" -} \ No newline at end of file diff --git a/common/changes/@typespec/migrate/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/migrate/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index 1dc1455f96..0000000000 --- a/common/changes/@typespec/migrate/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/migrate", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/migrate" -} \ No newline at end of file diff --git a/common/changes/@typespec/migrate/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/migrate/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index 85f79b2d0a..0000000000 --- a/common/changes/@typespec/migrate/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/migrate", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/migrate" -} diff --git a/common/changes/@typespec/openapi/2391-rest-http-peer-dep_2023-09-19-00-29.json b/common/changes/@typespec/openapi/2391-rest-http-peer-dep_2023-09-19-00-29.json deleted file mode 100644 index 16f3432f29..0000000000 --- a/common/changes/@typespec/openapi/2391-rest-http-peer-dep_2023-09-19-00-29.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi", - "comment": "Removes `@typespec/rest` as a `peerDependency`. Relates to #2391", - "type": "none" - } - ], - "packageName": "@typespec/openapi" -} diff --git a/common/changes/@typespec/openapi/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/openapi/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index 4697c1be8b..0000000000 --- a/common/changes/@typespec/openapi/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/openapi" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/openapi/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index 4697c1be8b..0000000000 --- a/common/changes/@typespec/openapi/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/openapi" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi/feature-status-code-ranges_2023-09-25-23-04.json b/common/changes/@typespec/openapi/feature-status-code-ranges_2023-09-25-23-04.json deleted file mode 100644 index 68fa4ca9af..0000000000 --- a/common/changes/@typespec/openapi/feature-status-code-ranges_2023-09-25-23-04.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi", - "comment": "Add support for http status code ranges", - "type": "none" - } - ], - "packageName": "@typespec/openapi" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi/openApi-FixNamespace_2023-09-19-19-48.json b/common/changes/@typespec/openapi/openApi-FixNamespace_2023-09-19-19-48.json deleted file mode 100644 index 10d05bbee4..0000000000 --- a/common/changes/@typespec/openapi/openApi-FixNamespace_2023-09-19-19-48.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi", - "comment": "Changed namespace from `OpenAPI` to `TypeSpec.OpenAPI`.", - "type": "none" - } - ], - "packageName": "@typespec/openapi" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/@typespec/openapi/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index 4697c1be8b..0000000000 --- a/common/changes/@typespec/openapi/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/openapi" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/openapi/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index b8e582bc1c..0000000000 --- a/common/changes/@typespec/openapi/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/openapi" -} diff --git a/common/changes/@typespec/openapi3/2391-rest-http-peer-dep_2023-09-19-00-29.json b/common/changes/@typespec/openapi3/2391-rest-http-peer-dep_2023-09-19-00-29.json deleted file mode 100644 index ae86051ffb..0000000000 --- a/common/changes/@typespec/openapi3/2391-rest-http-peer-dep_2023-09-19-00-29.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Removes `@typespec/rest` as a `peerDependency`. Relates to #2391", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} diff --git a/common/changes/@typespec/openapi3/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/openapi3/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index d9a70151de..0000000000 --- a/common/changes/@typespec/openapi3/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/constraint-allow-null_2023-09-22-22-38.json b/common/changes/@typespec/openapi3/constraint-allow-null_2023-09-22-22-38.json deleted file mode 100644 index 1ffa52e074..0000000000 --- a/common/changes/@typespec/openapi3/constraint-allow-null_2023-09-22-22-38.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Add support for constraints on unions", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/openapi3/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index d9a70151de..0000000000 --- a/common/changes/@typespec/openapi3/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/feature-op-returns-docs_2023-09-19-16-32.json b/common/changes/@typespec/openapi3/feature-op-returns-docs_2023-09-19-16-32.json deleted file mode 100644 index ee001dfd4c..0000000000 --- a/common/changes/@typespec/openapi3/feature-op-returns-docs_2023-09-19-16-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Add support for `@returns` and `@errors` doc comment tags.", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/feature-status-code-ranges_2023-09-25-23-04.json b/common/changes/@typespec/openapi3/feature-status-code-ranges_2023-09-25-23-04.json deleted file mode 100644 index ad6fdbc9b0..0000000000 --- a/common/changes/@typespec/openapi3/feature-status-code-ranges_2023-09-25-23-04.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Add support for http status code ranges", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/fix-discriminated-union-mapping-wrongly-mutated_2023-09-15-00-39.json b/common/changes/@typespec/openapi3/fix-discriminated-union-mapping-wrongly-mutated_2023-09-15-00-39.json deleted file mode 100644 index 291bf4ab30..0000000000 --- a/common/changes/@typespec/openapi3/fix-discriminated-union-mapping-wrongly-mutated_2023-09-15-00-39.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Fix: Correctly generate discriminated union mapping property with multiple visibilities involved", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/fix-numeric-union-default-openapi3_2023-09-11-23-13.json b/common/changes/@typespec/openapi3/fix-numeric-union-default-openapi3_2023-09-11-23-13.json deleted file mode 100644 index 0aa052c879..0000000000 --- a/common/changes/@typespec/openapi3/fix-numeric-union-default-openapi3_2023-09-11-23-13.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Fix: Crash when assigning a numeric default to a union", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/fix-openapi3-header-format_2023-09-20-17-20.json b/common/changes/@typespec/openapi3/fix-openapi3-header-format_2023-09-20-17-20.json deleted file mode 100644 index f621cac4e3..0000000000 --- a/common/changes/@typespec/openapi3/fix-openapi3-header-format_2023-09-20-17-20.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Fix: Using format `ssv` or `pipes` in `@header` produced an invalid OpenAPI3 schema. It will now change the type to string and ignore the format as well as logging a warning.", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/fix-openapi3-null-default_2023-09-20-01-06.json b/common/changes/@typespec/openapi3/fix-openapi3-null-default_2023-09-20-01-06.json deleted file mode 100644 index ae0ffe7b2c..0000000000 --- a/common/changes/@typespec/openapi3/fix-openapi3-null-default_2023-09-20-01-06.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Fix: Use `null` as a default", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/oneof-model-prop_2023-09-22-20-29.json b/common/changes/@typespec/openapi3/oneof-model-prop_2023-09-22-20-29.json deleted file mode 100644 index d221e6c84e..0000000000 --- a/common/changes/@typespec/openapi3/oneof-model-prop_2023-09-22-20-29.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Allow use of `@oneOf` on model properties", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/openApi-FixNamespace_2023-09-19-17-16.json b/common/changes/@typespec/openapi3/openApi-FixNamespace_2023-09-19-17-16.json deleted file mode 100644 index 1e4b242732..0000000000 --- a/common/changes/@typespec/openapi3/openApi-FixNamespace_2023-09-19-17-16.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Fix `OpenAPI` namespace to be `TypeSpec.OpenAPI`.", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/openapi3-DuplicateRefs_2023-09-27-19-57.json b/common/changes/@typespec/openapi3/openapi3-DuplicateRefs_2023-09-27-19-57.json deleted file mode 100644 index d9a70151de..0000000000 --- a/common/changes/@typespec/openapi3/openapi3-DuplicateRefs_2023-09-27-19-57.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/openapi3-FixCsvFormat_2023-09-19-21-04.json b/common/changes/@typespec/openapi3/openapi3-FixCsvFormat_2023-09-19-21-04.json deleted file mode 100644 index cdcd568687..0000000000 --- a/common/changes/@typespec/openapi3/openapi3-FixCsvFormat_2023-09-19-21-04.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Fix issue with CSV format representation.", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/openapi3-statusCodeShared_2023-10-10-20-29.json b/common/changes/@typespec/openapi3/openapi3-statusCodeShared_2023-10-10-20-29.json deleted file mode 100644 index 605ee4674f..0000000000 --- a/common/changes/@typespec/openapi3/openapi3-statusCodeShared_2023-10-10-20-29.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Fix issue where openAPI3 for shared routes incorrectly output a statusCode field.", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/@typespec/openapi3/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index d9a70151de..0000000000 --- a/common/changes/@typespec/openapi3/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} \ No newline at end of file diff --git a/common/changes/@typespec/openapi3/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/openapi3/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index 3ee5cf22b5..0000000000 --- a/common/changes/@typespec/openapi3/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} diff --git a/common/changes/@typespec/openapi3/yaml-stringify-max-line-len_2023-09-19-18-13.json b/common/changes/@typespec/openapi3/yaml-stringify-max-line-len_2023-09-19-18-13.json deleted file mode 100644 index 8457f149b1..0000000000 --- a/common/changes/@typespec/openapi3/yaml-stringify-max-line-len_2023-09-19-18-13.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/openapi3", - "comment": "Disable folding of serialized yaml if line is above 80 characters", - "type": "none" - } - ], - "packageName": "@typespec/openapi3" -} diff --git a/common/changes/@typespec/prettier-plugin-typespec/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/prettier-plugin-typespec/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index 5c09cd79f9..0000000000 --- a/common/changes/@typespec/prettier-plugin-typespec/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/prettier-plugin-typespec", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/prettier-plugin-typespec" -} \ No newline at end of file diff --git a/common/changes/@typespec/prettier-plugin-typespec/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/prettier-plugin-typespec/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index 5c09cd79f9..0000000000 --- a/common/changes/@typespec/prettier-plugin-typespec/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/prettier-plugin-typespec", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/prettier-plugin-typespec" -} \ No newline at end of file diff --git a/common/changes/@typespec/prettier-plugin-typespec/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/prettier-plugin-typespec/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index 66ea56cbf4..0000000000 --- a/common/changes/@typespec/prettier-plugin-typespec/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/prettier-plugin-typespec", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/prettier-plugin-typespec" -} diff --git a/common/changes/@typespec/protobuf/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/protobuf/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index 8f48e4e952..0000000000 --- a/common/changes/@typespec/protobuf/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/protobuf", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/protobuf" -} \ No newline at end of file diff --git a/common/changes/@typespec/protobuf/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/protobuf/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index 8f48e4e952..0000000000 --- a/common/changes/@typespec/protobuf/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/protobuf", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/protobuf" -} \ No newline at end of file diff --git a/common/changes/@typespec/protobuf/fix-format-union_2023-09-20-20-26.json b/common/changes/@typespec/protobuf/fix-format-union_2023-09-20-20-26.json deleted file mode 100644 index 8f48e4e952..0000000000 --- a/common/changes/@typespec/protobuf/fix-format-union_2023-09-20-20-26.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/protobuf", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/protobuf" -} \ No newline at end of file diff --git a/common/changes/@typespec/protobuf/protobuf-emit-doc-comments_2023-08-10-18-18.json b/common/changes/@typespec/protobuf/protobuf-emit-doc-comments_2023-08-10-18-18.json deleted file mode 100644 index 5874e70e4c..0000000000 --- a/common/changes/@typespec/protobuf/protobuf-emit-doc-comments_2023-08-10-18-18.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/protobuf", - "comment": "Added support for emitting documentation comments in protobuf specifications.", - "type": "none" - } - ], - "packageName": "@typespec/protobuf" -} \ No newline at end of file diff --git a/common/changes/@typespec/protobuf/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/protobuf/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index dfd9be7b95..0000000000 --- a/common/changes/@typespec/protobuf/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/protobuf", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/protobuf" -} diff --git a/common/changes/@typespec/rest/2391-rest-http-peer-dep_2023-09-19-00-29.json b/common/changes/@typespec/rest/2391-rest-http-peer-dep_2023-09-19-00-29.json deleted file mode 100644 index 020557eeac..0000000000 --- a/common/changes/@typespec/rest/2391-rest-http-peer-dep_2023-09-19-00-29.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/rest", - "comment": "Correct rest → http peer dependency. Fixes #2391", - "type": "none" - } - ], - "packageName": "@typespec/rest" -} diff --git a/common/changes/@typespec/rest/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/rest/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index 64135d54e3..0000000000 --- a/common/changes/@typespec/rest/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/rest", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/rest" -} \ No newline at end of file diff --git a/common/changes/@typespec/rest/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/rest/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index 64135d54e3..0000000000 --- a/common/changes/@typespec/rest/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/rest", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/rest" -} \ No newline at end of file diff --git a/common/changes/@typespec/rest/fixResourceLogic_2023-09-29-18-58.json b/common/changes/@typespec/rest/fixResourceLogic_2023-09-29-18-58.json deleted file mode 100644 index c64a7e528f..0000000000 --- a/common/changes/@typespec/rest/fixResourceLogic_2023-09-29-18-58.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/rest", - "comment": "Fix: `@key` can now appear on the base model of a resource.", - "type": "none" - } - ], - "packageName": "@typespec/rest" -} diff --git a/common/changes/@typespec/rest/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/@typespec/rest/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index 64135d54e3..0000000000 --- a/common/changes/@typespec/rest/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/rest", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/rest" -} \ No newline at end of file diff --git a/common/changes/@typespec/rest/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/rest/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index 022c073f96..0000000000 --- a/common/changes/@typespec/rest/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/rest", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/rest" -} diff --git a/common/changes/@typespec/versioning/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/@typespec/versioning/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index 3c8fd8571b..0000000000 --- a/common/changes/@typespec/versioning/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/versioning", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/versioning" -} \ No newline at end of file diff --git a/common/changes/@typespec/versioning/fake-changelog_2023-10-10-22-08.json b/common/changes/@typespec/versioning/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index 3c8fd8571b..0000000000 --- a/common/changes/@typespec/versioning/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/versioning", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/versioning" -} \ No newline at end of file diff --git a/common/changes/@typespec/versioning/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/@typespec/versioning/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index 3c8fd8571b..0000000000 --- a/common/changes/@typespec/versioning/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/versioning", - "comment": "", - "type": "none" - } - ], - "packageName": "@typespec/versioning" -} \ No newline at end of file diff --git a/common/changes/@typespec/versioning/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/@typespec/versioning/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index ff94dc0035..0000000000 --- a/common/changes/@typespec/versioning/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/versioning", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@typespec/versioning" -} diff --git a/common/changes/@typespec/versioning/versioning-RenamedFromBug_2023-09-27-22-20.json b/common/changes/@typespec/versioning/versioning-RenamedFromBug_2023-09-27-22-20.json deleted file mode 100644 index 60307d3fef..0000000000 --- a/common/changes/@typespec/versioning/versioning-RenamedFromBug_2023-09-27-22-20.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@typespec/versioning", - "comment": "Ensure that use of `@renamedFrom` does not result in duplicate properties on a model.", - "type": "none" - } - ], - "packageName": "@typespec/versioning" -} \ No newline at end of file diff --git a/common/changes/tmlanguage-generator/fake-changelog_2023-10-10-22-08.json b/common/changes/tmlanguage-generator/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index 01af755722..0000000000 --- a/common/changes/tmlanguage-generator/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "tmlanguage-generator", - "comment": "", - "type": "none" - } - ], - "packageName": "tmlanguage-generator" -} \ No newline at end of file diff --git a/common/changes/tmlanguage-generator/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/tmlanguage-generator/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index 01af755722..0000000000 --- a/common/changes/tmlanguage-generator/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "tmlanguage-generator", - "comment": "", - "type": "none" - } - ], - "packageName": "tmlanguage-generator" -} \ No newline at end of file diff --git a/common/changes/tmlanguage-generator/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/tmlanguage-generator/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index fca4bf8502..0000000000 --- a/common/changes/tmlanguage-generator/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "tmlanguage-generator", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "tmlanguage-generator" -} diff --git a/common/changes/typespec-vs/fake-changelog_2023-10-10-22-08.json b/common/changes/typespec-vs/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index fc3fb4b131..0000000000 --- a/common/changes/typespec-vs/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "typespec-vs", - "comment": "", - "type": "none" - } - ], - "packageName": "typespec-vs" -} \ No newline at end of file diff --git a/common/changes/typespec-vs/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/typespec-vs/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index fc3fb4b131..0000000000 --- a/common/changes/typespec-vs/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "typespec-vs", - "comment": "", - "type": "none" - } - ], - "packageName": "typespec-vs" -} \ No newline at end of file diff --git a/common/changes/typespec-vscode/backmerge-2023-09-19_2023-09-19-21-02.json b/common/changes/typespec-vscode/backmerge-2023-09-19_2023-09-19-21-02.json deleted file mode 100644 index 4ec67f8df3..0000000000 --- a/common/changes/typespec-vscode/backmerge-2023-09-19_2023-09-19-21-02.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "typespec-vscode", - "comment": "", - "type": "none" - } - ], - "packageName": "typespec-vscode" -} \ No newline at end of file diff --git a/common/changes/typespec-vscode/fake-changelog_2023-10-10-22-08.json b/common/changes/typespec-vscode/fake-changelog_2023-10-10-22-08.json deleted file mode 100644 index 4ec67f8df3..0000000000 --- a/common/changes/typespec-vscode/fake-changelog_2023-10-10-22-08.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "typespec-vscode", - "comment": "", - "type": "none" - } - ], - "packageName": "typespec-vscode" -} \ No newline at end of file diff --git a/common/changes/typespec-vscode/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json b/common/changes/typespec-vscode/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json deleted file mode 100644 index 4ec67f8df3..0000000000 --- a/common/changes/typespec-vscode/revert-2488-pkgjson-cleanup_2023-10-10-17-47.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "typespec-vscode", - "comment": "", - "type": "none" - } - ], - "packageName": "typespec-vscode" -} \ No newline at end of file diff --git a/common/changes/typespec-vscode/upgrade-deps-sep-2023_2023-09-20-20-41.json b/common/changes/typespec-vscode/upgrade-deps-sep-2023_2023-09-20-20-41.json deleted file mode 100644 index 71c13a9bca..0000000000 --- a/common/changes/typespec-vscode/upgrade-deps-sep-2023_2023-09-20-20-41.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "typespec-vscode", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "typespec-vscode" -} diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index bbab996df5..74c138b039 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -22,13 +22,13 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-plugin-typespec c8: specifier: ~8.0.1 @@ -73,7 +73,7 @@ importers: specifier: ~3.0.1 version: 3.0.1(rollup@3.29.2) '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler rollup: specifier: ~3.29.2 @@ -86,7 +86,7 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.1 @@ -180,10 +180,10 @@ importers: specifier: ~17.0.24 version: 17.0.24 '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../internal-build-utils c8: specifier: ~8.0.1 @@ -216,7 +216,7 @@ importers: specifier: ~0.5.21 version: 0.5.21 tmlanguage-generator: - specifier: workspace:~0.4.4 + specifier: workspace:~0.4.5 version: link:../tmlanguage-generator typescript: specifier: ~5.2.2 @@ -277,7 +277,7 @@ importers: specifier: ^6.2.1 version: 6.2.1(eslint@8.49.0)(typescript@5.2.2) '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.1 @@ -335,10 +335,10 @@ importers: specifier: ~18.2.7 version: 18.2.7 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.1 @@ -371,16 +371,16 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-plugin-typespec '@typespec/library-linter': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -435,7 +435,7 @@ importers: specifier: ~17.0.24 version: 17.0.24 '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.1 @@ -475,19 +475,19 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-plugin-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../internal-build-utils '@typespec/library-linter': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -529,10 +529,10 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec c8: specifier: ~8.0.1 @@ -565,13 +565,13 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-plugin-typespec c8: specifier: ~8.0.1 @@ -598,7 +598,7 @@ importers: ../../packages/migrate: dependencies: '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/compiler-v0.37': specifier: npm:@cadl-lang/compiler@0.37.0 @@ -644,10 +644,10 @@ importers: specifier: ~17.0.24 version: 17.0.24 '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-plugin-typespec c8: specifier: ~8.0.1 @@ -680,22 +680,22 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../http '@typespec/library-linter': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../library-linter '@typespec/rest': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../rest '@typespec/tspd': specifier: workspace:~0.46.0 @@ -735,31 +735,31 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../http '@typespec/library-linter': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../library-linter '@typespec/openapi': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../openapi '@typespec/rest': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../rest '@typespec/tspd': specifier: workspace:~0.46.0 version: link:../tspd '@typespec/versioning': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../versioning c8: specifier: ~8.0.1 @@ -795,28 +795,28 @@ importers: specifier: ~2.0.217 version: 2.0.217(react@18.2.0) '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/html-program-viewer': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../html-program-viewer '@typespec/http': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../http '@typespec/openapi': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../openapi3 '@typespec/protobuf': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../protobuf '@typespec/rest': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../rest '@typespec/versioning': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../versioning debounce: specifier: ~1.2.1 @@ -871,10 +871,10 @@ importers: specifier: ^4.18.0 version: 4.18.0 '@typespec/bundler': - specifier: workspace:~0.1.0-alpha.0 + specifier: workspace:~0.1.0-alpha.2 version: link:../bundler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@vitejs/plugin-react': specifier: ~4.0.4 @@ -916,34 +916,34 @@ importers: specifier: ^11.11.1 version: 11.11.1(@types/react@18.2.22)(react@18.2.0) '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/html-program-viewer': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../html-program-viewer '@typespec/http': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../http '@typespec/json-schema': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../json-schema '@typespec/openapi': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../openapi3 '@typespec/playground': - specifier: workspace:~0.1.0-alpha.1 + specifier: workspace:~0.1.0-alpha.2 version: link:../playground '@typespec/protobuf': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../protobuf '@typespec/rest': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../rest '@typespec/versioning': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../versioning react: specifier: ~18.2.0 @@ -980,7 +980,7 @@ importers: specifier: ^4.18.0 version: 4.18.0 '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@vitejs/plugin-react': specifier: ~4.0.4 @@ -1035,10 +1035,10 @@ importers: specifier: ~5.0.2 version: 5.0.2(rollup@3.29.2) '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/internal-build-utils': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../internal-build-utils mocha: specifier: ~10.2.0 @@ -1068,13 +1068,13 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-plugin-typespec '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1107,19 +1107,19 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../http '@typespec/library-linter': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1152,28 +1152,28 @@ importers: specifier: workspace:~0.45.0 version: link:../best-practices '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/html-program-viewer': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../html-program-viewer '@typespec/http': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../http '@typespec/json-schema': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../json-schema '@typespec/openapi': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../openapi3 '@typespec/rest': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../rest '@typespec/versioning': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../versioning devDependencies: '@types/mocha': @@ -1183,10 +1183,10 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../internal-build-utils autorest: specifier: ~3.3.2 @@ -1213,7 +1213,7 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/internal-build-utils': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../internal-build-utils ecmarkup: specifier: ~12.0.3 @@ -1235,7 +1235,7 @@ importers: specifier: ~3.0.2 version: 3.0.2 '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec eslint: specifier: ^8.49.0 @@ -1250,7 +1250,7 @@ importers: ../../packages/tspd: dependencies: '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler picocolors: specifier: ~1.0.0 @@ -1275,10 +1275,10 @@ importers: specifier: ~17.0.24 version: 17.0.24 '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/prettier-plugin-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../prettier-plugin-typespec c8: specifier: ~8.0.1 @@ -1314,10 +1314,10 @@ importers: ../../packages/typespec-vs: devDependencies: '@typespec/internal-build-utils': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../internal-build-utils typespec-vscode: - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../typespec-vscode ../../packages/typespec-vscode: @@ -1338,13 +1338,13 @@ importers: specifier: ~1.82.0 version: 1.82.0 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../internal-build-utils '@vscode/vsce': specifier: ~2.21.0 @@ -1386,16 +1386,16 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-plugin-typespec '@typespec/library-linter': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1462,28 +1462,28 @@ importers: specifier: ~18.11.9 version: 18.11.9 '@typespec/compiler': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../eslint-config-typespec '@typespec/http': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../http '@typespec/json-schema': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../json-schema '@typespec/openapi': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.48.1 + specifier: workspace:~0.49.0 version: link:../openapi3 '@typespec/protobuf': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../protobuf '@typespec/rest': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../rest '@typespec/spec': specifier: workspace:* @@ -1492,7 +1492,7 @@ importers: specifier: workspace:~0.46.0 version: link:../tspd '@typespec/versioning': - specifier: workspace:~0.48.0 + specifier: workspace:~0.49.0 version: link:../versioning dotenv: specifier: ~16.3.1 diff --git a/common/config/rush/version-policies.json b/common/config/rush/version-policies.json index 565562527c..35bef259f7 100644 --- a/common/config/rush/version-policies.json +++ b/common/config/rush/version-policies.json @@ -18,7 +18,7 @@ { "definitionName": "lockStepVersion", "policyName": "playground", - "version": "0.1.0-alpha.1", + "version": "0.1.0-alpha.2", "nextBump": "prerelease" } // { diff --git a/packages/best-practices/package.json b/packages/best-practices/package.json index a2309d7162..94e4f3bdd9 100644 --- a/packages/best-practices/package.json +++ b/packages/best-practices/package.json @@ -39,14 +39,14 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.48.1" + "@typespec/compiler": "workspace:~0.49.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/eslint-plugin": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/eslint-plugin": "workspace:~0.49.0", "eslint": "^8.49.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.1", diff --git a/packages/bundler/package.json b/packages/bundler/package.json index b3e158d332..c0b68ce3d9 100644 --- a/packages/bundler/package.json +++ b/packages/bundler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/bundler", - "version": "0.1.0-alpha.1", + "version": "0.1.0-alpha.2", "author": "Microsoft Corporation", "description": "Package to bundle a typespec library.", "homepage": "https://microsoft.github.io/typespec", @@ -38,7 +38,7 @@ "!dist/test/**" ], "dependencies": { - "@typespec/compiler": "workspace:~0.48.1", + "@typespec/compiler": "workspace:~0.49.0", "@rollup/plugin-virtual": "~3.0.1", "@rollup/plugin-commonjs": "~25.0.4", "@rollup/plugin-json": "~6.0.0", @@ -50,7 +50,7 @@ "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", "eslint": "^8.49.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.1", diff --git a/packages/compiler/CHANGELOG.json b/packages/compiler/CHANGELOG.json index 4dc1abb564..3b4aab886b 100644 --- a/packages/compiler/CHANGELOG.json +++ b/packages/compiler/CHANGELOG.json @@ -1,6 +1,80 @@ { "name": "@typespec/compiler", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/compiler_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Handle hyphen in @param doc comment" + }, + { + "comment": "The `never` type is now assignable to all types" + }, + { + "comment": "Allow nullable types for constraint decorators(min/max value, length, etc)" + }, + { + "comment": "Add support for `@returns` and `@errors` doc comment tags. `@returns`(or `@returnsDoc` decorator) can be used to describe the success return types of an operation. `@errors`(or `@errorsDoc` decorator) can be used to describe the error return types of an operation." + }, + { + "comment": "Fix: Colorization of line comment was bleeding over to the next line(s)." + }, + { + "comment": "Fix crash when using parenthesis on directives" + }, + { + "comment": "Fix: Assigning negative and 0 to float64" + }, + { + "comment": "`tsp format` now returns a non-zero exit code when it fails to format a file" + }, + { + "comment": "Fix: Anonymous union variants were formatted with an extra leading `:`" + }, + { + "comment": "Formatter: Unions and Enums members are now formatted following the same rules as model properties. An extra line will be added between members if the member is annotated with a decorator, directive or doc comment." + }, + { + "comment": "Fix: Correct formatting of comments between a directive or doc and its node" + }, + { + "comment": "Fix: `tsp init` was not creating the `tspconfig.yaml` file for templates that specified it" + }, + { + "comment": "Fix: `tsp init` will create a placeholder `tspconfig.yaml` file for templates that don't specify an explicit one." + }, + { + "comment": "Fix `tsp init` was ignoring the `files` specified in an init template" + }, + { + "comment": "Fix: Language Server wasn't loading the `tspconfig.yaml` correctly resulting in some options being dropped like the linter configuration." + }, + { + "comment": "Fix: Allow `null` to be assigned as a default value" + }, + { + "comment": "Fix: Using `TypeSpec.Xyz` namespace shouldn't require the `TypeSpec Prefix`" + }, + { + "comment": "Skip emit of `deprecated` diagnostic for a type reference that is used in a deprecated declaration statement" + }, + { + "comment": "Update dependencies" + }, + { + "comment": "Remove `decorators` export, import decorators individually" + } + ], + "dependency": [ + { + "comment": "Updating dependency \"tmlanguage-generator\" from `~0.4.4` to `~0.4.5`" + } + ] + } + }, { "version": "0.48.1", "tag": "@typespec/compiler_v0.48.1", diff --git a/packages/compiler/CHANGELOG.md b/packages/compiler/CHANGELOG.md index e98b9ddcf1..f55ab7a102 100644 --- a/packages/compiler/CHANGELOG.md +++ b/packages/compiler/CHANGELOG.md @@ -1,6 +1,32 @@ # Change Log - @typespec/compiler -This log was last generated on Tue, 19 Sep 2023 19:28:32 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Handle hyphen in @param doc comment +- The `never` type is now assignable to all types +- Allow nullable types for constraint decorators(min/max value, length, etc) +- Add support for `@returns` and `@errors` doc comment tags. `@returns`(or `@returnsDoc` decorator) can be used to describe the success return types of an operation. `@errors`(or `@errorsDoc` decorator) can be used to describe the error return types of an operation. +- Fix: Colorization of line comment was bleeding over to the next line(s). +- Fix crash when using parenthesis on directives +- Fix: Assigning negative and 0 to float64 +- `tsp format` now returns a non-zero exit code when it fails to format a file +- Fix: Anonymous union variants were formatted with an extra leading `:` +- Formatter: Unions and Enums members are now formatted following the same rules as model properties. An extra line will be added between members if the member is annotated with a decorator, directive or doc comment. +- Fix: Correct formatting of comments between a directive or doc and its node +- Fix: `tsp init` was not creating the `tspconfig.yaml` file for templates that specified it +- Fix: `tsp init` will create a placeholder `tspconfig.yaml` file for templates that don't specify an explicit one. +- Fix `tsp init` was ignoring the `files` specified in an init template +- Fix: Language Server wasn't loading the `tspconfig.yaml` correctly resulting in some options being dropped like the linter configuration. +- Fix: Allow `null` to be assigned as a default value +- Fix: Using `TypeSpec.Xyz` namespace shouldn't require the `TypeSpec Prefix` +- Skip emit of `deprecated` diagnostic for a type reference that is used in a deprecated declaration statement +- Update dependencies +- Remove `decorators` export, import decorators individually ## 0.48.1 Tue, 19 Sep 2023 19:28:32 GMT diff --git a/packages/compiler/package.json b/packages/compiler/package.json index f9150b0932..fc38926b95 100644 --- a/packages/compiler/package.json +++ b/packages/compiler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/compiler", - "version": "0.48.1", + "version": "0.49.0", "description": "TypeSpec Compiler Preview", "author": "Microsoft Corporation", "license": "MIT", @@ -98,8 +98,8 @@ "@types/prompts": "~2.4.4", "@types/semver": "^7.5.2", "@types/yargs": "~17.0.24", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/internal-build-utils": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/internal-build-utils": "workspace:~0.49.0", "eslint": "^8.49.0", "grammarkdown": "~3.3.2", "mocha": "~10.2.0", @@ -109,7 +109,7 @@ "prettier-plugin-organize-imports": "~3.2.3", "source-map-support": "~0.5.21", "rimraf": "~5.0.1", - "tmlanguage-generator": "workspace:~0.4.4", + "tmlanguage-generator": "workspace:~0.4.5", "typescript": "~5.2.2", "vscode-oniguruma": "~2.0.1", "vscode-textmate": "~9.0.0", diff --git a/packages/eslint-config-typespec/CHANGELOG.json b/packages/eslint-config-typespec/CHANGELOG.json index b6fbcfe276..77671c05bc 100644 --- a/packages/eslint-config-typespec/CHANGELOG.json +++ b/packages/eslint-config-typespec/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/eslint-config-typespec", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/eslint-config-typespec_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/eslint-config-typespec_v0.48.0", diff --git a/packages/eslint-config-typespec/CHANGELOG.md b/packages/eslint-config-typespec/CHANGELOG.md index 393f9aa5d6..04ec8c0833 100644 --- a/packages/eslint-config-typespec/CHANGELOG.md +++ b/packages/eslint-config-typespec/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/eslint-config-typespec -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/eslint-config-typespec/package.json b/packages/eslint-config-typespec/package.json index e757582e80..2a3499512d 100644 --- a/packages/eslint-config-typespec/package.json +++ b/packages/eslint-config-typespec/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/eslint-config-typespec", - "version": "0.48.0", + "version": "0.49.0", "description": "ESLint config for typespec packages", "main": "index.js", "repository": { diff --git a/packages/eslint-plugin-typespec/CHANGELOG.json b/packages/eslint-plugin-typespec/CHANGELOG.json index 8b8ac0650c..e5932ecd43 100644 --- a/packages/eslint-plugin-typespec/CHANGELOG.json +++ b/packages/eslint-plugin-typespec/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/eslint-plugin", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/eslint-plugin_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/eslint-plugin_v0.48.0", diff --git a/packages/eslint-plugin-typespec/CHANGELOG.md b/packages/eslint-plugin-typespec/CHANGELOG.md index 1a620576d4..0e0c8c2af3 100644 --- a/packages/eslint-plugin-typespec/CHANGELOG.md +++ b/packages/eslint-plugin-typespec/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/eslint-plugin -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/eslint-plugin-typespec/package.json b/packages/eslint-plugin-typespec/package.json index 02d1109488..fb99048c50 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.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "Eslint plugin providing set of rules to be used in the JS/TS code of TypeSpec libraries", "homepage": "https://microsoft.github.io/typespec", @@ -41,7 +41,7 @@ "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", "@typescript-eslint/parser": "^6.2.1", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/html-program-viewer/CHANGELOG.json b/packages/html-program-viewer/CHANGELOG.json index 6a75ffb045..836a38129e 100644 --- a/packages/html-program-viewer/CHANGELOG.json +++ b/packages/html-program-viewer/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/html-program-viewer", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/html-program-viewer_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/html-program-viewer_v0.48.0", diff --git a/packages/html-program-viewer/CHANGELOG.md b/packages/html-program-viewer/CHANGELOG.md index 49609894bd..aa215e46de 100644 --- a/packages/html-program-viewer/CHANGELOG.md +++ b/packages/html-program-viewer/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/html-program-viewer -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/html-program-viewer/package.json b/packages/html-program-viewer/package.json index f8c116e342..1946a2beec 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.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting an html view of the program.", "homepage": "https://microsoft.github.io/typespec", @@ -51,7 +51,7 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.48.1" + "@typespec/compiler": "workspace:~0.49.0" }, "dependencies": { "prettier": "~3.0.3", @@ -65,8 +65,8 @@ "@types/node": "~18.11.9", "@types/react": "~18.2.22", "@types/react-dom": "~18.2.7", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", "@babel/core": "^7.22.20", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/http/CHANGELOG.json b/packages/http/CHANGELOG.json index a2ba38cd4d..70fa8ce82d 100644 --- a/packages/http/CHANGELOG.json +++ b/packages/http/CHANGELOG.json @@ -1,6 +1,27 @@ { "name": "@typespec/http", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/http_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Add support for `@returns` and `@errors` doc comment tags." + }, + { + "comment": "Add support for status code ranges for http responses. **Change to API** Http responses can now also return a `HttpStatusCodeRange` object for their status codes" + }, + { + "comment": "Emit error when multiple properties on a response model have the `@statusCode` decorator." + }, + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/http_v0.48.0", diff --git a/packages/http/CHANGELOG.md b/packages/http/CHANGELOG.md index 3f517659f9..392a1e7679 100644 --- a/packages/http/CHANGELOG.md +++ b/packages/http/CHANGELOG.md @@ -1,6 +1,16 @@ # Change Log - @typespec/http -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Add support for `@returns` and `@errors` doc comment tags. +- Add support for status code ranges for http responses. **Change to API** Http responses can now also return a `HttpStatusCodeRange` object for their status codes +- Emit error when multiple properties on a response model have the `@statusCode` decorator. +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/http/package.json b/packages/http/package.json index f242d7f413..7317572332 100644 --- a/packages/http/package.json +++ b/packages/http/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/http", - "version": "0.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "TypeSpec HTTP protocol binding", "homepage": "https://github.com/microsoft/typespec", @@ -53,15 +53,15 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.48.1" + "@typespec/compiler": "workspace:~0.49.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/library-linter": "workspace:~0.48.0", - "@typespec/eslint-plugin": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/library-linter": "workspace:~0.49.0", + "@typespec/eslint-plugin": "workspace:~0.49.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/internal-build-utils/CHANGELOG.json b/packages/internal-build-utils/CHANGELOG.json index 79bb42d995..3b6fe73430 100644 --- a/packages/internal-build-utils/CHANGELOG.json +++ b/packages/internal-build-utils/CHANGELOG.json @@ -1,6 +1,21 @@ { "name": "@typespec/internal-build-utils", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/internal-build-utils_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Handle bumping version of prerelease packages" + }, + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/internal-build-utils_v0.48.0", diff --git a/packages/internal-build-utils/CHANGELOG.md b/packages/internal-build-utils/CHANGELOG.md index 031b315cc5..cd15196657 100644 --- a/packages/internal-build-utils/CHANGELOG.md +++ b/packages/internal-build-utils/CHANGELOG.md @@ -1,6 +1,14 @@ # Change Log - @typespec/internal-build-utils -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Handle bumping version of prerelease packages +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/internal-build-utils/package.json b/packages/internal-build-utils/package.json index ae77cab172..604758d417 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.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "Internal library to TypeSpec providing helpers to build.", "homepage": "https://microsoft.github.io/typespec", @@ -48,7 +48,7 @@ "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", "@types/yargs": "~17.0.24", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", "@types/semver": "^7.5.2", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/json-schema/CHANGELOG.json b/packages/json-schema/CHANGELOG.json index 8aa6c512e9..84761e5642 100644 --- a/packages/json-schema/CHANGELOG.json +++ b/packages/json-schema/CHANGELOG.json @@ -1,6 +1,21 @@ { "name": "@typespec/json-schema", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/json-schema_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Update dependencies" + }, + { + "comment": "Disable folding of serialized yaml if line is above 80 characters" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/json-schema_v0.48.0", diff --git a/packages/json-schema/CHANGELOG.md b/packages/json-schema/CHANGELOG.md index fdc1d5f78f..39ee1f6867 100644 --- a/packages/json-schema/CHANGELOG.md +++ b/packages/json-schema/CHANGELOG.md @@ -1,6 +1,14 @@ # Change Log - @typespec/json-schema -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Update dependencies +- Disable folding of serialized yaml if line is above 80 characters ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/json-schema/package.json b/packages/json-schema/package.json index 77e0343d30..c267d259ad 100644 --- a/packages/json-schema/package.json +++ b/packages/json-schema/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/json-schema", - "version": "0.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting TypeSpec to JSON Schema and converting JSON Schema to TypeSpec", "homepage": "https://github.com/microsoft/typespec", @@ -43,15 +43,15 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.48.1" + "@typespec/compiler": "workspace:~0.49.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/library-linter": "workspace:~0.48.0", - "@typespec/eslint-plugin": "workspace:~0.48.0", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/library-linter": "workspace:~0.49.0", + "@typespec/eslint-plugin": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.49.0", "mocha": "~10.2.0", @@ -61,7 +61,7 @@ "rimraf": "~5.0.1", "typescript": "~5.2.2", "ajv": "~8.12.0", - "@typespec/internal-build-utils": "workspace:~0.48.0", + "@typespec/internal-build-utils": "workspace:~0.49.0", "ajv-formats": "~2.1.1" }, "dependencies": { diff --git a/packages/library-linter/CHANGELOG.json b/packages/library-linter/CHANGELOG.json index a7417cfae1..69472ac091 100644 --- a/packages/library-linter/CHANGELOG.json +++ b/packages/library-linter/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/library-linter", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/library-linter_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/library-linter_v0.48.0", diff --git a/packages/library-linter/CHANGELOG.md b/packages/library-linter/CHANGELOG.md index f303ef57a8..b886727325 100644 --- a/packages/library-linter/CHANGELOG.md +++ b/packages/library-linter/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/library-linter -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/library-linter/package.json b/packages/library-linter/package.json index 282ad3dff8..7163cae81f 100644 --- a/packages/library-linter/package.json +++ b/packages/library-linter/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/library-linter", - "version": "0.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "TypeSpec library for linting another library.", "homepage": "https://microsoft.github.io/typespec", @@ -51,13 +51,13 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.48.1" + "@typespec/compiler": "workspace:~0.49.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", "eslint": "^8.49.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.1", diff --git a/packages/lint/CHANGELOG.json b/packages/lint/CHANGELOG.json index 4afd156bb7..70f2498274 100644 --- a/packages/lint/CHANGELOG.json +++ b/packages/lint/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/lint", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/lint_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/lint_v0.48.0", diff --git a/packages/lint/CHANGELOG.md b/packages/lint/CHANGELOG.md index aec9c7b0bf..8e5471ce1f 100644 --- a/packages/lint/CHANGELOG.md +++ b/packages/lint/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/lint -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/lint/package.json b/packages/lint/package.json index e08c96e096..b54eaa1415 100644 --- a/packages/lint/package.json +++ b/packages/lint/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/lint", - "version": "0.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "**DEPRECATED** Use typespec built-in linter.", "homepage": "https://microsoft.github.io/typespec", @@ -50,14 +50,14 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.48.1" + "@typespec/compiler": "workspace:~0.49.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/eslint-plugin": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/eslint-plugin": "workspace:~0.49.0", "eslint": "^8.49.0", "mocha": "~10.2.0", "mocha-junit-reporter": "~2.2.1", diff --git a/packages/migrate/CHANGELOG.json b/packages/migrate/CHANGELOG.json index 57080fc01c..a1863890da 100644 --- a/packages/migrate/CHANGELOG.json +++ b/packages/migrate/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/migrate", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/migrate_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/migrate_v0.48.0", diff --git a/packages/migrate/CHANGELOG.md b/packages/migrate/CHANGELOG.md index c9e96c6ab0..cf0db53752 100644 --- a/packages/migrate/CHANGELOG.md +++ b/packages/migrate/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/migrate -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/migrate/package.json b/packages/migrate/package.json index 2f35ee5d11..d54fdbc797 100644 --- a/packages/migrate/package.json +++ b/packages/migrate/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/migrate", - "version": "0.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "Migration tool for typespec.", "homepage": "https://microsoft.github.io/typespec", @@ -38,7 +38,7 @@ "!dist/test/**" ], "dependencies": { - "@typespec/compiler": "workspace:~0.48.1", + "@typespec/compiler": "workspace:~0.49.0", "@typespec/compiler-v0.37": "npm:@cadl-lang/compiler@0.37.0", "@typespec/compiler-v0.38": "npm:@cadl-lang/compiler@0.38.5", "@typespec/compiler-v0.40": "npm:@cadl-lang/compiler@0.40.0", @@ -55,9 +55,9 @@ "@types/node": "~18.11.9", "@types/semver": "^7.5.2", "@types/yargs": "~17.0.24", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/eslint-plugin": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/eslint-plugin": "workspace:~0.49.0", "c8": "~8.0.1", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/openapi/CHANGELOG.json b/packages/openapi/CHANGELOG.json index 373ebf2fb9..4afc4cbf3e 100644 --- a/packages/openapi/CHANGELOG.json +++ b/packages/openapi/CHANGELOG.json @@ -1,6 +1,27 @@ { "name": "@typespec/openapi", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/openapi_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Removes `@typespec/rest` as a `peerDependency`. Relates to #2391" + }, + { + "comment": "Add support for http status code ranges" + }, + { + "comment": "Changed namespace from `OpenAPI` to `TypeSpec.OpenAPI`." + }, + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/openapi_v0.48.0", diff --git a/packages/openapi/CHANGELOG.md b/packages/openapi/CHANGELOG.md index b80c499db4..4e0967838f 100644 --- a/packages/openapi/CHANGELOG.md +++ b/packages/openapi/CHANGELOG.md @@ -1,6 +1,16 @@ # Change Log - @typespec/openapi -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Removes `@typespec/rest` as a `peerDependency`. Relates to #2391 +- Add support for http status code ranges +- Changed namespace from `OpenAPI` to `TypeSpec.OpenAPI`. +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/openapi/package.json b/packages/openapi/package.json index d76078aef8..4eb69894c1 100644 --- a/packages/openapi/package.json +++ b/packages/openapi/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi", - "version": "0.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "TypeSpec library providing OpenAPI concepts", "homepage": "https://microsoft.github.io/typespec", @@ -53,18 +53,18 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/http": "workspace:~0.48.0" + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/http": "workspace:~0.49.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/http": "workspace:~0.48.0", - "@typespec/rest": "workspace:~0.48.0", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/library-linter": "workspace:~0.48.0", - "@typespec/eslint-plugin": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/http": "workspace:~0.49.0", + "@typespec/rest": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/library-linter": "workspace:~0.49.0", + "@typespec/eslint-plugin": "workspace:~0.49.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/openapi3/CHANGELOG.json b/packages/openapi3/CHANGELOG.json index 626d650a69..05724cc9e2 100644 --- a/packages/openapi3/CHANGELOG.json +++ b/packages/openapi3/CHANGELOG.json @@ -1,6 +1,57 @@ { "name": "@typespec/openapi3", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/openapi3_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Removes `@typespec/rest` as a `peerDependency`. Relates to #2391" + }, + { + "comment": "Add support for constraints on unions" + }, + { + "comment": "Add support for `@returns` and `@errors` doc comment tags." + }, + { + "comment": "Add support for http status code ranges" + }, + { + "comment": "Fix: Correctly generate discriminated union mapping property with multiple visibilities involved" + }, + { + "comment": "Fix: Crash when assigning a numeric default to a union" + }, + { + "comment": "Fix: Using format `ssv` or `pipes` in `@header` produced an invalid OpenAPI3 schema. It will now change the type to string and ignore the format as well as logging a warning." + }, + { + "comment": "Fix: Use `null` as a default" + }, + { + "comment": "Allow use of `@oneOf` on model properties" + }, + { + "comment": "Fix `OpenAPI` namespace to be `TypeSpec.OpenAPI`." + }, + { + "comment": "Fix issue with CSV format representation." + }, + { + "comment": "Fix issue where openAPI3 for shared routes incorrectly output a statusCode field." + }, + { + "comment": "Update dependencies" + }, + { + "comment": "Disable folding of serialized yaml if line is above 80 characters" + } + ] + } + }, { "version": "0.48.1", "tag": "@typespec/openapi3_v0.48.1", diff --git a/packages/openapi3/CHANGELOG.md b/packages/openapi3/CHANGELOG.md index 876733206c..1980574efb 100644 --- a/packages/openapi3/CHANGELOG.md +++ b/packages/openapi3/CHANGELOG.md @@ -1,6 +1,26 @@ # Change Log - @typespec/openapi3 -This log was last generated on Tue, 19 Sep 2023 19:28:32 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Removes `@typespec/rest` as a `peerDependency`. Relates to #2391 +- Add support for constraints on unions +- Add support for `@returns` and `@errors` doc comment tags. +- Add support for http status code ranges +- Fix: Correctly generate discriminated union mapping property with multiple visibilities involved +- Fix: Crash when assigning a numeric default to a union +- Fix: Using format `ssv` or `pipes` in `@header` produced an invalid OpenAPI3 schema. It will now change the type to string and ignore the format as well as logging a warning. +- Fix: Use `null` as a default +- Allow use of `@oneOf` on model properties +- Fix `OpenAPI` namespace to be `TypeSpec.OpenAPI`. +- Fix issue with CSV format representation. +- Fix issue where openAPI3 for shared routes incorrectly output a statusCode field. +- Update dependencies +- Disable folding of serialized yaml if line is above 80 characters ## 0.48.1 Tue, 19 Sep 2023 19:28:32 GMT diff --git a/packages/openapi3/package.json b/packages/openapi3/package.json index a54f5179ff..092e95b3ad 100644 --- a/packages/openapi3/package.json +++ b/packages/openapi3/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi3", - "version": "0.48.1", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding", "homepage": "https://microsoft.github.io/typespec", @@ -56,22 +56,22 @@ "yaml": "~2.3.2" }, "peerDependencies": { - "@typespec/versioning": "workspace:~0.48.0", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/http": "workspace:~0.48.0", - "@typespec/openapi": "workspace:~0.48.0" + "@typespec/versioning": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/http": "workspace:~0.49.0", + "@typespec/openapi": "workspace:~0.49.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/http": "workspace:~0.48.0", - "@typespec/rest": "workspace:~0.48.0", - "@typespec/openapi": "workspace:~0.48.0", - "@typespec/versioning": "workspace:~0.48.0", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/library-linter": "workspace:~0.48.0", - "@typespec/eslint-plugin": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/http": "workspace:~0.49.0", + "@typespec/rest": "workspace:~0.49.0", + "@typespec/openapi": "workspace:~0.49.0", + "@typespec/versioning": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/library-linter": "workspace:~0.49.0", + "@typespec/eslint-plugin": "workspace:~0.49.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/playground-website/package.json b/packages/playground-website/package.json index 35e1158bec..8b320e09d6 100644 --- a/packages/playground-website/package.json +++ b/packages/playground-website/package.json @@ -41,16 +41,16 @@ "!dist/test/**" ], "dependencies": { - "@typespec/playground": "workspace:~0.1.0-alpha.1", - "@typespec/versioning": "workspace:~0.48.0", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/http": "workspace:~0.48.0", - "@typespec/rest": "workspace:~0.48.0", - "@typespec/openapi3": "workspace:~0.48.1", - "@typespec/json-schema": "workspace:~0.48.0", - "@typespec/openapi": "workspace:~0.48.0", - "@typespec/protobuf": "workspace:~0.48.0", - "@typespec/html-program-viewer": "workspace:~0.48.0", + "@typespec/playground": "workspace:~0.1.0-alpha.2", + "@typespec/versioning": "workspace:~0.49.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/http": "workspace:~0.49.0", + "@typespec/rest": "workspace:~0.49.0", + "@typespec/openapi3": "workspace:~0.49.0", + "@typespec/json-schema": "workspace:~0.49.0", + "@typespec/openapi": "workspace:~0.49.0", + "@typespec/protobuf": "workspace:~0.49.0", + "@typespec/html-program-viewer": "workspace:~0.49.0", "@emotion/react": "^11.11.1", "react-dom": "~18.2.0", "react": "~18.2.0" @@ -65,7 +65,7 @@ "@types/react": "~18.2.22", "@types/swagger-ui-react": "^4.18.0", "@types/swagger-ui": "~3.52.0", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", "@vitejs/plugin-react": "~4.0.4", "c8": "~8.0.1", "cross-env": "~7.0.3", diff --git a/packages/playground/package.json b/packages/playground/package.json index 9f7159ee34..94dca04cea 100644 --- a/packages/playground/package.json +++ b/packages/playground/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/playground", - "version": "0.1.0-alpha.1", + "version": "0.1.0-alpha.2", "author": "Microsoft Corporation", "description": "TypeSpec playground UI components.", "homepage": "https://microsoft.github.io/typespec", @@ -50,14 +50,14 @@ "@emotion/react": "^11.11.1", "@fluentui/react-components": "~9.32.1", "@fluentui/react-icons": "~2.0.217", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/html-program-viewer": "workspace:~0.48.0", - "@typespec/http": "workspace:~0.48.0", - "@typespec/openapi": "workspace:~0.48.0", - "@typespec/openapi3": "workspace:~0.48.1", - "@typespec/protobuf": "workspace:~0.48.0", - "@typespec/rest": "workspace:~0.48.0", - "@typespec/versioning": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/html-program-viewer": "workspace:~0.49.0", + "@typespec/http": "workspace:~0.49.0", + "@typespec/openapi": "workspace:~0.49.0", + "@typespec/openapi3": "workspace:~0.49.0", + "@typespec/protobuf": "workspace:~0.49.0", + "@typespec/rest": "workspace:~0.49.0", + "@typespec/versioning": "workspace:~0.49.0", "debounce": "~1.2.1", "lzutf8": "0.6.3", "monaco-editor": "~0.43.0", @@ -77,8 +77,8 @@ "@types/react": "~18.2.22", "@types/swagger-ui-react": "^4.18.0", "@types/swagger-ui": "~3.52.0", - "@typespec/bundler": "workspace:~0.1.0-alpha.0", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/bundler": "workspace:~0.1.0-alpha.2", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", "@vitejs/plugin-react": "~4.0.4", "c8": "~8.0.1", "cross-env": "~7.0.3", diff --git a/packages/prettier-plugin-typespec/CHANGELOG.json b/packages/prettier-plugin-typespec/CHANGELOG.json index a4fa0dc0d7..f3715a0b58 100644 --- a/packages/prettier-plugin-typespec/CHANGELOG.json +++ b/packages/prettier-plugin-typespec/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@typespec/prettier-plugin-typespec", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/prettier-plugin-typespec_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/prettier-plugin-typespec_v0.48.0", diff --git a/packages/prettier-plugin-typespec/CHANGELOG.md b/packages/prettier-plugin-typespec/CHANGELOG.md index 5455ad6fae..da85d8fce8 100644 --- a/packages/prettier-plugin-typespec/CHANGELOG.md +++ b/packages/prettier-plugin-typespec/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @typespec/prettier-plugin-typespec -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/prettier-plugin-typespec/package.json b/packages/prettier-plugin-typespec/package.json index 0782753147..55834088f3 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.48.0", + "version": "0.49.0", "description": "", "main": "dist/index.js", "scripts": { @@ -16,8 +16,8 @@ }, "devDependencies": { "prettier_2": "npm:prettier@2.8.7", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/internal-build-utils": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/internal-build-utils": "workspace:~0.49.0", "@rollup/plugin-commonjs": "~25.0.4", "@rollup/plugin-json": "~6.0.0", "@rollup/plugin-node-resolve": "~15.2.1", diff --git a/packages/protobuf/CHANGELOG.json b/packages/protobuf/CHANGELOG.json index d294bc1eb9..8518e90a09 100644 --- a/packages/protobuf/CHANGELOG.json +++ b/packages/protobuf/CHANGELOG.json @@ -1,6 +1,21 @@ { "name": "@typespec/protobuf", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/protobuf_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Added support for emitting documentation comments in protobuf specifications." + }, + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/protobuf_v0.48.0", diff --git a/packages/protobuf/CHANGELOG.md b/packages/protobuf/CHANGELOG.md index 5e0823c463..d55afd7513 100644 --- a/packages/protobuf/CHANGELOG.md +++ b/packages/protobuf/CHANGELOG.md @@ -1,6 +1,14 @@ # Change Log - @typespec/protobuf -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Added support for emitting documentation comments in protobuf specifications. +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/protobuf/package.json b/packages/protobuf/package.json index 9e38b605f5..34a336a835 100644 --- a/packages/protobuf/package.json +++ b/packages/protobuf/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/protobuf", - "version": "0.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "TypeSpec library and emitter for Protobuf (gRPC)", "homepage": "https://github.com/microsoft/typespec", @@ -32,12 +32,12 @@ "regen-docs": "tspd doc . --enable-experimental --output-dir ../../docs/standard-library/protobuf/reference" }, "peerDependencies": { - "@typespec/compiler": "workspace:~0.48.1" + "@typespec/compiler": "workspace:~0.49.0" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/eslint-plugin": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/eslint-plugin": "workspace:~0.49.0", "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", "@typespec/tspd": "workspace:~0.46.0", diff --git a/packages/rest/CHANGELOG.json b/packages/rest/CHANGELOG.json index 9a1c5b3a28..bbcfbbf10d 100644 --- a/packages/rest/CHANGELOG.json +++ b/packages/rest/CHANGELOG.json @@ -1,6 +1,24 @@ { "name": "@typespec/rest", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/rest_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Correct rest → http peer dependency. Fixes #2391" + }, + { + "comment": "Fix: `@key` can now appear on the base model of a resource." + }, + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/rest_v0.48.0", diff --git a/packages/rest/CHANGELOG.md b/packages/rest/CHANGELOG.md index abdc515cad..8f0654099a 100644 --- a/packages/rest/CHANGELOG.md +++ b/packages/rest/CHANGELOG.md @@ -1,6 +1,15 @@ # Change Log - @typespec/rest -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Correct rest → http peer dependency. Fixes #2391 +- Fix: `@key` can now appear on the base model of a resource. +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/rest/package.json b/packages/rest/package.json index 2f46840e02..0ecb6ace7e 100644 --- a/packages/rest/package.json +++ b/packages/rest/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/rest", - "version": "0.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "TypeSpec REST protocol binding", "homepage": "https://microsoft.github.io/typespec", @@ -53,17 +53,17 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/http": "workspace:~0.48.0" + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/http": "workspace:~0.49.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/http": "workspace:~0.48.0", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/library-linter": "workspace:~0.48.0", - "@typespec/eslint-plugin": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/http": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/library-linter": "workspace:~0.49.0", + "@typespec/eslint-plugin": "workspace:~0.49.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/samples/package.json b/packages/samples/package.json index f8d6de521d..fcd8901ddc 100644 --- a/packages/samples/package.json +++ b/packages/samples/package.json @@ -44,20 +44,20 @@ ], "dependencies": { "@typespec/best-practices": "workspace:~0.45.0", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/html-program-viewer": "workspace:~0.48.0", - "@typespec/http": "workspace:~0.48.0", - "@typespec/json-schema": "workspace:~0.48.0", - "@typespec/openapi": "workspace:~0.48.0", - "@typespec/openapi3": "workspace:~0.48.1", - "@typespec/rest": "workspace:~0.48.0", - "@typespec/versioning": "workspace:~0.48.0" + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/html-program-viewer": "workspace:~0.49.0", + "@typespec/http": "workspace:~0.49.0", + "@typespec/json-schema": "workspace:~0.49.0", + "@typespec/openapi": "workspace:~0.49.0", + "@typespec/openapi3": "workspace:~0.49.0", + "@typespec/rest": "workspace:~0.49.0", + "@typespec/versioning": "workspace:~0.49.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/internal-build-utils": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/internal-build-utils": "workspace:~0.49.0", "autorest": "~3.3.2", "cross-env": "~7.0.3", "eslint": "^8.49.0", diff --git a/packages/spec/package.json b/packages/spec/package.json index b63a69591c..db411f20a3 100644 --- a/packages/spec/package.json +++ b/packages/spec/package.json @@ -22,6 +22,6 @@ "devDependencies": { "@types/node": "~18.11.9", "ecmarkup": "~12.0.3", - "@typespec/internal-build-utils": "workspace:~0.48.0" + "@typespec/internal-build-utils": "workspace:~0.49.0" } } diff --git a/packages/tmlanguage-generator/CHANGELOG.json b/packages/tmlanguage-generator/CHANGELOG.json index acc83811fb..46ed718af9 100644 --- a/packages/tmlanguage-generator/CHANGELOG.json +++ b/packages/tmlanguage-generator/CHANGELOG.json @@ -1,6 +1,23 @@ { "name": "tmlanguage-generator", "entries": [ + { + "version": "0.4.5", + "tag": "tmlanguage-generator_v0.4.5", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "dependency": [ + { + "comment": "Dependency @typespec/eslint-config-typespec version bump from workspace:~0.48.0 to workspace:~0.49.0." + } + ], + "none": [ + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.4.4", "tag": "tmlanguage-generator_v0.4.4", diff --git a/packages/tmlanguage-generator/CHANGELOG.md b/packages/tmlanguage-generator/CHANGELOG.md index 5cf0c1e1c9..cba4c5c538 100644 --- a/packages/tmlanguage-generator/CHANGELOG.md +++ b/packages/tmlanguage-generator/CHANGELOG.md @@ -1,6 +1,11 @@ # Change Log - tmlanguage-generator -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.4.5 +Wed, 11 Oct 2023 23:31:35 GMT + +_Version update only_ ## 0.4.4 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/tmlanguage-generator/package.json b/packages/tmlanguage-generator/package.json index bd2a6d3ba1..6298f0bd5f 100644 --- a/packages/tmlanguage-generator/package.json +++ b/packages/tmlanguage-generator/package.json @@ -1,6 +1,6 @@ { "name": "tmlanguage-generator", - "version": "0.4.4", + "version": "0.4.5", "author": "Microsoft Corporation", "description": "Helper library to generate TextMate syntax highlighting tmLanguage files.", "homepage": "https://github.com/microsoft/typespec/tree/master/packages/tmlanguage-generator", @@ -39,7 +39,7 @@ "devDependencies": { "@types/node": "~18.11.9", "@types/plist": "~3.0.2", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", "eslint": "^8.49.0", "rimraf": "~5.0.1", "typescript": "~5.2.2" diff --git a/packages/tspd/package.json b/packages/tspd/package.json index fd9eef72fc..d7b9ff1fb5 100644 --- a/packages/tspd/package.json +++ b/packages/tspd/package.json @@ -53,16 +53,16 @@ "!dist/test/**" ], "dependencies": { - "@typespec/compiler": "workspace:~0.48.1", + "@typespec/compiler": "workspace:~0.49.0", "yaml": "~2.3.2", "prettier": "~3.0.3", "picocolors": "~1.0.0", "yargs": "~17.7.2" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/prettier-plugin-typespec": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/prettier-plugin-typespec": "workspace:~0.49.0", "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", "@types/yargs": "~17.0.24", diff --git a/packages/typespec-vs/CHANGELOG.json b/packages/typespec-vs/CHANGELOG.json index 2fa2271cf0..a2c2addd10 100644 --- a/packages/typespec-vs/CHANGELOG.json +++ b/packages/typespec-vs/CHANGELOG.json @@ -1,6 +1,12 @@ { "name": "typespec-vs", "entries": [ + { + "version": "0.49.0", + "tag": "typespec-vs_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": {} + }, { "version": "0.48.0", "tag": "typespec-vs_v0.48.0", diff --git a/packages/typespec-vs/CHANGELOG.md b/packages/typespec-vs/CHANGELOG.md index f3b5920816..6ffc47a692 100644 --- a/packages/typespec-vs/CHANGELOG.md +++ b/packages/typespec-vs/CHANGELOG.md @@ -1,6 +1,11 @@ # Change Log - typespec-vs -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +_Version update only_ ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/typespec-vs/package.json b/packages/typespec-vs/package.json index 656f3f1685..39fab28402 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.48.0", + "version": "0.49.0", "description": "TypeSpec Language Support for Visual Studio", "homepage": "https://microsoft.github.io/typespec", "readme": "https://github.com/microsoft/typespec/blob/master/README.md", @@ -27,7 +27,7 @@ "build": "node scripts/build.js" }, "devDependencies": { - "typespec-vscode": "workspace:~0.48.0", - "@typespec/internal-build-utils": "workspace:~0.48.0" + "typespec-vscode": "workspace:~0.49.0", + "@typespec/internal-build-utils": "workspace:~0.49.0" } } diff --git a/packages/typespec-vscode/CHANGELOG.json b/packages/typespec-vscode/CHANGELOG.json index 0a212277e6..bb36e48426 100644 --- a/packages/typespec-vscode/CHANGELOG.json +++ b/packages/typespec-vscode/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "typespec-vscode", "entries": [ + { + "version": "0.49.0", + "tag": "typespec-vscode_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Update dependencies" + } + ] + } + }, { "version": "0.48.0", "tag": "typespec-vscode_v0.48.0", diff --git a/packages/typespec-vscode/CHANGELOG.md b/packages/typespec-vscode/CHANGELOG.md index 5e1bf6426a..beaab73579 100644 --- a/packages/typespec-vscode/CHANGELOG.md +++ b/packages/typespec-vscode/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - typespec-vscode -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Update dependencies ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/typespec-vscode/package.json b/packages/typespec-vscode/package.json index 2183cfa1b4..0e8fd699d6 100644 --- a/packages/typespec-vscode/package.json +++ b/packages/typespec-vscode/package.json @@ -1,6 +1,6 @@ { "name": "typespec-vscode", - "version": "0.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "TypeSpec Language Support for VS Code", "homepage": "https://microsoft.github.io/typespec", @@ -123,9 +123,9 @@ "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", "@types/vscode": "~1.82.0", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/internal-build-utils": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/internal-build-utils": "workspace:~0.49.0", "eslint": "^8.49.0", "c8": "~8.0.1", "mocha": "~10.2.0", diff --git a/packages/versioning/CHANGELOG.json b/packages/versioning/CHANGELOG.json index 3adc79810d..8a98cea41e 100644 --- a/packages/versioning/CHANGELOG.json +++ b/packages/versioning/CHANGELOG.json @@ -1,6 +1,21 @@ { "name": "@typespec/versioning", "entries": [ + { + "version": "0.49.0", + "tag": "@typespec/versioning_v0.49.0", + "date": "Wed, 11 Oct 2023 23:31:35 GMT", + "comments": { + "none": [ + { + "comment": "Update dependencies" + }, + { + "comment": "Ensure that use of `@renamedFrom` does not result in duplicate properties on a model." + } + ] + } + }, { "version": "0.48.0", "tag": "@typespec/versioning_v0.48.0", diff --git a/packages/versioning/CHANGELOG.md b/packages/versioning/CHANGELOG.md index 17361671d4..2f64003bae 100644 --- a/packages/versioning/CHANGELOG.md +++ b/packages/versioning/CHANGELOG.md @@ -1,6 +1,14 @@ # Change Log - @typespec/versioning -This log was last generated on Tue, 12 Sep 2023 21:47:11 GMT and should not be manually modified. +This log was last generated on Wed, 11 Oct 2023 23:31:35 GMT and should not be manually modified. + +## 0.49.0 +Wed, 11 Oct 2023 23:31:35 GMT + +### Updates + +- Update dependencies +- Ensure that use of `@renamedFrom` does not result in duplicate properties on a model. ## 0.48.0 Tue, 12 Sep 2023 21:47:11 GMT diff --git a/packages/versioning/package.json b/packages/versioning/package.json index 4e520967ec..de6954105a 100644 --- a/packages/versioning/package.json +++ b/packages/versioning/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/versioning", - "version": "0.48.0", + "version": "0.49.0", "author": "Microsoft Corporation", "description": "TypeSpec library for declaring and emitting versioned APIs", "homepage": "https://microsoft.github.io/typespec", @@ -53,15 +53,15 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.48.1" + "@typespec/compiler": "workspace:~0.49.0" }, "devDependencies": { "@types/mocha": "~10.0.1", "@types/node": "~18.11.9", - "@typespec/compiler": "workspace:~0.48.1", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", - "@typespec/library-linter": "workspace:~0.48.0", - "@typespec/eslint-plugin": "workspace:~0.48.0", + "@typespec/compiler": "workspace:~0.49.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", + "@typespec/library-linter": "workspace:~0.49.0", + "@typespec/eslint-plugin": "workspace:~0.49.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.49.0", "mocha": "~10.2.0", diff --git a/packages/website/package.json b/packages/website/package.json index 23cbd5cf72..a0608b1c89 100644 --- a/packages/website/package.json +++ b/packages/website/package.json @@ -33,16 +33,16 @@ }, "devDependencies": { "@swc/core": "^1.3.62", - "@typespec/compiler": "workspace:~0.48.1", + "@typespec/compiler": "workspace:~0.49.0", "@typespec/tspd": "workspace:~0.46.0", "@typespec/spec": "workspace:*", - "@typespec/http": "workspace:~0.48.0", - "@typespec/rest": "workspace:~0.48.0", - "@typespec/openapi": "workspace:~0.48.0", - "@typespec/openapi3": "workspace:~0.48.1", - "@typespec/protobuf": "workspace:~0.48.0", - "@typespec/versioning": "workspace:~0.48.0", - "@typespec/json-schema": "workspace:~0.48.0", + "@typespec/http": "workspace:~0.49.0", + "@typespec/rest": "workspace:~0.49.0", + "@typespec/openapi": "workspace:~0.49.0", + "@typespec/openapi3": "workspace:~0.49.0", + "@typespec/protobuf": "workspace:~0.49.0", + "@typespec/versioning": "workspace:~0.49.0", + "@typespec/json-schema": "workspace:~0.49.0", "@docusaurus/module-type-aliases": "^2.4.3", "@docusaurus/types": "^2.4.3", "@tsconfig/docusaurus": "^2.0.1", @@ -52,7 +52,7 @@ "playwright": "~1.32.2", "mermaid": "~10.4.0", "mdx-mermaid": "2.0.0", - "@typespec/eslint-config-typespec": "workspace:~0.48.0", + "@typespec/eslint-config-typespec": "workspace:~0.49.0", "eslint": "^8.49.0", "rimraf": "~5.0.1", "dotenv": "~16.3.1", diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$onEmit.md b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.$onEmit.md similarity index 62% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$onEmit.md rename to packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.$onEmit.md index 760ef20341..39def7970f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$onEmit.md +++ b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.$onEmit.md @@ -11,7 +11,7 @@ $onEmit(context): Promise< void > | Parameter | Type | | :------ | :------ | -| `context` | `EmitContext`< [`JSONSchemaEmitterOptions`](Interface.JSONSchemaEmitterOptions.md) \> | +| `context` | `EmitContext`< [`CSharpServiceEmitterOptions`](Interface.CSharpServiceEmitterOptions.md) \> | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.getTracer.md b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.getTracer.md new file mode 100644 index 0000000000..11ca56f1d4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.getTracer.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getTracer" + +--- +```ts +getTracer(program): Tracer +``` + +Returns a tracer scopped to the current library. +All trace area logged via this tracer will be prefixed with the library name. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | + +## Returns + +`Tracer` diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.reportDiagnostic.md b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.reportDiagnostic.md new file mode 100644 index 0000000000..1a568f8c0c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Function.reportDiagnostic.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[F] reportDiagnostic" + +--- +```ts +reportDiagnostic(program, diag): void +``` + +## Type parameters + +| Parameter | +| :------ | +| `C` *extends* `"invalid-identifier"` \| `"missing-type-parent"` \| `"no-numeric"` \| `"unrecognized-scalar"` | +| `M` *extends* `string` \| `number` \| `symbol` | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `diag` | `DiagnosticReport`< `Object`, `C`, `M` \> | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Interface.CSharpServiceEmitterOptions.md b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Interface.CSharpServiceEmitterOptions.md new file mode 100644 index 0000000000..e6f9b83ada --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Interface.CSharpServiceEmitterOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] CSharpServiceEmitterOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `skip-format?` | `boolean` | Skip formatting of output. Default is false (generated c-sharp files are formatted) | diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Variable.$lib.md b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Variable.$lib.md new file mode 100644 index 0000000000..ab9320c49a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/Variable.$lib.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] $lib" + +--- +```ts +const $lib: TypeSpecLibrary< Object, CSharpServiceEmitterOptions > +``` diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/_category_.json b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/_category_.json new file mode 100644 index 0000000000..eb101a8378 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/_category_.json @@ -0,0 +1 @@ +{"label":"JS Api","link":{"type":"doc","id":"index"}} \ No newline at end of file diff --git a/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/index.md new file mode 100644 index 0000000000..2f50409098 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/service-generator-csharp/reference/js-api/index.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[P] JS Api" + +--- +## Interfaces + +- [CSharpServiceEmitterOptions](Interface.CSharpServiceEmitterOptions.md) + +## Variables + +- [$lib](Variable.$lib.md) + +## Functions + +- [$onEmit](Function.$onEmit.md) +- [getTracer](Function.getTracer.md) +- [reportDiagnostic](Function.reportDiagnostic.md) diff --git a/packages/website/versioned_docs/version-latest/extending-typespec/basics.md b/packages/website/versioned_docs/version-latest/extending-typespec/basics.md index 71e9b91d07..da9bfd2a5b 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/basics.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/basics.md @@ -85,17 +85,23 @@ This will create `tsconfig.json`. But we need to make a couple changes to this. ### 4. Create `lib.ts` -Open `./src/lib.ts` and create your library definition that registers your library with the TypeSpec compiler and defines any diagnostics your library will emit. The following shows an example: +Open `./src/lib.ts` and create your library definition that registers your library with the TypeSpec compiler and defines any diagnostics your library will emit. Make sure to export the library definition as `$lib`. + +:::warn +If `$lib` is not accessible from your library package (`import {$lib} from "my-library";`) some functionality will be unavailable like validation of emitter options, linter rules, etc. +::: + +The following shows an example: ```typescript import { createTypeSpecLibrary } from "@typespec/compiler"; -export const myLibrary = createTypeSpecLibrary({ +export const $lib = createTypeSpecLibrary({ name: "myLibrary", diagnostics: {}, -}); +} as const); -// optional but convenient +// Optional but convenient, those are meant to be used locally in your library. export const { reportDiagnostic, createDiagnostic, createStateSymbol } = myLibrary; ``` @@ -105,9 +111,9 @@ Diagnostics are used for linters and decorators which are covered in subsequent Open `./src/index.ts` and import your library definition: - ```typescript -import { myLibrary } from "./lib.js"; +// Re-export $lib to the compiler can get access to it and register your library correctly. +export { $lib } from "./lib.js"; ``` ### 6. Build TypeScript diff --git a/packages/website/versioned_docs/version-latest/extending-typespec/diagnostics.md b/packages/website/versioned_docs/version-latest/extending-typespec/diagnostics.md index 332a1950ab..ef67bd7aa0 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/diagnostics.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/diagnostics.md @@ -1,4 +1,6 @@ -# Diagnostics +--- +title: Diagnostics +--- TypeSpec compiler report errors and warnings in the spec using the diagnostic API. diff --git a/packages/website/versioned_docs/version-latest/extending-typespec/emitter-metadata-handling.md b/packages/website/versioned_docs/version-latest/extending-typespec/emitter-metadata-handling.md index 89383ee24e..e06e888323 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/emitter-metadata-handling.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/emitter-metadata-handling.md @@ -23,16 +23,16 @@ However, if your emitter does want to split types as OpenAPI does, then it will These are the main API involved in handling these features. See the linked API reference documentation for more details. -- [`getRequestVisibility(HttpVerb): Visibility`](../standard-library/http/reference/js-api/index.md#getrequestvisibility) - Use this to determine the visibility implied for data in the request parameters or body. Also note that [`Visibility.Read`](../standard-library/http/reference/js-api/Enumeration.Visibility.md#item) is always applied for response data and therefore there is no corresponding API for the response. +- [`getRequestVisibility(HttpVerb): Visibility`](../standard-library/http/reference/js-api/index.md#getrequestvisibility) - Use this to determine the visibility implied for data in the request parameters or body. Also note that [`Visibility.Read`](../standard-library/http/reference/js-api/enumerations/Visibility.md#item) is always applied for response data and therefore there is no corresponding API for the response. -- [`MetadataInfo`](../standard-library/http/reference/js-api/Interface.MetadataInfo.md) - Create this once for each program using [`createMetadataInfo(Program, MetadataInfoOptions)`](../standard-library/http/reference/js-api/index.md#createmetadatainfo) then use it to reason about metadata and visibility implications with the API below. +- [`MetadataInfo`](../standard-library/http/reference/js-api/interfaces/MetadataInfo.md) - Create this once for each program using [`createMetadataInfo(Program, MetadataInfoOptions)`](../standard-library/http/reference/js-api/index.md#createmetadatainfo) then use it to reason about metadata and visibility implications with the API below. -- [`MetadataInfo.getEffectivePayloadType(Type, Visibility): Type`](../standard-library/http/reference/js-api/Interface.MetadataInfo.md#geteffectivepayloadtype) - Use this recursively on every type that is referenced. When given an anonymous model sourced entirely from a single named model after metadata is moved elsewhere or invisible properties are removed, it will recover the named model. This handles the commonly discussed case of seeing that `op something(...Thing)` receives a `Thing` in its request body, but also many other cases.. +- [`MetadataInfo.getEffectivePayloadType(Type, Visibility): Type`](../standard-library/http/reference/js-api/interfaces/MetadataInfo.md#geteffectivepayloadtype) - Use this recursively on every type that is referenced. When given an anonymous model sourced entirely from a single named model after metadata is moved elsewhere or invisible properties are removed, it will recover the named model. This handles the commonly discussed case of seeing that `op something(...Thing)` receives a `Thing` in its request body, but also many other cases.. -- [`MetadataInfo.isTransformed(Model, Visibility)`](../standard-library/http/reference/js-api/Interface.MetadataInfo.md#istransformed) - Use this to check if a type undergoes any changes in shape due to visibility or metadata. If not, this can allow for simplifications in emit. +- [`MetadataInfo.isTransformed(Model, Visibility)`](../standard-library/http/reference/js-api/interfaces/MetadataInfo.md#istransformed) - Use this to check if a type undergoes any changes in shape due to visibility or metadata. If not, this can allow for simplifications in emit. -- [`MetadataInfo.isPayloadProperty(ModelProperty, Visibility): boolean`](../standard-library/http/reference/js-api/Interface.MetadataInfo.md#ispayloadproperty) - Use this to check if a property is transmitted as an object property in the payload and is not invisible or metadata sent elsewhere. +- [`MetadataInfo.isPayloadProperty(ModelProperty, Visibility): boolean`](../standard-library/http/reference/js-api/interfaces/MetadataInfo.md#ispayloadproperty) - Use this to check if a property is transmitted as an object property in the payload and is not invisible or metadata sent elsewhere. -- [`MetadataInfo.isOptional(ModelProperty, Visibility): boolean`](../standard-library/http/reference/js-api/Interface.MetadataInfo.md#isoptional) - Use this to determine if a property is optional for the given visibility. This will differ from `ModelProperty.isOptional` when the Visibility is Update in which case the property is always considered optional. +- [`MetadataInfo.isOptional(ModelProperty, Visibility): boolean`](../standard-library/http/reference/js-api/interfaces/MetadataInfo.md#isoptional) - Use this to determine if a property is optional for the given visibility. This will differ from `ModelProperty.isOptional` when the Visibility is Update in which case the property is always considered optional. -- [`Visibility.Item`](../standard-library/http/reference/js-api/Enumeration.Visibility#item) - Add this flag when recursing into an array. This moves all metadata into the payload, which can be useful in scenarios like batching API calls. +- [`Visibility.Item`](../standard-library/http/reference/js-api/enumerations/Visibility.md#item) - Add this flag when recursing into an array. This moves all metadata into the payload, which can be useful in scenarios like batching API calls. diff --git a/packages/website/versioned_docs/version-latest/extending-typespec/linters.md b/packages/website/versioned_docs/version-latest/extending-typespec/linters.md index 0b43107349..c60191409b 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/linters.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/linters.md @@ -109,14 +109,14 @@ export const $lib = createTypeSpecLibrary({ ruleSets: { recommended: { // (optional) A ruleset takes a map of rules to explicitly enable - enable: { [`@typespec/my-linter:${requiredDocRule.name}`]: true }, + enable: { [`@typespec/my-linter/${requiredDocRule.name}`]: true }, // (optional) A rule set can extend another rule set - extends: ["@typespec/best-practices:recommended"], + extends: ["@typespec/best-practices/recommended"], // (optional) A rule set can disable a rule enabled in a ruleset it extended. disable: { - "`@typespec/best-practices:no-a": "This doesn't apply in this ruleset.", + "`@typespec/best-practices/no-a": "This doesn't apply in this ruleset.", }, }, }, @@ -124,7 +124,7 @@ export const $lib = createTypeSpecLibrary({ }); ``` -When referencing a rule or ruleset(in `enable`, `extends`, `disable`) the rule or rule set id must be used which in this format: `:` +When referencing a rule or ruleset(in `enable`, `extends`, `disable`) the rule or rule set id must be used which in this format: `/` ## Testing a linter @@ -147,7 +147,7 @@ describe("required-doc rule", () => { it("emit diagnostics when using model named foo", async () => { await ruleTester.expect(`model Foo {}`).toEmitDiagnostics({ - code: "@typespec/my-linter:no-foo-model", + code: "@typespec/my-linter/no-foo-model", message: "Cannot name a model with 'Foo'", }); }); 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 new file mode 100644 index 0000000000..49bbd1641e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/getting-started/getting-started-http.md @@ -0,0 +1,259 @@ +--- +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 concept 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](../standard-library/http/reference) +- [Rest library](../standard-library/rest/reference) +- [OpenAPI 3 emitter](../standard-library/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", + version: "2021-03-25", +}) +@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.md b/packages/website/versioned_docs/version-latest/getting-started/getting-started.md index 4ed298abb4..07c99deaa2 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,202 +5,4 @@ title: Getting Started # Getting Started with TypeSpec - - -Let's create a REST API definition with TypeSpec. TypeSpec has an official REST API "binding" called `@typespec/rest`. It's a set of TypeSpec declarations and decorators that describe REST APIs and can be used by code generators to generate OpenAPI descriptions, implementation code, and the like. - -TypeSpec also has an official OpenAPI emitter called `@typespec/openapi3` that consumes the REST API bindings and emits standard OpenAPI descriptions. This can then be fed in to any OpenAPI code generation pipeline. - -The following examples assume you have imported both `@typespec/openapi3` and `@typespec/rest` somewhere in your TypeSpec program (though importing them in `main.tsp` is the standard convention). For detailed library reference, please see rest library's [Readme.md](https://github.com/microsoft/typespec/blob/main/packages/rest/README.md). - -## 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 -@service({ - title: "Pet Store Service", - version: "2021-03-25", -}) -@server("https://example.com", "Single server endpoint") -@doc("This is a sample server Petstore server.") -namespace PetStore; -``` - -The `server` keyword can take a third parameter with parameters as necessary: - -```typespec -@server("https://{region}.foo.com", "Regional endpoint", { - @doc("Region name") - region?: string = "westus", -}) -``` - -## Resources & routes - -Resources are operations that are grouped in a namespace. You declare such a namespace by adding the `@route` decorator to provide the path to that resource: - -```typespec -using TypeSpec.Http; - -@route("/pets") -namespace Pets { - -} -``` - -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. Alternatively, you can name your operation `list`, `create`, `read`, `update`, `delete`, or `deleteAll` and the appropriate verb will be used automatically. 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; -} - -@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` parameters 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 { - 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): { - @body pets: 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 `@header` decorator on a property named `statusCode` 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; - }; -} -``` +- [Get started with HTTP in TypeSpec](./getting-started-http.md) diff --git a/packages/website/versioned_docs/version-latest/introduction/configuration/configuration.md b/packages/website/versioned_docs/version-latest/introduction/configuration/configuration.md index 0fd01e700f..a06e143a6a 100644 --- a/packages/website/versioned_docs/version-latest/introduction/configuration/configuration.md +++ b/packages/website/versioned_docs/version-latest/introduction/configuration/configuration.md @@ -316,13 +316,13 @@ Configure which linter rules should be enabled in this repository. Referencing t ```yaml linter: extends: # Extend `recommended` ruleset from @typespec/best-practices library - - "@typespec/best-practices:recommended" + - "@typespec/best-practices/recommended" enable: # Explicitly enable some rules - "@typespec/best-practices:no-x": true + "@typespec/best-practices/no-x": true disable: # Disable some rules defined in one of the ruleset extended. - "@typespec/best-practices:no-y": "This rule cannot be applied in this project because X" + "@typespec/best-practices/no-y": "This rule cannot be applied in this project because X" ``` ## Emitter control cli flags diff --git a/packages/website/versioned_docs/version-latest/introduction/editor/vs.md b/packages/website/versioned_docs/version-latest/introduction/editor/vs.md index 492208ee45..4ef5613854 100644 --- a/packages/website/versioned_docs/version-latest/introduction/editor/vs.md +++ b/packages/website/versioned_docs/version-latest/introduction/editor/vs.md @@ -1,4 +1,6 @@ -# TypeSpec Visual Studio Extension +--- +title: TypeSpec Visual Studio Extension +--- ## Installation diff --git a/packages/website/versioned_docs/version-latest/introduction/editor/vscode.md b/packages/website/versioned_docs/version-latest/introduction/editor/vscode.md index 220484e7ec..81e5427cfe 100644 --- a/packages/website/versioned_docs/version-latest/introduction/editor/vscode.md +++ b/packages/website/versioned_docs/version-latest/introduction/editor/vscode.md @@ -1,4 +1,6 @@ -# TypeSpec VSCode extension +--- +title: TypeSpec VSCode extension +--- ## Installation diff --git a/packages/website/versioned_docs/version-latest/introduction/reproducibility.md b/packages/website/versioned_docs/version-latest/introduction/reproducibility.md index 6db8cd5f84..c8f9b986b6 100644 --- a/packages/website/versioned_docs/version-latest/introduction/reproducibility.md +++ b/packages/website/versioned_docs/version-latest/introduction/reproducibility.md @@ -1,4 +1,6 @@ -# Reproducibility +--- +title: Reproducibility +--- A key point to service definition is the ability to reliably reproduce the exact same output over time. In cases like: diff --git a/packages/website/versioned_docs/version-latest/release-notes/cadl-typespec-migration.md b/packages/website/versioned_docs/version-latest/release-notes/cadl-typespec-migration.md index f34735f15d..45faa66f29 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/cadl-typespec-migration.md +++ b/packages/website/versioned_docs/version-latest/release-notes/cadl-typespec-migration.md @@ -1,4 +1,6 @@ -# Cadl to TypeSpec rename completed in March 2023 release +--- +title: Cadl to TypeSpec rename completed in March 2023 release +--- As you may recall from our previous email to partners, we are renaming the product as it becomes more mature, stable and one step closer to release. diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-10-11.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-10-11.md new file mode 100644 index 0000000000..8bde62a9bc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-10-11.md @@ -0,0 +1,100 @@ +--- +title: October 2023 +--- + +# Release Notes October 2023 (2023-10-11) + +:::danger +This release contains **breaking changes** +::: + +## New Features + +### `@typespec/compiler` New Features + +- The `never` type is now assignable to all types. +- Allow constraint decorators (e.g. `@minValue`, `@maxValue`, `@maxLength`, etc.) to be applied to nullable types. +- Add support for `@returns` and `@errors` doc comment tags. + - `@returns`(or `@returnsDoc` decorator) can be used to describe the success return types of an operation. + - `@errors`(or `@errorsDoc` decorator) can be used to describe the error return types of an operation. +- Skip emit of `deprecated` diagnostic for a type reference that is used in a deprecated declaration statement. +- Improve website performance by removing `decorators` export and importing decorators individually. + +### `@typespec/http` New Features + +- Add support for `@returns` and `@errors` doc comment tags. +- Add support for status code ranges for http responses. **Change to API** Http responses can now also return a `HttpStatusCodeRange` object for their status codes. +- Emit error diagnostic when multiple properties on a response model have the `@statusCode` decorator. + +### `@typespec/json-schema` New Features + +- Disable folding of serialized yaml if line is above 80 characters. + +### `@typespec/openapi` New Features + +- Remove `@typespec/rest` as a `peerDependency`. +- Support Http Status Code ranges. +- **Breaking Change** Changed namespace from `OpenAPI` to `TypeSpec.OpenAPI`. + +### `@typespec/openapi3` New Features + +- Remove `@typespec/rest` as a `peerDependency`. +- Add support for constraints on union types. +- Add support for `@returns` and `@errors` doc comment tags. +- Add support for http status code ranges. + +### `@typespec/protobuf` New features + +- Added support for emitting documentation comments in protobuf specifications. + +### `@typespec/rest` New features + +- Remove peer dependency on `@typespec/http` library. + +## Bug Fixes + +### `@typespec/compiler` Bug Fixes + +- Fix: Correct handling of hyphens in doc comments. +- Fix: Colorization of line comments extending into the next line. +- Fix: Crash when using parentheses in directives. +- Fix: Allow assigning negative and 0 values to `float64` types. +- Fix: Return non-zero format code when tsp formatting fails. +- Fix: Correct formatting of anonymous unions to exclude leading ':' character. +- Fix: Unions and Enum members are now formatted following the same rules as model properties. An extra line will be added between members if the member is annotated with a decorator, directive or doc comment. +- Fix: Correct formatting of comments between a directive or doc and its node. +- Fix: `tsp init` was not creating the `tspconfig.yaml` file for templates that specified it. +- Fix: `tsp init` will create a placeholder `tspconfig.yaml` file for templates that don't specify an explicit one. +- Fix: `tsp init` was ignoring the `files` specified in an init template. +- Fix: Language Server wasn't loading the `tspconfig.yaml` correctly resulting in some options being dropped, like the linter configuration. +- Fix: Allow `null` to be assigned as a default value. +- Fix: Using `TypeSpec.Xyz` namespace shouldn't require the `TypeSpec Prefix`. + +### `@typespec/openapi3` Bug Fixes + +- Fix: Correctly generate discriminated union mapping property with multiple visibilities. +- Fix: Crash when assigning a numeric default to a union. +- Fix: Using format `ssv` or `pipes` in `@header` produced an invalid OpenAPI3 schema. It will now change the type to string, ignore the format, and emit a warning diagnostic. +- Fix: Allow using null as a default value. +- Fix: Allow use of `@oneOf` on model properties. +- Fix: Correct representation of CSV format. +- Fix: Remove incorrect `statusCode` field for operations with shared routes. + +### `@typespec/rest` Bug Fixes + +- Fix: `@key` can now appear on the base model of a resource. + +### `@typespec/versioning` Bug Fixes + +- Ensure that use of `@renamedFrom` does not result in duplicate properties on a model. + +## Breaking Changes + +### `@typespec/http` Breaking Changes + +- Http responses can now also return a `HttpStatusCodeRange` object for their status codes. Emitters will need to handle the additional status code content when processing status codes. +- Emit error diagnostic when multiple properties on a response model have the `@statusCode` decorator. + +### `@typespec/openapi` Breaking Changes + +- Changed namespace from `OpenAPI` to `TypeSpec.OpenAPI`. 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 6e0a469f9d..9badf3d43e 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 @@ -3,5 +3,413 @@ title: "Built-in Data types" toc_min_heading_level: 2 toc_max_heading_level: 3 --- +# Data types +## TypeSpec +### `Array` {#Array} + + + + +```typespec +model Array +``` + +#### Template Parameters +| Name | Description | +|------|-------------| +| T | The type of the array elements | + + + +### `DefaultKeyVisibility` {#DefaultKeyVisibility} + +Applies a visibility setting to a collection of properties. + +```typespec +model DefaultKeyVisibility +``` + +#### Template Parameters +| Name | Description | +|------|-------------| +| T | An object whose properties are spread. | +| Visibility | The visibility to apply to all properties. | + + + +### `object` {#object} + +Represent a model + +```typespec +model object +``` + + + +### `OmitDefaults` {#OmitDefaults} + +Represents a collection of properties with default values omitted. + +```typespec +model OmitDefaults +``` + +#### Template Parameters +| Name | Description | +|------|-------------| +| T | An object whose spread property defaults are all omitted. | + + + +### `OmitProperties` {#OmitProperties} + +Represents a collection of omitted properties. + +```typespec +model OmitProperties +``` + +#### Template Parameters +| Name | Description | +|------|-------------| +| T | An object whose properties are spread. | +| TKeys | The property keys to omit. | + + + +### `OptionalProperties` {#OptionalProperties} + +Represents a collection of optional properties. + +```typespec +model OptionalProperties +``` + +#### Template Parameters +| Name | Description | +|------|-------------| +| T | An object whose spread properties are all optional. | + + + +### `Record` {#Record} + + + + +```typespec +model Record +``` + +#### Template Parameters +| Name | Description | +|------|-------------| +| T | The type of the properties | + + + +### `ServiceOptions` {#ServiceOptions} + +Service options. + +```typespec +model ServiceOptions +``` + + + +### `UpdateableProperties` {#UpdateableProperties} + +Represents a collection of updateable properties. + +```typespec +model UpdateableProperties +``` + +#### Template Parameters +| Name | Description | +|------|-------------| +| T | An object whose spread properties are all updateable. | + + + +### `BytesKnownEncoding` {#BytesKnownEncoding} + +Known encoding to use on bytes + +```typespec +enum BytesKnownEncoding +``` + + + +### `DateTimeKnownEncoding` {#DateTimeKnownEncoding} + +Known encoding to use on utcDateTime or offsetDateTime + +```typespec +enum DateTimeKnownEncoding +``` + + + +### `DurationKnownEncoding` {#DurationKnownEncoding} + +Known encoding to use on duration + +```typespec +enum DurationKnownEncoding +``` + + + +### `boolean` {#boolean} + +Boolean with `true` and `false` values. + +```typespec +scalar boolean +``` + + + +### `bytes` {#bytes} + +Represent a byte array + +```typespec +scalar bytes +``` + + + +### `decimal` {#decimal} + +A decimal number with any length and precision. + +```typespec +scalar decimal +``` + + + +### `decimal128` {#decimal128} + +A 128-bit decimal number. + +```typespec +scalar decimal128 +``` + + + +### `duration` {#duration} + +A duration/time period. e.g 5s, 10h + +```typespec +scalar duration +``` + + + +### `float` {#float} + +A number with decimal value + +```typespec +scalar float +``` + + + +### `float32` {#float32} + +A 32 bit floating point number. (`±5.0 × 10^−324` to `±1.7 × 10^308`) + +```typespec +scalar float32 +``` + + + +### `float64` {#float64} + +A 32 bit floating point number. (`±1.5 x 10^−45` to `±3.4 x 10^38`) + +```typespec +scalar float64 +``` + + + +### `int16` {#int16} + +A 16-bit integer. (`-32,768` to `32,767`) + +```typespec +scalar int16 +``` + + + +### `int32` {#int32} + +A 32-bit integer. (`-2,147,483,648` to `2,147,483,647`) + +```typespec +scalar int32 +``` + + + +### `int64` {#int64} + +A 64-bit integer. (`-9,223,372,036,854,775,808` to `9,223,372,036,854,775,807`) + +```typespec +scalar int64 +``` + + + +### `int8` {#int8} + +A 8-bit integer. (`-128` to `127`) + +```typespec +scalar int8 +``` + + + +### `integer` {#integer} + +A whole number + +```typespec +scalar integer +``` + + + +### `numeric` {#numeric} + +A numeric type + +```typespec +scalar numeric +``` + + + +### `offsetDateTime` {#offsetDateTime} + +A date and time in a particular time zone, e.g. "April 10th at 3:00am in PST" + +```typespec +scalar offsetDateTime +``` + + + +### `plainDate` {#plainDate} + +A date on a calendar without a time zone, e.g. "April 10th" + +```typespec +scalar plainDate +``` + + + +### `plainTime` {#plainTime} + +A time on a clock without a time zone, e.g. "3:00 am" + +```typespec +scalar plainTime +``` + + + +### `safeint` {#safeint} + +An integer that can be serialized to JSON (`−9007199254740991 (−(2^53 − 1))` to `9007199254740991 (2^53 − 1)` ) + +```typespec +scalar safeint +``` + + + +### `string` {#string} + +A sequence of textual characters. + +```typespec +scalar string +``` + + + +### `uint16` {#uint16} + +A 16-bit unsigned integer (`0` to `65,535`) + +```typespec +scalar uint16 +``` + + + +### `uint32` {#uint32} + +A 32-bit unsigned integer (`0` to `4,294,967,295`) + +```typespec +scalar uint32 +``` + + + +### `uint64` {#uint64} + +A 64-bit unsigned integer (`0` to `18,446,744,073,709,551,615`) + +```typespec +scalar uint64 +``` + + + +### `uint8` {#uint8} + +A 8-bit unsigned integer (`0` to `255`) + +```typespec +scalar uint8 +``` + + + +### `url` {#url} + +Represent a URL string as described by https://url.spec.whatwg.org/ + +```typespec +scalar url +``` + + + +### `utcDateTime` {#utcDateTime} + +An instant in coordinated universal time (UTC)" + +```typespec +scalar utcDateTime +``` + -See [Language Basics: Built-in types](../language-basics/built-in-types) diff --git a/packages/website/versioned_docs/version-latest/standard-library/built-in-decorators.md b/packages/website/versioned_docs/version-latest/standard-library/built-in-decorators.md index 7fe661ff2b..a6dcb9ade1 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 @@ -158,6 +158,32 @@ message: string; ``` +### `@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. + +```typespec +@errorsDoc(doc: valueof string) +``` + +#### Target + +`Operation` + +#### Parameters +| Name | Type | Description | +|------|------|-------------| +| doc | `valueof scalar string` | Documentation string | + +#### Examples + +```typespec +@errorsDoc("Returns doc") +op get(): Pet | NotFound; +``` + + ### `@format` {#@format} Specify a known data format hint for this string type. For example `uuid`, `uri`, etc. @@ -631,6 +657,32 @@ expireAt: int32; ``` +### `@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. + +```typespec +@returnsDoc(doc: valueof string) +``` + +#### Target + +`Operation` + +#### Parameters +| Name | Type | Description | +|------|------|-------------| +| doc | `valueof scalar string` | Documentation string | + +#### Examples + +```typespec +@returnsDoc("Returns doc") +op get(): Pet | NotFound; +``` + + ### `@returnTypeVisibility` {#@returnTypeVisibility} Sets which visibilities apply to the return type for the given operation. diff --git a/packages/website/versioned_docs/version-latest/standard-library/discriminated-types.md b/packages/website/versioned_docs/version-latest/standard-library/discriminated-types.md index 7aa7a8f739..3c616c844f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/discriminated-types.md +++ b/packages/website/versioned_docs/version-latest/standard-library/discriminated-types.md @@ -1,4 +1,6 @@ -# Discriminated types +--- +title: Discriminated types +--- TypeSpec can express unions and inheritance. However, when sending types over the wire many languages need a way to discriminate between the various union variants or models in an inheritance hierarchy. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/content-types.md b/packages/website/versioned_docs/version-latest/standard-library/http/content-types.md index 32e50b0711..f2420d1fd4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/content-types.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/content-types.md @@ -1,4 +1,6 @@ -# Content types +--- +title: Content types +--- ## Default behavior diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/encoding.md b/packages/website/versioned_docs/version-latest/standard-library/http/encoding.md index f7cbb1dec5..5089b05dd1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/encoding.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/encoding.md @@ -1,4 +1,6 @@ -# Encoding of types +--- +title: Encoding of types +--- This document describe how the http library interpret TypeSpec built-in types and how to configure diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Enumeration.Visibility.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Enumeration.Visibility.md deleted file mode 100644 index 91610301d3..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Enumeration.Visibility.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[E] Visibility" - ---- -Flags enum representation of well-known visibilities that are used in -REST API. - -## Enumeration Members - -| Member | Value | Description | -| :------ | :------ | :------ | -| `All` | ``31`` | - | -| `Create` | ``2`` | - | -| `Delete` | ``8`` | - | -| `Item` | ``1048576`` | Additional flag to indicate when something is nested in a collection
and therefore no metadata is applicable. | -| `None` | ``0`` | - | -| `Patch` | ``2097152`` | Additional flag to indicate when the verb is path and therefore
will have fields made optional if request visibility includes update. | -| `Query` | ``16`` | - | -| `Read` | ``1`` | - | -| `Update` | ``4`` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.DefaultRouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.DefaultRouteProducer.md deleted file mode 100644 index ee95561469..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.DefaultRouteProducer.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[F] DefaultRouteProducer" - ---- -```ts -DefaultRouteProducer( - program, - operation, - parentSegments, - overloadBase, - options): DiagnosticResult< RouteProducerResult > -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | `Program` | -| `operation` | `Operation` | -| `parentSegments` | `string`[] | -| `overloadBase` | `undefined` \| [`HttpOperation`](Interface.HttpOperation.md) | -| `options` | [`RouteOptions`](Interface.RouteOptions.md) | - -## Returns - -`DiagnosticResult`< [`RouteProducerResult`](Interface.RouteProducerResult.md) \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpService.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpService.md deleted file mode 100644 index 55cfd502ab..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpService.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] getHttpService" - ---- -```ts -getHttpService( - program, - serviceNamespace, - options?): [HttpService, readonly Diagnostic[]] -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | `Program` | -| `serviceNamespace` | `Namespace` | -| `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | - -## Returns - -[[`HttpService`](Interface.HttpService.md), *readonly* `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationParameters.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationParameters.md deleted file mode 100644 index e1b11c540a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationParameters.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[F] getOperationParameters" - ---- -```ts -getOperationParameters( - program, - operation, - overloadBase?, - knownPathParamNames? = [], - options? = {}): [HttpOperationParameters, readonly Diagnostic[]] -``` - -## Parameters - -| Parameter | Type | Default value | -| :------ | :------ | :------ | -| `program` | `Program` | `undefined` | -| `operation` | `Operation` | `undefined` | -| `overloadBase`? | [`HttpOperation`](Interface.HttpOperation.md) | `undefined` | -| `knownPathParamNames`? | `string`[] | `[]` | -| `options`? | [`OperationParameterOptions`](Interface.OperationParameterOptions.md) | `{}` | - -## Returns - -[[`HttpOperationParameters`](Interface.HttpOperationParameters.md), *readonly* `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodeDescription.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodeDescription.md deleted file mode 100644 index d98eb575a0..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodeDescription.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] getStatusCodeDescription" - ---- -```ts -getStatusCodeDescription(statusCode): undefined | "The request has succeeded." | "The request has succeeded and a new resource has been created as a result." | "The request has been accepted for processing, but processing has not yet completed." | "There is no content to send for this request, but the headers may be useful. " | "The URL of the requested resource has been changed permanently. The new URL is given in the response." | "The client has made a conditional request and the resource has not been modified." | "The server could not understand the request due to invalid syntax." | "Access is unauthorized." | "Access is forbidden" | "The server cannot find the requested resource." | "The request conflicts with the current state of the server." | "Precondition failed." | "Service unavailable." | "Informational" | "Successful" | "Redirection" | "Client Error" | "Server Error" -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `statusCode` | `string` | - -## Returns - -`undefined` \| `"The request has succeeded."` \| `"The request has succeeded and a new resource has been created as a result."` \| `"The request has been accepted for processing, but processing has not yet completed."` \| `"There is no content to send for this request, but the headers may be useful. "` \| `"The URL of the requested resource has been changed permanently. The new URL is given in the response."` \| `"The client has made a conditional request and the resource has not been modified."` \| `"The server could not understand the request due to invalid syntax."` \| `"Access is unauthorized."` \| `"Access is forbidden"` \| `"The server cannot find the requested resource."` \| `"The request conflicts with the current state of the server."` \| `"Precondition failed."` \| `"Service unavailable."` \| `"Informational"` \| `"Successful"` \| `"Redirection"` \| `"Client Error"` \| `"Server Error"` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.listHttpOperationsIn.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.listHttpOperationsIn.md deleted file mode 100644 index caa7e82c0f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.listHttpOperationsIn.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] listHttpOperationsIn" - ---- -```ts -listHttpOperationsIn( - program, - container, - options?): [HttpOperation[], readonly Diagnostic[]] -``` - -Get all the Http Operation in the given container. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | `Program` | Program | -| `container` | [`OperationContainer`](Type.OperationContainer.md) | Namespace or interface containing operations | -| `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | Resolution options | - -## Returns - -[[`HttpOperation`](Interface.HttpOperation.md)[], *readonly* `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolvePathAndParameters.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolvePathAndParameters.md deleted file mode 100644 index e5c09d78b5..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolvePathAndParameters.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] resolvePathAndParameters" - ---- -```ts -resolvePathAndParameters( - program, - operation, - overloadBase, - options): DiagnosticResult< {parameters: HttpOperationParameters; path: string; pathSegments: string[];} > -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | `Program` | -| `operation` | `Operation` | -| `overloadBase` | `undefined` \| [`HttpOperation`](Interface.HttpOperation.md) | -| `options` | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | - -## Returns - -`DiagnosticResult`< \{`parameters`: [`HttpOperationParameters`](Interface.HttpOperationParameters.md); `path`: `string`; `pathSegments`: `string`[];} \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ApiKeyAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ApiKeyAuth.md deleted file mode 100644 index a1345c324e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ApiKeyAuth.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -jsApi: true -title: "[I] ApiKeyAuth" - ---- -An API key is a token that a client provides when making API calls. The key can be sent in the query string: -``` -GET /something?api_key=abcdef12345 -``` - -or as a request header - -``` -GET /something HTTP/1.1 -X-API-Key: abcdef12345 -``` - -or as a cookie - -``` -GET /something HTTP/1.1 -Cookie: X-API-KEY=abcdef12345 -``` - -## Extends - -- [`HttpAuthBase`](Interface.HttpAuthBase.md) - -## Type parameters - -| Parameter | -| :------ | -| `TLocation` *extends* `ApiKeyLocation` | -| `TName` *extends* `string` | - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `description`? | `string` | Optional description. | -| `id` | `string` | Id of the authentication scheme. | -| `in` | `TLocation` | - | -| `name` | `TName` | - | -| `type` | `"apiKey"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthenticationOption.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthenticationOption.md deleted file mode 100644 index 99ad2de87b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthenticationOption.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] AuthenticationOption" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `schemes` | [`HttpAuth`](Type.HttpAuth.md)[] | For this authentication option all the given auth have to be used together. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthorizationCodeFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthorizationCodeFlow.md deleted file mode 100644 index bcf7feb4dd..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.AuthorizationCodeFlow.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] AuthorizationCodeFlow" - ---- -Authorization Code flow - -## Properties - -| Property | Type | -| :------ | :------ | -| `authorizationUrl` | `string` | -| `refreshUrl`? | `string` | -| `scopes` | [`OAuth2Scope`](Interface.OAuth2Scope.md)[] | -| `tokenUrl` | `string` | -| `type` | `"authorizationCode"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ClientCredentialsFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ClientCredentialsFlow.md deleted file mode 100644 index 483411e271..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ClientCredentialsFlow.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[I] ClientCredentialsFlow" - ---- -Client credentials flow - -## Properties - -| Property | Type | -| :------ | :------ | -| `refreshUrl`? | `string` | -| `scopes` | [`OAuth2Scope`](Interface.OAuth2Scope.md)[] | -| `tokenUrl` | `string` | -| `type` | `"clientCredentials"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HeaderFieldOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HeaderFieldOptions.md deleted file mode 100644 index 963137286e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HeaderFieldOptions.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] HeaderFieldOptions" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `format`? | `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` \| `"form"` | The string format of the array. "csv" and "simple" are used interchangeably, as are
"multi" and "form". | -| `name` | `string` | - | -| `type` | `"header"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpAuthBase.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpAuthBase.md deleted file mode 100644 index b9fdbd2aa2..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpAuthBase.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[I] HttpAuthBase" - ---- -## Extended By - -- [`BasicAuth`](Interface.BasicAuth.md) -- [`BearerAuth`](Interface.BearerAuth.md) -- [`ApiKeyAuth`](Interface.ApiKeyAuth.md) -- [`Oauth2Auth`](Interface.Oauth2Auth.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `description`? | `string` | Optional description. | -| `id` | `string` | Id of the authentication scheme. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperation.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperation.md deleted file mode 100644 index 12343783b6..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperation.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[I] HttpOperation" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `container` | [`OperationContainer`](Type.OperationContainer.md) | Parent type being the interface, namespace or global namespace. | -| `operation` | `Operation` | Operation type reference. | -| `overloading`? | [`HttpOperation`](Interface.HttpOperation.md) | Overload this operation | -| `overloads`? | [`HttpOperation`](Interface.HttpOperation.md)[] | List of operations that overloads this one. | -| `parameters` | [`HttpOperationParameters`](Interface.HttpOperationParameters.md) | Parameters. | -| `path` | `string` | Route path | -| `pathSegments` | `string`[] | Path segments | -| `responses` | [`HttpOperationResponse`](Interface.HttpOperationResponse.md)[] | Responses. | -| `verb` | [`HttpVerb`](Type.HttpVerb.md) | Route verb. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationParameters.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationParameters.md deleted file mode 100644 index 65804ab169..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationParameters.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[I] HttpOperationParameters" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `body`? | [`HttpOperationRequestBody`](Interface.HttpOperationRequestBody.md) | - | -| `bodyParameter`? | `ModelProperty` | **Deprecated**

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

use body.type | -| `parameters` | [`HttpOperationParameter`](Type.HttpOperationParameter.md)[] | - | -| `verb` | [`HttpVerb`](Type.HttpVerb.md) | NOTE: The verb is determined when processing parameters as it can
depend on whether there is a request body if not explicitly specified.
Marked internal to keep from polluting the public API with the verb at
two levels. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationRequestBody.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationRequestBody.md deleted file mode 100644 index 73ce748a9b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationRequestBody.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] HttpOperationRequestBody" - ---- -Represent the body information for an http request. - -## Note - -the `type` must be a `Model` if the content type is multipart. - -## Extends - -- [`HttpOperationBody`](Interface.HttpOperationBody.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `contentTypes` | `string`[] | Content types. | -| `parameter`? | `ModelProperty` | If the body was explicitly set as a property. Correspond to the property with `@body` | -| `type` | `Type` | Type of the operation body. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponse.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponse.md deleted file mode 100644 index 3cc2c128f5..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponse.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] HttpOperationResponse" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `description`? | `string` | -| `responses` | [`HttpOperationResponseContent`](Interface.HttpOperationResponseContent.md)[] | -| `statusCode` | [`StatusCode`](Type.StatusCode.md) | -| `type` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponseContent.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponseContent.md deleted file mode 100644 index 1fbc763c1d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationResponseContent.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] HttpOperationResponseContent" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `body`? | [`HttpOperationBody`](Interface.HttpOperationBody.md) | -| `headers`? | `Record`< `string`, `ModelProperty` \> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpServer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpServer.md deleted file mode 100644 index 830b9f97ab..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpServer.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] HttpServer" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `description` | `string` | -| `parameters` | `Map`< `string`, `ModelProperty` \> | -| `url` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpService.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpService.md deleted file mode 100644 index 43eddde92b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpService.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] HttpService" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `namespace` | `Namespace` | -| `operations` | [`HttpOperation`](Interface.HttpOperation.md)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ImplicitFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ImplicitFlow.md deleted file mode 100644 index f35a786663..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ImplicitFlow.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[I] ImplicitFlow" - ---- -Implicit flow - -## Properties - -| Property | Type | -| :------ | :------ | -| `authorizationUrl` | `string` | -| `refreshUrl`? | `string` | -| `scopes` | [`OAuth2Scope`](Interface.OAuth2Scope.md)[] | -| `type` | `"implicit"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfoOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfoOptions.md deleted file mode 100644 index 02cc394bcf..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfoOptions.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -jsApi: true -title: "[I] MetadataInfoOptions" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `canonicalVisibility`? | [`Visibility`](Enumeration.Visibility.md) | The visibility to be used as the baseline against which
[isEmptied](Interface.MetadataInfo.md#isemptied) and [isTransformed](Interface.MetadataInfo.md#istransformed)
are computed. If not specified, [None](Enumeration.Visibility.md#none) is used, which
will consider that any model that has fields that are only visible to
some visibilities as transformed. | - -## Methods - -### canShareProperty - -```ts -optional canShareProperty(property): boolean -``` - -Optional callback to indicate that a property can be shared with the -canonical representation even for visibilities where it is not visible. - -This is used, for example, in OpenAPI emit where a property can be -marked `readOnly: true` to represent @visibility("read") without -creating a separate schema schema for [Read](Enumeration.Visibility.md#read). - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `property` | `ModelProperty` | - -#### Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OAuth2Scope.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OAuth2Scope.md deleted file mode 100644 index ba74099dbb..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OAuth2Scope.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] OAuth2Scope" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `description`? | `string` | -| `value` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OperationParameterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OperationParameterOptions.md deleted file mode 100644 index 8c2f5e9acc..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.OperationParameterOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] OperationParameterOptions" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `verbSelector`? | [`OperationVerbSelector`](Type.OperationVerbSelector.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PasswordFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PasswordFlow.md deleted file mode 100644 index e5398bb708..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PasswordFlow.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[I] PasswordFlow" - ---- -Resource Owner Password flow - -## Properties - -| Property | Type | -| :------ | :------ | -| `authorizationUrl` | `string` | -| `refreshUrl`? | `string` | -| `scopes` | [`OAuth2Scope`](Interface.OAuth2Scope.md)[] | -| `type` | `"password"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PathParameterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PathParameterOptions.md deleted file mode 100644 index e1ff10adac..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.PathParameterOptions.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] PathParameterOptions" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `name` | `string` | -| `type` | `"path"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.QueryParameterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.QueryParameterOptions.md deleted file mode 100644 index 8447f32e64..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.QueryParameterOptions.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] QueryParameterOptions" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `format`? | `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` \| `"form"` | The string format of the array. "csv" and "simple" are used interchangeably, as are
"multi" and "form". | -| `name` | `string` | - | -| `type` | `"query"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteOptions.md deleted file mode 100644 index 4d24a9c3d8..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteOptions.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[I] RouteOptions" - ---- -## Extended By - -- [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) - -## Indexable - - \[`prop`: `string`\]: `any` - -## Properties - -| Property | Type | -| :------ | :------ | -| `paramOptions`? | [`OperationParameterOptions`](Interface.OperationParameterOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RoutePath.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RoutePath.md deleted file mode 100644 index 9dab4e018a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RoutePath.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] RoutePath" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `path` | `string` | -| `shared` | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteProducerResult.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteProducerResult.md deleted file mode 100644 index 9e578d50c4..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteProducerResult.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] RouteProducerResult" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `parameters` | [`HttpOperationParameters`](Interface.HttpOperationParameters.md) | -| `segments` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteResolutionOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteResolutionOptions.md deleted file mode 100644 index e852623d71..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.RouteResolutionOptions.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[I] RouteResolutionOptions" - ---- -## Extends - -- [`RouteOptions`](Interface.RouteOptions.md) - -## Properties - -| Property | Type | -| :------ | :------ | -| `listOptions`? | `ListOperationOptions` | -| `paramOptions`? | [`OperationParameterOptions`](Interface.OperationParameterOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ServiceAuthentication.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ServiceAuthentication.md deleted file mode 100644 index 409ce5e3cd..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.ServiceAuthentication.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] ServiceAuthentication" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `options` | [`AuthenticationOption`](Interface.AuthenticationOption.md)[] | Either one of those options can be used independently to authenticate. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpAuth.md deleted file mode 100644 index 5d71a8b772..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpAuth.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] HttpAuth" - ---- -```ts -HttpAuth: BasicAuth | BearerAuth | ApiKeyAuth< ApiKeyLocation, string > | Oauth2Auth< OAuth2Flow[] > -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpOperationParameter.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpOperationParameter.md deleted file mode 100644 index da6f6c422e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpOperationParameter.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[T] HttpOperationParameter" - ---- -```ts -HttpOperationParameter: HeaderFieldOptions | QueryParameterOptions | PathParameterOptions & {param: ModelProperty;} -``` - -| Member | Type | -| :------ | :------ | -| `param` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpVerb.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpVerb.md deleted file mode 100644 index 134813fa30..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.HttpVerb.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] HttpVerb" - ---- -```ts -HttpVerb: "get" | "put" | "post" | "patch" | "delete" | "head" -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2Flow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2Flow.md deleted file mode 100644 index cea2bd210a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2Flow.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] OAuth2Flow" - ---- -```ts -OAuth2Flow: AuthorizationCodeFlow | ImplicitFlow | PasswordFlow | ClientCredentialsFlow -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.RouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.RouteProducer.md deleted file mode 100644 index d31bc6614d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.RouteProducer.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[T] RouteProducer" - ---- -```ts -RouteProducer: (program, operation, parentSegments, overloadBase, options) => DiagnosticResult< RouteProducerResult > -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | `Program` | -| `operation` | `Operation` | -| `parentSegments` | `string`[] | -| `overloadBase` | [`HttpOperation`](Interface.HttpOperation.md) \| `undefined` | -| `options` | [`RouteOptions`](Interface.RouteOptions.md) | - -## Returns - -`DiagnosticResult`< [`RouteProducerResult`](Interface.RouteProducerResult.md) \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.StatusCode.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.StatusCode.md deleted file mode 100644 index 3cd9f5c6fb..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.StatusCode.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] StatusCode" - ---- -```ts -StatusCode: \${number}\ | "" -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.$lib.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.$lib.md deleted file mode 100644 index d11cee9bf5..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.$lib.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] $lib" - ---- -```ts -const $lib: TypeSpecLibrary< Object, Record< string, any > > -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/enumerations/Visibility.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/enumerations/Visibility.md new file mode 100644 index 0000000000..c78bd9f91c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/enumerations/Visibility.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[E] Visibility" + +--- +Flags enum representation of well-known visibilities that are used in +REST API. + +## Enumeration Members + +| Member | Value | Description | +| :------ | :------ | :------ | +| `All` | `31` | - | +| `Create` | `2` | - | +| `Delete` | `8` | - | +| `Item` | `1048576` | Additional flag to indicate when something is nested in a collection
and therefore no metadata is applicable. | +| `None` | `0` | - | +| `Patch` | `2097152` | Additional flag to indicate when the verb is path and therefore
will have fields made optional if request visibility includes update. | +| `Query` | `16` | - | +| `Read` | `1` | - | +| `Update` | `4` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$body.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$body.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$body.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$body.md index 74c51eca4a..08f4597c71 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$body.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$body.md @@ -13,7 +13,3 @@ $body(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `ModelProperty` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$delete.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$delete.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$delete.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$delete.md index a97fdb5e37..9d1cbc7d2d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$delete.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$delete.md @@ -13,7 +13,3 @@ $delete(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$get.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$get.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$get.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$get.md index 0815e4bbf2..81fd259857 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$get.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$get.md @@ -13,7 +13,3 @@ $get(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$head.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$head.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$head.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$head.md index 63c0520514..2759bf9991 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$head.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$head.md @@ -13,7 +13,3 @@ $head(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$header.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$header.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$header.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$header.md index 73340df6fd..d5f560f5de 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$header.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$header.md @@ -5,9 +5,9 @@ title: "[F] $header" --- ```ts $header( - context, - entity, - headerNameOrOptions?): void + context, + entity, + headerNameOrOptions?): void ``` ## Parameters @@ -17,7 +17,3 @@ $header( | `context` | `DecoratorContext` | | `entity` | `ModelProperty` | | `headerNameOrOptions`? | `StringLiteral` \| `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$includeInapplicableMetadataInPayload.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md similarity index 95% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$includeInapplicableMetadataInPayload.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md index 0b205fd19c..4797ed6bbe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$includeInapplicableMetadataInPayload.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md @@ -5,9 +5,9 @@ title: "[F] $includeInapplicableMetadataInPayload" --- ```ts $includeInapplicableMetadataInPayload( - context, - entity, - value): void + context, + entity, + value): void ``` Specifies if inapplicable metadata should be included in the payload for @@ -24,8 +24,6 @@ decorator. ## Returns -`void` - ## See isApplicableMetadata diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$onValidate.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$onValidate.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$onValidate.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$onValidate.md index 212e92eb72..df5dda0051 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$onValidate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$onValidate.md @@ -12,7 +12,3 @@ $onValidate(program): void | Parameter | Type | | :------ | :------ | | `program` | `Program` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$patch.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$patch.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$patch.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$patch.md index 32efa20c4d..a9555a332f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$patch.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$patch.md @@ -13,7 +13,3 @@ $patch(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$path.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$path.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$path.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$path.md index 4e0192e5b6..50616f10c8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$path.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$path.md @@ -5,9 +5,9 @@ title: "[F] $path" --- ```ts $path( - context, - entity, - paramName?): void + context, + entity, + paramName?): void ``` ## Parameters @@ -17,7 +17,3 @@ $path( | `context` | `DecoratorContext` | | `entity` | `ModelProperty` | | `paramName`? | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$plainData.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$plainData.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$plainData.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$plainData.md index d61d12c6bb..f2ffd4286e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$plainData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$plainData.md @@ -13,7 +13,3 @@ $plainData(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$post.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$post.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$post.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$post.md index 61ab855910..d2b97129dc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$post.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$post.md @@ -13,7 +13,3 @@ $post(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$put.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$put.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$put.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$put.md index 0c991e4bbe..a8011177d0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$put.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$put.md @@ -13,7 +13,3 @@ $put(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$query.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$query.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$query.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$query.md index 3d08e36c5b..2f8f230b95 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$query.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$query.md @@ -5,9 +5,9 @@ title: "[F] $query" --- ```ts $query( - context, - entity, - queryNameOrOptions?): void + context, + entity, + queryNameOrOptions?): void ``` ## Parameters @@ -17,7 +17,3 @@ $query( | `context` | `DecoratorContext` | | `entity` | `ModelProperty` | | `queryNameOrOptions`? | `StringLiteral` \| `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$route.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$route.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$route.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$route.md index c3a8565557..a70fe4adb5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$route.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$route.md @@ -5,10 +5,10 @@ title: "[F] $route" --- ```ts $route( - context, - entity, - path, - parameters?): void + context, + entity, + path, + parameters?): void ``` `@route` defines the relative route URI for the target operation @@ -27,7 +27,3 @@ it will be used as a prefix to the route URI of the operation. | `entity` | `Type` | | `path` | `string` | | `parameters`? | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$server.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$server.md similarity index 87% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$server.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$server.md index 12a350714c..4456caa306 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$server.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$server.md @@ -5,11 +5,11 @@ title: "[F] $server" --- ```ts $server( - context, - target, - url, - description, - parameters?): void + context, + target, + url, + description, + parameters?): void ``` Configure the server url for the service. @@ -26,8 +26,6 @@ Configure the server url for the service. ## Returns -`void` - ## Optional Parameters to interpolate in the server url. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$sharedRoute.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$sharedRoute.md similarity index 96% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$sharedRoute.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$sharedRoute.md index 85f083c588..c0e11dd7dd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$sharedRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$sharedRoute.md @@ -20,7 +20,3 @@ route path as long as those operations are also marked with `@sharedRoute`. | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Operation` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$statusCode.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$statusCode.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$statusCode.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$statusCode.md index 6fa9dcb737..cfbc299977 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$statusCode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$statusCode.md @@ -13,7 +13,3 @@ $statusCode(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `ModelProperty` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$useAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$useAuth.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$useAuth.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$useAuth.md index df37baa99a..c9be7e0c30 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$useAuth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/$useAuth.md @@ -5,9 +5,9 @@ title: "[F] $useAuth" --- ```ts $useAuth( - context, - serviceNamespace, - authConfig): void + context, + serviceNamespace, + authConfig): void ``` ## Parameters @@ -17,7 +17,3 @@ $useAuth( | `context` | `DecoratorContext` | | `serviceNamespace` | `Namespace` | | `authConfig` | `Model` \| `Tuple` \| `Union` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/DefaultRouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/DefaultRouteProducer.md new file mode 100644 index 0000000000..c3baa9cc3f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/DefaultRouteProducer.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] DefaultRouteProducer" + +--- +```ts +DefaultRouteProducer( + program, + operation, + parentSegments, + overloadBase, +options): DiagnosticResult +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `operation` | `Operation` | +| `parentSegments` | `string`[] | +| `overloadBase` | `undefined` \| [`HttpOperation`](../interfaces/HttpOperation.md) | +| `options` | [`RouteOptions`](../interfaces/RouteOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.createMetadataInfo.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/createMetadataInfo.md similarity index 60% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.createMetadataInfo.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/createMetadataInfo.md index 4041c77635..fc9c4b7c80 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.createMetadataInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/createMetadataInfo.md @@ -12,8 +12,4 @@ createMetadataInfo(program, options?): MetadataInfo | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `options`? | [`MetadataInfoOptions`](Interface.MetadataInfoOptions.md) | - -## Returns - -[`MetadataInfo`](Interface.MetadataInfo.md) +| `options`? | [`MetadataInfoOptions`](../interfaces/MetadataInfoOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.gatherMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/gatherMetadata.md similarity index 54% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.gatherMetadata.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/gatherMetadata.md index ae5c7eb97d..ddecacfe31 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.gatherMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/gatherMetadata.md @@ -5,12 +5,12 @@ title: "[F] gatherMetadata" --- ```ts gatherMetadata( - program, - diagnostics, - type, - visibility, - isMetadataCallback = isMetadata, - rootMapOut?): Set< ModelProperty > + program, + diagnostics, + type, + visibility, + isMetadataCallback, +rootMapOut?): Set ``` Walks the given type and collects all applicable metadata and `@body` @@ -23,10 +23,6 @@ properties recursively. | `program` | `Program` | `undefined` | - | | `diagnostics` | `DiagnosticCollector` | `undefined` | - | | `type` | `Type` | `undefined` | - | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | `undefined` | - | +| `visibility` | [`Visibility`](../enumerations/Visibility.md) | `undefined` | - | | `isMetadataCallback` | (`program`, `property`) => `boolean` | `isMetadata` | - | -| `rootMapOut`? | `Map`< `ModelProperty`, `ModelProperty` \> | `undefined` | If provided, the map will be populated to link
nested metadata properties to their root properties. | - -## Returns - -`Set`< `ModelProperty` \> +| `rootMapOut`? | `Map`<`ModelProperty`, `ModelProperty`\> | `undefined` | If provided, the map will be populated to link
nested metadata properties to their root properties. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllHttpServices.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllHttpServices.md similarity index 60% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllHttpServices.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllHttpServices.md index 2e8bb3d67e..63f1e62d6d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllHttpServices.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllHttpServices.md @@ -14,8 +14,4 @@ Returns all the services defined. | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | - -## Returns - -[[`HttpService`](Interface.HttpService.md)[], *readonly* `Diagnostic`[]] +| `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllRoutes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllRoutes.md similarity index 63% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllRoutes.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllRoutes.md index f83f9629fb..4b4588af1e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAllRoutes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAllRoutes.md @@ -12,12 +12,10 @@ getAllRoutes(program, options?): [HttpOperation[], readonly Diagnostic[]] | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | +| `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | ## Returns -[[`HttpOperation`](Interface.HttpOperation.md)[], *readonly* `Diagnostic`[]] - ## Deprecated use `getAllHttpServices` instead diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAuthentication.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAuthentication.md similarity index 73% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAuthentication.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAuthentication.md index 9cccaa8124..972a1ae8e8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getAuthentication.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getAuthentication.md @@ -13,7 +13,3 @@ getAuthentication(program, namespace): ServiceAuthentication | undefined | :------ | :------ | | `program` | `Program` | | `namespace` | `Namespace` | - -## Returns - -[`ServiceAuthentication`](Interface.ServiceAuthentication.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getContentTypes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getContentTypes.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getContentTypes.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getContentTypes.md index 51d55ff282..b72f3b5765 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getContentTypes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getContentTypes.md @@ -17,6 +17,4 @@ Resolve the content types from a model property by looking at the value. ## Returns -[`string`[], *readonly* `Diagnostic`[]] - List of contnet types and any diagnostics if there was an issue. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldName.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldName.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldName.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldName.md index 5096ca42e6..524de93e36 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldName.md @@ -13,7 +13,3 @@ getHeaderFieldName(program, entity): string | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldOptions.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldOptions.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldOptions.md index 4ac36c8e5a..96ee40708c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHeaderFieldOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHeaderFieldOptions.md @@ -13,7 +13,3 @@ getHeaderFieldOptions(program, entity): HeaderFieldOptions | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -[`HeaderFieldOptions`](Interface.HeaderFieldOptions.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpOperation.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpOperation.md similarity index 50% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpOperation.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpOperation.md index fad628d115..6e53c0d77e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getHttpOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpOperation.md @@ -5,9 +5,9 @@ title: "[F] getHttpOperation" --- ```ts getHttpOperation( - program, - operation, - options?): [HttpOperation, readonly Diagnostic[]] + program, + operation, + options?): [HttpOperation, readonly Diagnostic[]] ``` Return the Http Operation details for a given TypeSpec operation. @@ -18,8 +18,4 @@ Return the Http Operation details for a given TypeSpec operation. | :------ | :------ | :------ | | `program` | `Program` | - | | `operation` | `Operation` | Operation | -| `options`? | [`RouteResolutionOptions`](Interface.RouteResolutionOptions.md) | Optional option on how to resolve the http details. | - -## Returns - -[[`HttpOperation`](Interface.HttpOperation.md), *readonly* `Diagnostic`[]] +| `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | Optional option on how to resolve the http details. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpService.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpService.md new file mode 100644 index 0000000000..281ee897be --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getHttpService.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getHttpService" + +--- +```ts +getHttpService( + program, + serviceNamespace, + options?): [HttpService, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `serviceNamespace` | `Namespace` | +| `options`? | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationParameters.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationParameters.md new file mode 100644 index 0000000000..48bb22851b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationParameters.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getOperationParameters" + +--- +```ts +getOperationParameters( + program, + operation, + overloadBase?, + knownPathParamNames?, + options?): [HttpOperationParameters, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `program` | `Program` | `undefined` | +| `operation` | `Operation` | `undefined` | +| `overloadBase`? | [`HttpOperation`](../interfaces/HttpOperation.md) | `undefined` | +| `knownPathParamNames`? | `string`[] | `[]` | +| `options`? | [`OperationParameterOptions`](../interfaces/OperationParameterOptions.md) | `{}` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationVerb.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationVerb.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationVerb.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationVerb.md index b749843421..20d663b6b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getOperationVerb.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getOperationVerb.md @@ -13,7 +13,3 @@ getOperationVerb(program, entity): HttpVerb | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -[`HttpVerb`](Type.HttpVerb.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamName.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamName.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamName.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamName.md index 947c88dedf..e5e188999f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamName.md @@ -13,7 +13,3 @@ getPathParamName(program, entity): string | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamOptions.md similarity index 75% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamOptions.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamOptions.md index 87008abe9e..d15be02de9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getPathParamOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getPathParamOptions.md @@ -13,7 +13,3 @@ getPathParamOptions(program, entity): PathParameterOptions | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -[`PathParameterOptions`](Interface.PathParameterOptions.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamName.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamName.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamName.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamName.md index da9c1758b2..696a31c9dd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamName.md @@ -13,7 +13,3 @@ getQueryParamName(program, entity): string | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamOptions.md similarity index 75% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamOptions.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamOptions.md index a1535812df..785bc543a6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getQueryParamOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getQueryParamOptions.md @@ -13,7 +13,3 @@ getQueryParamOptions(program, entity): QueryParameterOptions | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -[`QueryParameterOptions`](Interface.QueryParameterOptions.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRequestVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRequestVisibility.md similarity index 83% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRequestVisibility.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRequestVisibility.md index 42e003f768..6da65bcb1b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRequestVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRequestVisibility.md @@ -19,12 +19,10 @@ Determines the visibility to use for a request with the given verb. | Parameter | Type | Description | | :------ | :------ | :------ | -| `verb` | [`HttpVerb`](Type.HttpVerb.md) | The HTTP verb for the operation. | +| `verb` | [`HttpVerb`](../type-aliases/HttpVerb.md) | The HTTP verb for the operation. | ## Returns -[`Visibility`](Enumeration.Visibility.md) - The applicable parameter visibility or visibilities for the request. ## Deprecated diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getResponsesForOperation.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getResponsesForOperation.md similarity index 75% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getResponsesForOperation.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getResponsesForOperation.md index 68da7f5af0..6b262563a5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getResponsesForOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getResponsesForOperation.md @@ -15,7 +15,3 @@ Get the responses for a given operation. | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | - -## Returns - -[[`HttpOperationResponse`](Interface.HttpOperationResponse.md)[], *readonly* `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteOptionsForNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteOptionsForNamespace.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteOptionsForNamespace.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteOptionsForNamespace.md index e7f2f4dd25..73f28e58b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteOptionsForNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteOptionsForNamespace.md @@ -13,7 +13,3 @@ getRouteOptionsForNamespace(program, namespace): RouteOptions | undefined | :------ | :------ | | `program` | `Program` | | `namespace` | `Namespace` | - -## Returns - -[`RouteOptions`](Interface.RouteOptions.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRoutePath.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRoutePath.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRoutePath.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRoutePath.md index 67f28cb7f6..47013e291f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRoutePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRoutePath.md @@ -13,7 +13,3 @@ getRoutePath(program, entity): RoutePath | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Interface` \| `Namespace` \| `Operation` | - -## Returns - -[`RoutePath`](Interface.RoutePath.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteProducer.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteProducer.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteProducer.md index 2d6d3d7fbe..dfd2808edd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getRouteProducer.md @@ -13,7 +13,3 @@ getRouteProducer(program, operation): RouteProducer | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | - -## Returns - -[`RouteProducer`](Type.RouteProducer.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getServers.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getServers.md similarity index 75% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getServers.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getServers.md index 5ca51b72c9..5209b6a692 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getServers.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getServers.md @@ -13,7 +13,3 @@ getServers(program, type): HttpServer[] | undefined | :------ | :------ | | `program` | `Program` | | `type` | `Namespace` | - -## Returns - -[`HttpServer`](Interface.HttpServer.md)[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodeDescription.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodeDescription.md new file mode 100644 index 0000000000..7af635a291 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodeDescription.md @@ -0,0 +1,33 @@ +--- +jsApi: true +title: "[F] getStatusCodeDescription" + +--- +```ts +getStatusCodeDescription(statusCode): + | undefined + | "Informational" + | "Successful" + | "Redirection" + | "Client error" + | "Server error" + | "The request has succeeded." + | "The request has succeeded and a new resource has been created as a result." + | "The request has been accepted for processing, but processing has not yet completed." + | "There is no content to send for this request, but the headers may be useful. " + | "The URL of the requested resource has been changed permanently. The new URL is given in the response." + | "The client has made a conditional request and the resource has not been modified." + | "The server could not understand the request due to invalid syntax." + | "Access is unauthorized." + | "Access is forbidden" + | "The server cannot find the requested resource." + | "The request conflicts with the current state of the server." + | "Precondition failed." + | "Service unavailable." +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `statusCode` | `string` \| `number` \| [`HttpStatusCodeRange`](../interfaces/HttpStatusCodeRange.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodes.md similarity index 62% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodes.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodes.md index 5f10358c8c..839f283fbe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getStatusCodes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodes.md @@ -4,7 +4,7 @@ title: "[F] getStatusCodes" --- ```ts -getStatusCodes(program, entity): string[] +getStatusCodes(program, entity): HttpStatusCodes ``` ## Parameters @@ -12,8 +12,4 @@ getStatusCodes(program, entity): string[] | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `entity` | `Type` | - -## Returns - -`string`[] +| `entity` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md new file mode 100644 index 0000000000..befc459194 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] getStatusCodesWithDiagnostics" + +--- +```ts +getStatusCodesWithDiagnostics(program, type): [HttpStatusCodes, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `type` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getVisibilitySuffix.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getVisibilitySuffix.md similarity index 72% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getVisibilitySuffix.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getVisibilitySuffix.md index af621fa04e..4cdda1001e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.getVisibilitySuffix.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/getVisibilitySuffix.md @@ -4,7 +4,7 @@ title: "[F] getVisibilitySuffix" --- ```ts -getVisibilitySuffix(visibility, canonicalVisibility = Visibility.None): string +getVisibilitySuffix(visibility, canonicalVisibility): string ``` Provides a naming suffix to create a unique name for a type with this @@ -25,9 +25,5 @@ Examples (with canonicalVisibility = Visibility.Read): | Parameter | Type | Default value | | :------ | :------ | :------ | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | `undefined` | -| `canonicalVisibility` | `undefined` \| [`Visibility`](Enumeration.Visibility.md) | `Visibility.None` | - -## Returns - -`string` +| `visibility` | [`Visibility`](../enumerations/Visibility.md) | `undefined` | +| `canonicalVisibility` | `undefined` \| [`Visibility`](../enumerations/Visibility.md) | `Visibility.None` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInapplicableMetadataInPayload.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md similarity index 97% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInapplicableMetadataInPayload.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md index 293ee6ea1e..8b3844fa84 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInapplicableMetadataInPayload.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md @@ -19,8 +19,6 @@ inapplicable metadata. ## Returns -`boolean` - ## See - isApplicableMetadata diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInterfaceRoutesInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInterfaceRoutesInNamespace.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md index 81e88b7153..ab7e3e2f8e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.includeInterfaceRoutesInNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md @@ -5,9 +5,9 @@ title: "[F] includeInterfaceRoutesInNamespace" --- ```ts includeInterfaceRoutesInNamespace( - program, - target, - sourceInterface): void + program, + target, + sourceInterface): void ``` ## Parameters @@ -20,8 +20,6 @@ includeInterfaceRoutesInNamespace( ## Returns -`void` - ## Deprecated DO NOT USE. For internal use only as a workaround. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadata.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadata.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadata.md index 74cf604799..d67080497b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadata.md @@ -5,10 +5,10 @@ title: "[F] isApplicableMetadata" --- ```ts isApplicableMetadata( - program, - property, - visibility, - isMetadataCallback = isMetadata): boolean + program, + property, + visibility, + isMetadataCallback): boolean ``` Determines if the given property is metadata that is applicable with the @@ -26,9 +26,5 @@ given visibility. | :------ | :------ | :------ | | `program` | `Program` | `undefined` | | `property` | `ModelProperty` | `undefined` | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | `undefined` | +| `visibility` | [`Visibility`](../enumerations/Visibility.md) | `undefined` | | `isMetadataCallback` | (`program`, `property`) => `boolean` | `isMetadata` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadataOrBody.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadataOrBody.md similarity index 71% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadataOrBody.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadataOrBody.md index 2bc4545859..0766374972 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isApplicableMetadataOrBody.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isApplicableMetadataOrBody.md @@ -5,10 +5,10 @@ title: "[F] isApplicableMetadataOrBody" --- ```ts isApplicableMetadataOrBody( - program, - property, - visibility, - isMetadataCallback = isMetadata): boolean + program, + property, + visibility, + isMetadataCallback): boolean ``` Determines if the given property is metadata or marked `@body` and @@ -20,9 +20,5 @@ applicable with the given visibility. | :------ | :------ | :------ | | `program` | `Program` | `undefined` | | `property` | `ModelProperty` | `undefined` | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | `undefined` | +| `visibility` | [`Visibility`](../enumerations/Visibility.md) | `undefined` | | `isMetadataCallback` | (`program`, `property`) => `boolean` | `isMetadata` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isBody.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isBody.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isBody.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isBody.md index 5507e46ac0..ba6a93bb59 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isBody.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isBody.md @@ -13,7 +13,3 @@ isBody(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isContentTypeHeader.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isContentTypeHeader.md similarity index 97% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isContentTypeHeader.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isContentTypeHeader.md index 9eb585e9b3..f4601f390f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isContentTypeHeader.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isContentTypeHeader.md @@ -18,6 +18,4 @@ Check if the given model property is the content type header. ## Returns -`boolean` - True if the model property is marked as a header and has the name `content-type`(case insensitive.) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isHeader.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isHeader.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isHeader.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isHeader.md index 12866ccaca..e45fcf8309 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isHeader.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isHeader.md @@ -13,7 +13,3 @@ isHeader(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isMetadata.md similarity index 93% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isMetadata.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isMetadata.md index ee8b7f7952..3222e3c661 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isMetadata.md @@ -16,7 +16,3 @@ metadata if it is marked `@header`, `@query`, `@path`, or `@statusCode`. | :------ | :------ | | `program` | `Program` | | `property` | `ModelProperty` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isOverloadSameEndpoint.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isOverloadSameEndpoint.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isOverloadSameEndpoint.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isOverloadSameEndpoint.md index 523e6f072d..55c0a6446f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isOverloadSameEndpoint.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isOverloadSameEndpoint.md @@ -11,8 +11,4 @@ isOverloadSameEndpoint(overload): boolean | Parameter | Type | | :------ | :------ | -| `overload` | [`HttpOperation`](Interface.HttpOperation.md) & \{`overloading`: [`HttpOperation`](Interface.HttpOperation.md);} | - -## Returns - -`boolean` +| `overload` | [`HttpOperation`](../interfaces/HttpOperation.md) & `object` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isPathParam.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isPathParam.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isPathParam.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isPathParam.md index 234c9d49c1..56ed9917c3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isPathParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isPathParam.md @@ -13,7 +13,3 @@ isPathParam(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isQueryParam.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isQueryParam.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isQueryParam.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isQueryParam.md index ce13bfe40f..20917a8cef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isQueryParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isQueryParam.md @@ -13,7 +13,3 @@ isQueryParam(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isSharedRoute.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isSharedRoute.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isSharedRoute.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isSharedRoute.md index 20dcc9fea4..2aab23560f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isSharedRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isSharedRoute.md @@ -13,7 +13,3 @@ isSharedRoute(program, operation): boolean | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isStatusCode.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isStatusCode.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isStatusCode.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isStatusCode.md index 8242346511..6d2c3dbd78 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isStatusCode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isStatusCode.md @@ -13,7 +13,3 @@ isStatusCode(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isVisible.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isVisible.md similarity index 66% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isVisible.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isVisible.md index c1b7035b9c..bf10fe75fe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.isVisible.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/isVisible.md @@ -5,9 +5,9 @@ title: "[F] isVisible" --- ```ts isVisible( - program, - property, - visibility): boolean + program, + property, + visibility): boolean ``` Determines if the given property is visible with the given visibility. @@ -18,8 +18,4 @@ Determines if the given property is visible with the given visibility. | :------ | :------ | | `program` | `Program` | | `property` | `ModelProperty` | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | - -## Returns - -`boolean` +| `visibility` | [`Visibility`](../enumerations/Visibility.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/listHttpOperationsIn.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/listHttpOperationsIn.md new file mode 100644 index 0000000000..4d726d7d73 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/listHttpOperationsIn.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] listHttpOperationsIn" + +--- +```ts +listHttpOperationsIn( + program, + container, + options?): [HttpOperation[], readonly Diagnostic[]] +``` + +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 | + +## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.reportIfNoRoutes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/reportIfNoRoutes.md similarity index 69% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.reportIfNoRoutes.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/reportIfNoRoutes.md index 55102c45fc..1f91975eeb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.reportIfNoRoutes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/reportIfNoRoutes.md @@ -12,8 +12,4 @@ reportIfNoRoutes(program, routes): void | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `routes` | [`HttpOperation`](Interface.HttpOperation.md)[] | - -## Returns - -`void` +| `routes` | [`HttpOperation`](../interfaces/HttpOperation.md)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolvePathAndParameters.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolvePathAndParameters.md new file mode 100644 index 0000000000..94c273380e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolvePathAndParameters.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] resolvePathAndParameters" + +--- +```ts +resolvePathAndParameters( + program, + operation, + overloadBase, +options): DiagnosticResult +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `operation` | `Operation` | +| `overloadBase` | `undefined` \| [`HttpOperation`](../interfaces/HttpOperation.md) | +| `options` | [`RouteResolutionOptions`](../interfaces/RouteResolutionOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolveRequestVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolveRequestVisibility.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolveRequestVisibility.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolveRequestVisibility.md index cbf03c3ba4..a186cc04ad 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.resolveRequestVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/resolveRequestVisibility.md @@ -5,9 +5,9 @@ title: "[F] resolveRequestVisibility" --- ```ts resolveRequestVisibility( - program, - operation, - verb): Visibility + program, + operation, + verb): Visibility ``` Returns the applicable parameter visibility or visibilities for the request if `@requestVisibility` was used. @@ -19,10 +19,8 @@ Otherwise, returns the default visibility based on the HTTP verb for the operati | :------ | :------ | :------ | | `program` | `Program` | - | | `operation` | `Operation` | The TypeSpec Operation for the request. | -| `verb` | [`HttpVerb`](Type.HttpVerb.md) | The HTTP verb for the operation. | +| `verb` | [`HttpVerb`](../type-aliases/HttpVerb.md) | The HTTP verb for the operation. | ## Returns -[`Visibility`](Enumeration.Visibility.md) - The applicable parameter visibility or visibilities for the request. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setAuthentication.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setAuthentication.md similarity index 59% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setAuthentication.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setAuthentication.md index cb6312ada3..95b1e8cd32 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setAuthentication.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setAuthentication.md @@ -5,9 +5,9 @@ title: "[F] setAuthentication" --- ```ts setAuthentication( - program, - serviceNamespace, - auth): void + program, + serviceNamespace, + auth): void ``` ## Parameters @@ -16,8 +16,4 @@ setAuthentication( | :------ | :------ | | `program` | `Program` | | `serviceNamespace` | `Namespace` | -| `auth` | [`ServiceAuthentication`](Interface.ServiceAuthentication.md) | - -## Returns - -`void` +| `auth` | [`ServiceAuthentication`](../interfaces/ServiceAuthentication.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRoute.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRoute.md similarity index 61% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRoute.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRoute.md index 10f8440014..ee3af48db7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRoute.md @@ -5,9 +5,9 @@ title: "[F] setRoute" --- ```ts setRoute( - context, - entity, - details): void + context, + entity, + details): void ``` ## Parameters @@ -16,8 +16,4 @@ setRoute( | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Type` | -| `details` | [`RoutePath`](Interface.RoutePath.md) | - -## Returns - -`void` +| `details` | [`RoutePath`](../interfaces/RoutePath.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteOptionsForNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteOptionsForNamespace.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteOptionsForNamespace.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteOptionsForNamespace.md index fab2adb253..320776737e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteOptionsForNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteOptionsForNamespace.md @@ -5,9 +5,9 @@ title: "[F] setRouteOptionsForNamespace" --- ```ts setRouteOptionsForNamespace( - program, - namespace, - options): void + program, + namespace, + options): void ``` ## Parameters @@ -16,8 +16,4 @@ setRouteOptionsForNamespace( | :------ | :------ | | `program` | `Program` | | `namespace` | `Namespace` | -| `options` | [`RouteOptions`](Interface.RouteOptions.md) | - -## Returns - -`void` +| `options` | [`RouteOptions`](../interfaces/RouteOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteProducer.md similarity index 59% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteProducer.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteProducer.md index f854833a46..3cb9e47bc8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setRouteProducer.md @@ -5,9 +5,9 @@ title: "[F] setRouteProducer" --- ```ts setRouteProducer( - program, - operation, - routeProducer): void + program, + operation, + routeProducer): void ``` ## Parameters @@ -16,8 +16,4 @@ setRouteProducer( | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | -| `routeProducer` | [`RouteProducer`](Type.RouteProducer.md) | - -## Returns - -`void` +| `routeProducer` | [`RouteProducer`](../type-aliases/RouteProducer.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setSharedRoute.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setSharedRoute.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setSharedRoute.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setSharedRoute.md index 5a17f9bf5e..d922723c21 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setSharedRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setSharedRoute.md @@ -13,7 +13,3 @@ setSharedRoute(program, operation): void | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setStatusCode.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setStatusCode.md similarity index 72% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setStatusCode.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setStatusCode.md index e622d2a1c8..aa7246eb1b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.setStatusCode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/setStatusCode.md @@ -5,9 +5,9 @@ title: "[F] setStatusCode" --- ```ts setStatusCode( - program, - entity, - codes): void + program, + entity, + codes): void ``` ## Parameters @@ -20,4 +20,6 @@ setStatusCode( ## Returns -`void` +## Deprecated + +DO NOT USE, for internal use only. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.validateRouteUnique.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/validateRouteUnique.md similarity index 61% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.validateRouteUnique.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/validateRouteUnique.md index 99be23d27f..c9779ec6a9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.validateRouteUnique.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/functions/validateRouteUnique.md @@ -5,9 +5,9 @@ title: "[F] validateRouteUnique" --- ```ts validateRouteUnique( - program, - diagnostics, - operations): void + program, + diagnostics, + operations): void ``` ## Parameters @@ -16,8 +16,4 @@ validateRouteUnique( | :------ | :------ | | `program` | `Program` | | `diagnostics` | `DiagnosticCollector` | -| `operations` | [`HttpOperation`](Interface.HttpOperation.md)[] | - -## Returns - -`void` +| `operations` | [`HttpOperation`](../interfaces/HttpOperation.md)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/index.md index 78edbdc180..ccaa57f7ed 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/index.md @@ -3,131 +3,135 @@ jsApi: true title: "[P] JS Api" --- -## Index +## Exports ### Enumerations -- [Visibility](Enumeration.Visibility.md) +- [Visibility](enumerations/Visibility.md) ### Interfaces -- [ApiKeyAuth](Interface.ApiKeyAuth.md) -- [AuthenticationOption](Interface.AuthenticationOption.md) -- [AuthorizationCodeFlow](Interface.AuthorizationCodeFlow.md) -- [BasicAuth](Interface.BasicAuth.md) -- [BearerAuth](Interface.BearerAuth.md) -- [ClientCredentialsFlow](Interface.ClientCredentialsFlow.md) -- [HeaderFieldOptions](Interface.HeaderFieldOptions.md) -- [HttpAuthBase](Interface.HttpAuthBase.md) -- [HttpOperation](Interface.HttpOperation.md) -- [HttpOperationBody](Interface.HttpOperationBody.md) -- [HttpOperationParameters](Interface.HttpOperationParameters.md) -- [HttpOperationRequestBody](Interface.HttpOperationRequestBody.md) -- [HttpOperationResponse](Interface.HttpOperationResponse.md) -- [HttpOperationResponseContent](Interface.HttpOperationResponseContent.md) -- [HttpServer](Interface.HttpServer.md) -- [HttpService](Interface.HttpService.md) -- [ImplicitFlow](Interface.ImplicitFlow.md) -- [MetadataInfo](Interface.MetadataInfo.md) -- [MetadataInfoOptions](Interface.MetadataInfoOptions.md) -- [OAuth2Scope](Interface.OAuth2Scope.md) -- [Oauth2Auth](Interface.Oauth2Auth.md) -- [OperationParameterOptions](Interface.OperationParameterOptions.md) -- [PasswordFlow](Interface.PasswordFlow.md) -- [PathParameterOptions](Interface.PathParameterOptions.md) -- [QueryParameterOptions](Interface.QueryParameterOptions.md) -- [RouteOptions](Interface.RouteOptions.md) -- [RoutePath](Interface.RoutePath.md) -- [RouteProducerResult](Interface.RouteProducerResult.md) -- [RouteResolutionOptions](Interface.RouteResolutionOptions.md) -- [ServiceAuthentication](Interface.ServiceAuthentication.md) +- [ApiKeyAuth](interfaces/ApiKeyAuth.md) +- [AuthenticationOption](interfaces/AuthenticationOption.md) +- [AuthorizationCodeFlow](interfaces/AuthorizationCodeFlow.md) +- [BasicAuth](interfaces/BasicAuth.md) +- [BearerAuth](interfaces/BearerAuth.md) +- [ClientCredentialsFlow](interfaces/ClientCredentialsFlow.md) +- [HeaderFieldOptions](interfaces/HeaderFieldOptions.md) +- [HttpAuthBase](interfaces/HttpAuthBase.md) +- [HttpOperation](interfaces/HttpOperation.md) +- [HttpOperationBody](interfaces/HttpOperationBody.md) +- [HttpOperationParameters](interfaces/HttpOperationParameters.md) +- [HttpOperationRequestBody](interfaces/HttpOperationRequestBody.md) +- [HttpOperationResponse](interfaces/HttpOperationResponse.md) +- [HttpOperationResponseContent](interfaces/HttpOperationResponseContent.md) +- [HttpServer](interfaces/HttpServer.md) +- [HttpService](interfaces/HttpService.md) +- [HttpStatusCodeRange](interfaces/HttpStatusCodeRange.md) +- [ImplicitFlow](interfaces/ImplicitFlow.md) +- [MetadataInfo](interfaces/MetadataInfo.md) +- [MetadataInfoOptions](interfaces/MetadataInfoOptions.md) +- [OAuth2Scope](interfaces/OAuth2Scope.md) +- [Oauth2Auth](interfaces/Oauth2Auth.md) +- [OperationParameterOptions](interfaces/OperationParameterOptions.md) +- [PasswordFlow](interfaces/PasswordFlow.md) +- [PathParameterOptions](interfaces/PathParameterOptions.md) +- [QueryParameterOptions](interfaces/QueryParameterOptions.md) +- [RouteOptions](interfaces/RouteOptions.md) +- [RoutePath](interfaces/RoutePath.md) +- [RouteProducerResult](interfaces/RouteProducerResult.md) +- [RouteResolutionOptions](interfaces/RouteResolutionOptions.md) +- [ServiceAuthentication](interfaces/ServiceAuthentication.md) ### Type Aliases -- [HttpAuth](Type.HttpAuth.md) -- [HttpOperationParameter](Type.HttpOperationParameter.md) -- [HttpVerb](Type.HttpVerb.md) -- [OAuth2Flow](Type.OAuth2Flow.md) -- [OAuth2FlowType](Type.OAuth2FlowType.md) -- [OperationContainer](Type.OperationContainer.md) -- [OperationDetails](Type.OperationDetails.md) -- [OperationVerbSelector](Type.OperationVerbSelector.md) -- [RouteProducer](Type.RouteProducer.md) -- [StatusCode](Type.StatusCode.md) +- [HttpAuth](type-aliases/HttpAuth.md) +- [HttpOperationParameter](type-aliases/HttpOperationParameter.md) +- [HttpStatusCodes](type-aliases/HttpStatusCodes.md) +- [HttpStatusCodesEntry](type-aliases/HttpStatusCodesEntry.md) +- [HttpVerb](type-aliases/HttpVerb.md) +- [OAuth2Flow](type-aliases/OAuth2Flow.md) +- [OAuth2FlowType](type-aliases/OAuth2FlowType.md) +- [OperationContainer](type-aliases/OperationContainer.md) +- [OperationDetails](type-aliases/OperationDetails.md) +- [OperationVerbSelector](type-aliases/OperationVerbSelector.md) +- [RouteProducer](type-aliases/RouteProducer.md) +- [StatusCode](type-aliases/StatusCode.md) ### Variables -- [$lib](Variable.$lib.md) -- [namespace](Variable.namespace.md) +- [$lib](variables/$lib.md) +- [namespace](variables/namespace.md) ### Functions -- [$body](Function.$body.md) -- [$delete](Function.$delete.md) -- [$get](Function.$get.md) -- [$head](Function.$head.md) -- [$header](Function.$header.md) -- [$includeInapplicableMetadataInPayload](Function.$includeInapplicableMetadataInPayload.md) -- [$onValidate](Function.$onValidate.md) -- [$patch](Function.$patch.md) -- [$path](Function.$path.md) -- [$plainData](Function.$plainData.md) -- [$post](Function.$post.md) -- [$put](Function.$put.md) -- [$query](Function.$query.md) -- [$route](Function.$route.md) -- [$server](Function.$server.md) -- [$sharedRoute](Function.$sharedRoute.md) -- [$statusCode](Function.$statusCode.md) -- [$useAuth](Function.$useAuth.md) -- [DefaultRouteProducer](Function.DefaultRouteProducer.md) -- [createMetadataInfo](Function.createMetadataInfo.md) -- [gatherMetadata](Function.gatherMetadata.md) -- [getAllHttpServices](Function.getAllHttpServices.md) -- [getAllRoutes](Function.getAllRoutes.md) -- [getAuthentication](Function.getAuthentication.md) -- [getContentTypes](Function.getContentTypes.md) -- [getHeaderFieldName](Function.getHeaderFieldName.md) -- [getHeaderFieldOptions](Function.getHeaderFieldOptions.md) -- [getHttpOperation](Function.getHttpOperation.md) -- [getHttpService](Function.getHttpService.md) -- [getOperationParameters](Function.getOperationParameters.md) -- [getOperationVerb](Function.getOperationVerb.md) -- [getPathParamName](Function.getPathParamName.md) -- [getPathParamOptions](Function.getPathParamOptions.md) -- [getQueryParamName](Function.getQueryParamName.md) -- [getQueryParamOptions](Function.getQueryParamOptions.md) -- [getRequestVisibility](Function.getRequestVisibility.md) -- [getResponsesForOperation](Function.getResponsesForOperation.md) -- [getRouteOptionsForNamespace](Function.getRouteOptionsForNamespace.md) -- [getRoutePath](Function.getRoutePath.md) -- [getRouteProducer](Function.getRouteProducer.md) -- [getServers](Function.getServers.md) -- [getStatusCodeDescription](Function.getStatusCodeDescription.md) -- [getStatusCodes](Function.getStatusCodes.md) -- [getVisibilitySuffix](Function.getVisibilitySuffix.md) -- [includeInapplicableMetadataInPayload](Function.includeInapplicableMetadataInPayload.md) -- [includeInterfaceRoutesInNamespace](Function.includeInterfaceRoutesInNamespace.md) -- [isApplicableMetadata](Function.isApplicableMetadata.md) -- [isApplicableMetadataOrBody](Function.isApplicableMetadataOrBody.md) -- [isBody](Function.isBody.md) -- [isContentTypeHeader](Function.isContentTypeHeader.md) -- [isHeader](Function.isHeader.md) -- [isMetadata](Function.isMetadata.md) -- [isOverloadSameEndpoint](Function.isOverloadSameEndpoint.md) -- [isPathParam](Function.isPathParam.md) -- [isQueryParam](Function.isQueryParam.md) -- [isSharedRoute](Function.isSharedRoute.md) -- [isStatusCode](Function.isStatusCode.md) -- [isVisible](Function.isVisible.md) -- [listHttpOperationsIn](Function.listHttpOperationsIn.md) -- [reportIfNoRoutes](Function.reportIfNoRoutes.md) -- [resolvePathAndParameters](Function.resolvePathAndParameters.md) -- [resolveRequestVisibility](Function.resolveRequestVisibility.md) -- [setAuthentication](Function.setAuthentication.md) -- [setRoute](Function.setRoute.md) -- [setRouteOptionsForNamespace](Function.setRouteOptionsForNamespace.md) -- [setRouteProducer](Function.setRouteProducer.md) -- [setSharedRoute](Function.setSharedRoute.md) -- [setStatusCode](Function.setStatusCode.md) -- [validateRouteUnique](Function.validateRouteUnique.md) +- [$body](functions/$body.md) +- [$delete](functions/$delete.md) +- [$get](functions/$get.md) +- [$head](functions/$head.md) +- [$header](functions/$header.md) +- [$includeInapplicableMetadataInPayload](functions/$includeInapplicableMetadataInPayload.md) +- [$onValidate](functions/$onValidate.md) +- [$patch](functions/$patch.md) +- [$path](functions/$path.md) +- [$plainData](functions/$plainData.md) +- [$post](functions/$post.md) +- [$put](functions/$put.md) +- [$query](functions/$query.md) +- [$route](functions/$route.md) +- [$server](functions/$server.md) +- [$sharedRoute](functions/$sharedRoute.md) +- [$statusCode](functions/$statusCode.md) +- [$useAuth](functions/$useAuth.md) +- [DefaultRouteProducer](functions/DefaultRouteProducer.md) +- [createMetadataInfo](functions/createMetadataInfo.md) +- [gatherMetadata](functions/gatherMetadata.md) +- [getAllHttpServices](functions/getAllHttpServices.md) +- [getAllRoutes](functions/getAllRoutes.md) +- [getAuthentication](functions/getAuthentication.md) +- [getContentTypes](functions/getContentTypes.md) +- [getHeaderFieldName](functions/getHeaderFieldName.md) +- [getHeaderFieldOptions](functions/getHeaderFieldOptions.md) +- [getHttpOperation](functions/getHttpOperation.md) +- [getHttpService](functions/getHttpService.md) +- [getOperationParameters](functions/getOperationParameters.md) +- [getOperationVerb](functions/getOperationVerb.md) +- [getPathParamName](functions/getPathParamName.md) +- [getPathParamOptions](functions/getPathParamOptions.md) +- [getQueryParamName](functions/getQueryParamName.md) +- [getQueryParamOptions](functions/getQueryParamOptions.md) +- [getRequestVisibility](functions/getRequestVisibility.md) +- [getResponsesForOperation](functions/getResponsesForOperation.md) +- [getRouteOptionsForNamespace](functions/getRouteOptionsForNamespace.md) +- [getRoutePath](functions/getRoutePath.md) +- [getRouteProducer](functions/getRouteProducer.md) +- [getServers](functions/getServers.md) +- [getStatusCodeDescription](functions/getStatusCodeDescription.md) +- [getStatusCodes](functions/getStatusCodes.md) +- [getStatusCodesWithDiagnostics](functions/getStatusCodesWithDiagnostics.md) +- [getVisibilitySuffix](functions/getVisibilitySuffix.md) +- [includeInapplicableMetadataInPayload](functions/includeInapplicableMetadataInPayload.md) +- [includeInterfaceRoutesInNamespace](functions/includeInterfaceRoutesInNamespace.md) +- [isApplicableMetadata](functions/isApplicableMetadata.md) +- [isApplicableMetadataOrBody](functions/isApplicableMetadataOrBody.md) +- [isBody](functions/isBody.md) +- [isContentTypeHeader](functions/isContentTypeHeader.md) +- [isHeader](functions/isHeader.md) +- [isMetadata](functions/isMetadata.md) +- [isOverloadSameEndpoint](functions/isOverloadSameEndpoint.md) +- [isPathParam](functions/isPathParam.md) +- [isQueryParam](functions/isQueryParam.md) +- [isSharedRoute](functions/isSharedRoute.md) +- [isStatusCode](functions/isStatusCode.md) +- [isVisible](functions/isVisible.md) +- [listHttpOperationsIn](functions/listHttpOperationsIn.md) +- [reportIfNoRoutes](functions/reportIfNoRoutes.md) +- [resolvePathAndParameters](functions/resolvePathAndParameters.md) +- [resolveRequestVisibility](functions/resolveRequestVisibility.md) +- [setAuthentication](functions/setAuthentication.md) +- [setRoute](functions/setRoute.md) +- [setRouteOptionsForNamespace](functions/setRouteOptionsForNamespace.md) +- [setRouteProducer](functions/setRouteProducer.md) +- [setSharedRoute](functions/setSharedRoute.md) +- [setStatusCode](functions/setStatusCode.md) +- [validateRouteUnique](functions/validateRouteUnique.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ApiKeyAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ApiKeyAuth.md new file mode 100644 index 0000000000..a7f2719fa1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ApiKeyAuth.md @@ -0,0 +1,44 @@ +--- +jsApi: true +title: "[I] ApiKeyAuth" + +--- +An API key is a token that a client provides when making API calls. The key can be sent in the query string: +``` +GET /something?api_key=abcdef12345 +``` + +or as a request header + +``` +GET /something HTTP/1.1 +X-API-Key: abcdef12345 +``` + +or as a cookie + +``` +GET /something HTTP/1.1 +Cookie: X-API-KEY=abcdef12345 +``` + +## Extends + +- [`HttpAuthBase`](HttpAuthBase.md) + +## Type parameters + +| Parameter | +| :------ | +| `TLocation` extends `ApiKeyLocation` | +| `TName` extends `string` | + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `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"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/AuthenticationOption.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/AuthenticationOption.md new file mode 100644 index 0000000000..02df8838ac --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/AuthenticationOption.md @@ -0,0 +1,10 @@ +--- +jsApi: true +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/standard-library/http/reference/js-api/interfaces/AuthorizationCodeFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/AuthorizationCodeFlow.md new file mode 100644 index 0000000000..8d08d57e88 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/AuthorizationCodeFlow.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] AuthorizationCodeFlow" + +--- +Authorization Code flow + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `authorizationUrl` | `string` | - | +| `refreshUrl?` | `string` | - | +| `scopes` | [`OAuth2Scope`](OAuth2Scope.md)[] | - | +| `tokenUrl` | `string` | - | +| `type` | `"authorizationCode"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BasicAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BasicAuth.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BasicAuth.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BasicAuth.md index 6a02c3a473..64ab64df50 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BasicAuth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BasicAuth.md @@ -12,13 +12,13 @@ For example, to authorize as demo / p@55w0rd the client would send ## Extends -- [`HttpAuthBase`](Interface.HttpAuthBase.md) +- [`HttpAuthBase`](HttpAuthBase.md) ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `description`? | `string` | Optional description. | -| `id` | `string` | Id of the authentication scheme. | -| `scheme` | `"basic"` | - | -| `type` | `"http"` | - | +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | +| `scheme` | `"basic"` | - | - | +| `type` | `"http"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BearerAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BearerAuth.md similarity index 59% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BearerAuth.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BearerAuth.md index bd21824e29..93a3cecf47 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.BearerAuth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/BearerAuth.md @@ -12,13 +12,13 @@ The client must send this token in the Authorization header when making requests ## Extends -- [`HttpAuthBase`](Interface.HttpAuthBase.md) +- [`HttpAuthBase`](HttpAuthBase.md) ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `description`? | `string` | Optional description. | -| `id` | `string` | Id of the authentication scheme. | -| `scheme` | `"bearer"` | - | -| `type` | `"http"` | - | +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | +| `scheme` | `"bearer"` | - | - | +| `type` | `"http"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ClientCredentialsFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ClientCredentialsFlow.md new file mode 100644 index 0000000000..5f2581ad8b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ClientCredentialsFlow.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[I] ClientCredentialsFlow" + +--- +Client credentials flow + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `refreshUrl?` | `string` | - | +| `scopes` | [`OAuth2Scope`](OAuth2Scope.md)[] | - | +| `tokenUrl` | `string` | - | +| `type` | `"clientCredentials"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HeaderFieldOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HeaderFieldOptions.md new file mode 100644 index 0000000000..837614e712 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HeaderFieldOptions.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] HeaderFieldOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `format?` | \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` \| `"form"` | The string format of the array. "csv" and "simple" are used interchangeably, as are
"multi" and "form". | +| `name` | `string` | - | +| `type` | `"header"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpAuthBase.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpAuthBase.md new file mode 100644 index 0000000000..a0f47d0f33 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpAuthBase.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] HttpAuthBase" + +--- +## Extended By + +- [`BasicAuth`](BasicAuth.md) +- [`BearerAuth`](BearerAuth.md) +- [`ApiKeyAuth`](ApiKeyAuth.md) +- [`Oauth2Auth`](Oauth2Auth.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `description?` | `string` | Optional description. | +| `id` | `string` | Id of the authentication scheme. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperation.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperation.md new file mode 100644 index 0000000000..54b3006633 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperation.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] HttpOperation" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `container` | [`OperationContainer`](../type-aliases/OperationContainer.md) | Parent type being the interface, namespace or global namespace. | +| `operation` | `Operation` | Operation type reference. | +| `overloading?` | [`HttpOperation`](HttpOperation.md) | Overload this operation | +| `overloads?` | [`HttpOperation`](HttpOperation.md)[] | List of operations that overloads this one. | +| `parameters` | [`HttpOperationParameters`](HttpOperationParameters.md) | Parameters. | +| `path` | `string` | Route path | +| `pathSegments` | `string`[] | Path segments | +| `responses` | [`HttpOperationResponse`](HttpOperationResponse.md)[] | Responses. | +| `verb` | [`HttpVerb`](../type-aliases/HttpVerb.md) | Route verb. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationBody.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationBody.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationBody.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationBody.md index 382f56b9a3..177aa96c62 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.HttpOperationBody.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationBody.md @@ -5,7 +5,7 @@ title: "[I] HttpOperationBody" --- ## Extended By -- [`HttpOperationRequestBody`](Interface.HttpOperationRequestBody.md) +- [`HttpOperationRequestBody`](HttpOperationRequestBody.md) ## Properties diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationParameters.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationParameters.md new file mode 100644 index 0000000000..46ee03bfa2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationParameters.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] HttpOperationParameters" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `body?` | [`HttpOperationRequestBody`](HttpOperationRequestBody.md) | - | +| `bodyParameter?` | `ModelProperty` | **Deprecated**

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

use body.type | +| `parameters` | [`HttpOperationParameter`](../type-aliases/HttpOperationParameter.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationRequestBody.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationRequestBody.md new file mode 100644 index 0000000000..2a9975009b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationRequestBody.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] HttpOperationRequestBody" + +--- +Represent the body information for an http request. + +## Note + +the `type` must be a `Model` if the content type is multipart. + +## Extends + +- [`HttpOperationBody`](HttpOperationBody.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `contentTypes` | `string`[] | Content types. | [`HttpOperationBody`](HttpOperationBody.md).`contentTypes` | +| `parameter?` | `ModelProperty` | If the body was explicitly set as a property. Correspond to the property with `@body` | - | +| `type` | `Type` | Type of the operation body. | [`HttpOperationBody`](HttpOperationBody.md).`type` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponse.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponse.md new file mode 100644 index 0000000000..0696432090 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponse.md @@ -0,0 +1,14 @@ +--- +jsApi: true +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) | +| `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/standard-library/http/reference/js-api/interfaces/HttpOperationResponseContent.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponseContent.md new file mode 100644 index 0000000000..09b3215d45 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpOperationResponseContent.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] HttpOperationResponseContent" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `body?` | [`HttpOperationBody`](HttpOperationBody.md) | - | +| `headers?` | `Record`<`string`, `ModelProperty`\> | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpServer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpServer.md new file mode 100644 index 0000000000..aa04851859 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpServer.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] HttpServer" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `description` | `string` | - | +| `parameters` | `Map`<`string`, `ModelProperty`\> | - | +| `url` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpService.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpService.md new file mode 100644 index 0000000000..53d2857318 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpService.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] HttpService" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `namespace` | `Namespace` | - | +| `operations` | [`HttpOperation`](HttpOperation.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpStatusCodeRange.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpStatusCodeRange.md new file mode 100644 index 0000000000..24f8700bf3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/HttpStatusCodeRange.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] HttpStatusCodeRange" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `end` | `number` | - | +| `start` | `number` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ImplicitFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ImplicitFlow.md new file mode 100644 index 0000000000..ea657e4562 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ImplicitFlow.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[I] ImplicitFlow" + +--- +Implicit flow + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `authorizationUrl` | `string` | - | +| `refreshUrl?` | `string` | - | +| `scopes` | [`OAuth2Scope`](OAuth2Scope.md)[] | - | +| `type` | `"implicit"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfo.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfo.md similarity index 75% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfo.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfo.md index 32ae18d23d..0903bf3af8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.MetadataInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfo.md @@ -10,7 +10,7 @@ Results are computed on demand and expensive computations are memoized. ## Methods -### getEffectivePayloadType +### getEffectivePayloadType() ```ts getEffectivePayloadType(type, visibility): Type @@ -24,15 +24,11 @@ same set of properties when non-payload properties are excluded. | Parameter | Type | | :------ | :------ | | `type` | `Type` | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | - -#### Returns - -`Type` +| `visibility` | [`Visibility`](../enumerations/Visibility.md) | *** -### isEmptied +### isEmptied() ```ts isEmptied(type, visibility): boolean @@ -52,15 +48,11 @@ itself is also removed. | Parameter | Type | | :------ | :------ | | `type` | `undefined` \| `Type` | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | - -#### Returns - -`boolean` +| `visibility` | [`Visibility`](../enumerations/Visibility.md) | *** -### isOptional +### isOptional() ```ts isOptional(property, visibility): boolean @@ -74,22 +66,18 @@ response payload for the given visibility. | Parameter | Type | | :------ | :------ | | `property` | `ModelProperty` | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | - -#### Returns - -`boolean` +| `visibility` | [`Visibility`](../enumerations/Visibility.md) | *** -### isPayloadProperty +### isPayloadProperty() ```ts isPayloadProperty(property, visibility): boolean ``` Determines if the given property is part of the request or response -payload and not applicable metadata [isApplicableMetadata](Function.isApplicableMetadata.md) or +payload and not applicable metadata [isApplicableMetadata](../functions/isApplicableMetadata.md) or filtered out by the given visibility. #### Parameters @@ -97,15 +85,11 @@ filtered out by the given visibility. | Parameter | Type | | :------ | :------ | | `property` | `ModelProperty` | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | - -#### Returns - -`boolean` +| `visibility` | [`Visibility`](../enumerations/Visibility.md) | *** -### isTransformed +### isTransformed() ```ts isTransformed(type, visibility): boolean @@ -120,8 +104,4 @@ metadata properties. | Parameter | Type | | :------ | :------ | | `type` | `undefined` \| `Type` | -| `visibility` | [`Visibility`](Enumeration.Visibility.md) | - -#### Returns - -`boolean` +| `visibility` | [`Visibility`](../enumerations/Visibility.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfoOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfoOptions.md new file mode 100644 index 0000000000..d31ce48a8d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/MetadataInfoOptions.md @@ -0,0 +1,31 @@ +--- +jsApi: true +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. | + +## Methods + +### canShareProperty() + +```ts +optional canShareProperty(property): boolean +``` + +Optional callback to indicate that a property can be shared with the +canonical representation even for visibilities where it is not visible. + +This is used, for example, in OpenAPI emit where a property can be +marked `readOnly: true` to represent @visibility("read") without +creating a separate schema schema for [Visibility.Read](../enumerations/Visibility.md). + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `property` | `ModelProperty` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OAuth2Scope.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OAuth2Scope.md new file mode 100644 index 0000000000..58030f0a1f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OAuth2Scope.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] OAuth2Scope" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `description?` | `string` | - | +| `value` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.Oauth2Auth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/Oauth2Auth.md similarity index 58% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.Oauth2Auth.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/Oauth2Auth.md index e37ae61d24..1e23a42405 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Interface.Oauth2Auth.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/Oauth2Auth.md @@ -10,19 +10,19 @@ For more information about OAuth 2.0, see oauth.net and RFC 6749. ## Extends -- [`HttpAuthBase`](Interface.HttpAuthBase.md) +- [`HttpAuthBase`](HttpAuthBase.md) ## Type parameters | Parameter | | :------ | -| `TFlows` *extends* [`OAuth2Flow`](Type.OAuth2Flow.md)[] | +| `TFlows` extends [`OAuth2Flow`](../type-aliases/OAuth2Flow.md)[] | ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `description`? | `string` | Optional description. | -| `flows` | `TFlows` | - | -| `id` | `string` | Id of the authentication scheme. | -| `type` | `"oauth2"` | - | +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `description?` | `string` | Optional description. | [`HttpAuthBase`](HttpAuthBase.md).`description` | +| `flows` | `TFlows` | - | - | +| `id` | `string` | Id of the authentication scheme. | [`HttpAuthBase`](HttpAuthBase.md).`id` | +| `type` | `"oauth2"` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OperationParameterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OperationParameterOptions.md new file mode 100644 index 0000000000..796a441838 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/OperationParameterOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] OperationParameterOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `verbSelector?` | [`OperationVerbSelector`](../type-aliases/OperationVerbSelector.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/PasswordFlow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/PasswordFlow.md new file mode 100644 index 0000000000..4c0ba57d72 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/PasswordFlow.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[I] PasswordFlow" + +--- +Resource Owner Password flow + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `authorizationUrl` | `string` | - | +| `refreshUrl?` | `string` | - | +| `scopes` | [`OAuth2Scope`](OAuth2Scope.md)[] | - | +| `type` | `"password"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/PathParameterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/PathParameterOptions.md new file mode 100644 index 0000000000..105e571681 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/PathParameterOptions.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] PathParameterOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | - | +| `type` | `"path"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/QueryParameterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/QueryParameterOptions.md new file mode 100644 index 0000000000..7ac6b91f02 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/QueryParameterOptions.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] QueryParameterOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `format?` | \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` \| `"form"` | The string format of the array. "csv" and "simple" are used interchangeably, as are
"multi" and "form". | +| `name` | `string` | - | +| `type` | `"query"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteOptions.md new file mode 100644 index 0000000000..6f88a4d2cb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteOptions.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] RouteOptions" + +--- +## Extended By + +- [`RouteResolutionOptions`](RouteResolutionOptions.md) + +## Indexable + + \[`prop`: `string`\]: `any` + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `paramOptions?` | [`OperationParameterOptions`](OperationParameterOptions.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RoutePath.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RoutePath.md new file mode 100644 index 0000000000..7829364bb6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RoutePath.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] RoutePath" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `path` | `string` | - | +| `shared` | `boolean` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteProducerResult.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteProducerResult.md new file mode 100644 index 0000000000..688453edb2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteProducerResult.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] RouteProducerResult" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `parameters` | [`HttpOperationParameters`](HttpOperationParameters.md) | - | +| `segments` | `string`[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteResolutionOptions.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteResolutionOptions.md new file mode 100644 index 0000000000..6731e98e36 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/RouteResolutionOptions.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[I] RouteResolutionOptions" + +--- +## Extends + +- [`RouteOptions`](RouteOptions.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `listOptions?` | `ListOperationOptions` | - | - | +| `paramOptions?` | [`OperationParameterOptions`](OperationParameterOptions.md) | - | [`RouteOptions`](RouteOptions.md).`paramOptions` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ServiceAuthentication.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ServiceAuthentication.md new file mode 100644 index 0000000000..0245bf7799 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/interfaces/ServiceAuthentication.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] ServiceAuthentication" + +--- +## 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/standard-library/http/reference/js-api/type-aliases/HttpAuth.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpAuth.md new file mode 100644 index 0000000000..06bb976461 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpAuth.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] HttpAuth" + +--- +```ts +type HttpAuth: BasicAuth | BearerAuth | ApiKeyAuth | Oauth2Auth; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpOperationParameter.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpOperationParameter.md new file mode 100644 index 0000000000..d6a790a219 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpOperationParameter.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] HttpOperationParameter" + +--- +```ts +type HttpOperationParameter: HeaderFieldOptions | QueryParameterOptions | PathParameterOptions & object; +``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `param` | `ModelProperty` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpStatusCodes.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpStatusCodes.md new file mode 100644 index 0000000000..8420e0f83e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpStatusCodes.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] HttpStatusCodes" + +--- +```ts +type HttpStatusCodes: HttpStatusCodesEntry[]; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpStatusCodesEntry.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpStatusCodesEntry.md new file mode 100644 index 0000000000..717df4a69d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpStatusCodesEntry.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] HttpStatusCodesEntry" + +--- +```ts +type HttpStatusCodesEntry: HttpStatusCodeRange | number | "*"; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpVerb.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpVerb.md new file mode 100644 index 0000000000..e8c878b690 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/HttpVerb.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] HttpVerb" + +--- +```ts +type HttpVerb: + | "get" + | "put" + | "post" + | "patch" + | "delete" + | "head"; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OAuth2Flow.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OAuth2Flow.md new file mode 100644 index 0000000000..5d4664957e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OAuth2Flow.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] OAuth2Flow" + +--- +```ts +type OAuth2Flow: AuthorizationCodeFlow | ImplicitFlow | PasswordFlow | ClientCredentialsFlow; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2FlowType.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OAuth2FlowType.md similarity index 59% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2FlowType.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OAuth2FlowType.md index 510f5f4054..599818333a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OAuth2FlowType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OAuth2FlowType.md @@ -4,5 +4,5 @@ title: "[T] OAuth2FlowType" --- ```ts -OAuth2FlowType: OAuth2Flow["type"] +type OAuth2FlowType: OAuth2Flow["type"]; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationContainer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationContainer.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationContainer.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationContainer.md index 9b2f3cd364..b349f604c9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationContainer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationContainer.md @@ -4,5 +4,5 @@ title: "[T] OperationContainer" --- ```ts -OperationContainer: Namespace | Interface +type OperationContainer: Namespace | Interface; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationDetails.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationDetails.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationDetails.md index c7da2af5d4..43a0fed1f2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationDetails.md @@ -4,7 +4,7 @@ title: "[T] OperationDetails" --- ```ts -OperationDetails: HttpOperation +type OperationDetails: HttpOperation; ``` ## Deprecated diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationVerbSelector.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationVerbSelector.md similarity index 58% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationVerbSelector.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationVerbSelector.md index 85be67f16d..d8815ecd75 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Type.OperationVerbSelector.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/OperationVerbSelector.md @@ -4,7 +4,7 @@ title: "[T] OperationVerbSelector" --- ```ts -OperationVerbSelector: (program, operation) => HttpVerb | undefined +type OperationVerbSelector: (program, operation) => HttpVerb | undefined; ``` ## Parameters @@ -13,7 +13,3 @@ OperationVerbSelector: (program, operation) => HttpVerb | undefined | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | - -## Returns - -[`HttpVerb`](Type.HttpVerb.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/RouteProducer.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/RouteProducer.md new file mode 100644 index 0000000000..336a0c4b25 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/RouteProducer.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[T] RouteProducer" + +--- +```ts +type RouteProducer: (program, operation, parentSegments, overloadBase, options) => DiagnosticResult; +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `operation` | `Operation` | +| `parentSegments` | `string`[] | +| `overloadBase` | [`HttpOperation`](../interfaces/HttpOperation.md) \| `undefined` | +| `options` | [`RouteOptions`](../interfaces/RouteOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/StatusCode.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/StatusCode.md new file mode 100644 index 0000000000..a51f7c07c0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/type-aliases/StatusCode.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[T] StatusCode" + +--- +```ts +type StatusCode: \${number}\ | "*"; +``` + +## Deprecated + +Use `HttpStatusCodesEntry` instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/variables/$lib.md new file mode 100644 index 0000000000..3da9627f33 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/variables/$lib.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] $lib" + +--- +```ts +const $lib: TypeSpecLibrary>; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/variables/namespace.md similarity index 50% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Variable.namespace.md rename to packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/variables/namespace.md index 47635e306f..7b486f6f90 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Variable.namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/variables/namespace.md @@ -4,5 +4,5 @@ title: "[V] namespace" --- ```ts -const namespace: "OpenAPI" = "OpenAPI" +const namespace: "TypeSpec.Http" = "TypeSpec.Http"; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.ExtensionRecord.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.ExtensionRecord.md deleted file mode 100644 index cad8f6a473..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.ExtensionRecord.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] ExtensionRecord" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.$lib.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.$lib.md deleted file mode 100644 index 297b2b284c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.$lib.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] $lib" - ---- -```ts -const $lib: TypeSpecLibrary< {}, JSONSchemaEmitterOptions > -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.EmitterOptionsSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.EmitterOptionsSchema.md deleted file mode 100644 index ba94990b7e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.EmitterOptionsSchema.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] EmitterOptionsSchema" - ---- -```ts -const EmitterOptionsSchema: JSONSchemaType< JSONSchemaEmitterOptions > -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.namespace.md deleted file mode 100644 index 4e9054404c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Variable.namespace.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] namespace" - ---- -```ts -const namespace: "TypeSpec.JsonSchema" = "TypeSpec.JsonSchema" -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Class.JsonSchemaEmitter.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/classes/JsonSchemaEmitter.md similarity index 66% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Class.JsonSchemaEmitter.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/classes/JsonSchemaEmitter.md index 787ecb13fc..34e4a1e707 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Class.JsonSchemaEmitter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/classes/JsonSchemaEmitter.md @@ -5,11 +5,11 @@ title: "[C] JsonSchemaEmitter" --- ## Extends -- `TypeEmitter`< `Record`< `string`, `any` \>, [`JSONSchemaEmitterOptions`](Interface.JSONSchemaEmitterOptions.md) \> +- `TypeEmitter`<`Record`<`string`, `any`\>, [`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> ## Constructors -### new JsonSchemaEmitter +### new JsonSchemaEmitter(emitter) ```ts new JsonSchemaEmitter(emitter): JsonSchemaEmitter @@ -22,11 +22,7 @@ call `createAssetEmitter` on the emitter context object. | Parameter | Type | Description | | :------ | :------ | :------ | -| `emitter` | `AssetEmitter`< `Record`< `string`, `any` \>, [`JSONSchemaEmitterOptions`](Interface.JSONSchemaEmitterOptions.md) \> | The asset emitter | - -#### Returns - -[`JsonSchemaEmitter`](Class.JsonSchemaEmitter.md) +| `emitter` | `AssetEmitter`<`Record`<`string`, `any`\>, [`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> | The asset emitter | #### Inherited from @@ -34,16 +30,16 @@ TypeEmitter, JSONSchemaEmitterOptions\>.constructor ## Properties -| Property | Type | -| :------ | :------ | -| `private` `#refToDecl` | `Map`< `string`, `Declaration`< `Record`< `string`, `unknown` \> \> \> | -| `private` `#seenIds` | `Set`< `unknown` \> | -| `private` `#typeForSourceFile` | `Map`< `SourceFile`< `any` \>, [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) \> | -| `protected` `emitter` | `AssetEmitter`< `Record`< `string`, `any` \>, [`JSONSchemaEmitterOptions`](Interface.JSONSchemaEmitterOptions.md) \> | +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `private` | `#refToDecl` | `Map`<`string`, `Declaration`<`Record`<`string`, `unknown`\>\>\> | - | - | +| `private` | `#seenIds` | `Set`<`unknown`\> | - | - | +| `private` | `#typeForSourceFile` | `Map`<`SourceFile`<`any`\>, [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md)\> | - | - | +| `public` | `emitter` | `AssetEmitter`<`Record`<`string`, `any`\>, [`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> | - | TypeEmitter.emitter | ## Methods -### #applyConstraints +### #applyConstraints() ```ts private #applyConstraints(type, schema): void @@ -53,16 +49,12 @@ private #applyConstraints(type, schema): void | Parameter | Type | | :------ | :------ | -| `type` | `Model` \| `ModelProperty` \| `Scalar` \| `Enum` \| `Union` | -| `schema` | `ObjectBuilder`< `unknown` \> | - -#### Returns - -`void` +| `type` | \| `Model` \| `ModelProperty` \| `Scalar` \| `Enum` \| `Union` | +| `schema` | `ObjectBuilder`<`unknown`\> | *** -### #checkForDuplicateId +### #checkForDuplicateId() ```ts private #checkForDuplicateId(id): string @@ -74,60 +66,44 @@ private #checkForDuplicateId(id): string | :------ | :------ | | `id` | `string` | -#### Returns - -`string` - *** -### #createDeclaration +### #createDeclaration() ```ts private #createDeclaration( - type, - name, - schema): Declaration< Record< string, any > > + type, + name, +schema): Declaration> ``` #### Parameters | Parameter | Type | | :------ | :------ | -| `type` | [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | +| `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | | `name` | `string` | -| `schema` | `ObjectBuilder`< `unknown` \> | - -#### Returns - -`Declaration`< `Record`< `string`, `any` \> \> +| `schema` | `ObjectBuilder`<`unknown`\> | *** -### #fileExtension +### #fileExtension() ```ts private #fileExtension(): "json" | "yaml" ``` -#### Returns - -`"json"` \| `"yaml"` - *** -### #getCurrentSourceFile +### #getCurrentSourceFile() ```ts -private #getCurrentSourceFile(): SourceFile< object > +private #getCurrentSourceFile(): SourceFile ``` -#### Returns - -`SourceFile`< `object` \> - *** -### #getDeclId +### #getDeclId() ```ts private #getDeclId(type, name): string @@ -137,16 +113,12 @@ private #getDeclId(type, name): string | Parameter | Type | | :------ | :------ | -| `type` | [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | +| `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | | `name` | `string` | -#### Returns - -`string` - *** -### #isStdType +### #isStdType() ```ts private #isStdType(type): boolean @@ -158,13 +130,9 @@ private #isStdType(type): boolean | :------ | :------ | | `type` | `Type` | -#### Returns - -`boolean` - *** -### #newFileScope +### #newFileScope() ```ts private #newFileScope(type): object @@ -174,17 +142,18 @@ private #newFileScope(type): object | Parameter | Type | | :------ | :------ | -| `type` | [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | +| `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | #### Returns -| Member | Type | -| :------ | :------ | -| `scope` | `Scope`< `Record`< `string`, `any` \> \> | +> | Member | Type | Description | +> | :------ | :------ | :------ | +> | `scope` | `Scope`<`Record`<`string`, `any`\>\> | - | +> *** -### #requiredModelProperties +### #requiredModelProperties() ```ts private #requiredModelProperties(model): undefined | string[] @@ -196,13 +165,9 @@ private #requiredModelProperties(model): undefined | string[] | :------ | :------ | | `model` | `Model` | -#### Returns - -`undefined` \| `string`[] - *** -### #scalarBuiltinBaseType +### #scalarBuiltinBaseType() ```ts private #scalarBuiltinBaseType(scalar): null | Scalar @@ -214,19 +179,15 @@ private #scalarBuiltinBaseType(scalar): null | Scalar | :------ | :------ | | `scalar` | `Scalar` | -#### Returns - -`null` \| `Scalar` - *** -### arrayDeclaration +### arrayDeclaration() ```ts arrayDeclaration( - array, - name, - elementType): EmitterOutput< object > + array, + name, +elementType): EmitterOutput ``` #### Parameters @@ -237,17 +198,13 @@ arrayDeclaration( | `name` | `string` | | `elementType` | `Type` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.arrayDeclaration *** -### arrayDeclarationContext +### arrayDeclarationContext() ```ts arrayDeclarationContext(array): Context @@ -259,23 +216,19 @@ arrayDeclarationContext(array): Context | :------ | :------ | | `array` | `Model` | -#### Returns - -`Context` - #### Overrides TypeEmitter.arrayDeclarationContext *** -### arrayDeclarationReferenceContext +### arrayDeclarationReferenceContext() ```ts arrayDeclarationReferenceContext( - array, - name, - elementType): Context + array, + name, + elementType): Context ``` #### Parameters @@ -286,20 +239,16 @@ arrayDeclarationReferenceContext( | `name` | `string` | | `elementType` | `Type` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.arrayDeclarationReferenceContext *** -### arrayLiteral +### arrayLiteral() ```ts -arrayLiteral(array, elementType): EmitterOutput< object > +arrayLiteral(array, elementType): EmitterOutput ``` #### Parameters @@ -309,17 +258,13 @@ arrayLiteral(array, elementType): EmitterOutput< object > | `array` | `Model` | | `elementType` | `Type` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.arrayLiteral *** -### arrayLiteralContext +### arrayLiteralContext() ```ts arrayLiteralContext(array, elementType): Context @@ -332,17 +277,13 @@ arrayLiteralContext(array, elementType): Context | `array` | `Model` | | `elementType` | `Type` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.arrayLiteralContext *** -### arrayLiteralReferenceContext +### arrayLiteralReferenceContext() ```ts arrayLiteralReferenceContext(array, elementType): Context @@ -355,20 +296,16 @@ arrayLiteralReferenceContext(array, elementType): Context | `array` | `Model` | | `elementType` | `Type` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.arrayLiteralReferenceContext *** -### booleanLiteral +### booleanLiteral() ```ts -booleanLiteral(boolean): EmitterOutput< object > +booleanLiteral(boolean): EmitterOutput ``` #### Parameters @@ -377,17 +314,13 @@ booleanLiteral(boolean): EmitterOutput< object > | :------ | :------ | | `boolean` | `BooleanLiteral` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.booleanLiteral *** -### booleanLiteralContext +### booleanLiteralContext() ```ts booleanLiteralContext(boolean): Context @@ -399,17 +332,13 @@ booleanLiteralContext(boolean): Context | :------ | :------ | | `boolean` | `BooleanLiteral` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.booleanLiteralContext *** -### declarationName +### declarationName() ```ts declarationName(declarationType): undefined | string @@ -421,20 +350,16 @@ declarationName(declarationType): undefined | string | :------ | :------ | | `declarationType` | `TypeSpecDeclaration` | -#### Returns - -`undefined` \| `string` - #### Inherited from TypeEmitter.declarationName *** -### enumDeclaration +### enumDeclaration() ```ts -enumDeclaration(en, name): EmitterOutput< object > +enumDeclaration(en, name): EmitterOutput ``` #### Parameters @@ -444,17 +369,13 @@ enumDeclaration(en, name): EmitterOutput< object > | `en` | `Enum` | | `name` | `string` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.enumDeclaration *** -### enumDeclarationContext +### enumDeclarationContext() ```ts enumDeclarationContext(en): Context @@ -466,20 +387,16 @@ enumDeclarationContext(en): Context | :------ | :------ | | `en` | `Enum` | -#### Returns - -`Context` - #### Overrides TypeEmitter.enumDeclarationContext *** -### enumMember +### enumMember() ```ts -enumMember(member): EmitterOutput< Record< string, any > > +enumMember(member): EmitterOutput> ``` #### Parameters @@ -488,17 +405,13 @@ enumMember(member): EmitterOutput< Record< string, any > > | :------ | :------ | | `member` | `EnumMember` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Inherited from TypeEmitter.enumMember *** -### enumMemberContext +### enumMemberContext() ```ts enumMemberContext(member): object @@ -510,20 +423,16 @@ enumMemberContext(member): object | :------ | :------ | | `member` | `EnumMember` | -#### Returns - -`object` - #### Inherited from TypeEmitter.enumMemberContext *** -### enumMemberReference +### enumMemberReference() ```ts -enumMemberReference(member): EmitterOutput< Record< string, any > > +enumMemberReference(member): EmitterOutput> ``` #### Parameters @@ -532,20 +441,16 @@ enumMemberReference(member): EmitterOutput< Record< string, any > > | :------ | :------ | | `member` | `EnumMember` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Overrides TypeEmitter.enumMemberReference *** -### enumMembers +### enumMembers() ```ts -enumMembers(en): EmitterOutput< Record< string, any > > +enumMembers(en): EmitterOutput> ``` #### Parameters @@ -554,17 +459,13 @@ enumMembers(en): EmitterOutput< Record< string, any > > | :------ | :------ | | `en` | `Enum` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Inherited from TypeEmitter.enumMembers *** -### enumMembersContext +### enumMembersContext() ```ts enumMembersContext(en): Context @@ -576,20 +477,16 @@ enumMembersContext(en): Context | :------ | :------ | | `en` | `Enum` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.enumMembersContext *** -### interfaceDeclaration +### interfaceDeclaration() ```ts -interfaceDeclaration(iface, name): EmitterOutput< Record< string, any > > +interfaceDeclaration(iface, name): EmitterOutput> ``` #### Parameters @@ -599,17 +496,13 @@ interfaceDeclaration(iface, name): EmitterOutput< Record< string, any > > | `iface` | `Interface` | | `name` | `string` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Inherited from TypeEmitter.interfaceDeclaration *** -### interfaceDeclarationContext +### interfaceDeclarationContext() ```ts interfaceDeclarationContext(iface, name): Context @@ -622,20 +515,16 @@ interfaceDeclarationContext(iface, name): Context | `iface` | `Interface` | | `name` | `string` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.interfaceDeclarationContext *** -### interfaceDeclarationOperations +### interfaceDeclarationOperations() ```ts -interfaceDeclarationOperations(iface): EmitterOutput< Record< string, any > > +interfaceDeclarationOperations(iface): EmitterOutput> ``` #### Parameters @@ -644,17 +533,13 @@ interfaceDeclarationOperations(iface): EmitterOutput< Record< string, any > > | :------ | :------ | | `iface` | `Interface` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Inherited from TypeEmitter.interfaceDeclarationOperations *** -### interfaceDeclarationOperationsContext +### interfaceDeclarationOperationsContext() ```ts interfaceDeclarationOperationsContext(iface): Context @@ -666,17 +551,13 @@ interfaceDeclarationOperationsContext(iface): Context | :------ | :------ | | `iface` | `Interface` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.interfaceDeclarationOperationsContext *** -### interfaceDeclarationOperationsReferenceContext +### interfaceDeclarationOperationsReferenceContext() ```ts interfaceDeclarationOperationsReferenceContext(iface): Context @@ -688,17 +569,13 @@ interfaceDeclarationOperationsReferenceContext(iface): Context | :------ | :------ | | `iface` | `Interface` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.interfaceDeclarationOperationsReferenceContext *** -### interfaceDeclarationReferenceContext +### interfaceDeclarationReferenceContext() ```ts interfaceDeclarationReferenceContext(iface, name): Context @@ -711,20 +588,16 @@ interfaceDeclarationReferenceContext(iface, name): Context | `iface` | `Interface` | | `name` | `string` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.interfaceDeclarationReferenceContext *** -### interfaceOperationDeclaration +### interfaceOperationDeclaration() ```ts -interfaceOperationDeclaration(operation, name): EmitterOutput< Record< string, any > > +interfaceOperationDeclaration(operation, name): EmitterOutput> ``` #### Parameters @@ -734,17 +607,13 @@ interfaceOperationDeclaration(operation, name): EmitterOutput< Record< string, a | `operation` | `Operation` | | `name` | `string` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Inherited from TypeEmitter.interfaceOperationDeclaration *** -### interfaceOperationDeclarationContext +### interfaceOperationDeclarationContext() ```ts interfaceOperationDeclarationContext(operation, name): Context @@ -757,17 +626,13 @@ interfaceOperationDeclarationContext(operation, name): Context | `operation` | `Operation` | | `name` | `string` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.interfaceOperationDeclarationContext *** -### interfaceOperationDeclarationReferenceContext +### interfaceOperationDeclarationReferenceContext() ```ts interfaceOperationDeclarationReferenceContext(operation, name): Context @@ -780,20 +645,16 @@ interfaceOperationDeclarationReferenceContext(operation, name): Context | `operation` | `Operation` | | `name` | `string` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.interfaceOperationDeclarationReferenceContext *** -### intrinsic +### intrinsic() ```ts -intrinsic(intrinsic, name): EmitterOutput< object > +intrinsic(intrinsic, name): EmitterOutput ``` #### Parameters @@ -803,17 +664,13 @@ intrinsic(intrinsic, name): EmitterOutput< object > | `intrinsic` | `IntrinsicType` | | `name` | `string` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.intrinsic *** -### intrinsicContext +### intrinsicContext() ```ts intrinsicContext(intrinsic, name): Context @@ -826,20 +683,16 @@ intrinsicContext(intrinsic, name): Context | `intrinsic` | `IntrinsicType` | | `name` | `string` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.intrinsicContext *** -### modelDeclaration +### modelDeclaration() ```ts -modelDeclaration(model, name): EmitterOutput< object > +modelDeclaration(model, name): EmitterOutput ``` #### Parameters @@ -849,17 +702,13 @@ modelDeclaration(model, name): EmitterOutput< object > | `model` | `Model` | | `name` | `string` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.modelDeclaration *** -### modelDeclarationContext +### modelDeclarationContext() ```ts modelDeclarationContext(model, name): Context @@ -872,17 +721,13 @@ modelDeclarationContext(model, name): Context | `model` | `Model` | | `name` | `string` | -#### Returns - -`Context` - #### Overrides TypeEmitter.modelDeclarationContext *** -### modelDeclarationReferenceContext +### modelDeclarationReferenceContext() ```ts modelDeclarationReferenceContext(model, name): Context @@ -897,20 +742,16 @@ Set reference context for a model declaration. | `model` | `Model` | | | `name` | `string` | - | -#### Returns - -`Context` - #### Inherited from TypeEmitter.modelDeclarationReferenceContext *** -### modelInstantiation +### modelInstantiation() ```ts -modelInstantiation(model, name): EmitterOutput< Record< string, any > > +modelInstantiation(model, name): EmitterOutput> ``` #### Parameters @@ -920,17 +761,13 @@ modelInstantiation(model, name): EmitterOutput< Record< string, any > > | `model` | `Model` | | `name` | `undefined` \| `string` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Overrides TypeEmitter.modelInstantiation *** -### modelInstantiationContext +### modelInstantiationContext() ```ts modelInstantiationContext(model, name): Context @@ -943,17 +780,13 @@ modelInstantiationContext(model, name): Context | `model` | `Model` | | `name` | `undefined` \| `string` | -#### Returns - -`Context` - #### Overrides TypeEmitter.modelInstantiationContext *** -### modelInstantiationReferenceContext +### modelInstantiationReferenceContext() ```ts modelInstantiationReferenceContext(model, name): Context @@ -968,20 +801,16 @@ Set reference context for a model declaration. | `model` | `Model` | | | `name` | `undefined` \| `string` | - | -#### Returns - -`Context` - #### Inherited from TypeEmitter.modelInstantiationReferenceContext *** -### modelLiteral +### modelLiteral() ```ts -modelLiteral(model): EmitterOutput< object > +modelLiteral(model): EmitterOutput ``` #### Parameters @@ -990,17 +819,13 @@ modelLiteral(model): EmitterOutput< object > | :------ | :------ | | `model` | `Model` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.modelLiteral *** -### modelLiteralContext +### modelLiteralContext() ```ts modelLiteralContext(model): Context @@ -1014,17 +839,13 @@ Set lexical context for a model literal. | :------ | :------ | :------ | | `model` | `Model` | | -#### Returns - -`Context` - #### Inherited from TypeEmitter.modelLiteralContext *** -### modelLiteralReferenceContext +### modelLiteralReferenceContext() ```ts modelLiteralReferenceContext(model): Context @@ -1038,20 +859,16 @@ Set reference context for a model literal. | :------ | :------ | :------ | | `model` | `Model` | | -#### Returns - -`Context` - #### Inherited from TypeEmitter.modelLiteralReferenceContext *** -### modelProperties +### modelProperties() ```ts -modelProperties(model): EmitterOutput< object > +modelProperties(model): EmitterOutput ``` #### Parameters @@ -1060,17 +877,13 @@ modelProperties(model): EmitterOutput< object > | :------ | :------ | | `model` | `Model` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.modelProperties *** -### modelPropertiesContext +### modelPropertiesContext() ```ts modelPropertiesContext(model): Context @@ -1082,17 +895,13 @@ modelPropertiesContext(model): Context | :------ | :------ | | `model` | `Model` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.modelPropertiesContext *** -### modelPropertiesReferenceContext +### modelPropertiesReferenceContext() ```ts modelPropertiesReferenceContext(model): Context @@ -1104,20 +913,16 @@ modelPropertiesReferenceContext(model): Context | :------ | :------ | | `model` | `Model` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.modelPropertiesReferenceContext *** -### modelPropertyLiteral +### modelPropertyLiteral() ```ts -modelPropertyLiteral(property): EmitterOutput< object > +modelPropertyLiteral(property): EmitterOutput ``` #### Parameters @@ -1126,17 +931,13 @@ modelPropertyLiteral(property): EmitterOutput< object > | :------ | :------ | | `property` | `ModelProperty` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.modelPropertyLiteral *** -### modelPropertyLiteralContext +### modelPropertyLiteralContext() ```ts modelPropertyLiteralContext(property): Context @@ -1150,17 +951,13 @@ Set lexical context for a property of a model. | :------ | :------ | :------ | | `property` | `ModelProperty` | | -#### Returns - -`Context` - #### Inherited from TypeEmitter.modelPropertyLiteralContext *** -### modelPropertyLiteralReferenceContext +### modelPropertyLiteralReferenceContext() ```ts modelPropertyLiteralReferenceContext(property): Context @@ -1174,20 +971,16 @@ Set reference context for a property of a model. | :------ | :------ | :------ | | `property` | `ModelProperty` | | -#### Returns - -`Context` - #### Inherited from TypeEmitter.modelPropertyLiteralReferenceContext *** -### modelPropertyReference +### modelPropertyReference() ```ts -modelPropertyReference(property): EmitterOutput< object > +modelPropertyReference(property): EmitterOutput ``` #### Parameters @@ -1196,20 +989,16 @@ modelPropertyReference(property): EmitterOutput< object > | :------ | :------ | | `property` | `ModelProperty` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.modelPropertyReference *** -### namespace +### namespace() ```ts -namespace(namespace): EmitterOutput< Record< string, any > > +namespace(namespace): EmitterOutput> ``` Emit a namespace @@ -1222,8 +1011,6 @@ Emit a namespace #### Returns -`EmitterOutput`< `Record`< `string`, `any` \> \> - Emitter output #### Inherited from @@ -1232,7 +1019,7 @@ TypeEmitter.namespace *** -### namespaceContext +### namespaceContext() ```ts namespaceContext(namespace): Context @@ -1246,17 +1033,13 @@ Set lexical context for a namespace | :------ | :------ | :------ | | `namespace` | `Namespace` | | -#### Returns - -`Context` - #### Inherited from TypeEmitter.namespaceContext *** -### namespaceReferenceContext +### namespaceReferenceContext() ```ts namespaceReferenceContext(namespace): Context @@ -1270,20 +1053,16 @@ Set reference context for a namespace. | :------ | :------ | :------ | | `namespace` | `Namespace` | | -#### Returns - -`Context` - #### Inherited from TypeEmitter.namespaceReferenceContext *** -### numericLiteral +### numericLiteral() ```ts -numericLiteral(number): EmitterOutput< object > +numericLiteral(number): EmitterOutput ``` #### Parameters @@ -1292,17 +1071,13 @@ numericLiteral(number): EmitterOutput< object > | :------ | :------ | | `number` | `NumericLiteral` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.numericLiteral *** -### numericLiteralContext +### numericLiteralContext() ```ts numericLiteralContext(number): Context @@ -1314,20 +1089,16 @@ numericLiteralContext(number): Context | :------ | :------ | | `number` | `NumericLiteral` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.numericLiteralContext *** -### operationDeclaration +### operationDeclaration() ```ts -operationDeclaration(operation, name): EmitterOutput< Record< string, any > > +operationDeclaration(operation, name): EmitterOutput> ``` #### Parameters @@ -1337,17 +1108,13 @@ operationDeclaration(operation, name): EmitterOutput< Record< string, any > > | `operation` | `Operation` | | `name` | `string` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Inherited from TypeEmitter.operationDeclaration *** -### operationDeclarationContext +### operationDeclarationContext() ```ts operationDeclarationContext(operation, name): Context @@ -1360,17 +1127,13 @@ operationDeclarationContext(operation, name): Context | `operation` | `Operation` | | `name` | `string` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.operationDeclarationContext *** -### operationDeclarationReferenceContext +### operationDeclarationReferenceContext() ```ts operationDeclarationReferenceContext(operation, name): Context @@ -1383,20 +1146,16 @@ operationDeclarationReferenceContext(operation, name): Context | `operation` | `Operation` | | `name` | `string` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.operationDeclarationReferenceContext *** -### operationParameters +### operationParameters() ```ts -operationParameters(operation, parameters): EmitterOutput< Record< string, any > > +operationParameters(operation, parameters): EmitterOutput> ``` #### Parameters @@ -1406,17 +1165,13 @@ operationParameters(operation, parameters): EmitterOutput< Record< string, any > | `operation` | `Operation` | | `parameters` | `Model` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Inherited from TypeEmitter.operationParameters *** -### operationParametersContext +### operationParametersContext() ```ts operationParametersContext(operation, parameters): Context @@ -1429,17 +1184,13 @@ operationParametersContext(operation, parameters): Context | `operation` | `Operation` | | `parameters` | `Model` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.operationParametersContext *** -### operationParametersReferenceContext +### operationParametersReferenceContext() ```ts operationParametersReferenceContext(operation, parameters): Context @@ -1452,20 +1203,16 @@ operationParametersReferenceContext(operation, parameters): Context | `operation` | `Operation` | | `parameters` | `Model` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.operationParametersReferenceContext *** -### operationReturnType +### operationReturnType() ```ts -operationReturnType(operation, returnType): EmitterOutput< Record< string, any > > +operationReturnType(operation, returnType): EmitterOutput> ``` #### Parameters @@ -1475,17 +1222,13 @@ operationReturnType(operation, returnType): EmitterOutput< Record< string, any > | `operation` | `Operation` | | `returnType` | `Type` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Inherited from TypeEmitter.operationReturnType *** -### operationReturnTypeContext +### operationReturnTypeContext() ```ts operationReturnTypeContext(operation, returnType): Context @@ -1498,17 +1241,13 @@ operationReturnTypeContext(operation, returnType): Context | `operation` | `Operation` | | `returnType` | `Type` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.operationReturnTypeContext *** -### operationReturnTypeReferenceContext +### operationReturnTypeReferenceContext() ```ts operationReturnTypeReferenceContext(operation, returnType): Context @@ -1521,17 +1260,13 @@ operationReturnTypeReferenceContext(operation, returnType): Context | `operation` | `Operation` | | `returnType` | `Type` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.operationReturnTypeReferenceContext *** -### programContext +### programContext() ```ts programContext(program): Context @@ -1543,38 +1278,30 @@ programContext(program): Context | :------ | :------ | | `program` | `Program` | -#### Returns - -`Context` - #### Overrides TypeEmitter.programContext *** -### reference +### reference() ```ts reference( - targetDeclaration, - pathUp, - pathDown, - commonScope): object | EmitEntity< Record< string, unknown > > + targetDeclaration, + pathUp, + pathDown, +commonScope): object | EmitEntity> ``` #### Parameters | Parameter | Type | | :------ | :------ | -| `targetDeclaration` | `Declaration`< `Record`< `string`, `unknown` \> \> | -| `pathUp` | `Scope`< `Record`< `string`, `unknown` \> \>[] | -| `pathDown` | `Scope`< `Record`< `string`, `unknown` \> \>[] | -| `commonScope` | `null` \| `Scope`< `Record`< `string`, `unknown` \> \> | - -#### Returns - -`object` \| `EmitEntity`< `Record`< `string`, `unknown` \> \> +| `targetDeclaration` | `Declaration`<`Record`<`string`, `unknown`\>\> | +| `pathUp` | `Scope`<`Record`<`string`, `unknown`\>\>[] | +| `pathDown` | `Scope`<`Record`<`string`, `unknown`\>\>[] | +| `commonScope` | `null` \| `Scope`<`Record`<`string`, `unknown`\>\> | #### Overrides @@ -1582,10 +1309,10 @@ TypeEmitter.reference *** -### scalarDeclaration +### scalarDeclaration() ```ts -scalarDeclaration(scalar, name): EmitterOutput< object > +scalarDeclaration(scalar, name): EmitterOutput ``` #### Parameters @@ -1595,17 +1322,13 @@ scalarDeclaration(scalar, name): EmitterOutput< object > | `scalar` | `Scalar` | | `name` | `string` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.scalarDeclaration *** -### scalarDeclarationContext +### scalarDeclarationContext() ```ts scalarDeclarationContext(scalar): Context @@ -1617,20 +1340,16 @@ scalarDeclarationContext(scalar): Context | :------ | :------ | | `scalar` | `Scalar` | -#### Returns - -`Context` - #### Overrides TypeEmitter.scalarDeclarationContext *** -### scalarInstantiation +### scalarInstantiation() ```ts -scalarInstantiation(scalar, name): EmitterOutput< Record< string, any > > +scalarInstantiation(scalar, name): EmitterOutput> ``` #### Parameters @@ -1640,17 +1359,13 @@ scalarInstantiation(scalar, name): EmitterOutput< Record< string, any > > | `scalar` | `Scalar` | | `name` | `undefined` \| `string` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Inherited from TypeEmitter.scalarInstantiation *** -### scalarInstantiationContext +### scalarInstantiationContext() ```ts scalarInstantiationContext(scalar, name): Context @@ -1663,17 +1378,13 @@ scalarInstantiationContext(scalar, name): Context | `scalar` | `Scalar` | | `name` | `undefined` \| `string` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.scalarInstantiationContext *** -### sourceFile +### sourceFile() ```ts sourceFile(sourceFile): EmittedSourceFile @@ -1683,11 +1394,7 @@ sourceFile(sourceFile): EmittedSourceFile | Parameter | Type | | :------ | :------ | -| `sourceFile` | `SourceFile`< `object` \> | - -#### Returns - -`EmittedSourceFile` +| `sourceFile` | `SourceFile`<`object`\> | #### Overrides @@ -1695,10 +1402,10 @@ TypeEmitter.sourceFile *** -### stringLiteral +### stringLiteral() ```ts -stringLiteral(string): EmitterOutput< object > +stringLiteral(string): EmitterOutput ``` #### Parameters @@ -1707,17 +1414,13 @@ stringLiteral(string): EmitterOutput< object > | :------ | :------ | | `string` | `StringLiteral` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.stringLiteral *** -### stringLiteralContext +### stringLiteralContext() ```ts stringLiteralContext(string): Context @@ -1729,20 +1432,16 @@ stringLiteralContext(string): Context | :------ | :------ | | `string` | `StringLiteral` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.stringLiteralContext *** -### tupleLiteral +### tupleLiteral() ```ts -tupleLiteral(tuple): EmitterOutput< Record< string, any > > +tupleLiteral(tuple): EmitterOutput> ``` #### Parameters @@ -1751,17 +1450,13 @@ tupleLiteral(tuple): EmitterOutput< Record< string, any > > | :------ | :------ | | `tuple` | `Tuple` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Inherited from TypeEmitter.tupleLiteral *** -### tupleLiteralContext +### tupleLiteralContext() ```ts tupleLiteralContext(tuple): Context @@ -1773,17 +1468,13 @@ tupleLiteralContext(tuple): Context | :------ | :------ | | `tuple` | `Tuple` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.tupleLiteralContext *** -### tupleLiteralReferenceContext +### tupleLiteralReferenceContext() ```ts tupleLiteralReferenceContext(tuple): Context @@ -1795,20 +1486,16 @@ tupleLiteralReferenceContext(tuple): Context | :------ | :------ | | `tuple` | `Tuple` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.tupleLiteralReferenceContext *** -### tupleLiteralValues +### tupleLiteralValues() ```ts -tupleLiteralValues(tuple): EmitterOutput< Record< string, any > > +tupleLiteralValues(tuple): EmitterOutput> ``` #### Parameters @@ -1817,20 +1504,16 @@ tupleLiteralValues(tuple): EmitterOutput< Record< string, any > > | :------ | :------ | | `tuple` | `Tuple` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Inherited from TypeEmitter.tupleLiteralValues *** -### unionDeclaration +### unionDeclaration() ```ts -unionDeclaration(union, name): EmitterOutput< object > +unionDeclaration(union, name): EmitterOutput ``` #### Parameters @@ -1840,17 +1523,13 @@ unionDeclaration(union, name): EmitterOutput< object > | `union` | `Union` | | `name` | `string` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.unionDeclaration *** -### unionDeclarationContext +### unionDeclarationContext() ```ts unionDeclarationContext(union): Context @@ -1862,17 +1541,13 @@ unionDeclarationContext(union): Context | :------ | :------ | | `union` | `Union` | -#### Returns - -`Context` - #### Overrides TypeEmitter.unionDeclarationContext *** -### unionDeclarationReferenceContext +### unionDeclarationReferenceContext() ```ts unionDeclarationReferenceContext(union): Context @@ -1884,20 +1559,16 @@ unionDeclarationReferenceContext(union): Context | :------ | :------ | | `union` | `Union` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.unionDeclarationReferenceContext *** -### unionInstantiation +### unionInstantiation() ```ts -unionInstantiation(union, name): EmitterOutput< Record< string, any > > +unionInstantiation(union, name): EmitterOutput> ``` #### Parameters @@ -1907,17 +1578,13 @@ unionInstantiation(union, name): EmitterOutput< Record< string, any > > | `union` | `Union` | | `name` | `string` | -#### Returns - -`EmitterOutput`< `Record`< `string`, `any` \> \> - #### Inherited from TypeEmitter.unionInstantiation *** -### unionInstantiationContext +### unionInstantiationContext() ```ts unionInstantiationContext(union, name): Context @@ -1930,17 +1597,13 @@ unionInstantiationContext(union, name): Context | `union` | `Union` | | `name` | `string` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.unionInstantiationContext *** -### unionInstantiationReferenceContext +### unionInstantiationReferenceContext() ```ts unionInstantiationReferenceContext(union, name): Context @@ -1953,20 +1616,16 @@ unionInstantiationReferenceContext(union, name): Context | `union` | `Union` | | `name` | `string` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.unionInstantiationReferenceContext *** -### unionLiteral +### unionLiteral() ```ts -unionLiteral(union): EmitterOutput< object > +unionLiteral(union): EmitterOutput ``` #### Parameters @@ -1975,17 +1634,13 @@ unionLiteral(union): EmitterOutput< object > | :------ | :------ | | `union` | `Union` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.unionLiteral *** -### unionLiteralContext +### unionLiteralContext() ```ts unionLiteralContext(union): Context @@ -1997,17 +1652,13 @@ unionLiteralContext(union): Context | :------ | :------ | | `union` | `Union` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.unionLiteralContext *** -### unionLiteralReferenceContext +### unionLiteralReferenceContext() ```ts unionLiteralReferenceContext(union): Context @@ -2019,20 +1670,16 @@ unionLiteralReferenceContext(union): Context | :------ | :------ | | `union` | `Union` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.unionLiteralReferenceContext *** -### unionVariant +### unionVariant() ```ts -unionVariant(variant): EmitterOutput< object > +unionVariant(variant): EmitterOutput ``` #### Parameters @@ -2041,17 +1688,13 @@ unionVariant(variant): EmitterOutput< object > | :------ | :------ | | `variant` | `UnionVariant` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.unionVariant *** -### unionVariantContext +### unionVariantContext() ```ts unionVariantContext(union): Context @@ -2063,17 +1706,13 @@ unionVariantContext(union): Context | :------ | :------ | | `union` | `Union` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.unionVariantContext *** -### unionVariantReferenceContext +### unionVariantReferenceContext() ```ts unionVariantReferenceContext(union): Context @@ -2085,20 +1724,16 @@ unionVariantReferenceContext(union): Context | :------ | :------ | | `union` | `Union` | -#### Returns - -`Context` - #### Inherited from TypeEmitter.unionVariantReferenceContext *** -### unionVariants +### unionVariants() ```ts -unionVariants(union): EmitterOutput< object > +unionVariants(union): EmitterOutput ``` #### Parameters @@ -2107,63 +1742,47 @@ unionVariants(union): EmitterOutput< object > | :------ | :------ | | `union` | `Union` | -#### Returns - -`EmitterOutput`< `object` \> - #### Overrides TypeEmitter.unionVariants *** -### unionVariantsContext +### unionVariantsContext() ```ts unionVariantsContext(): Context ``` -#### Returns - -`Context` - #### Inherited from TypeEmitter.unionVariantsContext *** -### unionVariantsReferenceContext +### unionVariantsReferenceContext() ```ts unionVariantsReferenceContext(): Context ``` -#### Returns - -`Context` - #### Inherited from TypeEmitter.unionVariantsReferenceContext *** -### writeOutput +### writeOutput() ```ts -writeOutput(sourceFiles): Promise< void > +writeOutput(sourceFiles): Promise ``` #### Parameters | Parameter | Type | | :------ | :------ | -| `sourceFiles` | `SourceFile`< `Record`< `string`, `any` \> \>[] | - -#### Returns - -`Promise`< `void` \> +| `sourceFiles` | `SourceFile`<`Record`<`string`, `any`\>\>[] | #### Overrides diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$baseUri.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$baseUri.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$baseUri.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$baseUri.md index d8c44a2543..4fb6ee2ccd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$baseUri.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$baseUri.md @@ -5,9 +5,9 @@ title: "[F] $baseUri" --- ```ts $baseUri( - context, - target, - baseUri): void + context, + target, + baseUri): void ``` ## Parameters @@ -17,7 +17,3 @@ $baseUri( | `context` | `DecoratorContext` | | `target` | `Namespace` | | `baseUri` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contains.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contains.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contains.md index 92ac56d6e8..77d35d5d4e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contains.md @@ -5,9 +5,9 @@ title: "[F] $contains" --- ```ts $contains( - context, - target, - value): void + context, + target, + value): void ``` ## Parameters @@ -17,7 +17,3 @@ $contains( | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `value` | `Type` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentEncoding.md similarity index 81% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentEncoding.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentEncoding.md index de78004bf4..2dcef7681d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentEncoding.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentEncoding.md @@ -5,9 +5,9 @@ title: "[F] $contentEncoding" --- ```ts $contentEncoding( - context, - target, - value): void + context, + target, + value): void ``` ## Parameters @@ -17,7 +17,3 @@ $contentEncoding( | `context` | `DecoratorContext` | | `target` | `StringLiteral` \| `ModelProperty` | | `value` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentMediaType.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentMediaType.md similarity index 81% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentMediaType.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentMediaType.md index 773d7935c7..efdd8b2caf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentMediaType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentMediaType.md @@ -5,9 +5,9 @@ title: "[F] $contentMediaType" --- ```ts $contentMediaType( - context, - target, - value): void + context, + target, + value): void ``` ## Parameters @@ -17,7 +17,3 @@ $contentMediaType( | `context` | `DecoratorContext` | | `target` | `StringLiteral` \| `ModelProperty` | | `value` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentSchema.md similarity index 81% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentSchema.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentSchema.md index c96d8354ca..e0ea17ecb7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$contentSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$contentSchema.md @@ -5,9 +5,9 @@ title: "[F] $contentSchema" --- ```ts $contentSchema( - context, - target, - value): void + context, + target, + value): void ``` ## Parameters @@ -17,7 +17,3 @@ $contentSchema( | `context` | `DecoratorContext` | | `target` | `StringLiteral` \| `ModelProperty` | | `value` | `Type` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$extension.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$extension.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$extension.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$extension.md index 3d1a9ea67b..62fa25355f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$extension.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$extension.md @@ -5,10 +5,10 @@ title: "[F] $extension" --- ```ts $extension( - context, - target, - key, - value): void + context, + target, + key, + value): void ``` ## Parameters @@ -19,7 +19,3 @@ $extension( | `target` | `Type` | | `key` | `string` | | `value` | `Type` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$id.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$id.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$id.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$id.md index 72612867c9..a9a22c68e0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$id.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$id.md @@ -5,9 +5,9 @@ title: "[F] $id" --- ```ts $id( - context, - target, - value): void + context, + target, + value): void ``` ## Parameters @@ -17,7 +17,3 @@ $id( | `context` | `DecoratorContext` | | `target` | `Model` \| `Scalar` \| `Enum` \| `Union` | | `value` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$jsonSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$jsonSchema.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$jsonSchema.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$jsonSchema.md index b63c53b10f..d71d8272f1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$jsonSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$jsonSchema.md @@ -5,9 +5,9 @@ title: "[F] $jsonSchema" --- ```ts $jsonSchema( - context, - target, - baseUriOrId?): void + context, + target, + baseUriOrId?): void ``` ## Parameters @@ -15,9 +15,5 @@ $jsonSchema( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Namespace` \| [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | +| `target` | `Namespace` \| [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | | `baseUriOrId`? | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxContains.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxContains.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxContains.md index b096e943b1..b6433ac379 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxContains.md @@ -5,9 +5,9 @@ title: "[F] $maxContains" --- ```ts $maxContains( - context, - target, - value): void + context, + target, + value): void ``` ## Parameters @@ -17,7 +17,3 @@ $maxContains( | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxProperties.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxProperties.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxProperties.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxProperties.md index 349ef62129..3797b6ed0a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$maxProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$maxProperties.md @@ -5,9 +5,9 @@ title: "[F] $maxProperties" --- ```ts $maxProperties( - context, - target, - value): void + context, + target, + value): void ``` ## Parameters @@ -17,7 +17,3 @@ $maxProperties( | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minContains.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minContains.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minContains.md index 1889672b17..aa8d6c5779 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minContains.md @@ -5,9 +5,9 @@ title: "[F] $minContains" --- ```ts $minContains( - context, - target, - value): void + context, + target, + value): void ``` ## Parameters @@ -17,7 +17,3 @@ $minContains( | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minProperties.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minProperties.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minProperties.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minProperties.md index ea42687c28..7220726f9e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$minProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$minProperties.md @@ -5,9 +5,9 @@ title: "[F] $minProperties" --- ```ts $minProperties( - context, - target, - value): void + context, + target, + value): void ``` ## Parameters @@ -17,7 +17,3 @@ $minProperties( | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$multipleOf.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$multipleOf.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$multipleOf.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$multipleOf.md index f1eb1cc59c..29df2c371b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$multipleOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$multipleOf.md @@ -5,9 +5,9 @@ title: "[F] $multipleOf" --- ```ts $multipleOf( - context, - target, - value): void + context, + target, + value): void ``` ## Parameters @@ -17,7 +17,3 @@ $multipleOf( | `context` | `DecoratorContext` | | `target` | `Model` | | `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$onEmit.md new file mode 100644 index 0000000000..c8d2de9fb2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$onEmit.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[F] $onEmit" + +--- +```ts +$onEmit(context): Promise +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `EmitContext`<[`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$prefixItems.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$prefixItems.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$prefixItems.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$prefixItems.md index dc825cef20..efe0c3c814 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$prefixItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$prefixItems.md @@ -5,9 +5,9 @@ title: "[F] $prefixItems" --- ```ts $prefixItems( - context, - target, - value): void + context, + target, + value): void ``` ## Parameters @@ -17,7 +17,3 @@ $prefixItems( | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | | `value` | `Tuple` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$uniqueItems.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$uniqueItems.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$uniqueItems.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$uniqueItems.md index cd02cd49ca..d1e815ecfc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$uniqueItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$uniqueItems.md @@ -13,7 +13,3 @@ $uniqueItems(context, target): void | :------ | :------ | | `context` | `DecoratorContext` | | `target` | `Model` \| `ModelProperty` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$validatesRawJson.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$validatesRawJson.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$validatesRawJson.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$validatesRawJson.md index 8ba5269b15..2b38c02950 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.$validatesRawJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/$validatesRawJson.md @@ -5,9 +5,9 @@ title: "[F] $validatesRawJson" --- ```ts $validatesRawJson( - context, - target, - value): void + context, + target, + value): void ``` ## Parameters @@ -17,7 +17,3 @@ $validatesRawJson( | `context` | `DecoratorContext` | | `target` | `Model` | | `value` | `Type` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.findBaseUri.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/findBaseUri.md similarity index 60% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.findBaseUri.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/findBaseUri.md index 0e69c3675d..8278960d03 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.findBaseUri.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/findBaseUri.md @@ -12,8 +12,4 @@ findBaseUri(program, target): string | undefined | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `target` | `Namespace` \| [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | - -## Returns - -`string` \| `undefined` +| `target` | `Namespace` \| [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getBaseUri.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getBaseUri.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getBaseUri.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getBaseUri.md index c94f662005..dd83a9c6c9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getBaseUri.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getBaseUri.md @@ -13,7 +13,3 @@ getBaseUri(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContains.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContains.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContains.md index b0da5ad87f..17ffcc61ec 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContains.md @@ -13,7 +13,3 @@ getContains(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentEncoding.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentEncoding.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentEncoding.md index daaac1ade3..efff65e2a2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentEncoding.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentEncoding.md @@ -13,7 +13,3 @@ getContentEncoding(program, target): string | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentMediaType.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentMediaType.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentMediaType.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentMediaType.md index a3e3c8a6c0..774f13f7bf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentMediaType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentMediaType.md @@ -13,7 +13,3 @@ getContentMediaType(program, target): string | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentSchema.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentSchema.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentSchema.md index 52c63e3751..2ed8dd9350 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getContentSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getContentSchema.md @@ -13,7 +13,3 @@ getContentSchema(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getExtensions.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getExtensions.md similarity index 76% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getExtensions.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getExtensions.md index 5e6cf89ee2..d254dde711 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getExtensions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getExtensions.md @@ -13,7 +13,3 @@ getExtensions(program, target): ExtensionRecord[] | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -[`ExtensionRecord`](Interface.ExtensionRecord.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getId.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getId.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getId.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getId.md index c1a7a41f97..468b2321a9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getId.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getId.md @@ -13,7 +13,3 @@ getId(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchema.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchema.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchema.md index d08e1edf47..39392a1288 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchema.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchema.md @@ -13,7 +13,3 @@ getJsonSchema(program, target): boolean | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchemaTypes.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchemaTypes.md similarity index 83% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchemaTypes.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchemaTypes.md index 1d0453f616..6dc439ba2f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getJsonSchemaTypes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getJsonSchemaTypes.md @@ -12,7 +12,3 @@ getJsonSchemaTypes(program): (Namespace | Model)[] | Parameter | Type | | :------ | :------ | | `program` | `Program` | - -## Returns - -(`Namespace` \| `Model`)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxContains.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxContains.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxContains.md index 1444d48312..1bd1d037a9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxContains.md @@ -13,7 +13,3 @@ getMaxContains(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxProperties.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxProperties.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxProperties.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxProperties.md index d00b87352e..b7fadc390d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMaxProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMaxProperties.md @@ -13,7 +13,3 @@ getMaxProperties(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinContains.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinContains.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinContains.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinContains.md index 84ee972bfd..44059475b4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinContains.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinContains.md @@ -13,7 +13,3 @@ getMinContains(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinProperties.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinProperties.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinProperties.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinProperties.md index 6c748548e2..5ab738c867 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMinProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMinProperties.md @@ -13,7 +13,3 @@ getMinProperties(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMultipleOf.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMultipleOf.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMultipleOf.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMultipleOf.md index 1c0a704b15..f312718da3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getMultipleOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getMultipleOf.md @@ -13,7 +13,3 @@ getMultipleOf(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getPrefixItems.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getPrefixItems.md similarity index 85% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getPrefixItems.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getPrefixItems.md index 0e6407ad2f..ea9a32b3d6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getPrefixItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getPrefixItems.md @@ -13,7 +13,3 @@ getPrefixItems(program, target): Tuple | undefined | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`Tuple` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getUniqueItems.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getUniqueItems.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getUniqueItems.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getUniqueItems.md index 1de081729c..7a516e1991 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.getUniqueItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/getUniqueItems.md @@ -13,7 +13,3 @@ getUniqueItems(program, target): any | :------ | :------ | | `program` | `Program` | | `target` | `Type` | - -## Returns - -`any` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.isJsonSchemaDeclaration.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.isJsonSchemaDeclaration.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md index 0909d92558..8d6cd648bd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Function.isJsonSchemaDeclaration.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md @@ -12,8 +12,4 @@ isJsonSchemaDeclaration(program, target): boolean | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `target` | [`JsonSchemaDeclaration`](Type.JsonSchemaDeclaration.md) | - -## Returns - -`boolean` +| `target` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/index.md index 457dd4e42c..4848588ac1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/index.md @@ -3,65 +3,65 @@ jsApi: true title: "[P] JS Api" --- -## Index +## Exports ### Namespaces -- [$validatesRawJson](Namespace.$validatesRawJson.md) +- [$validatesRawJson](namespaces/$validatesRawJson/index.md) ### Classes -- [JsonSchemaEmitter](Class.JsonSchemaEmitter.md) +- [JsonSchemaEmitter](classes/JsonSchemaEmitter.md) ### Interfaces -- [ExtensionRecord](Interface.ExtensionRecord.md) -- [JSONSchemaEmitterOptions](Interface.JSONSchemaEmitterOptions.md) +- [ExtensionRecord](interfaces/ExtensionRecord.md) +- [JSONSchemaEmitterOptions](interfaces/JSONSchemaEmitterOptions.md) ### Type Aliases -- [JsonSchemaDeclaration](Type.JsonSchemaDeclaration.md) +- [JsonSchemaDeclaration](type-aliases/JsonSchemaDeclaration.md) ### Variables -- [$lib](Variable.$lib.md) -- [EmitterOptionsSchema](Variable.EmitterOptionsSchema.md) -- [namespace](Variable.namespace.md) +- [$lib](variables/$lib.md) +- [EmitterOptionsSchema](variables/EmitterOptionsSchema.md) +- [namespace](variables/namespace.md) ### Functions -- [$baseUri](Function.$baseUri.md) -- [$contains](Function.$contains.md) -- [$contentEncoding](Function.$contentEncoding.md) -- [$contentMediaType](Function.$contentMediaType.md) -- [$contentSchema](Function.$contentSchema.md) -- [$extension](Function.$extension.md) -- [$id](Function.$id.md) -- [$jsonSchema](Function.$jsonSchema.md) -- [$maxContains](Function.$maxContains.md) -- [$maxProperties](Function.$maxProperties.md) -- [$minContains](Function.$minContains.md) -- [$minProperties](Function.$minProperties.md) -- [$multipleOf](Function.$multipleOf.md) -- [$onEmit](Function.$onEmit.md) -- [$prefixItems](Function.$prefixItems.md) -- [$uniqueItems](Function.$uniqueItems.md) -- [$validatesRawJson](Function.$validatesRawJson.md) -- [findBaseUri](Function.findBaseUri.md) -- [getBaseUri](Function.getBaseUri.md) -- [getContains](Function.getContains.md) -- [getContentEncoding](Function.getContentEncoding.md) -- [getContentMediaType](Function.getContentMediaType.md) -- [getContentSchema](Function.getContentSchema.md) -- [getExtensions](Function.getExtensions.md) -- [getId](Function.getId.md) -- [getJsonSchema](Function.getJsonSchema.md) -- [getJsonSchemaTypes](Function.getJsonSchemaTypes.md) -- [getMaxContains](Function.getMaxContains.md) -- [getMaxProperties](Function.getMaxProperties.md) -- [getMinContains](Function.getMinContains.md) -- [getMinProperties](Function.getMinProperties.md) -- [getMultipleOf](Function.getMultipleOf.md) -- [getPrefixItems](Function.getPrefixItems.md) -- [getUniqueItems](Function.getUniqueItems.md) -- [isJsonSchemaDeclaration](Function.isJsonSchemaDeclaration.md) +- [$baseUri](functions/$baseUri.md) +- [$contains](functions/$contains.md) +- [$contentEncoding](functions/$contentEncoding.md) +- [$contentMediaType](functions/$contentMediaType.md) +- [$contentSchema](functions/$contentSchema.md) +- [$extension](functions/$extension.md) +- [$id](functions/$id.md) +- [$jsonSchema](functions/$jsonSchema.md) +- [$maxContains](functions/$maxContains.md) +- [$maxProperties](functions/$maxProperties.md) +- [$minContains](functions/$minContains.md) +- [$minProperties](functions/$minProperties.md) +- [$multipleOf](functions/$multipleOf.md) +- [$onEmit](functions/$onEmit.md) +- [$prefixItems](functions/$prefixItems.md) +- [$uniqueItems](functions/$uniqueItems.md) +- [$validatesRawJson](functions/$validatesRawJson.md) +- [findBaseUri](functions/findBaseUri.md) +- [getBaseUri](functions/getBaseUri.md) +- [getContains](functions/getContains.md) +- [getContentEncoding](functions/getContentEncoding.md) +- [getContentMediaType](functions/getContentMediaType.md) +- [getContentSchema](functions/getContentSchema.md) +- [getExtensions](functions/getExtensions.md) +- [getId](functions/getId.md) +- [getJsonSchema](functions/getJsonSchema.md) +- [getJsonSchemaTypes](functions/getJsonSchemaTypes.md) +- [getMaxContains](functions/getMaxContains.md) +- [getMaxProperties](functions/getMaxProperties.md) +- [getMinContains](functions/getMinContains.md) +- [getMinProperties](functions/getMinProperties.md) +- [getMultipleOf](functions/getMultipleOf.md) +- [getPrefixItems](functions/getPrefixItems.md) +- [getUniqueItems](functions/getUniqueItems.md) +- [isJsonSchemaDeclaration](functions/isJsonSchemaDeclaration.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/interfaces/ExtensionRecord.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/interfaces/ExtensionRecord.md new file mode 100644 index 0000000000..ab1f993a6e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/interfaces/ExtensionRecord.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] ExtensionRecord" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `key` | `string` | - | +| `value` | `Type` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.JSONSchemaEmitterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md similarity index 72% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.JSONSchemaEmitterOptions.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md index d0e8671a3e..2c8423baa5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Interface.JSONSchemaEmitterOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md @@ -7,8 +7,8 @@ title: "[I] JSONSchemaEmitterOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `bundleId`? | `string` | When provided, bundle all the schemas into a single json schema document
with schemas under $defs. The provided id is the id of the root document
and is also used for the file name. | -| `emitAllModels`? | `boolean` | When true, emit all model declarations to JSON Schema without requiring
the

**Json Schema**

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

**Default**

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

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

**Json Schema**

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

**Default**

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

* string: serialize as a string (widely interoperable)
* number: serialize as a number (not widely interoperable) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/namespaces/$validatesRawJson/index.md similarity index 54% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/namespaces/$validatesRawJson/index.md index f911163273..9f710c9c49 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/namespaces/$validatesRawJson/index.md @@ -7,4 +7,4 @@ title: "[N] $validatesRawJson" ### Variables -- [namespace](Namespace.$validatesRawJson.Variable.namespace.md) +- [namespace](variables/namespace.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/namespaces/$validatesRawJson/variables/namespace.md similarity index 71% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.Variable.namespace.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/namespaces/$validatesRawJson/variables/namespace.md index 326ad2a476..ef9b0531d5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Namespace.$validatesRawJson.Variable.namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/namespaces/$validatesRawJson/variables/namespace.md @@ -4,5 +4,5 @@ title: "[V] namespace" --- ```ts -let namespace: string +namespace: string; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Type.JsonSchemaDeclaration.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/type-aliases/JsonSchemaDeclaration.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Type.JsonSchemaDeclaration.md rename to packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/type-aliases/JsonSchemaDeclaration.md index 172ba48cf8..7d5536527f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/Type.JsonSchemaDeclaration.md +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/type-aliases/JsonSchemaDeclaration.md @@ -4,5 +4,5 @@ title: "[T] JsonSchemaDeclaration" --- ```ts -JsonSchemaDeclaration: Model | Union | Enum | Scalar +type JsonSchemaDeclaration: Model | Union | Enum | Scalar; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/variables/$lib.md new file mode 100644 index 0000000000..5743d59edd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/variables/$lib.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] $lib" + +--- +```ts +const $lib: TypeSpecLibrary; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/variables/EmitterOptionsSchema.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/variables/EmitterOptionsSchema.md new file mode 100644 index 0000000000..7a97c4e8cb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/variables/EmitterOptionsSchema.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] EmitterOptionsSchema" + +--- +```ts +const EmitterOptionsSchema: JSONSchemaType; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/variables/namespace.md b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/variables/namespace.md new file mode 100644 index 0000000000..1787cce0cc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/json-schema/reference/js-api/variables/namespace.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] namespace" + +--- +```ts +const namespace: "TypeSpec.JsonSchema" = "TypeSpec.JsonSchema"; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/data-types.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/data-types.md index 476b98eae0..0a0fd0d0b5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/data-types.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/data-types.md @@ -6,28 +6,28 @@ toc_max_heading_level: 3 # Data types -## OpenAPI +## TypeSpec.OpenAPI -### `AdditionalInfo` {#OpenAPI.AdditionalInfo} +### `AdditionalInfo` {#TypeSpec.OpenAPI.AdditionalInfo} Additional information for the OpenAPI document. ```typespec -model OpenAPI.AdditionalInfo +model TypeSpec.OpenAPI.AdditionalInfo ``` -### `Contact` {#OpenAPI.Contact} +### `Contact` {#TypeSpec.OpenAPI.Contact} Contact information for the exposed API. ```typespec -model OpenAPI.Contact +model TypeSpec.OpenAPI.Contact ``` -### `License` {#OpenAPI.License} +### `License` {#TypeSpec.OpenAPI.License} License information for the exposed API. ```typespec -model OpenAPI.License +model TypeSpec.OpenAPI.License ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/decorators.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/decorators.md index 754b99b909..44ae2d91da 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/decorators.md @@ -6,15 +6,15 @@ toc_max_heading_level: 3 # Decorators -## OpenAPI +## TypeSpec.OpenAPI -### `@defaultResponse` {#@OpenAPI.defaultResponse} +### `@defaultResponse` {#@TypeSpec.OpenAPI.defaultResponse} Specify that this model is to be treated as the OpenAPI `default` response. This differs from the compiler built-in `@error` decorator as this does not necessarily represent an error. ```typespec -@OpenAPI.defaultResponse +@TypeSpec.OpenAPI.defaultResponse ``` #### Target @@ -34,12 +34,12 @@ model PetStoreResponse is object; op listPets(): Pet[] | PetStoreResponse; ``` -### `@extension` {#@OpenAPI.extension} +### `@extension` {#@TypeSpec.OpenAPI.extension} Attach some custom data to the OpenAPI element generated from this type. ```typespec -@OpenAPI.extension(key: valueof string, value: unknown) +@TypeSpec.OpenAPI.extension(key: valueof string, value: unknown) ``` #### Target @@ -66,12 +66,12 @@ Attach some custom data to the OpenAPI element generated from this type. op read(): string; ``` -### `@externalDocs` {#@OpenAPI.externalDocs} +### `@externalDocs` {#@TypeSpec.OpenAPI.externalDocs} Specify the OpenAPI `externalDocs` property for this type. ```typespec -@OpenAPI.externalDocs(url: valueof string, description?: valueof string) +@TypeSpec.OpenAPI.externalDocs(url: valueof string, description?: valueof string) ``` #### Target @@ -95,13 +95,13 @@ Specify the OpenAPI `externalDocs` property for this type. op listPets(): Pet[]; ``` -### `@info` {#@OpenAPI.info} +### `@info` {#@TypeSpec.OpenAPI.info} Specify OpenAPI additional information. The service `title` and `version` are already specified using `@service`. ```typespec -@OpenAPI.info(additionalInfo: OpenAPI.AdditionalInfo) +@TypeSpec.OpenAPI.info(additionalInfo: TypeSpec.OpenAPI.AdditionalInfo) ``` #### Target @@ -110,16 +110,16 @@ The service `title` and `version` are already specified using `@service`. #### Parameters -| Name | Type | Description | -| -------------- | ------------------------------ | ---------------------- | -| additionalInfo | `model OpenAPI.AdditionalInfo` | Additional information | +| Name | Type | Description | +| -------------- | --------------------------------------- | ---------------------- | +| additionalInfo | `model TypeSpec.OpenAPI.AdditionalInfo` | Additional information | -### `@operationId` {#@OpenAPI.operationId} +### `@operationId` {#@TypeSpec.OpenAPI.operationId} Specify the OpenAPI `operationId` property for this operation. ```typespec -@OpenAPI.operationId(operationId: valueof string) +@TypeSpec.OpenAPI.operationId(operationId: valueof string) ``` #### Target diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/index.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/index.md index 59735201ac..7626cf0bda 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/index.md @@ -31,18 +31,18 @@ npm install --save-peer @typespec/openapi -## OpenAPI +## TypeSpec.OpenAPI ### Decorators -- [`@defaultResponse`](./decorators.md#@OpenAPI.defaultResponse) -- [`@extension`](./decorators.md#@OpenAPI.extension) -- [`@externalDocs`](./decorators.md#@OpenAPI.externalDocs) -- [`@info`](./decorators.md#@OpenAPI.info) -- [`@operationId`](./decorators.md#@OpenAPI.operationId) +- [`@defaultResponse`](./decorators.md#@TypeSpec.OpenAPI.defaultResponse) +- [`@extension`](./decorators.md#@TypeSpec.OpenAPI.extension) +- [`@externalDocs`](./decorators.md#@TypeSpec.OpenAPI.externalDocs) +- [`@info`](./decorators.md#@TypeSpec.OpenAPI.info) +- [`@operationId`](./decorators.md#@TypeSpec.OpenAPI.operationId) ### Models -- [`AdditionalInfo`](./data-types.md#OpenAPI.AdditionalInfo) -- [`Contact`](./data-types.md#OpenAPI.Contact) -- [`License`](./data-types.md#OpenAPI.License) +- [`AdditionalInfo`](./data-types.md#TypeSpec.OpenAPI.AdditionalInfo) +- [`Contact`](./data-types.md#TypeSpec.OpenAPI.Contact) +- [`License`](./data-types.md#TypeSpec.OpenAPI.License) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExtensions.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExtensions.md deleted file mode 100644 index 49f558fb58..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExtensions.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getExtensions" - ---- -```ts -getExtensions(program, entity): ReadonlyMap< ExtensionKey, any > -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | `Program` | -| `entity` | `Type` | - -## Returns - -`ReadonlyMap`< [`ExtensionKey`](Type.ExtensionKey.md), `any` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.AdditionalInfo.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.AdditionalInfo.md deleted file mode 100644 index 5947ef994b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.AdditionalInfo.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[I] AdditionalInfo" - ---- -OpenAPI additional information - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `contact`? | [`Contact`](Interface.Contact.md) | The contact information for the exposed API. | -| `license`? | [`License`](Interface.License.md) | The license information for the exposed API. | -| `termsOfService`? | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.ExternalDocs.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.ExternalDocs.md deleted file mode 100644 index 8c671d062d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.ExternalDocs.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] ExternalDocs" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `description`? | `string` | -| `url` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$defaultResponse.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$defaultResponse.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$defaultResponse.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$defaultResponse.md index d22dfd043e..f8a37538b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$defaultResponse.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$defaultResponse.md @@ -13,7 +13,3 @@ $defaultResponse(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$extension.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$extension.md similarity index 76% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$extension.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$extension.md index 38407efdc7..8dcc3b8258 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$extension.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$extension.md @@ -5,10 +5,10 @@ title: "[F] $extension" --- ```ts $extension( - context, - entity, - extensionName, - value): void + context, + entity, + extensionName, + value): void ``` ## Parameters @@ -19,7 +19,3 @@ $extension( | `entity` | `Type` | | `extensionName` | `string` | | `value` | `TypeSpecValue` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$externalDocs.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$externalDocs.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$externalDocs.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$externalDocs.md index 0d11dded05..68ad6f4ee0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$externalDocs.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$externalDocs.md @@ -5,10 +5,10 @@ title: "[F] $externalDocs" --- ```ts $externalDocs( - context, - target, - url, - description?): void + context, + target, + url, + description?): void ``` Allows referencing an external resource for extended documentation. @@ -24,8 +24,6 @@ Allows referencing an external resource for extended documentation. ## Returns -`void` - ## Optional description A short description of the target documentation. diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$info.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$info.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$info.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$info.md index ca81a88cad..0141b98e84 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$info.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$info.md @@ -5,9 +5,9 @@ title: "[F] $info" --- ```ts $info( - context, - entity, - model): void + context, + entity, + model): void ``` ## Parameters @@ -17,7 +17,3 @@ $info( | `context` | `DecoratorContext` | | `entity` | `Namespace` | | `model` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$operationId.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$operationId.md similarity index 85% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$operationId.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$operationId.md index 0e202b6092..30665d8f6b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.$operationId.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/$operationId.md @@ -5,9 +5,9 @@ title: "[F] $operationId" --- ```ts $operationId( - context, - entity, - opId): void + context, + entity, + opId): void ``` Set a specific operation ID. @@ -19,7 +19,3 @@ Set a specific operation ID. | `context` | `DecoratorContext` | Decorator Context | | `entity` | `Operation` | Decorator target | | `opId` | `string` | Operation ID. | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.checkDuplicateTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/checkDuplicateTypeName.md similarity index 62% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.checkDuplicateTypeName.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/checkDuplicateTypeName.md index 34ad11796d..94f42f3be8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.checkDuplicateTypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/checkDuplicateTypeName.md @@ -5,10 +5,10 @@ title: "[F] checkDuplicateTypeName" --- ```ts checkDuplicateTypeName( - program, - type, - name, - existing): void + program, + type, + name, + existing): void ``` ## Parameters @@ -18,8 +18,4 @@ checkDuplicateTypeName( | `program` | `Program` | | `type` | `Type` | | `name` | `string` | -| `existing` | `undefined` \| `Record`< `string`, `unknown` \> | - -## Returns - -`void` +| `existing` | `undefined` \| `Record`<`string`, `unknown`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExtensions.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExtensions.md new file mode 100644 index 0000000000..ea291e3d14 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExtensions.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] getExtensions" + +--- +```ts +getExtensions(program, entity): ReadonlyMap +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `entity` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExternalDocs.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExternalDocs.md similarity index 75% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExternalDocs.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExternalDocs.md index cf1f8cfd85..cbe57a38f1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getExternalDocs.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getExternalDocs.md @@ -13,7 +13,3 @@ getExternalDocs(program, entity): ExternalDocs | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -[`ExternalDocs`](Interface.ExternalDocs.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getInfo.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getInfo.md similarity index 74% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getInfo.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getInfo.md index f4520131dc..11cb22187d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getInfo.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getInfo.md @@ -13,7 +13,3 @@ getInfo(program, entity): AdditionalInfo | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Namespace` | - -## Returns - -[`AdditionalInfo`](Interface.AdditionalInfo.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOpenAPITypeName.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOpenAPITypeName.md similarity index 82% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOpenAPITypeName.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOpenAPITypeName.md index 026fd11016..0cd33dcdf5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOpenAPITypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOpenAPITypeName.md @@ -5,10 +5,10 @@ title: "[F] getOpenAPITypeName" --- ```ts getOpenAPITypeName( - program, - type, - options, - existing?): string + program, + type, + options, + existing?): string ``` Gets the name of a type to be used in OpenAPI. @@ -27,8 +27,4 @@ namespace using the provided `TypeNameOptions`. | `program` | `Program` | | `type` | `Type` | | `options` | `TypeNameOptions` | -| `existing`? | `Record`< `string`, `any` \> | - -## Returns - -`string` +| `existing`? | `Record`<`string`, `any`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOperationId.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOperationId.md similarity index 92% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOperationId.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOperationId.md index f6150de6c4..296f2bba76 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getOperationId.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getOperationId.md @@ -16,8 +16,6 @@ getOperationId(program, entity): string | undefined ## Returns -`string` \| `undefined` - operationId set via the ## Operation Id diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getParameterKey.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getParameterKey.md similarity index 67% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getParameterKey.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getParameterKey.md index 1f3d1f367a..67521629ca 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.getParameterKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/getParameterKey.md @@ -5,11 +5,11 @@ title: "[F] getParameterKey" --- ```ts getParameterKey( - program, - property, - newParam, - existingParams, - options): string + program, + property, + newParam, + existingParams, + options): string ``` Gets the key that is used to define a parameter in OpenAPI. @@ -21,9 +21,5 @@ Gets the key that is used to define a parameter in OpenAPI. | `program` | `Program` | | `property` | `ModelProperty` | | `newParam` | `unknown` | -| `existingParams` | `Record`< `string`, `unknown` \> | +| `existingParams` | `Record`<`string`, `unknown`\> | | `options` | `TypeNameOptions` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isDefaultResponse.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isDefaultResponse.md similarity index 97% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isDefaultResponse.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isDefaultResponse.md index 0e1a024b76..0c5f649df4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isDefaultResponse.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isDefaultResponse.md @@ -18,6 +18,4 @@ Check if the given model has been mark as a default response. ## Returns -`boolean` - boolean. diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isReadonlyProperty.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isReadonlyProperty.md similarity index 95% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isReadonlyProperty.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isReadonlyProperty.md index 6594fe9490..64ca698c3d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.isReadonlyProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/isReadonlyProperty.md @@ -20,7 +20,3 @@ designate a read-only property. | :------ | :------ | | `program` | `Program` | | `property` | `ModelProperty` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.resolveOperationId.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/resolveOperationId.md similarity index 98% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.resolveOperationId.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/resolveOperationId.md index 7c61cc8101..eb42f6d1b2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.resolveOperationId.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/resolveOperationId.md @@ -19,8 +19,6 @@ Resolve the OpenAPI operation ID for the given operation using the following log ## Returns -`string` - Operation ID in this format `` or `_` ## Operation Id diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.setExtension.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/setExtension.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.setExtension.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/setExtension.md index b544a1c5e3..71e5b0c5ea 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.setExtension.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/setExtension.md @@ -5,10 +5,10 @@ title: "[F] setExtension" --- ```ts setExtension( - program, - entity, - extensionName, - data): void + program, + entity, + extensionName, + data): void ``` ## Parameters @@ -17,9 +17,5 @@ setExtension( | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | -| `extensionName` | \`x-$\{string}\` | +| `extensionName` | \`x-${string}\` | | `data` | `unknown` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.shouldInline.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/shouldInline.md similarity index 96% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.shouldInline.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/shouldInline.md index 539e51977b..295054eeb8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Function.shouldInline.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/functions/shouldInline.md @@ -23,7 +23,3 @@ decorator, or chosen by default in simple cases. | :------ | :------ | | `program` | `Program` | | `type` | `Type` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/index.md index c7afe41ec9..a3de3658a4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/index.md @@ -3,39 +3,39 @@ jsApi: true title: "[P] JS Api" --- -## Index +## Exports ### Interfaces -- [AdditionalInfo](Interface.AdditionalInfo.md) -- [Contact](Interface.Contact.md) -- [ExternalDocs](Interface.ExternalDocs.md) -- [License](Interface.License.md) +- [AdditionalInfo](interfaces/AdditionalInfo.md) +- [Contact](interfaces/Contact.md) +- [ExternalDocs](interfaces/ExternalDocs.md) +- [License](interfaces/License.md) ### Type Aliases -- [ExtensionKey](Type.ExtensionKey.md) +- [ExtensionKey](type-aliases/ExtensionKey.md) ### Variables -- [namespace](Variable.namespace.md) +- [namespace](variables/namespace.md) ### Functions -- [$defaultResponse](Function.$defaultResponse.md) -- [$extension](Function.$extension.md) -- [$externalDocs](Function.$externalDocs.md) -- [$info](Function.$info.md) -- [$operationId](Function.$operationId.md) -- [checkDuplicateTypeName](Function.checkDuplicateTypeName.md) -- [getExtensions](Function.getExtensions.md) -- [getExternalDocs](Function.getExternalDocs.md) -- [getInfo](Function.getInfo.md) -- [getOpenAPITypeName](Function.getOpenAPITypeName.md) -- [getOperationId](Function.getOperationId.md) -- [getParameterKey](Function.getParameterKey.md) -- [isDefaultResponse](Function.isDefaultResponse.md) -- [isReadonlyProperty](Function.isReadonlyProperty.md) -- [resolveOperationId](Function.resolveOperationId.md) -- [setExtension](Function.setExtension.md) -- [shouldInline](Function.shouldInline.md) +- [$defaultResponse](functions/$defaultResponse.md) +- [$extension](functions/$extension.md) +- [$externalDocs](functions/$externalDocs.md) +- [$info](functions/$info.md) +- [$operationId](functions/$operationId.md) +- [checkDuplicateTypeName](functions/checkDuplicateTypeName.md) +- [getExtensions](functions/getExtensions.md) +- [getExternalDocs](functions/getExternalDocs.md) +- [getInfo](functions/getInfo.md) +- [getOpenAPITypeName](functions/getOpenAPITypeName.md) +- [getOperationId](functions/getOperationId.md) +- [getParameterKey](functions/getParameterKey.md) +- [isDefaultResponse](functions/isDefaultResponse.md) +- [isReadonlyProperty](functions/isReadonlyProperty.md) +- [resolveOperationId](functions/resolveOperationId.md) +- [setExtension](functions/setExtension.md) +- [shouldInline](functions/shouldInline.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/AdditionalInfo.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/AdditionalInfo.md new file mode 100644 index 0000000000..ecaf31b41b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/AdditionalInfo.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[I] AdditionalInfo" + +--- +OpenAPI additional information + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `contact?` | [`Contact`](Contact.md) | The contact information for the exposed API. | +| `license?` | [`License`](License.md) | The license information for the exposed API. | +| `termsOfService?` | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.Contact.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/Contact.md similarity index 55% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.Contact.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/Contact.md index b4f3364320..c50d5c3dee 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.Contact.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/Contact.md @@ -7,6 +7,6 @@ title: "[I] Contact" | Property | Type | Description | | :------ | :------ | :------ | -| `email`? | `string` | The email address of the contact person/organization. MUST be in the format of an email address. | -| `name`? | `string` | The identifying name of the contact person/organization. | -| `url`? | `string` | The URL pointing to the contact information. MUST be in the format of a URL. | +| `email?` | `string` | The email address of the contact person/organization. MUST be in the format of an email address. | +| `name?` | `string` | The identifying name of the contact person/organization. | +| `url?` | `string` | The URL pointing to the contact information. MUST be in the format of a URL. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/ExternalDocs.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/ExternalDocs.md new file mode 100644 index 0000000000..debe31f244 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/ExternalDocs.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] ExternalDocs" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `description?` | `string` | - | +| `url` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.License.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/License.md similarity index 76% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.License.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/License.md index e4880abc50..785a5aa31c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Interface.License.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/interfaces/License.md @@ -8,4 +8,4 @@ title: "[I] License" | Property | Type | Description | | :------ | :------ | :------ | | `name` | `string` | The license name used for the API. | -| `url`? | `string` | A URL to the license used for the API. MUST be in the format of a URL. | +| `url?` | `string` | A URL to the license used for the API. MUST be in the format of a URL. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Type.ExtensionKey.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/type-aliases/ExtensionKey.md similarity index 62% rename from packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Type.ExtensionKey.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/type-aliases/ExtensionKey.md index 4a2123ae00..e5249ff81c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/Type.ExtensionKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/type-aliases/ExtensionKey.md @@ -4,5 +4,5 @@ title: "[T] ExtensionKey" --- ```ts -ExtensionKey: \x-${string}\ +type ExtensionKey: \x-${string}\; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/variables/namespace.md b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/variables/namespace.md new file mode 100644 index 0000000000..b13059d83c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi/reference/js-api/variables/namespace.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] namespace" + +--- +```ts +const namespace: "TypeSpec.OpenAPI" = "TypeSpec.OpenAPI"; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/decorators.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/decorators.md index 12ff4bfbce..eefd6469cc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/decorators.md @@ -6,30 +6,30 @@ toc_max_heading_level: 3 # Decorators -## OpenAPI +## TypeSpec.OpenAPI -### `@oneOf` {#@OpenAPI.oneOf} +### `@oneOf` {#@TypeSpec.OpenAPI.oneOf} Specify that `oneOf` should be used instead of `anyOf` for that union. ```typespec -@OpenAPI.oneOf +@TypeSpec.OpenAPI.oneOf ``` #### Target -`Union` +`union Union | ModelProperty` #### Parameters None -### `@useRef` {#@OpenAPI.useRef} +### `@useRef` {#@TypeSpec.OpenAPI.useRef} Specify an external reference that should be used inside of emitting this type. ```typespec -@OpenAPI.useRef(ref: valueof string) +@TypeSpec.OpenAPI.useRef(ref: valueof string) ``` #### Target diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/index.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/index.md index 4042980019..712b79d863 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/index.md @@ -35,9 +35,9 @@ npm install --save-peer @typespec/openapi3 [See documentation](./emitter.md) -## OpenAPI +## TypeSpec.OpenAPI ### Decorators -- [`@oneOf`](./decorators.md#@OpenAPI.oneOf) -- [`@useRef`](./decorators.md#@OpenAPI.useRef) +- [`@oneOf`](./decorators.md#@TypeSpec.OpenAPI.oneOf) +- [`@useRef`](./decorators.md#@TypeSpec.OpenAPI.useRef) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$onEmit.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$onEmit.md deleted file mode 100644 index cbb2709ca2..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$onEmit.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] $onEmit" - ---- -```ts -$onEmit(context): Promise< void > -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | `EmitContext`< `OpenAPI3EmitterOptions` \> | - -## Returns - -`Promise`< `void` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Interface.ResolvedOpenAPI3EmitterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Interface.ResolvedOpenAPI3EmitterOptions.md deleted file mode 100644 index 767582100d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Interface.ResolvedOpenAPI3EmitterOptions.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[I] ResolvedOpenAPI3EmitterOptions" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `fileType` | `FileType` | -| `includeXTypeSpecName` | `"never"` \| `"inline-only"` | -| `newLine` | `NewLine` | -| `omitUnreachableTypes` | `boolean` | -| `outputFile` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.$lib.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.$lib.md deleted file mode 100644 index 5429b6e443..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.$lib.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] $lib" - ---- -```ts -const $lib: TypeSpecLibrary< Object, OpenAPI3EmitterOptions > -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$onEmit.md new file mode 100644 index 0000000000..50fae6e43c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$onEmit.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[F] $onEmit" + +--- +```ts +$onEmit(context): Promise +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `EmitContext`<`OpenAPI3EmitterOptions`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$oneOf.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$oneOf.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$oneOf.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$oneOf.md index 18f2c87522..459a442ef7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$oneOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$oneOf.md @@ -12,8 +12,4 @@ $oneOf(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Union` | - -## Returns - -`void` +| `entity` | `ModelProperty` \| `Union` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$useRef.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$useRef.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$useRef.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$useRef.md index 817f618684..7529f0ea27 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.$useRef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/$useRef.md @@ -5,9 +5,9 @@ title: "[F] $useRef" --- ```ts $useRef( - context, - entity, - refUrl): void + context, + entity, + refUrl): void ``` ## Parameters @@ -17,7 +17,3 @@ $useRef( | `context` | `DecoratorContext` | | `entity` | `Model` \| `ModelProperty` | | `refUrl` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getOneOf.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getOneOf.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getOneOf.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getOneOf.md index 3f4d727042..81127ca863 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getOneOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getOneOf.md @@ -13,7 +13,3 @@ getOneOf(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getRef.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getRef.md similarity index 84% rename from packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getRef.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getRef.md index 20ad7ec648..9a9b91c704 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.getRef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/getRef.md @@ -13,7 +13,3 @@ getRef(program, entity): string | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.resolveOptions.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/resolveOptions.md similarity index 53% rename from packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.resolveOptions.md rename to packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/resolveOptions.md index 415323ec6f..9f16f99c4d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Function.resolveOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/functions/resolveOptions.md @@ -11,8 +11,4 @@ resolveOptions(context): ResolvedOpenAPI3EmitterOptions | Parameter | Type | | :------ | :------ | -| `context` | `EmitContext`< `OpenAPI3EmitterOptions` \> | - -## Returns - -[`ResolvedOpenAPI3EmitterOptions`](Interface.ResolvedOpenAPI3EmitterOptions.md) +| `context` | `EmitContext`<`OpenAPI3EmitterOptions`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/index.md index c814985a01..19aca6efba 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/index.md @@ -3,22 +3,22 @@ jsApi: true title: "[P] JS Api" --- -## Index +## Exports ### Interfaces -- [ResolvedOpenAPI3EmitterOptions](Interface.ResolvedOpenAPI3EmitterOptions.md) +- [ResolvedOpenAPI3EmitterOptions](interfaces/ResolvedOpenAPI3EmitterOptions.md) ### Variables -- [$lib](Variable.$lib.md) -- [namespace](Variable.namespace.md) +- [$lib](variables/$lib.md) +- [namespace](variables/namespace.md) ### Functions -- [$onEmit](Function.$onEmit.md) -- [$oneOf](Function.$oneOf.md) -- [$useRef](Function.$useRef.md) -- [getOneOf](Function.getOneOf.md) -- [getRef](Function.getRef.md) -- [resolveOptions](Function.resolveOptions.md) +- [$onEmit](functions/$onEmit.md) +- [$oneOf](functions/$oneOf.md) +- [$useRef](functions/$useRef.md) +- [getOneOf](functions/getOneOf.md) +- [getRef](functions/getRef.md) +- [resolveOptions](functions/resolveOptions.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/interfaces/ResolvedOpenAPI3EmitterOptions.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/interfaces/ResolvedOpenAPI3EmitterOptions.md new file mode 100644 index 0000000000..7f745c8b1d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/interfaces/ResolvedOpenAPI3EmitterOptions.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[I] ResolvedOpenAPI3EmitterOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `fileType` | `FileType` | - | +| `includeXTypeSpecName` | `"never"` \| `"inline-only"` | - | +| `newLine` | `NewLine` | - | +| `omitUnreachableTypes` | `boolean` | - | +| `outputFile` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/variables/$lib.md new file mode 100644 index 0000000000..85fb7e0518 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/variables/$lib.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] $lib" + +--- +```ts +const $lib: TypeSpecLibrary; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/variables/namespace.md b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/variables/namespace.md new file mode 100644 index 0000000000..b13059d83c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/variables/namespace.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] namespace" + +--- +```ts +const namespace: "TypeSpec.OpenAPI" = "TypeSpec.OpenAPI"; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$_map.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$_map.md deleted file mode 100644 index afe55c5864..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$_map.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] $_map" - ---- -```ts -$_map(ctx, target): void -``` - -Binds the internal representation of a Protobuf map. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `ctx` | `DecoratorContext` | | -| `target` | `Model` | | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Interface.PackageDetails.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Interface.PackageDetails.md deleted file mode 100644 index bbaf2aa397..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Interface.PackageDetails.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] PackageDetails" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `name`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Type.Reservation.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Type.Reservation.md deleted file mode 100644 index afe66d7dae..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Type.Reservation.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] Reservation" - ---- -```ts -Reservation: string | number | [number, number] & {type: Type;} -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.$lib.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.$lib.md deleted file mode 100644 index 283584fea3..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.$lib.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] $lib" - ---- -```ts -const $lib: TypeSpecLibrary< Object, ProtobufEmitterOptions > = TypeSpecProtobufLibrary -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.namespace.md deleted file mode 100644 index 2530651317..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.namespace.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] namespace" - ---- -```ts -const namespace: "TypeSpec.Protobuf" = "TypeSpec.Protobuf" -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$externRef.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$externRef.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$externRef.md rename to packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$externRef.md index 30e67c0b36..fa39273374 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$externRef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$externRef.md @@ -5,10 +5,10 @@ title: "[F] $externRef" --- ```ts $externRef( - ctx, - target, - path, - name): void + ctx, + target, + path, + name): void ``` ## Parameters @@ -19,7 +19,3 @@ $externRef( | `target` | `Model` | | `path` | `StringLiteral` | | `name` | `StringLiteral` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$field.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$field.md similarity index 88% rename from packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$field.md rename to packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$field.md index 570560f61d..bc746fcc8c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$field.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$field.md @@ -5,9 +5,9 @@ title: "[F] $field" --- ```ts $field( - ctx, - target, - fieldIndex): void + ctx, + target, + fieldIndex): void ``` Decorate a model property with a field index. Field indices are required for all fields of emitted messages. @@ -21,5 +21,3 @@ Decorate a model property with a field index. Field indices are required for all | `fieldIndex` | `number` | | ## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$message.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$message.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$message.md rename to packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$message.md index a20a75e381..e5c6e41724 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$message.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$message.md @@ -13,7 +13,3 @@ $message(ctx, target): void | :------ | :------ | | `ctx` | `DecoratorContext` | | `target` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onEmit.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onEmit.md similarity index 53% rename from packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onEmit.md rename to packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onEmit.md index 54b9679253..01e6dc7191 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onEmit.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onEmit.md @@ -4,7 +4,7 @@ title: "[F] $onEmit" --- ```ts -$onEmit(ctx): Promise< void > +$onEmit(ctx): Promise ``` Emitter main function. @@ -13,8 +13,4 @@ Emitter main function. | Parameter | Type | | :------ | :------ | -| `ctx` | `EmitContext`< `ProtobufEmitterOptions` \> | - -## Returns - -`Promise`< `void` \> +| `ctx` | `EmitContext`<`ProtobufEmitterOptions`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onValidate.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onValidate.md similarity index 69% rename from packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onValidate.md rename to packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onValidate.md index 43874617fb..cc74dab946 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$onValidate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$onValidate.md @@ -4,7 +4,7 @@ title: "[F] $onValidate" --- ```ts -$onValidate(program): Promise< void > +$onValidate(program): Promise ``` Validation function @@ -14,7 +14,3 @@ Validation function | Parameter | Type | | :------ | :------ | | `program` | `Program` | - -## Returns - -`Promise`< `void` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$package.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$package.md similarity index 84% rename from packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$package.md rename to packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$package.md index dfc505b38f..d9f5e7864f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$package.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$package.md @@ -5,9 +5,9 @@ title: "[F] $package" --- ```ts $package( - ctx, - target, - details?): void + ctx, + target, + details?): void ``` Declare a Protobuf package. @@ -19,7 +19,3 @@ Declare a Protobuf package. | `ctx` | `DecoratorContext` | decorator context | | `target` | `Namespace` | target decorator namespace | | `details`? | `Model` | - | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$reserve.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$reserve.md similarity index 57% rename from packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$reserve.md rename to packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$reserve.md index 2eceea00f7..0a12d36415 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$reserve.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$reserve.md @@ -5,9 +5,9 @@ title: "[F] $reserve" --- ```ts $reserve( - ctx, - target, - ...reservations): void + ctx, + target, ... + reservations): void ``` ## Parameters @@ -16,8 +16,4 @@ $reserve( | :------ | :------ | | `ctx` | `DecoratorContext` | | `target` | `Model` | -| ...`reservations` | *readonly* (`string` \| `number` \| `Type`)[] | - -## Returns - -`void` +| ...`reservations` | readonly (`string` \| `number` \| `Type`)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$service.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$service.md similarity index 94% rename from packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$service.md rename to packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$service.md index 3f35f2324f..7875c0597a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$service.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$service.md @@ -15,7 +15,3 @@ Decorate an interface as a service, indicating that it represents a Protobuf `se | :------ | :------ | :------ | | `ctx` | `DecoratorContext` | decorator context | | `target` | `Interface` | the decorated interface | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$stream.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$stream.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$stream.md rename to packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$stream.md index 6ff322eb03..8daf2a13d1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.$stream.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/$stream.md @@ -5,9 +5,9 @@ title: "[F] $stream" --- ```ts $stream( - ctx, - target, - mode): void + ctx, + target, + mode): void ``` ## Parameters @@ -17,7 +17,3 @@ $stream( | `ctx` | `DecoratorContext` | | `target` | `Operation` | | `mode` | `EnumMember` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.isMap.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/isMap.md similarity index 97% rename from packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.isMap.md rename to packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/isMap.md index 6708926d07..500f6c2fe9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Function.isMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/functions/isMap.md @@ -18,6 +18,4 @@ Determines whether a type represents a Protobuf map. ## Returns -`boolean` - true if the internal representation of a Protobuf map is bound to this type. diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/index.md index b7bc0b4c4b..2e166c36ae 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/index.md @@ -3,32 +3,31 @@ jsApi: true title: "[P] JS Api" --- -## Index +## Exports ### Interfaces -- [PackageDetails](Interface.PackageDetails.md) +- [PackageDetails](interfaces/PackageDetails.md) ### Type Aliases -- [Reservation](Type.Reservation.md) +- [Reservation](type-aliases/Reservation.md) ### Variables -- [$lib](Variable.$lib.md) -- [PROTO\_FULL\_IDENT](Variable.PROTO_FULL_IDENT.md) -- [namespace](Variable.namespace.md) +- [$lib](variables/$lib.md) +- [PROTO\_FULL\_IDENT](variables/PROTO_FULL_IDENT.md) +- [namespace](variables/namespace.md) ### Functions -- [$\_map](Function.$_map.md) -- [$externRef](Function.$externRef.md) -- [$field](Function.$field.md) -- [$message](Function.$message.md) -- [$onEmit](Function.$onEmit.md) -- [$onValidate](Function.$onValidate.md) -- [$package](Function.$package.md) -- [$reserve](Function.$reserve.md) -- [$service](Function.$service.md) -- [$stream](Function.$stream.md) -- [isMap](Function.isMap.md) +- [$externRef](functions/$externRef.md) +- [$field](functions/$field.md) +- [$message](functions/$message.md) +- [$onEmit](functions/$onEmit.md) +- [$onValidate](functions/$onValidate.md) +- [$package](functions/$package.md) +- [$reserve](functions/$reserve.md) +- [$service](functions/$service.md) +- [$stream](functions/$stream.md) +- [isMap](functions/isMap.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/interfaces/PackageDetails.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/interfaces/PackageDetails.md new file mode 100644 index 0000000000..1495e8a304 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/interfaces/PackageDetails.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] PackageDetails" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `name?` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/type-aliases/Reservation.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/type-aliases/Reservation.md new file mode 100644 index 0000000000..22298fc322 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/type-aliases/Reservation.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] Reservation" + +--- +```ts +type Reservation: string | number | [number, number] & object; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/variables/$lib.md new file mode 100644 index 0000000000..d0b3766f7d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/variables/$lib.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] $lib" + +--- +```ts +const $lib: TypeSpecLibrary = TypeSpecProtobufLibrary; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.PROTO_FULL_IDENT.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/variables/PROTO_FULL_IDENT.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.PROTO_FULL_IDENT.md rename to packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/variables/PROTO_FULL_IDENT.md index 5d1d8b4f61..99c17b6e90 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/Variable.PROTO_FULL_IDENT.md +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/variables/PROTO_FULL_IDENT.md @@ -4,7 +4,7 @@ title: "[V] PROTO_FULL_IDENT" --- ```ts -const PROTO_FULL_IDENT: RegExp +const PROTO_FULL_IDENT: RegExp; ``` Defined in the [ProtoBuf Language Spec](https://developers.google.com/protocol-buffers/docs/reference/proto3-spec#identifiers). diff --git a/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/variables/namespace.md b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/variables/namespace.md new file mode 100644 index 0000000000..767743f38d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/protobuf/reference/js-api/variables/namespace.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] namespace" + +--- +```ts +const namespace: "TypeSpec.Protobuf" = "TypeSpec.Protobuf"; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.IdentifierKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.IdentifierKind.md deleted file mode 100644 index aa43c10f1b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.IdentifierKind.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[E] IdentifierKind" - ---- -## Enumeration Members - -| Member | Value | -| :------ | :------ | -| `Declaration` | ``4`` | -| `Decorator` | ``1`` | -| `Function` | ``2`` | -| `Other` | ``5`` | -| `TypeReference` | ``0`` | -| `Using` | ``3`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.KeywordLimit.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.KeywordLimit.md deleted file mode 100644 index 3284e72767..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.KeywordLimit.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[E] KeywordLimit" - ---- - -## Enumeration Members - -| Member | Value | -| :------ | :------ | -| `MaxLength` | ``10`` | -| `MinLength` | ``2`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.NodeFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.NodeFlags.md deleted file mode 100644 index 91c9776289..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.NodeFlags.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[E] NodeFlags" - ---- -## Enumeration Members - -| Member | Value | Description | -| :------ | :------ | :------ | -| `DescendantErrorsExamined` | ``1`` | If this is set, the DescendantHasError bit can be trusted. If this not set,
children need to be visited still to see if DescendantHasError should be
set.

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

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

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

Use TypeSpecScript | -| `DecoratorDeclarationStatement` | ``25`` | - | -| `DecoratorExpression` | ``5`` | - | -| `DirectiveExpression` | ``6`` | - | -| `Doc` | ``47`` | - | -| `DocParamTag` | ``49`` | - | -| `DocReturnsTag` | ``50`` | - | -| `DocTemplateTag` | ``51`` | - | -| `DocText` | ``48`` | - | -| `DocUnknownTag` | ``52`` | - | -| `EmptyStatement` | ``43`` | - | -| `EnumMember` | ``22`` | - | -| `EnumSpreadMember` | ``23`` | - | -| `EnumStatement` | ``21`` | - | -| `ExternKeyword` | ``35`` | - | -| `FunctionDeclarationStatement` | ``26`` | - | -| `FunctionParameter` | ``27`` | - | -| `Identifier` | ``3`` | - | -| `ImportStatement` | ``2`` | - | -| `InterfaceStatement` | ``18`` | - | -| `IntersectionExpression` | ``29`` | - | -| `InvalidStatement` | ``44`` | - | -| `JsNamespaceDeclaration` | ``83`` | - | -| `JsSourceFile` | ``1`` | - | -| `LineComment` | ``45`` | - | -| `MemberExpression` | ``7`` | - | -| `ModelExpression` | ``14`` | - | -| `ModelProperty` | ``15`` | - | -| `ModelSpreadProperty` | ``16`` | - | -| `ModelStatement` | ``13`` | - | -| `NamespaceStatement` | ``8`` | - | -| `NeverKeyword` | ``37`` | - | -| `NumericLiteral` | ``33`` | - | -| `OperationSignatureDeclaration` | ``11`` | - | -| `OperationSignatureReference` | ``12`` | - | -| `OperationStatement` | ``10`` | - | -| `Projection` | ``53`` | - | -| `ProjectionArithmeticExpression` | ``71`` | - | -| `ProjectionBlockExpression` | ``65`` | - | -| `ProjectionCallExpression` | ``72`` | - | -| `ProjectionDecoratorReferenceExpression` | ``81`` | - | -| `ProjectionEnumMemberSelector` | ``62`` | - | -| `ProjectionEnumSelector` | ``61`` | - | -| `ProjectionEqualityExpression` | ``68`` | - | -| `ProjectionExpressionStatement` | ``63`` | - | -| `ProjectionIfExpression` | ``64`` | - | -| `ProjectionInterfaceSelector` | ``60`` | - | -| `ProjectionLambdaExpression` | ``73`` | - | -| `ProjectionLambdaParameterDeclaration` | ``74`` | - | -| `ProjectionLogicalExpression` | ``67`` | - | -| `ProjectionMemberExpression` | ``66`` | - | -| `ProjectionModelExpression` | ``75`` | - | -| `ProjectionModelProperty` | ``76`` | - | -| `ProjectionModelPropertySelector` | ``56`` | - | -| `ProjectionModelSelector` | ``55`` | - | -| `ProjectionModelSpreadProperty` | ``77`` | - | -| `ProjectionOperationSelector` | ``57`` | - | -| `ProjectionParameterDeclaration` | ``54`` | - | -| `ProjectionReference` | ``41`` | - | -| `ProjectionRelationalExpression` | ``70`` | - | -| `ProjectionSpreadProperty` | ``78`` | - | -| `ProjectionStatement` | ``80`` | - | -| `ProjectionTupleExpression` | ``79`` | - | -| `ProjectionUnaryExpression` | ``69`` | - | -| `ProjectionUnionSelector` | ``58`` | - | -| `ProjectionUnionVariantSelector` | ``59`` | - | -| `Return` | ``82`` | - | -| `ScalarStatement` | ``17`` | - | -| `StringLiteral` | ``32`` | - | -| `TemplateParameterDeclaration` | ``42`` | - | -| `TupleExpression` | ``30`` | - | -| `TypeReference` | ``40`` | - | -| `TypeSpecScript` | ``0`` | - | -| `UnionExpression` | ``28`` | - | -| `UnionStatement` | ``19`` | - | -| `UnionVariant` | ``20`` | - | -| `UnknownKeyword` | ``38`` | - | -| `UsingStatement` | ``9`` | - | -| `ValueOfExpression` | ``39`` | - | -| `VoidKeyword` | ``36`` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.Token.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.Token.md deleted file mode 100644 index 92c3bae72f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.Token.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -jsApi: true -title: "[E] Token" - ---- -## Enumeration Members - -| Member | Value | -| :------ | :------ | -| `AliasKeyword` | ``54`` | -| `Ampersand` | ``27`` | -| `AmpsersandAmpersand` | ``42`` | -| `At` | ``32`` | -| `AtAt` | ``33`` | -| `Bar` | ``28`` | -| `BarBar` | ``43`` | -| `CloseBrace` | ``15`` | -| `CloseBracket` | ``19`` | -| `CloseParen` | ``17`` | -| `Colon` | ``30`` | -| `ColonColon` | ``31`` | -| `Comma` | ``23`` | -| `ConflictMarker` | ``10`` | -| `DecKeyword` | ``61`` | -| `DocCodeFenceDelimiter` | ``13`` | -| `DocCodeSpan` | ``12`` | -| `DocText` | ``11`` | -| `Dot` | ``20`` | -| `Ellipsis` | ``21`` | -| `ElseKeyword` | ``59`` | -| `EndOfFile` | ``2`` | -| `EnumKeyword` | ``53`` | -| `Equals` | ``26`` | -| `EqualsEquals` | ``44`` | -| `EqualsGreaterThan` | ``46`` | -| `Exclamation` | ``39`` | -| `ExclamationEquals` | ``45`` | -| `ExtendsKeyword` | ``65`` | -| `ExternKeyword` | ``64`` | -| `FalseKeyword` | ``67`` | -| `FnKeyword` | ``62`` | -| `ForwardSlash` | ``36`` | -| `GreaterThan` | ``25`` | -| `GreaterThanEquals` | ``41`` | -| `Hash` | ``34`` | -| `Hyphen` | ``38`` | -| `Identifier` | ``3`` | -| `IfKeyword` | ``60`` | -| `ImportKeyword` | ``47`` | -| `InterfaceKeyword` | ``56`` | -| `Invalid` | ``1`` | -| `IsKeyword` | ``55`` | -| `LessThan` | ``24`` | -| `LessThanEquals` | ``40`` | -| `ModelKeyword` | ``48`` | -| `MultiLineComment` | ``7`` | -| `NamespaceKeyword` | ``50`` | -| `NeverKeyword` | ``70`` | -| `NewLine` | ``8`` | -| `None` | ``0`` | -| `NumericLiteral` | ``4`` | -| `OpKeyword` | ``52`` | -| `OpenBrace` | ``14`` | -| `OpenBracket` | ``18`` | -| `OpenParen` | ``16`` | -| `Plus` | ``37`` | -| `ProjectionKeyword` | ``58`` | -| `Question` | ``29`` | -| `ReturnKeyword` | ``68`` | -| `ScalarKeyword` | ``49`` | -| `Semicolon` | ``22`` | -| `SingleLineComment` | ``6`` | -| `Star` | ``35`` | -| `StringLiteral` | ``5`` | -| `TrueKeyword` | ``66`` | -| `UnionKeyword` | ``57`` | -| `UnknownKeyword` | ``71`` | -| `UsingKeyword` | ``51`` | -| `ValueOfKeyword` | ``63`` | -| `VoidKeyword` | ``69`` | -| `Whitespace` | ``9`` | -| `__Count` | ``72`` | -| `__EndDocComment` | ``14`` | -| `__EndKeyword` | ``72`` | -| `__EndModifierKeyword` | ``65`` | -| `__EndPunctuation` | ``47`` | -| `__EndStatementKeyword` | ``64`` | -| `__EndTrivia` | ``11`` | -| `__StartDocComment` | ``11`` | -| `__StartKeyword` | ``47`` | -| `__StartModifierKeyword` | ``64`` | -| `__StartPunctuation` | ``14`` | -| `__StartStatementKeyword` | ``47`` | -| `__StartTrivia` | ``6`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.TokenFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.TokenFlags.md deleted file mode 100644 index 52037df622..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.TokenFlags.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[E] TokenFlags" - ---- -## Enumeration Members - -| Member | Value | -| :------ | :------ | -| `Backticked` | ``32`` | -| `DocComment` | ``16`` | -| `Escaped` | ``1`` | -| `NonAscii` | ``8`` | -| `None` | ``0`` | -| `TripleQuoted` | ``2`` | -| `Unterminated` | ``4`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.assertType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.assertType.md deleted file mode 100644 index c1e989b128..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.assertType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -jsApi: true -title: "[F] assertType" - ---- -```ts -assertType( - typeDescription, - t, - ...kinds): asserts t is Object -``` - -Assert that the input type has one of the kinds provided - -## Type parameters - -| Parameter | -| :------ | -| `TKind` *extends* (`"Model"` \| `"ModelProperty"` \| `"Scalar"` \| `"Interface"` \| `"Enum"` \| `"EnumMember"` \| `"TemplateParameter"` \| `"Namespace"` \| `"Operation"` \| `"String"` \| `"Number"` \| `"Boolean"` \| `"Tuple"` \| `"Union"` \| `"UnionVariant"` \| `"Intrinsic"` \| `"Function"` \| `"Decorator"` \| `"FunctionParameter"` \| `"Object"` \| `"Projection"`)[] | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `typeDescription` | `string` | -| `t` | [`Type`](Type.Type.md) | -| ...`kinds` | `TKind` | - -## Returns - -`asserts t is Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compile.md deleted file mode 100644 index ba90b5c93c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compile.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] compile" - ---- -```ts -compile( - host, - mainFile, - options = {}, - oldProgram?): Promise< Program > -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `host` | [`CompilerHost`](Interface.CompilerHost.md) | -| `mainFile` | `string` | -| `options` | [`CompilerOptions`](Interface.CompilerOptions.md) | -| `oldProgram`? | [`Program`](Interface.Program.md) | - -## Returns - -`Promise`< [`Program`](Interface.Program.md) \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createCadlLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createCadlLibrary.md deleted file mode 100644 index 5bab3040e7..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createCadlLibrary.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -jsApi: true -title: "[F] createCadlLibrary" - ---- -```ts -createCadlLibrary(lib): TypeSpecLibrary< T, E > -``` - -## Type parameters - -| Parameter | -| :------ | -| `T` *extends* \{} | -| `E` *extends* `Record`< `string`, `any` \> | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `lib` | `Readonly`< [`TypeSpecLibraryDef`](Interface.TypeSpecLibraryDef.md)< `T`, `E` \> \> | - -## Returns - -[`TypeSpecLibrary`](Interface.TypeSpecLibrary.md)< `T`, `E` \> - -## Deprecated - -use createTypeSpecLibrary diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDecoratorDefinition.md deleted file mode 100644 index 8f86e81d53..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDecoratorDefinition.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -jsApi: true -title: "[F] createDecoratorDefinition" - ---- -```ts -createDecoratorDefinition(definition): DecoratorValidator< T, P, S > -``` - -## Type parameters - -| Parameter | -| :------ | -| `T` *extends* [`TypeKind`](Type.TypeKind.md) | -| `P` *extends* *readonly* [`DecoratorParamDefinition`](Interface.DecoratorParamDefinition.md)< [`TypeKind`](Type.TypeKind.md) \>[] | -| `S` *extends* `undefined` \| [`DecoratorParamDefinition`](Interface.DecoratorParamDefinition.md)< [`TypeKind`](Type.TypeKind.md) \> | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `definition` | [`DecoratorDefinition`](Interface.DecoratorDefinition.md)< `T`, `P`, `S` \> | - -## Returns - -[`DecoratorValidator`](Interface.DecoratorValidator.md)< `T`, `P`, `S` \> - -## Deprecated - -use extern dec definition in typespec instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRule.md deleted file mode 100644 index fb2f0beaf5..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRule.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[F] createRule" - ---- -```ts -createRule(definition): LinterRuleDefinition< N, T > -``` - -Create a new linter rule. - -## Type parameters - -| Parameter | -| :------ | -| `N` *extends* `string` | -| `T` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `definition` | [`LinterRuleDefinition`](Interface.LinterRuleDefinition.md)< `N`, `T` \> | - -## Returns - -[`LinterRuleDefinition`](Interface.LinterRuleDefinition.md)< `N`, `T` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createScanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createScanner.md deleted file mode 100644 index 2a3ed5b3e0..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createScanner.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] createScanner" - ---- -```ts -createScanner(source, diagnosticHandler): Scanner -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `source` | `string` \| [`SourceFile`](Interface.SourceFile.md) | -| `diagnosticHandler` | [`DiagnosticHandler`](Type.DiagnosticHandler.md) | - -## Returns - -[`Scanner`](Interface.Scanner.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createStateAccessors.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createStateAccessors.md deleted file mode 100644 index fcb4e64b5d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createStateAccessors.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[F] createStateAccessors" - ---- -```ts -createStateAccessors( - stateMaps, - stateSets, - projector?): object -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `stateMaps` | `Map`< `symbol`, `StateMap` \> | -| `stateSets` | `Map`< `symbol`, `StateSet` \> | -| `projector`? | [`Projector`](Interface.Projector.md) | - -## Returns - -| Member | Type | -| :------ | :------ | -| `stateMap` | <`T`>(`key`) => `StateMapView`< `T` \> | -| `stateSet` | (`key`) => `StateSetView` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.emitFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.emitFile.md deleted file mode 100644 index 379e9ca824..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.emitFile.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] emitFile" - ---- -```ts -emitFile(program, options): Promise< void > -``` - -Helper to emit a file. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | TypeSpec Program | -| `options` | [`EmitFileOptions`](Interface.EmitFileOptions.md) | File Emitter options | - -## Returns - -`Promise`< `void` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ensurePathIsNonModuleName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ensurePathIsNonModuleName.md deleted file mode 100644 index 6ea91a4cc3..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ensurePathIsNonModuleName.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -jsApi: true -title: "[F] ensurePathIsNonModuleName" - ---- -```ts -ensurePathIsNonModuleName(path): string -``` - -Ensures a path is either absolute (prefixed with `/` or `c:`) or dot-relative (prefixed -with `./` or `../`) so as not to be confused with an unprefixed module name. - -```ts -ensurePathIsNonModuleName("/path/to/file.ext") === "/path/to/file.ext" -ensurePathIsNonModuleName("./path/to/file.ext") === "./path/to/file.ext" -ensurePathIsNonModuleName("../path/to/file.ext") === "../path/to/file.ext" -ensurePathIsNonModuleName("path/to/file.ext") === "./path/to/file.ext" -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getCompletionNodeAtPosition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getCompletionNodeAtPosition.md deleted file mode 100644 index 364014c888..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getCompletionNodeAtPosition.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[F] getCompletionNodeAtPosition" - ---- -```ts -getCompletionNodeAtPosition( - script, - position, - filter = ...): Node | undefined -``` - -Resolve the node that should be auto completed at the given position. -It will try to guess what node it could be as during auto complete the ast might not be complete. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `script` | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | -| `position` | `number` | -| `filter` | (`node`) => `boolean` | - -## Returns - -[`Node`](Type.Node.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDiscriminatedUnion.md deleted file mode 100644 index 7c4731a11b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDiscriminatedUnion.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getDiscriminatedUnion" - ---- -```ts -getDiscriminatedUnion(type, discriminator): [DiscriminatedUnion, readonly Diagnostic[]] -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Model`](Interface.Model.md) \| [`Union`](Interface.Union.md) | -| `discriminator` | [`Discriminator`](Namespace.decorators.Interface.Discriminator.md) | - -## Returns - -[[`DiscriminatedUnion`](Interface.DiscriminatedUnion.md), *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceLocation.md deleted file mode 100644 index 6619125458..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceLocation.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -jsApi: true -title: "[F] getSourceLocation" - ---- -```ts -getSourceLocation(target, options?): SourceLocation -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | -| `options`? | [`SourceLocationOptions`](Interface.SourceLocationOptions.md) | - -## Returns - -[`SourceLocation`](Interface.SourceLocation.md) - -```ts -getSourceLocation(target, options?): undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `target` | `undefined` \| *typeof* [`NoTarget`](Variable.NoTarget.md) | -| `options`? | [`SourceLocationOptions`](Interface.SourceLocationOptions.md) | - -## Returns - -`undefined` - -```ts -getSourceLocation(target, options?): SourceLocation | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `target` | `undefined` \| [`DiagnosticTarget`](Type.DiagnosticTarget.md) \| *typeof* [`NoTarget`](Variable.NoTarget.md) | -| `options`? | [`SourceLocationOptions`](Interface.SourceLocationOptions.md) | - -## Returns - -[`SourceLocation`](Interface.SourceLocation.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getTypeName.md deleted file mode 100644 index 63b5782662..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getTypeName.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getTypeName" - ---- -```ts -getTypeName(type, options?): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Type`](Type.Type.md) \| [`ValueType`](Interface.ValueType.md) | -| `options`? | [`TypeNameOptions`](Interface.TypeNameOptions.md) | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isIntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isIntrinsicType.md deleted file mode 100644 index d4173bc254..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isIntrinsicType.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] isIntrinsicType" - ---- -```ts -isIntrinsicType( - program, - type, - kind): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `type` | [`Scalar`](Interface.Scalar.md) | -| `kind` | [`IntrinsicScalarName`](Type.IntrinsicScalarName.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.listOperationsIn.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.listOperationsIn.md deleted file mode 100644 index bde92a9d27..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.listOperationsIn.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] listOperationsIn" - ---- -```ts -listOperationsIn(container, options = {}): Operation[] -``` - -List operations in the given container. Will list operation recursively by default(Check subnamespaces.) - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `container` | [`Interface`](Interface.Interface.md) \| [`Namespace`](Interface.Namespace.md) | Container. | -| `options` | [`ListOperationOptions`](Interface.ListOperationOptions.md) | Options. | - -## Returns - -[`Operation`](Interface.Operation.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.markDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.markDeprecated.md deleted file mode 100644 index 1187ed0366..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.markDeprecated.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] markDeprecated" - ---- -```ts -markDeprecated( - program, - type, - details): void -``` - -Mark the given type as deprecated with the provided details. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `type` | [`Type`](Type.Type.md) | Type | -| `details` | [`DeprecationDetails`](Interface.DeprecationDetails.md) | Details of the deprecation | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateProgram.md deleted file mode 100644 index c9d166c1e5..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateProgram.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] navigateProgram" - ---- -```ts -navigateProgram( - program, - listeners, - options = {}): void -``` - -Navigate all types in the program. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program to navigate. | -| `listeners` | [`SemanticNodeListener`](Type.SemanticNodeListener.md) | Listener called when visiting types. | -| `options` | [`NavigationOptions`](Interface.NavigationOptions.md) | Navigation options. | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateType.md deleted file mode 100644 index a8323ae924..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateType.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] navigateType" - ---- -```ts -navigateType( - type, - listeners, - options): void -``` - -Navigate the given type and all the types that are used in it. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `type` | [`Type`](Type.Type.md) | Type to navigate. | -| `listeners` | [`SemanticNodeListener`](Type.SemanticNodeListener.md) | Listener for the types found. | -| `options` | [`NavigationOptions`](Interface.NavigationOptions.md) | Navigation options | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateTypesInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateTypesInNamespace.md deleted file mode 100644 index 6a45efe1aa..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.navigateTypesInNamespace.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] navigateTypesInNamespace" - ---- -```ts -navigateTypesInNamespace( - namespace, - listeners, - options = {}): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `namespace` | [`Namespace`](Interface.Namespace.md) | -| `listeners` | \{`exitModel`: `undefined` \| `TypeListener`< [`Model`](Interface.Model.md) \>; `model`: `undefined` \| `TypeListener`< [`Model`](Interface.Model.md) \>;} & \{`exitModelProperty`: `undefined` \| `TypeListener`< [`ModelProperty`](Interface.ModelProperty.md) \>; `modelProperty`: `undefined` \| `TypeListener`< [`ModelProperty`](Interface.ModelProperty.md) \>;} & \{`exitScalar`: `undefined` \| `TypeListener`< [`Scalar`](Interface.Scalar.md) \>; `scalar`: `undefined` \| `TypeListener`< [`Scalar`](Interface.Scalar.md) \>;} & \{`exitInterface`: `undefined` \| `TypeListener`< [`Interface`](Interface.Interface.md) \>; `interface`: `undefined` \| `TypeListener`< [`Interface`](Interface.Interface.md) \>;} & \{`enum`: `undefined` \| `TypeListener`< [`Enum`](Interface.Enum.md) \>; `exitEnum`: `undefined` \| `TypeListener`< [`Enum`](Interface.Enum.md) \>;} & \{`enumMember`: `undefined` \| `TypeListener`< [`EnumMember`](Interface.EnumMember.md) \>; `exitEnumMember`: `undefined` \| `TypeListener`< [`EnumMember`](Interface.EnumMember.md) \>;} & \{`exitTemplateParameter`: `undefined` \| `TypeListener`< [`TemplateParameter`](Interface.TemplateParameter.md) \>; `templateParameter`: `undefined` \| `TypeListener`< [`TemplateParameter`](Interface.TemplateParameter.md) \>;} & \{`exitNamespace`: `undefined` \| `TypeListener`< [`Namespace`](Interface.Namespace.md) \>; `namespace`: `undefined` \| `TypeListener`< [`Namespace`](Interface.Namespace.md) \>;} & \{`exitOperation`: `undefined` \| `TypeListener`< [`Operation`](Interface.Operation.md) \>; `operation`: `undefined` \| `TypeListener`< [`Operation`](Interface.Operation.md) \>;} & \{`exitString`: `undefined` \| `TypeListener`< [`StringLiteral`](Interface.StringLiteral.md) \>; `string`: `undefined` \| `TypeListener`< [`StringLiteral`](Interface.StringLiteral.md) \>;} & \{`exitNumber`: `undefined` \| `TypeListener`< [`NumericLiteral`](Interface.NumericLiteral.md) \>; `number`: `undefined` \| `TypeListener`< [`NumericLiteral`](Interface.NumericLiteral.md) \>;} & \{`boolean`: `undefined` \| `TypeListener`< [`BooleanLiteral`](Interface.BooleanLiteral.md) \>; `exitBoolean`: `undefined` \| `TypeListener`< [`BooleanLiteral`](Interface.BooleanLiteral.md) \>;} & \{`exitTuple`: `undefined` \| `TypeListener`< [`Tuple`](Interface.Tuple.md) \>; `tuple`: `undefined` \| `TypeListener`< [`Tuple`](Interface.Tuple.md) \>;} & \{`exitUnion`: `undefined` \| `TypeListener`< [`Union`](Interface.Union.md) \>; `union`: `undefined` \| `TypeListener`< [`Union`](Interface.Union.md) \>;} & \{`exitUnionVariant`: `undefined` \| `TypeListener`< [`UnionVariant`](Interface.UnionVariant.md) \>; `unionVariant`: `undefined` \| `TypeListener`< [`UnionVariant`](Interface.UnionVariant.md) \>;} & \{`exitIntrinsic`: `undefined` \| `TypeListener`< [`IntrinsicType`](Interface.IntrinsicType.md) \>; `intrinsic`: `undefined` \| `TypeListener`< [`IntrinsicType`](Interface.IntrinsicType.md) \>;} & \{`exitFunction`: `undefined` \| `TypeListener`< [`FunctionType`](Interface.FunctionType.md) \>; `function`: `undefined` \| `TypeListener`< [`FunctionType`](Interface.FunctionType.md) \>;} & \{`decorator`: `undefined` \| `TypeListener`< [`Decorator`](Interface.Decorator.md) \>; `exitDecorator`: `undefined` \| `TypeListener`< [`Decorator`](Interface.Decorator.md) \>;} & \{`exitFunctionParameter`: `undefined` \| `TypeListener`< [`FunctionParameter`](Interface.FunctionParameter.md) \>; `functionParameter`: `undefined` \| `TypeListener`< [`FunctionParameter`](Interface.FunctionParameter.md) \>;} & \{`exitObject`: `undefined` \| `TypeListener`< [`ObjectType`](Interface.ObjectType.md) \>; `object`: `undefined` \| `TypeListener`< [`ObjectType`](Interface.ObjectType.md) \>;} & \{`exitProjection`: `undefined` \| `TypeListener`< [`Projection`](Interface.Projection.md) \>; `projection`: `undefined` \| `TypeListener`< [`Projection`](Interface.Projection.md) \>;} | -| `options` | [`NamespaceNavigationOptions`](Interface.NamespaceNavigationOptions.md) & [`NavigationOptions`](Interface.NavigationOptions.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.paramMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.paramMessage.md deleted file mode 100644 index b8527ddd5f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.paramMessage.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] paramMessage" - ---- -```ts -paramMessage(strings, ...keys): CallableMessage< T > -``` - -## Type parameters - -| Parameter | -| :------ | -| `T` *extends* `string`[] | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `strings` | *readonly* `string`[] | -| ...`keys` | `T` | - -## Returns - -[`CallableMessage`](Interface.CallableMessage.md)< `T` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.parse.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.parse.md deleted file mode 100644 index 42dc4744c7..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.parse.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] parse" - ---- -```ts -parse(code, options = {}): TypeSpecScriptNode -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `code` | `string` \| [`SourceFile`](Interface.SourceFile.md) | -| `options` | [`ParseOptions`](Interface.ParseOptions.md) | - -## Returns - -[`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.projectProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.projectProgram.md deleted file mode 100644 index bc3287bc7a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.projectProgram.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] projectProgram" - ---- -```ts -projectProgram( - program, - projections, - startNode?): ProjectedProgram -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `projections` | [`ProjectionApplication`](Interface.ProjectionApplication.md)[] | -| `startNode`? | [`Type`](Type.Type.md) | - -## Returns - -[`ProjectedProgram`](Interface.ProjectedProgram.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.reportDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.reportDeprecated.md deleted file mode 100644 index 5106a534fb..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.reportDeprecated.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] reportDeprecated" - ---- -```ts -reportDeprecated( - program, - message, - target): void -``` - -Report a deprecated diagnostic. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | TypeSpec Program. | -| `message` | `string` | Message describing the deprecation. | -| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) \| *typeof* [`NoTarget`](Variable.NoTarget.md) | Target of the deprecation. | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveCompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveCompilerOptions.md deleted file mode 100644 index 3f0397939b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveCompilerOptions.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] resolveCompilerOptions" - ---- -```ts -resolveCompilerOptions(host, options): Promise< [CompilerOptions, readonly Diagnostic[]] > -``` - -Resolve the compiler options for the given entrypoint by resolving the tspconfig.yaml. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `host` | [`CompilerHost`](Interface.CompilerHost.md) | Compiler host | -| `options` | [`ResolveCompilerOptionsOptions`](Interface.ResolveCompilerOptionsOptions.md) | - | - -## Returns - -`Promise`< [[`CompilerOptions`](Interface.CompilerOptions.md), *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveModule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveModule.md deleted file mode 100644 index 286df7354e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveModule.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] resolveModule" - ---- -```ts -resolveModule( - host, - name, - options): Promise< ModuleResolutionResult > -``` - -Resolve a module - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `host` | [`ResolveModuleHost`](Interface.ResolveModuleHost.md) | | -| `name` | `string` | | -| `options` | [`ResolveModuleOptions`](Interface.ResolveModuleOptions.md) | | - -## Returns - -`Promise`< [`ModuleResolutionResult`](Type.ModuleResolutionResult.md) \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.scopeNavigationToNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.scopeNavigationToNamespace.md deleted file mode 100644 index 7c161b3502..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.scopeNavigationToNamespace.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -jsApi: true -title: "[F] scopeNavigationToNamespace" - ---- -```ts -scopeNavigationToNamespace( - namespace, - listeners, - options = {}): T -``` - -Scope the current navigation to the given namespace. - -## Type parameters - -| Parameter | -| :------ | -| `T` *extends* \{`exitModel`: `undefined` \| `TypeListener`< [`Model`](Interface.Model.md) \>; `model`: `undefined` \| `TypeListener`< [`Model`](Interface.Model.md) \>;} & \{`exitModelProperty`: `undefined` \| `TypeListener`< [`ModelProperty`](Interface.ModelProperty.md) \>; `modelProperty`: `undefined` \| `TypeListener`< [`ModelProperty`](Interface.ModelProperty.md) \>;} & \{`exitScalar`: `undefined` \| `TypeListener`< [`Scalar`](Interface.Scalar.md) \>; `scalar`: `undefined` \| `TypeListener`< [`Scalar`](Interface.Scalar.md) \>;} & \{`exitInterface`: `undefined` \| `TypeListener`< [`Interface`](Interface.Interface.md) \>; `interface`: `undefined` \| `TypeListener`< [`Interface`](Interface.Interface.md) \>;} & \{`enum`: `undefined` \| `TypeListener`< [`Enum`](Interface.Enum.md) \>; `exitEnum`: `undefined` \| `TypeListener`< [`Enum`](Interface.Enum.md) \>;} & \{`enumMember`: `undefined` \| `TypeListener`< [`EnumMember`](Interface.EnumMember.md) \>; `exitEnumMember`: `undefined` \| `TypeListener`< [`EnumMember`](Interface.EnumMember.md) \>;} & \{`exitTemplateParameter`: `undefined` \| `TypeListener`< [`TemplateParameter`](Interface.TemplateParameter.md) \>; `templateParameter`: `undefined` \| `TypeListener`< [`TemplateParameter`](Interface.TemplateParameter.md) \>;} & \{`exitNamespace`: `undefined` \| `TypeListener`< [`Namespace`](Interface.Namespace.md) \>; `namespace`: `undefined` \| `TypeListener`< [`Namespace`](Interface.Namespace.md) \>;} & \{`exitOperation`: `undefined` \| `TypeListener`< [`Operation`](Interface.Operation.md) \>; `operation`: `undefined` \| `TypeListener`< [`Operation`](Interface.Operation.md) \>;} & \{`exitString`: `undefined` \| `TypeListener`< [`StringLiteral`](Interface.StringLiteral.md) \>; `string`: `undefined` \| `TypeListener`< [`StringLiteral`](Interface.StringLiteral.md) \>;} & \{`exitNumber`: `undefined` \| `TypeListener`< [`NumericLiteral`](Interface.NumericLiteral.md) \>; `number`: `undefined` \| `TypeListener`< [`NumericLiteral`](Interface.NumericLiteral.md) \>;} & \{`boolean`: `undefined` \| `TypeListener`< [`BooleanLiteral`](Interface.BooleanLiteral.md) \>; `exitBoolean`: `undefined` \| `TypeListener`< [`BooleanLiteral`](Interface.BooleanLiteral.md) \>;} & \{`exitTuple`: `undefined` \| `TypeListener`< [`Tuple`](Interface.Tuple.md) \>; `tuple`: `undefined` \| `TypeListener`< [`Tuple`](Interface.Tuple.md) \>;} & \{`exitUnion`: `undefined` \| `TypeListener`< [`Union`](Interface.Union.md) \>; `union`: `undefined` \| `TypeListener`< [`Union`](Interface.Union.md) \>;} & \{`exitUnionVariant`: `undefined` \| `TypeListener`< [`UnionVariant`](Interface.UnionVariant.md) \>; `unionVariant`: `undefined` \| `TypeListener`< [`UnionVariant`](Interface.UnionVariant.md) \>;} & \{`exitIntrinsic`: `undefined` \| `TypeListener`< [`IntrinsicType`](Interface.IntrinsicType.md) \>; `intrinsic`: `undefined` \| `TypeListener`< [`IntrinsicType`](Interface.IntrinsicType.md) \>;} & \{`exitFunction`: `undefined` \| `TypeListener`< [`FunctionType`](Interface.FunctionType.md) \>; `function`: `undefined` \| `TypeListener`< [`FunctionType`](Interface.FunctionType.md) \>;} & \{`decorator`: `undefined` \| `TypeListener`< [`Decorator`](Interface.Decorator.md) \>; `exitDecorator`: `undefined` \| `TypeListener`< [`Decorator`](Interface.Decorator.md) \>;} & \{`exitFunctionParameter`: `undefined` \| `TypeListener`< [`FunctionParameter`](Interface.FunctionParameter.md) \>; `functionParameter`: `undefined` \| `TypeListener`< [`FunctionParameter`](Interface.FunctionParameter.md) \>;} & \{`exitObject`: `undefined` \| `TypeListener`< [`ObjectType`](Interface.ObjectType.md) \>; `object`: `undefined` \| `TypeListener`< [`ObjectType`](Interface.ObjectType.md) \>;} & \{`exitProjection`: `undefined` \| `TypeListener`< [`Projection`](Interface.Projection.md) \>; `projection`: `undefined` \| `TypeListener`< [`Projection`](Interface.Projection.md) \>;} | - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `namespace` | [`Namespace`](Interface.Namespace.md) | Namespace the traversal shouldn't leave. | -| `listeners` | `T` | Type listeners. | -| `options` | [`NamespaceNavigationOptions`](Interface.NamespaceNavigationOptions.md) | Scope options | - -## Returns - -`T` - -wrapped listeners that that can be used with `navigateType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorNotOnType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorNotOnType.md deleted file mode 100644 index 43c4bf791d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorNotOnType.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -jsApi: true -title: "[F] validateDecoratorNotOnType" - ---- -```ts -validateDecoratorNotOnType( - context, - type, - badDecorator, - givenDecorator): boolean -``` - -Validate that a given decorator is not on a type or any of its base types. -Useful to check for decorator usage that conflicts with another decorator. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | Decorator context | -| `type` | [`Type`](Type.Type.md) | The type to check | -| `badDecorator` | [`DecoratorFunction`](Interface.DecoratorFunction.md) | The decorator we don't want present | -| `givenDecorator` | [`DecoratorFunction`](Interface.DecoratorFunction.md) | The decorator that is the reason why we don't want the bad decorator present | - -## Returns - -`boolean` - -Whether the decorator application is valid diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamType.md deleted file mode 100644 index 35596187b7..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamType.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -jsApi: true -title: "[F] validateDecoratorParamType" - ---- -```ts -validateDecoratorParamType( - program, - target, - value, - expectedType): value is InferredTypeSpecValue -``` - -Validate a decorator parameter has the correct type. - -## Type parameters - -| Parameter | -| :------ | -| `K` *extends* `"Model"` \| `"ModelProperty"` \| `"Scalar"` \| `"Interface"` \| `"Enum"` \| `"EnumMember"` \| `"TemplateParameter"` \| `"Namespace"` \| `"Operation"` \| `"String"` \| `"Number"` \| `"Boolean"` \| `"Tuple"` \| `"Union"` \| `"UnionVariant"` \| `"Intrinsic"` \| `"Function"` \| `"Decorator"` \| `"FunctionParameter"` \| `"Object"` \| `"Projection"` | - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `target` | [`Type`](Type.Type.md) | Decorator target | -| `value` | [`TypeSpecValue`](Type.TypeSpecValue.md) | Value of the parameter. | -| `expectedType` | `K` \| `K`[] | Expected type or list of expected type | - -## Returns - -`value is InferredTypeSpecValue` - -true if the value is of one of the type in the list of expected types. If not emit a diagnostic. - -## Deprecated - -use - -## See - -createDecoratorDefinition#validate instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTarget.md deleted file mode 100644 index 94209a4691..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTarget.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -jsApi: true -title: "[F] validateDecoratorTarget" - ---- -```ts -validateDecoratorTarget( - context, - target, - decoratorName, - expectedType): target is K extends "Any" ? Type : Object -``` - -Validate the decorator target is matching the expected value. - -## Type parameters - -| Parameter | -| :------ | -| `K` *extends* [`TypeKind`](Type.TypeKind.md) | - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | - | -| `target` | [`Type`](Type.Type.md) | | -| `decoratorName` | `string` | | -| `expectedType` | `K` \| *readonly* `K`[] | | - -## Returns - -`target is K extends "Any" ? Type : Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTargetIntrinsic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTargetIntrinsic.md deleted file mode 100644 index b71c9fed1f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorTargetIntrinsic.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] validateDecoratorTargetIntrinsic" - ---- -```ts -validateDecoratorTargetIntrinsic( - context, - target, - decoratorName, - expectedType): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | -| `decoratorName` | `string` | -| `expectedType` | [`IntrinsicScalarName`](Type.IntrinsicScalarName.md) \| [`IntrinsicScalarName`](Type.IntrinsicScalarName.md)[] | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorUniqueOnNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorUniqueOnNode.md deleted file mode 100644 index 281a3f964b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorUniqueOnNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] validateDecoratorUniqueOnNode" - ---- -```ts -validateDecoratorUniqueOnNode( - context, - type, - decorator): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `type` | [`Type`](Type.Type.md) | -| `decorator` | [`DecoratorFunction`](Interface.DecoratorFunction.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AliasStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AliasStatementNode.md deleted file mode 100644 index 54e2e2ba0a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AliasStatementNode.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[I] AliasStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md).[`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`AliasStatement`](Enumeration.SyntaxKind.md#aliasstatement) | - | -| `locals`? | `SymbolTable` | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | - | -| `readonly` `value` | [`Expression`](Type.Expression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AnyKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AnyKeywordNode.md deleted file mode 100644 index 4ef7454c11..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AnyKeywordNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] AnyKeywordNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`UnknownKeyword`](Enumeration.SyntaxKind.md#unknownkeyword) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ArrayExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ArrayExpressionNode.md deleted file mode 100644 index 59c89887a1..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ArrayExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ArrayExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `elementType` | [`Expression`](Type.Expression.md) | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ArrayExpression`](Enumeration.SyntaxKind.md#arrayexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ArrayModelType.md deleted file mode 100644 index 9d7910c0bb..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ArrayModelType.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -jsApi: true -title: "[I] ArrayModelType" - ---- -## Extends - -- [`Model`](Interface.Model.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `baseModel`? | [`Model`](Interface.Model.md) | Model this model extends. This represent inheritance. | -| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | -| `derivedModels` | [`Model`](Interface.Model.md)[] | Direct children. This is the reverse relation of [baseModel](Interface.ArrayModelType.md#basemodel) | -| `indexer` | `object` | - | -| `indexer.key` | [`Scalar`](Interface.Scalar.md) | - | -| `indexer.value` | [`Type`](Type.Type.md) | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Model"` | - | -| `name` | `string` | - | -| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | -| `node`? | [`ModelStatementNode`](Interface.ModelStatementNode.md) \| [`ModelExpressionNode`](Interface.ModelExpressionNode.md) \| [`IntersectionExpressionNode`](Interface.IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](Interface.ProjectionModelExpressionNode.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `properties` | `RekeyableMap`< `string`, [`ModelProperty`](Interface.ModelProperty.md) \> | The properties of the model.

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

Properties inherited via `model extends` are not included. Use
[walkPropertiesInherited](Function.walkPropertiesInherited.md) to enumerate all properties in the
inheritance hierarchy. | -| `sourceModel`? | [`Model`](Interface.Model.md) | The model that is referenced via `model is`. | -| `symbol`? | [`Sym`](Interface.Sym.md) | Late-bound symbol of this model type. | -| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

use templateMapper instead. | -| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | -| `templateNode`? | [`Node`](Type.Node.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`Model`](Interface.Model.md).[`projections`](Interface.Model.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`Model`](Interface.Model.md).[`projectionsByName`](Interface.Model.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AugmentDecoratorStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AugmentDecoratorStatementNode.md deleted file mode 100644 index cd4a2a35ec..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.AugmentDecoratorStatementNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] AugmentDecoratorStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `arguments` | *readonly* [`Expression`](Type.Expression.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`AugmentDecoratorStatement`](Enumeration.SyntaxKind.md#augmentdecoratorstatement) | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `targetType` | [`TypeReferenceNode`](Interface.TypeReferenceNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseNode.md deleted file mode 100644 index e1c4ee786d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] BaseNode" - ---- -## Extends - -- [`TextRange`](Interface.TextRange.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`SyntaxKind`](Enumeration.SyntaxKind.md) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseType.md deleted file mode 100644 index ea9874bc10..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BaseType.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -jsApi: true -title: "[I] BaseType" - ---- -## Extended By - -- [`ObjectType`](Interface.ObjectType.md) -- [`Projection`](Interface.Projection.md) -- [`IntrinsicType`](Interface.IntrinsicType.md) -- [`Model`](Interface.Model.md) -- [`ModelProperty`](Interface.ModelProperty.md) -- [`Scalar`](Interface.Scalar.md) -- [`Interface`](Interface.Interface.md) -- [`Enum`](Interface.Enum.md) -- [`EnumMember`](Interface.EnumMember.md) -- [`Operation`](Interface.Operation.md) -- [`Namespace`](Interface.Namespace.md) -- [`StringLiteral`](Interface.StringLiteral.md) -- [`NumericLiteral`](Interface.NumericLiteral.md) -- [`BooleanLiteral`](Interface.BooleanLiteral.md) -- [`Tuple`](Interface.Tuple.md) -- [`Union`](Interface.Union.md) -- [`UnionVariant`](Interface.UnionVariant.md) -- [`TemplateParameter`](Interface.TemplateParameter.md) -- [`Decorator`](Interface.Decorator.md) -- [`FunctionType`](Interface.FunctionType.md) -- [`FunctionParameter`](Interface.FunctionParameter.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `string` | - | -| `node`? | [`Node`](Type.Node.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BlockComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BlockComment.md deleted file mode 100644 index 46565dc46d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BlockComment.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -jsApi: true -title: "[I] BlockComment" - ---- -## Extends - -- [`TextRange`](Interface.TextRange.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `kind` | [`BlockComment`](Enumeration.SyntaxKind.md#blockcomment) | - | -| `parsedAsDocs`? | `boolean` | If that comment was parsed as a doc comment. If parserOptions.docs=false this will always be false. | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteral.md deleted file mode 100644 index f5f3511c0c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteral.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] BooleanLiteral" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Boolean"` | - | -| `node`? | [`BooleanLiteralNode`](Interface.BooleanLiteralNode.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `value` | `boolean` | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteralNode.md deleted file mode 100644 index b1b8c3133e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.BooleanLiteralNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] BooleanLiteralNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`BooleanLiteral`](Enumeration.SyntaxKind.md#booleanliteral) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `value` | `boolean` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Checker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Checker.md deleted file mode 100644 index 1e071bb4ac..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Checker.md +++ /dev/null @@ -1,633 +0,0 @@ ---- -jsApi: true -title: "[I] Checker" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `anyType` | [`UnknownType`](Interface.UnknownType.md) | -| `errorType` | [`ErrorType`](Interface.ErrorType.md) | -| `neverType` | [`NeverType`](Interface.NeverType.md) | -| `typePrototype` | `TypePrototype` | -| `voidType` | [`VoidType`](Interface.VoidType.md) | - -## Methods - -### checkProgram - -```ts -checkProgram(): void -``` - -#### Returns - -`void` - -*** - -### checkSourceFile - -```ts -checkSourceFile(file): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `file` | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | - -#### Returns - -`void` - -*** - -### cloneType - -```ts -cloneType(type, additionalProps?): T -``` - -#### Type parameters - -| Parameter | -| :------ | -| `T` *extends* [`Type`](Type.Type.md) | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | `T` | -| `additionalProps`? | \{ [P in string \| number \| symbol]?: T[P] } | - -#### Returns - -`T` - -*** - -### createAndFinishType - -```ts -createAndFinishType(typeDef): T & TypePrototype -``` - -#### Type parameters - -| Parameter | -| :------ | -| `T` *extends* [`CreateTypeProps`](Type.CreateTypeProps.md) | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `typeDef` | `T` | - -#### Returns - -`T` & `TypePrototype` - -*** - -### createFunctionType - -```ts -createFunctionType(fn): FunctionType -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `fn` | (...`args`) => [`Type`](Type.Type.md) | - -#### Returns - -[`FunctionType`](Interface.FunctionType.md) - -*** - -### createLiteralType - -```ts -createLiteralType(value, node?): StringLiteral -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `value` | `string` | -| `node`? | [`StringLiteralNode`](Interface.StringLiteralNode.md) | - -#### Returns - -[`StringLiteral`](Interface.StringLiteral.md) - -```ts -createLiteralType(value, node?): NumericLiteral -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `value` | `number` | -| `node`? | [`NumericLiteralNode`](Interface.NumericLiteralNode.md) | - -#### Returns - -[`NumericLiteral`](Interface.NumericLiteral.md) - -```ts -createLiteralType(value, node?): BooleanLiteral -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `value` | `boolean` | -| `node`? | [`BooleanLiteralNode`](Interface.BooleanLiteralNode.md) | - -#### Returns - -[`BooleanLiteral`](Interface.BooleanLiteral.md) - -```ts -createLiteralType(value, node?): StringLiteral | NumericLiteral | BooleanLiteral -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `value` | `string` \| `number` \| `boolean` | -| `node`? | [`StringLiteralNode`](Interface.StringLiteralNode.md) \| [`NumericLiteralNode`](Interface.NumericLiteralNode.md) \| [`BooleanLiteralNode`](Interface.BooleanLiteralNode.md) | - -#### Returns - -[`StringLiteral`](Interface.StringLiteral.md) \| [`NumericLiteral`](Interface.NumericLiteral.md) \| [`BooleanLiteral`](Interface.BooleanLiteral.md) - -```ts -createLiteralType(value, node?): StringLiteral | NumericLiteral | BooleanLiteral -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `value` | `string` \| `number` \| `boolean` | -| `node`? | [`StringLiteralNode`](Interface.StringLiteralNode.md) \| [`NumericLiteralNode`](Interface.NumericLiteralNode.md) \| [`BooleanLiteralNode`](Interface.BooleanLiteralNode.md) | - -#### Returns - -[`StringLiteral`](Interface.StringLiteral.md) \| [`NumericLiteral`](Interface.NumericLiteral.md) \| [`BooleanLiteral`](Interface.BooleanLiteral.md) - -*** - -### createType - -```ts -createType(typeDef): T & TypePrototype & {isFinished: boolean;} -``` - -#### Type parameters - -| Parameter | -| :------ | -| `T` *extends* [`CreateTypeProps`](Type.CreateTypeProps.md) | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `typeDef` | `T` | - -#### Returns - -`T` & `TypePrototype` & \{`isFinished`: `boolean`;} - -*** - -### evalProjection - -```ts -evalProjection( - node, - target, - args): Type -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`ProjectionNode`](Interface.ProjectionNode.md) | -| `target` | [`Type`](Type.Type.md) | -| `args` | [`Type`](Type.Type.md)[] | - -#### Returns - -[`Type`](Type.Type.md) - -*** - -### finishType - -```ts -finishType(typeDef): T -``` - -#### Type parameters - -| Parameter | -| :------ | -| `T` *extends* [`Type`](Type.Type.md) | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `typeDef` | `T` | - -#### Returns - -`T` - -*** - -### getGlobalNamespaceNode - -```ts -getGlobalNamespaceNode(): NamespaceStatementNode -``` - -#### Returns - -[`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) - -*** - -### getGlobalNamespaceType - -```ts -getGlobalNamespaceType(): Namespace -``` - -#### Returns - -[`Namespace`](Interface.Namespace.md) - -*** - -### getLiteralType - -```ts -getLiteralType(node): StringLiteral -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`StringLiteralNode`](Interface.StringLiteralNode.md) | - -#### Returns - -[`StringLiteral`](Interface.StringLiteral.md) - -```ts -getLiteralType(node): NumericLiteral -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`NumericLiteralNode`](Interface.NumericLiteralNode.md) | - -#### Returns - -[`NumericLiteral`](Interface.NumericLiteral.md) - -```ts -getLiteralType(node): BooleanLiteral -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`BooleanLiteralNode`](Interface.BooleanLiteralNode.md) | - -#### Returns - -[`BooleanLiteral`](Interface.BooleanLiteral.md) - -```ts -getLiteralType(node): LiteralType -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`LiteralNode`](Type.LiteralNode.md) | - -#### Returns - -[`LiteralType`](Type.LiteralType.md) - -*** - -### getMergedSymbol - -```ts -getMergedSymbol(sym): undefined | Sym -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `sym` | `undefined` \| [`Sym`](Interface.Sym.md) | - -#### Returns - -`undefined` \| [`Sym`](Interface.Sym.md) - -*** - -### getNamespaceString - -```ts -getNamespaceString(type, options?): string -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | `undefined` \| [`Namespace`](Interface.Namespace.md) | -| `options`? | [`TypeNameOptions`](Interface.TypeNameOptions.md) | - -#### Returns - -`string` - -#### Deprecated - -use `import { getNamespaceFullName } from "@typespec/compiler";` - -*** - -### getStdType - -```ts -getStdType(name): StdTypes[T] -``` - -Std type - -#### Type parameters - -| Parameter | -| :------ | -| `T` *extends* [`IntrinsicScalarName`](Type.IntrinsicScalarName.md) \| `"Array"` \| `"Record"` | - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `name` | `T` | Name | - -#### Returns - -[`StdTypes`](Type.StdTypes.md)[`T`] - -*** - -### getTypeForNode - -```ts -getTypeForNode(node): Type -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`Node`](Type.Node.md) | - -#### Returns - -[`Type`](Type.Type.md) - -*** - -### getTypeName - -```ts -getTypeName(type, options?): string -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Type`](Type.Type.md) | -| `options`? | [`TypeNameOptions`](Interface.TypeNameOptions.md) | - -#### Returns - -`string` - -#### Deprecated - -use `import { getTypeName } from "@typespec/compiler";` - -*** - -### isStdType - -```ts -isStdType(type, stdType?): type is Scalar & Object -``` - -Check if the given type is one of the built-in standard TypeSpec Types. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `type` | [`Scalar`](Interface.Scalar.md) | Type to check | -| `stdType`? | [`IntrinsicScalarName`](Type.IntrinsicScalarName.md) | If provided check is that standard type | - -#### Returns - -`type is Scalar & Object` - -```ts -isStdType(type, stdType?): type is Type & Object -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Type`](Type.Type.md) | -| `stdType`? | [`IntrinsicScalarName`](Type.IntrinsicScalarName.md) \| `"Array"` \| `"Record"` | - -#### Returns - -`type is Type & Object` - -*** - -### isTypeAssignableTo - -```ts -isTypeAssignableTo( - source, - target, - diagnosticTarget): [boolean, readonly Diagnostic[]] -``` - -Check if the source type can be assigned to the target type. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `source` | [`Type`](Type.Type.md) \| [`ValueType`](Interface.ValueType.md) | Source type, should be assignable to the target. | -| `target` | [`Type`](Type.Type.md) \| [`ValueType`](Interface.ValueType.md) | Target type | -| `diagnosticTarget` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | Target for the diagnostic, unless something better can be inferred. | - -#### Returns - -[`boolean`, *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] - -[related, list of diagnostics] - -*** - -### mergeSourceFile - -```ts -mergeSourceFile(file): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `file` | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`JsSourceFileNode`](Interface.JsSourceFileNode.md) | - -#### Returns - -`void` - -*** - -### project - -```ts -project( - target, - projection, - args?): Type -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `target` | [`Type`](Type.Type.md) | -| `projection` | [`ProjectionNode`](Interface.ProjectionNode.md) | -| `args`? | (`string` \| `number` \| `boolean` \| [`Type`](Type.Type.md))[] | - -#### Returns - -[`Type`](Type.Type.md) - -*** - -### resolveCompletions - -```ts -resolveCompletions(node): Map< string, TypeSpecCompletionItem > -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`IdentifierNode`](Interface.IdentifierNode.md) | - -#### Returns - -`Map`< `string`, [`TypeSpecCompletionItem`](Interface.TypeSpecCompletionItem.md) \> - -*** - -### resolveIdentifier - -```ts -resolveIdentifier(node): undefined | Sym -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`IdentifierNode`](Interface.IdentifierNode.md) | - -#### Returns - -`undefined` \| [`Sym`](Interface.Sym.md) - -*** - -### resolveTypeReference - -```ts -resolveTypeReference(node): [undefined | Type, readonly Diagnostic[]] -``` - -Check and resolve a type for the given type reference node. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `node` | [`TypeReferenceNode`](Interface.TypeReferenceNode.md) | Node. | - -#### Returns - -[`undefined` \| [`Type`](Type.Type.md), *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] - -Resolved type and diagnostics if there was an error. - -*** - -### setUsingsForFile - -```ts -setUsingsForFile(file): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `file` | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerLocationContext.md deleted file mode 100644 index 0850e9c398..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerLocationContext.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] CompilerLocationContext" - ---- -Built-in - -## Properties - -| Property | Type | -| :------ | :------ | -| `type` | `"compiler"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerOptions.md deleted file mode 100644 index 5eb07d8972..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerOptions.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[I] CompilerOptions" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `additionalImports`? | `string`[] | - | -| `config`? | `string` | Path to config YAML file or folder in which to search for default tspconfig.yaml file. | -| `designTimeBuild`? | `boolean` | When true, indicates that a compilation is being performed for live
analysis in the language server. | -| `emit`? | `string`[] | List or path to emitters to use. | -| `emitters`? | `Record`< `string`, `EmitterOptions` \> | **Deprecated**

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

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

**Default**

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

use outputDir. | -| `parseOptions`? | [`ParseOptions`](Interface.ParseOptions.md) | - | -| `trace`? | `string`[] | Trace area to enable. | -| `warningAsError`? | `boolean` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeclarationNode.md deleted file mode 100644 index 3fcfe528c7..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeclarationNode.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -jsApi: true -title: "[I] DeclarationNode" - ---- -## Extended By - -- [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) -- [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) -- [`OperationStatementNode`](Interface.OperationStatementNode.md) -- [`ModelStatementNode`](Interface.ModelStatementNode.md) -- [`ScalarStatementNode`](Interface.ScalarStatementNode.md) -- [`InterfaceStatementNode`](Interface.InterfaceStatementNode.md) -- [`UnionStatementNode`](Interface.UnionStatementNode.md) -- [`EnumStatementNode`](Interface.EnumStatementNode.md) -- [`AliasStatementNode`](Interface.AliasStatementNode.md) -- [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md) -- [`DecoratorDeclarationStatementNode`](Interface.DecoratorDeclarationStatementNode.md) -- [`FunctionDeclarationStatementNode`](Interface.FunctionDeclarationStatementNode.md) -- [`ProjectionParameterDeclarationNode`](Interface.ProjectionParameterDeclarationNode.md) -- [`ProjectionLambdaParameterDeclarationNode`](Interface.ProjectionLambdaParameterDeclarationNode.md) -- [`ProjectionStatementNode`](Interface.ProjectionStatementNode.md) -- [`JsSourceFileNode`](Interface.JsSourceFileNode.md) -- [`JsNamespaceDeclarationNode`](Interface.JsNamespaceDeclarationNode.md) - -## Properties - -| Property | Type | -| :------ | :------ | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratedType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratedType.md deleted file mode 100644 index caf20748a5..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratedType.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratedType" - ---- -## Extended By - -- [`Model`](Interface.Model.md) -- [`ModelProperty`](Interface.ModelProperty.md) -- [`Scalar`](Interface.Scalar.md) -- [`Interface`](Interface.Interface.md) -- [`Enum`](Interface.Enum.md) -- [`EnumMember`](Interface.EnumMember.md) -- [`Operation`](Interface.Operation.md) -- [`Namespace`](Interface.Namespace.md) -- [`Union`](Interface.Union.md) -- [`UnionVariant`](Interface.UnionVariant.md) - -## Properties - -| Property | Type | -| :------ | :------ | -| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Decorator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Decorator.md deleted file mode 100644 index 619425ea83..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Decorator.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -jsApi: true -title: "[I] Decorator" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `implementation` | (...`args`) => `void` | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Decorator"` | - | -| `name` | \`@$\{string}\` | - | -| `namespace` | [`Namespace`](Interface.Namespace.md) | - | -| `node` | [`DecoratorDeclarationStatementNode`](Interface.DecoratorDeclarationStatementNode.md) | - | -| `parameters` | [`FunctionParameter`](Interface.FunctionParameter.md)[] | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `target` | [`FunctionParameter`](Interface.FunctionParameter.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorApplication.md deleted file mode 100644 index 9edf692c45..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorApplication.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorApplication" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `args` | [`DecoratorArgument`](Interface.DecoratorArgument.md)[] | -| `decorator` | [`DecoratorFunction`](Interface.DecoratorFunction.md) | -| `definition`? | [`Decorator`](Interface.Decorator.md) | -| `node`? | [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md) \| [`AugmentDecoratorStatementNode`](Interface.AugmentDecoratorStatementNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorArgument.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorArgument.md deleted file mode 100644 index 07148c0b3e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorArgument.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorArgument" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `jsValue` | `string` \| `number` \| `boolean` \| [`Type`](Type.Type.md) | Marshalled value for use in Javascript. | -| `node`? | [`Node`](Type.Node.md) | - | -| `value` | [`Type`](Type.Type.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDeclarationStatementNode.md deleted file mode 100644 index 058008c901..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDeclarationStatementNode.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorDeclarationStatementNode" - ---- -Represent a decorator declaration - -## Example - -```typespec -extern dec doc(target: Type, value: valueof string); -``` - -## Extends - -- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`DecoratorDeclarationStatement`](Enumeration.SyntaxKind.md#decoratordeclarationstatement) | - | -| `readonly` `modifierFlags` | [`ModifierFlags`](Enumeration.ModifierFlags.md) | - | -| `readonly` `modifiers` | *readonly* [`ExternKeywordNode`](Interface.ExternKeywordNode.md)[] | - | -| `readonly` `parameters` | [`FunctionParameterNode`](Interface.FunctionParameterNode.md)[] | Additional parameters | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`FunctionParameterNode`](Interface.FunctionParameterNode.md) | Decorator target. First parameter. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDefinition.md deleted file mode 100644 index 8adac87603..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorDefinition.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorDefinition" - ---- -## Type parameters - -| Parameter | Default | -| :------ | :------ | -| `T` *extends* [`TypeKind`](Type.TypeKind.md) | - | -| `P` *extends* *readonly* [`DecoratorParamDefinition`](Interface.DecoratorParamDefinition.md)< [`TypeKind`](Type.TypeKind.md) \>[] | - | -| `S` *extends* [`DecoratorParamDefinition`](Interface.DecoratorParamDefinition.md)< [`TypeKind`](Type.TypeKind.md) \> \| `undefined` | `undefined` | - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `args` | `P` | List of positional arguments in the function. | -| `readonly` `name` | `string` | Name of the decorator. | -| `spreadArgs`? | `S` | **Optional**

Type of the spread args at the end of the function if applicable. | -| `readonly` `target` | `T` \| *readonly* `T`[] | Decorator target. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorExpressionNode.md deleted file mode 100644 index 214488f033..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorExpressionNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `arguments` | *readonly* [`Expression`](Type.Expression.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`DecoratorExpression`](Enumeration.SyntaxKind.md#decoratorexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorParamDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorParamDefinition.md deleted file mode 100644 index 9940cc6d4a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorParamDefinition.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorParamDefinition" - ---- -## Type parameters - -| Parameter | -| :------ | -| `K` *extends* [`TypeKind`](Type.TypeKind.md) | - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `kind` | `K` \| *readonly* `K`[] | Kind of the parameter | -| `optional`? | `boolean` | Is the parameter optional. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorValidator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorValidator.md deleted file mode 100644 index 8731052121..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorValidator.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorValidator" - ---- -## Type parameters - -| Parameter | Default | -| :------ | :------ | -| `T` *extends* [`TypeKind`](Type.TypeKind.md) | - | -| `P` *extends* *readonly* [`DecoratorParamDefinition`](Interface.DecoratorParamDefinition.md)< [`TypeKind`](Type.TypeKind.md) \>[] | - | -| `S` *extends* [`DecoratorParamDefinition`](Interface.DecoratorParamDefinition.md)< [`TypeKind`](Type.TypeKind.md) \> \| `undefined` | `undefined` | - -## Methods - -### validate - -```ts -validate( - context, - target, - parameters): boolean -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`InferredTypeSpecValue`](Type.InferredTypeSpecValue.md)< `T` \> | -| `parameters` | `InferParameters`< `P`, `S` \> | - -#### Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeprecatedDirective.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeprecatedDirective.md deleted file mode 100644 index c5faa7ab3a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeprecatedDirective.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] DeprecatedDirective" - ---- -## Extends - -- [`DirectiveBase`](Interface.DirectiveBase.md) - -## Properties - -| Property | Type | -| :------ | :------ | -| `message` | `string` | -| `name` | `"deprecated"` | -| `node` | [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Diagnostic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Diagnostic.md deleted file mode 100644 index 5298e186ef..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Diagnostic.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] Diagnostic" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `code` | `string` | -| `message` | `string` | -| `severity` | [`DiagnosticSeverity`](Type.DiagnosticSeverity.md) | -| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) \| *typeof* [`NoTarget`](Variable.NoTarget.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCreator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCreator.md deleted file mode 100644 index e4fcac425e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCreator.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -jsApi: true -title: "[I] DiagnosticCreator" - ---- -## Type parameters - -| Parameter | -| :------ | -| `T` *extends* \{} | - -## Properties - -| Property | Type | -| :------ | :------ | -| `readonly` `diagnostics` | [`DiagnosticMap`](Type.DiagnosticMap.md)< `T` \> | -| `readonly` `type` | `T` | - -## Methods - -### createDiagnostic - -```ts -createDiagnostic(diag): Diagnostic -``` - -#### Type parameters - -| Parameter | Default | -| :------ | :------ | -| `C` *extends* `string` \| `number` \| `symbol` | - | -| `M` *extends* `string` \| `number` \| `symbol` | `"default"` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diag` | [`DiagnosticReport`](Type.DiagnosticReport.md)< `T`, `C`, `M` \> | - -#### Returns - -[`Diagnostic`](Interface.Diagnostic.md) - -*** - -### reportDiagnostic - -```ts -reportDiagnostic(program, diag): void -``` - -#### Type parameters - -| Parameter | Default | -| :------ | :------ | -| `C` *extends* `string` \| `number` \| `symbol` | - | -| `M` *extends* `string` \| `number` \| `symbol` | `"default"` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `diag` | [`DiagnosticReport`](Type.DiagnosticReport.md)< `T`, `C`, `M` \> | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticDefinition.md deleted file mode 100644 index f99ffd6efa..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticDefinition.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -jsApi: true -title: "[I] DiagnosticDefinition" - ---- -## Type parameters - -| Parameter | -| :------ | -| `M` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | - -## Properties - -| Property | Type | -| :------ | :------ | -| `readonly` `messages` | `M` | -| `readonly` `severity` | `"error"` \| `"warning"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticMessages.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticMessages.md deleted file mode 100644 index bdc460bb33..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticMessages.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[I] DiagnosticMessages" - ---- -## Indexable - - \[`messageId`: `string`\]: `string` \| [`CallableMessage`](Interface.CallableMessage.md)< `string`[] \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveBase.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveBase.md deleted file mode 100644 index e9dce2bd83..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveBase.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[I] DirectiveBase" - ---- -## Extended By - -- [`SuppressDirective`](Interface.SuppressDirective.md) -- [`DeprecatedDirective`](Interface.DeprecatedDirective.md) - -## Properties - -| Property | Type | -| :------ | :------ | -| `node` | [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveExpressionNode.md deleted file mode 100644 index 7345d1de2b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DirectiveExpressionNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DirectiveExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `arguments` | *readonly* [`DirectiveArgument`](Type.DirectiveArgument.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`DirectiveExpression`](Enumeration.SyntaxKind.md#directiveexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Dirent.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Dirent.md deleted file mode 100644 index 1847e66d52..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Dirent.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -jsApi: true -title: "[I] Dirent" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `name` | `string` | - -## Methods - -### isDirectory - -```ts -isDirectory(): boolean -``` - -#### Returns - -`boolean` - -*** - -### isFile - -```ts -isFile(): boolean -``` - -#### Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiscriminatedUnion.md deleted file mode 100644 index 6d567f800e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiscriminatedUnion.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] DiscriminatedUnion" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `propertyName` | `string` | -| `variants` | `Map`< `string`, [`Model`](Interface.Model.md) \> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocNode.md deleted file mode 100644 index f775bd5ea4..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DocNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `content` | *readonly* [`DocTextNode`](Interface.DocTextNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`Doc`](Enumeration.SyntaxKind.md#doc) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `tags` | *readonly* [`DocTag`](Type.DocTag.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocParamTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocParamTagNode.md deleted file mode 100644 index 16c886b801..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocParamTagNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] DocParamTagNode" - ---- -## Extends - -- [`DocTagBaseNode`](Interface.DocTagBaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `content` | *readonly* [`DocTextNode`](Interface.DocTextNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`DocParamTag`](Enumeration.SyntaxKind.md#docparamtag) | - | -| `readonly` `paramName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `tagName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocReturnsTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocReturnsTagNode.md deleted file mode 100644 index 0d35e59ec6..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocReturnsTagNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DocReturnsTagNode" - ---- -## Extends - -- [`DocTagBaseNode`](Interface.DocTagBaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `content` | *readonly* [`DocTextNode`](Interface.DocTextNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`DocReturnsTag`](Enumeration.SyntaxKind.md#docreturnstag) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `tagName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTagBaseNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTagBaseNode.md deleted file mode 100644 index eb4c34712d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTagBaseNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DocTagBaseNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `content` | *readonly* [`DocTextNode`](Interface.DocTextNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`SyntaxKind`](Enumeration.SyntaxKind.md) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `tagName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTemplateTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTemplateTagNode.md deleted file mode 100644 index 47b7d5073e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTemplateTagNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] DocTemplateTagNode" - ---- -## Extends - -- [`DocTagBaseNode`](Interface.DocTagBaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `content` | *readonly* [`DocTextNode`](Interface.DocTextNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`DocTemplateTag`](Enumeration.SyntaxKind.md#doctemplatetag) | - | -| `readonly` `paramName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `tagName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTextNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTextNode.md deleted file mode 100644 index cc77d7f954..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocTextNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] DocTextNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`DocText`](Enumeration.SyntaxKind.md#doctext) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `text` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocUnknownTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocUnknownTagNode.md deleted file mode 100644 index 74bcd2488d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DocUnknownTagNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DocUnknownTagNode" - ---- -## Extends - -- [`DocTagBaseNode`](Interface.DocTagBaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `content` | *readonly* [`DocTextNode`](Interface.DocTextNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`DocUnknownTag`](Enumeration.SyntaxKind.md#docunknowntag) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `tagName` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmitFileOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmitFileOptions.md deleted file mode 100644 index 3c19d0cb53..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmitFileOptions.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] EmitFileOptions" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `content` | `string` | -| `newLine`? | [`NewLine`](Type.NewLine.md) | -| `path` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmptyStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmptyStatementNode.md deleted file mode 100644 index dd327a6393..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmptyStatementNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] EmptyStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`EmptyStatement`](Enumeration.SyntaxKind.md#emptystatement) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Enum.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Enum.md deleted file mode 100644 index 3142d73270..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Enum.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -jsApi: true -title: "[I] Enum" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Enum"` | - | -| `members` | `RekeyableMap`< `string`, [`EnumMember`](Interface.EnumMember.md) \> | The members of the enum.

Members are ordered in the order that they appear in source. Members
obtained via `...` are inserted where the spread appears in source. | -| `name` | `string` | - | -| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | -| `node` | [`EnumStatementNode`](Interface.EnumStatementNode.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMember.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMember.md deleted file mode 100644 index 98265435b6..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMember.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -jsApi: true -title: "[I] EnumMember" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | -| `enum` | [`Enum`](Interface.Enum.md) | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"EnumMember"` | - | -| `name` | `string` | - | -| `node` | [`EnumMemberNode`](Interface.EnumMemberNode.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `sourceMember`? | [`EnumMember`](Interface.EnumMember.md) | when spread operators make new enum members,
this tracks the enum member we copied from. | -| `value`? | `string` \| `number` | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMemberNode.md deleted file mode 100644 index 203b4697a1..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumMemberNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] EnumMemberNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`EnumMember`](Enumeration.SyntaxKind.md#enummember) | - | -| `parent`? | [`EnumStatementNode`](Interface.EnumStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `value`? | [`StringLiteralNode`](Interface.StringLiteralNode.md) \| [`NumericLiteralNode`](Interface.NumericLiteralNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumSpreadMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumSpreadMemberNode.md deleted file mode 100644 index b6dd4a258f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumSpreadMemberNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] EnumSpreadMemberNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`EnumSpreadMember`](Enumeration.SyntaxKind.md#enumspreadmember) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`TypeReferenceNode`](Interface.TypeReferenceNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumStatementNode.md deleted file mode 100644 index ea4a30bdce..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EnumStatementNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] EnumStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`EnumStatement`](Enumeration.SyntaxKind.md#enumstatement) | - | -| `readonly` `members` | *readonly* ([`EnumMemberNode`](Interface.EnumMemberNode.md) \| [`EnumSpreadMemberNode`](Interface.EnumSpreadMemberNode.md))[] | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ErrorType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ErrorType.md deleted file mode 100644 index e73fe85e89..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ErrorType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] ErrorType" - ---- -## Extends - -- [`IntrinsicType`](Interface.IntrinsicType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Intrinsic"` | - | -| `name` | `"ErrorType"` | - | -| `node`? | [`Node`](Type.Node.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`IntrinsicType`](Interface.IntrinsicType.md).[`projections`](Interface.IntrinsicType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`IntrinsicType`](Interface.IntrinsicType.md).[`projectionsByName`](Interface.IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ExternKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ExternKeywordNode.md deleted file mode 100644 index b63a5e24f1..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ExternKeywordNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ExternKeywordNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ExternKeyword`](Enumeration.SyntaxKind.md#externkeyword) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FileLibraryMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FileLibraryMetadata.md deleted file mode 100644 index 9a4e443908..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FileLibraryMetadata.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[I] FileLibraryMetadata" - ---- -## Extends - -- `LibraryMetadataBase` - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `bugs`? | `object` | - | -| `bugs.url`? | `string` | Url where to file bugs for this library. | -| `homepage`? | `string` | Library homepage. | -| `name`? | `string` | Library name as specified in the package.json or in exported $lib. | -| `type` | `"file"` | - | -| `version`? | `string` | Library version | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionDeclarationStatementNode.md deleted file mode 100644 index 9bf566cd98..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionDeclarationStatementNode.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -jsApi: true -title: "[I] FunctionDeclarationStatementNode" - ---- -Represent a function declaration - -## Example - -```typespec -extern fn camelCase(value: StringLiteral): StringLiteral; -``` - -## Extends - -- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`FunctionDeclarationStatement`](Enumeration.SyntaxKind.md#functiondeclarationstatement) | - | -| `readonly` `modifierFlags` | [`ModifierFlags`](Enumeration.ModifierFlags.md) | - | -| `readonly` `modifiers` | *readonly* [`ExternKeywordNode`](Interface.ExternKeywordNode.md)[] | - | -| `readonly` `parameters` | [`FunctionParameterNode`](Interface.FunctionParameterNode.md)[] | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `returnType`? | [`Expression`](Type.Expression.md) | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameter.md deleted file mode 100644 index 8ec9469a5b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameter.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -jsApi: true -title: "[I] FunctionParameter" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"FunctionParameter"` | - | -| `name` | `string` | - | -| `node` | [`FunctionParameterNode`](Interface.FunctionParameterNode.md) | - | -| `optional` | `boolean` | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `rest` | `boolean` | - | -| `type` | [`Type`](Type.Type.md) \| [`ValueType`](Interface.ValueType.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameterNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameterNode.md deleted file mode 100644 index 710499fcf5..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionParameterNode.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[I] FunctionParameterNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`FunctionParameter`](Enumeration.SyntaxKind.md#functionparameter) | - | -| `readonly` `optional` | `boolean` | Parameter defined with `?` | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `rest` | `boolean` | Parameter defined with `...` notation. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `type`? | [`Expression`](Type.Expression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionType.md deleted file mode 100644 index 83d61c0390..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.FunctionType.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -jsApi: true -title: "[I] FunctionType" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `implementation` | (...`args`) => `unknown` | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Function"` | - | -| `name` | `string` | - | -| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | -| `node`? | [`FunctionDeclarationStatementNode`](Interface.FunctionDeclarationStatementNode.md) | - | -| `parameters` | [`FunctionParameter`](Interface.FunctionParameter.md)[] | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `returnType` | [`Type`](Type.Type.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierContext.md deleted file mode 100644 index db5daaff30..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierContext.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] IdentifierContext" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `kind` | [`IdentifierKind`](Enumeration.IdentifierKind.md) | -| `node` | [`Node`](Type.Node.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierNode.md deleted file mode 100644 index bbd0f1f78b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IdentifierNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] IdentifierNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`Identifier`](Enumeration.SyntaxKind.md#identifier) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `sv` | `string` | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ImportStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ImportStatementNode.md deleted file mode 100644 index fa14f72a12..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ImportStatementNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ImportStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ImportStatement`](Enumeration.SyntaxKind.md#importstatement) | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | - | -| `readonly` `path` | [`StringLiteralNode`](Interface.StringLiteralNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Interface.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Interface.md deleted file mode 100644 index 322a0bfec3..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Interface.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -jsApi: true -title: "[I] Interface" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md).[`TemplatedTypeBase`](Interface.TemplatedTypeBase.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Interface"` | - | -| `name` | `string` | - | -| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | -| `node` | [`InterfaceStatementNode`](Interface.InterfaceStatementNode.md) | - | -| `operations` | `RekeyableMap`< `string`, [`Operation`](Interface.Operation.md) \> | The operations of the interface.

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

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

use templateMapper instead. | -| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | -| `templateNode`? | [`Node`](Type.Node.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InterfaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InterfaceStatementNode.md deleted file mode 100644 index eb3baf3e12..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InterfaceStatementNode.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[I] InterfaceStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md).[`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `extends` | *readonly* [`TypeReferenceNode`](Interface.TypeReferenceNode.md)[] | - | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`InterfaceStatement`](Enumeration.SyntaxKind.md#interfacestatement) | - | -| `locals`? | `SymbolTable` | - | -| `readonly` `operations` | *readonly* [`OperationStatementNode`](Interface.OperationStatementNode.md)[] | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntersectionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntersectionExpressionNode.md deleted file mode 100644 index 5f0a882d9a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntersectionExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] IntersectionExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`IntersectionExpression`](Enumeration.SyntaxKind.md#intersectionexpression) | - | -| `readonly` `options` | *readonly* [`Expression`](Type.Expression.md)[] | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntrinsicType.md deleted file mode 100644 index 077d1fa82b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.IntrinsicType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] IntrinsicType" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Intrinsic"` | - | -| `name` | `"unknown"` \| `"never"` \| `"null"` \| `"void"` \| `"ErrorType"` | - | -| `node`? | [`Node`](Type.Node.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InvalidStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InvalidStatementNode.md deleted file mode 100644 index 0f60cd491f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.InvalidStatementNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] InvalidStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`InvalidStatement`](Enumeration.SyntaxKind.md#invalidstatement) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsNamespaceDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsNamespaceDeclarationNode.md deleted file mode 100644 index 74b0c91bee..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsNamespaceDeclarationNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] JsNamespaceDeclarationNode" - ---- -## Extends - -- [`DeclarationNode`](Interface.DeclarationNode.md).[`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`JsNamespaceDeclaration`](Enumeration.SyntaxKind.md#jsnamespacedeclaration) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsSourceFileNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsSourceFileNode.md deleted file mode 100644 index 60cf614fc9..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JsSourceFileNode.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[I] JsSourceFileNode" - ---- -## Extends - -- [`DeclarationNode`](Interface.DeclarationNode.md).[`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `esmExports` | `any` | - | -| `readonly` `file` | [`SourceFile`](Interface.SourceFile.md) | - | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`JsSourceFile`](Enumeration.SyntaxKind.md#jssourcefile) | - | -| `readonly` `namespaceSymbols` | [`Sym`](Interface.Sym.md)[] | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryInstance.md deleted file mode 100644 index f773d3610b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryInstance.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] LibraryInstance" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `definition`? | [`TypeSpecLibrary`](Interface.TypeSpecLibrary.md)< `any`, `Record`< `string`, `never` \> \> | -| `entrypoint` | `undefined` \| [`JsSourceFileNode`](Interface.JsSourceFileNode.md) | -| `metadata` | [`LibraryMetadata`](Type.LibraryMetadata.md) | -| `module` | [`ModuleResolutionResult`](Type.ModuleResolutionResult.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryLocationContext.md deleted file mode 100644 index 0d048fe4b4..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LibraryLocationContext.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] LibraryLocationContext" - ---- -Defined in a library. - -## Properties - -| Property | Type | -| :------ | :------ | -| `metadata` | [`ModuleLibraryMetadata`](Interface.ModuleLibraryMetadata.md) | -| `type` | `"library"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LineComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LineComment.md deleted file mode 100644 index 71ec42ac29..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LineComment.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] LineComment" - ---- -## Extends - -- [`TextRange`](Interface.TextRange.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `kind` | [`LineComment`](Enumeration.SyntaxKind.md#linecomment) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterDefinition.md deleted file mode 100644 index fc648fb4f6..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterDefinition.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] LinterDefinition" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `ruleSets`? | `Record`< `string`, [`LinterRuleSet`](Interface.LinterRuleSet.md) \> | -| `rules` | [`LinterRuleDefinition`](Interface.LinterRuleDefinition.md)< `string`, [`DiagnosticMessages`](Interface.DiagnosticMessages.md) \>[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRule.md deleted file mode 100644 index c9a2a18548..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRule.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -jsApi: true -title: "[I] LinterRule" - ---- -Resolved instance of a linter rule that will run. - -## Extends - -- [`LinterRuleDefinition`](Interface.LinterRuleDefinition.md)< `N`, `DM` \> - -## Type parameters - -| Parameter | -| :------ | -| `N` *extends* `string` | -| `DM` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `description` | `string` | - | -| `id` | `string` | Expanded rule id in format `:` | -| `messages` | `DM` | - | -| `name` | `N` | - | -| `severity` | `"warning"` | - | - -## Methods - -### create - -```ts -create(context): SemanticNodeListener -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`LinterRuleContext`](Interface.LinterRuleContext.md)< `DM` \> | - -#### Returns - -[`SemanticNodeListener`](Type.SemanticNodeListener.md) - -#### Inherited from - -[`LinterRuleDefinition`](Interface.LinterRuleDefinition.md).[`create`](Interface.LinterRuleDefinition.md#create) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleContext.md deleted file mode 100644 index b3eb8cbf3c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleContext.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -jsApi: true -title: "[I] LinterRuleContext" - ---- -## Type parameters - -| Parameter | -| :------ | -| `DM` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | - -## Properties - -| Property | Type | -| :------ | :------ | -| `readonly` `program` | [`Program`](Interface.Program.md) | - -## Methods - -### reportDiagnostic - -```ts -reportDiagnostic(diag): void -``` - -#### Type parameters - -| Parameter | -| :------ | -| `M` *extends* `string` \| `number` \| `symbol` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diag` | [`LinterRuleDiagnosticReport`](Type.LinterRuleDiagnosticReport.md)< `DM`, `M` \> | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleDefinition.md deleted file mode 100644 index 2fa4aa78db..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleDefinition.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -jsApi: true -title: "[I] LinterRuleDefinition" - ---- -## Extended By - -- [`LinterRule`](Interface.LinterRule.md) - -## Type parameters - -| Parameter | -| :------ | -| `N` *extends* `string` | -| `DM` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | - -## Properties - -| Property | Type | -| :------ | :------ | -| `description` | `string` | -| `messages` | `DM` | -| `name` | `N` | -| `severity` | `"warning"` | - -## Methods - -### create - -```ts -create(context): SemanticNodeListener -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`LinterRuleContext`](Interface.LinterRuleContext.md)< `DM` \> | - -#### Returns - -[`SemanticNodeListener`](Type.SemanticNodeListener.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleSet.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleSet.md deleted file mode 100644 index 91bd0e0cc4..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LinterRuleSet.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] LinterRuleSet" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `disable`? | `Record`< \`$\{string}/$\{string}\`, `string` \> | Rules to disable. A rule CANNOT be in enable and disable map. | -| `enable`? | `Record`< \`$\{string}/$\{string}\`, `boolean` \> | Rules to enable/configure | -| `extends`? | \`$\{string}/$\{string}\`[] | Other ruleset this ruleset extends | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LogInfo.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LogInfo.md deleted file mode 100644 index 09cff0ca36..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LogInfo.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] LogInfo" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `code`? | `string` | -| `level` | [`LogLevel`](Type.LogLevel.md) | -| `message` | `string` | -| `target`? | [`DiagnosticTarget`](Type.DiagnosticTarget.md) \| *typeof* [`NoTarget`](Variable.NoTarget.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.MemberExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.MemberExpressionNode.md deleted file mode 100644 index e1abe7a5da..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.MemberExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] MemberExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `base` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`MemberExpression`](Enumeration.SyntaxKind.md#memberexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `selector` | `"."` \| `"::"` | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Model.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Model.md deleted file mode 100644 index 595d5d5f41..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Model.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -jsApi: true -title: "[I] Model" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md).[`TemplatedTypeBase`](Interface.TemplatedTypeBase.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `baseModel`? | [`Model`](Interface.Model.md) | Model this model extends. This represent inheritance. | -| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | -| `derivedModels` | [`Model`](Interface.Model.md)[] | Direct children. This is the reverse relation of [baseModel](Interface.ArrayModelType.md#basemodel) | -| `indexer`? | [`ModelIndexer`](Type.ModelIndexer.md) | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Model"` | - | -| `name` | `string` | - | -| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | -| `node`? | [`ModelStatementNode`](Interface.ModelStatementNode.md) \| [`ModelExpressionNode`](Interface.ModelExpressionNode.md) \| [`IntersectionExpressionNode`](Interface.IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](Interface.ProjectionModelExpressionNode.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `properties` | `RekeyableMap`< `string`, [`ModelProperty`](Interface.ModelProperty.md) \> | The properties of the model.

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

Properties inherited via `model extends` are not included. Use
[walkPropertiesInherited](Function.walkPropertiesInherited.md) to enumerate all properties in the
inheritance hierarchy. | -| `sourceModel`? | [`Model`](Interface.Model.md) | The model that is referenced via `model is`. | -| `symbol`? | [`Sym`](Interface.Sym.md) | Late-bound symbol of this model type. | -| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

use templateMapper instead. | -| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | -| `templateNode`? | [`Node`](Type.Node.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelExpressionNode.md deleted file mode 100644 index c75f2cd5fa..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ModelExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ModelExpression`](Enumeration.SyntaxKind.md#modelexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `properties` | ([`ModelPropertyNode`](Interface.ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](Interface.ModelSpreadPropertyNode.md))[] | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelProperty.md deleted file mode 100644 index 55b2fe0190..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelProperty.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -jsApi: true -title: "[I] ModelProperty" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | -| `default`? | [`Type`](Type.Type.md) | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"ModelProperty"` | - | -| `model`? | [`Model`](Interface.Model.md) | - | -| `name` | `string` | - | -| `node` | [`ModelPropertyNode`](Interface.ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](Interface.ModelSpreadPropertyNode.md) \| [`ProjectionModelPropertyNode`](Interface.ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](Interface.ProjectionModelSpreadPropertyNode.md) | - | -| `optional` | `boolean` | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `sourceProperty`? | [`ModelProperty`](Interface.ModelProperty.md) | - | -| `type` | [`Type`](Type.Type.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelPropertyNode.md deleted file mode 100644 index 333f90e367..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelPropertyNode.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[I] ModelPropertyNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | -| `default`? | [`Expression`](Type.Expression.md) | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`ModelProperty`](Enumeration.SyntaxKind.md#modelproperty) | - | -| `readonly` `optional` | `boolean` | - | -| `parent`? | [`ModelStatementNode`](Interface.ModelStatementNode.md) \| [`ModelExpressionNode`](Interface.ModelExpressionNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `value` | [`Expression`](Type.Expression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelSpreadPropertyNode.md deleted file mode 100644 index 3a2ecf2072..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelSpreadPropertyNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ModelSpreadPropertyNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ModelSpreadProperty`](Enumeration.SyntaxKind.md#modelspreadproperty) | - | -| `parent`? | [`ModelStatementNode`](Interface.ModelStatementNode.md) \| [`ModelExpressionNode`](Interface.ModelExpressionNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`TypeReferenceNode`](Interface.TypeReferenceNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelStatementNode.md deleted file mode 100644 index 66baba1706..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModelStatementNode.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -jsApi: true -title: "[I] ModelStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md).[`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `extends`? | [`Expression`](Type.Expression.md) | - | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `is`? | [`Expression`](Type.Expression.md) | - | -| `readonly` `kind` | [`ModelStatement`](Enumeration.SyntaxKind.md#modelstatement) | - | -| `locals`? | `SymbolTable` | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `properties` | *readonly* ([`ModelPropertyNode`](Interface.ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](Interface.ModelSpreadPropertyNode.md))[] | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModuleLibraryMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModuleLibraryMetadata.md deleted file mode 100644 index beb67925f2..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ModuleLibraryMetadata.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ModuleLibraryMetadata" - ---- -Data for a library. Either loaded via a node_modules package or a standalone js file - -## Extends - -- `LibraryMetadataBase` - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `bugs`? | `object` | - | -| `bugs.url`? | `string` | Url where to file bugs for this library. | -| `homepage`? | `string` | Library homepage. | -| `name` | `string` | Library name as specified in the package.json or in exported $lib. | -| `type` | `"module"` | - | -| `version`? | `string` | Library version | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Namespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Namespace.md deleted file mode 100644 index e2c2845c2a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Namespace.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -jsApi: true -title: "[I] Namespace" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `decoratorDeclarations` | `Map`< `string`, [`Decorator`](Interface.Decorator.md) \> | The decorators declared in the namespace.

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

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

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

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

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

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

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

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

Order is implementation-defined and may change. | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NamespaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NamespaceStatementNode.md deleted file mode 100644 index 330ea87038..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NamespaceStatementNode.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[I] NamespaceStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`NamespaceStatement`](Enumeration.SyntaxKind.md#namespacestatement) | - | -| `locals`? | `SymbolTable` | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `statements`? | [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) \| *readonly* [`Statement`](Type.Statement.md)[] | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverKeywordNode.md deleted file mode 100644 index ef43549abe..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverKeywordNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] NeverKeywordNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`NeverKeyword`](Enumeration.SyntaxKind.md#neverkeyword) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverType.md deleted file mode 100644 index 133dd29064..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NeverType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] NeverType" - ---- -## Extends - -- [`IntrinsicType`](Interface.IntrinsicType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Intrinsic"` | - | -| `name` | `"never"` | - | -| `node`? | [`Node`](Type.Node.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`IntrinsicType`](Interface.IntrinsicType.md).[`projections`](Interface.IntrinsicType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`IntrinsicType`](Interface.IntrinsicType.md).[`projectionsByName`](Interface.IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NodePackage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NodePackage.md deleted file mode 100644 index 5cf75f5909..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NodePackage.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[I] NodePackage" - ---- -Type for package.json https://docs.npmjs.com/cli/v8/configuring-npm/package-json - -## Properties - -| Property | Type | -| :------ | :------ | -| `bugs`? | `object` | -| `bugs.email`? | `string` | -| `bugs.url`? | `string` | -| `dependencies`? | `Record`< `string`, `string` \> | -| `description`? | `string` | -| `devDependencies`? | `Record`< `string`, `string` \> | -| `homepage`? | `string` | -| `main`? | `string` | -| `name` | `string` | -| `peerDependencies`? | `Record`< `string`, `string` \> | -| `private`? | `boolean` | -| `tspMain`? | `string` | -| `type`? | `"module"` \| `"commonjs"` | -| `version` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NullType.md deleted file mode 100644 index c3f85a362f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NullType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] NullType" - ---- -## Extends - -- [`IntrinsicType`](Interface.IntrinsicType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Intrinsic"` | - | -| `name` | `"null"` | - | -| `node`? | [`Node`](Type.Node.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`IntrinsicType`](Interface.IntrinsicType.md).[`projections`](Interface.IntrinsicType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`IntrinsicType`](Interface.IntrinsicType.md).[`projectionsByName`](Interface.IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteral.md deleted file mode 100644 index 0b088a741d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteral.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -jsApi: true -title: "[I] NumericLiteral" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Number"` | - | -| `node`? | [`NumericLiteralNode`](Interface.NumericLiteralNode.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `value` | `number` | - | -| `valueAsString` | `string` | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteralNode.md deleted file mode 100644 index c450ebefc9..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.NumericLiteralNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] NumericLiteralNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`NumericLiteral`](Enumeration.SyntaxKind.md#numericliteral) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `value` | `number` | - | -| `readonly` `valueAsString` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ObjectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ObjectType.md deleted file mode 100644 index 94b97f9bf4..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ObjectType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] ObjectType" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Object"` | - | -| `node`? | [`Node`](Type.Node.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `properties` | `Record`< `string`, [`Type`](Type.Type.md) \> | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Operation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Operation.md deleted file mode 100644 index 25de67834d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Operation.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -jsApi: true -title: "[I] Operation" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md).[`TemplatedTypeBase`](Interface.TemplatedTypeBase.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `interface`? | [`Interface`](Interface.Interface.md) | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Operation"` | - | -| `name` | `string` | - | -| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | -| `node` | [`OperationStatementNode`](Interface.OperationStatementNode.md) | - | -| `parameters` | [`Model`](Interface.Model.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `returnType` | [`Type`](Type.Type.md) | - | -| `sourceOperation`? | [`Operation`](Interface.Operation.md) | The operation that is referenced via `op is`. | -| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

use templateMapper instead. | -| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | -| `templateNode`? | [`Node`](Type.Node.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureDeclarationNode.md deleted file mode 100644 index 398bd7d338..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureDeclarationNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] OperationSignatureDeclarationNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`OperationSignatureDeclaration`](Enumeration.SyntaxKind.md#operationsignaturedeclaration) | - | -| `readonly` `parameters` | [`ModelExpressionNode`](Interface.ModelExpressionNode.md) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `returnType` | [`Expression`](Type.Expression.md) | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureReferenceNode.md deleted file mode 100644 index 5ce92957b0..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationSignatureReferenceNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] OperationSignatureReferenceNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `baseOperation` | [`TypeReferenceNode`](Interface.TypeReferenceNode.md) | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`OperationSignatureReference`](Enumeration.SyntaxKind.md#operationsignaturereference) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationStatementNode.md deleted file mode 100644 index 6ff3d7a432..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.OperationStatementNode.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[I] OperationStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md).[`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`OperationStatement`](Enumeration.SyntaxKind.md#operationstatement) | - | -| `locals`? | `SymbolTable` | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) \| [`InterfaceStatementNode`](Interface.InterfaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `signature` | [`OperationSignature`](Type.OperationSignature.md) | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ParseOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ParseOptions.md deleted file mode 100644 index b25dce3bc1..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ParseOptions.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] ParseOptions" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `comments`? | `boolean` | When true, collect comment ranges in [comments](Interface.TypeSpecScriptNode.md#comments). | -| `docs`? | `boolean` | When true, parse doc comments into [docs](Interface.BaseNode.md#docs). | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProcessedLog.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProcessedLog.md deleted file mode 100644 index c150128564..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProcessedLog.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] ProcessedLog" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `code`? | `string` | -| `level` | [`LogLevel`](Type.LogLevel.md) | -| `message` | `string` | -| `sourceLocation`? | [`SourceLocation`](Interface.SourceLocation.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Program.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Program.md deleted file mode 100644 index 1706154881..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Program.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -jsApi: true -title: "[I] Program" - ---- -## Extended By - -- [`ProjectedProgram`](Interface.ProjectedProgram.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `checker` | [`Checker`](Interface.Checker.md) | - | -| `compilerOptions` | [`CompilerOptions`](Interface.CompilerOptions.md) | - | -| `readonly` `diagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | - | -| `emitters` | `EmitterRef`[] | - | -| `host` | [`CompilerHost`](Interface.CompilerHost.md) | - | -| `jsSourceFiles` | `Map`< `string`, [`JsSourceFileNode`](Interface.JsSourceFileNode.md) \> | - | -| `literalTypes` | `Map`< `string` \| `number` \| `boolean`, [`LiteralType`](Type.LiteralType.md) \> | - | -| `mainFile`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | - | -| `readonly` `projectRoot` | `string` | Project root. If a tsconfig was found/specified this is the directory for the tsconfig.json. Otherwise directory where the entrypoint is located. | -| `sourceFiles` | `Map`< `string`, [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \> | All source files in the program, keyed by their file path. | -| `stateMaps` | `Map`< `symbol`, `StateMap` \> | - | -| `stateSets` | `Map`< `symbol`, `StateSet` \> | - | -| `tracer` | [`Tracer`](Interface.Tracer.md) | - | - -## Methods - -### getGlobalNamespaceType - -```ts -getGlobalNamespaceType(): Namespace -``` - -#### Returns - -[`Namespace`](Interface.Namespace.md) - -*** - -### getOption - -```ts -getOption(key): undefined | string -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`undefined` \| `string` - -*** - -### getSourceFileLocationContext - -```ts -getSourceFileLocationContext(sourceFile): LocationContext -``` - -Return location context of the given source file. - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `sourceFile` | [`SourceFile`](Interface.SourceFile.md) | - -#### Returns - -[`LocationContext`](Type.LocationContext.md) - -*** - -### hasError - -```ts -hasError(): boolean -``` - -#### Returns - -`boolean` - -*** - -### loadTypeSpecScript - -```ts -loadTypeSpecScript(typespecScript): Promise< TypeSpecScriptNode > -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `typespecScript` | [`SourceFile`](Interface.SourceFile.md) | - -#### Returns - -`Promise`< [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \> - -*** - -### onValidate - -```ts -onValidate(cb, LibraryMetadata): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `cb` | (`program`) => `void` \| `Promise`< `void` \> | -| `LibraryMetadata` | [`LibraryMetadata`](Type.LibraryMetadata.md) | - -#### Returns - -`void` - -*** - -### reportDiagnostic - -```ts -reportDiagnostic(diagnostic): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diagnostic` | [`Diagnostic`](Interface.Diagnostic.md) | - -#### Returns - -`void` - -*** - -### reportDiagnostics - -```ts -reportDiagnostics(diagnostics): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | - -#### Returns - -`void` - -*** - -### reportDuplicateSymbols - -```ts -reportDuplicateSymbols(symbols): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `symbols` | `undefined` \| `SymbolTable` | - -#### Returns - -`void` - -*** - -### resolveTypeReference - -```ts -resolveTypeReference(reference): [undefined | Type, readonly Diagnostic[]] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `reference` | `string` | - -#### Returns - -[`undefined` \| [`Type`](Type.Type.md), *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] - -*** - -### stateMap - -```ts -stateMap(key): Map< Type, any > -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `key` | `symbol` | - -#### Returns - -`Map`< [`Type`](Type.Type.md), `any` \> - -*** - -### stateSet - -```ts -stateSet(key): Set< Type > -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `key` | `symbol` | - -#### Returns - -`Set`< [`Type`](Type.Type.md) \> - -*** - -### trace - -```ts -trace(area, message): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `area` | `string` | -| `message` | `string` | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedProgram.md deleted file mode 100644 index 0a46f6c988..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedProgram.md +++ /dev/null @@ -1,305 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectedProgram" - ---- -## Extends - -- [`Program`](Interface.Program.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `checker` | [`Checker`](Interface.Checker.md) | - | -| `compilerOptions` | [`CompilerOptions`](Interface.CompilerOptions.md) | - | -| `readonly` `diagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | - | -| `emitters` | `EmitterRef`[] | - | -| `host` | [`CompilerHost`](Interface.CompilerHost.md) | - | -| `jsSourceFiles` | `Map`< `string`, [`JsSourceFileNode`](Interface.JsSourceFileNode.md) \> | - | -| `literalTypes` | `Map`< `string` \| `number` \| `boolean`, [`LiteralType`](Type.LiteralType.md) \> | - | -| `mainFile`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | - | -| `readonly` `projectRoot` | `string` | Project root. If a tsconfig was found/specified this is the directory for the tsconfig.json. Otherwise directory where the entrypoint is located. | -| `projector` | [`Projector`](Interface.Projector.md) | - | -| `sourceFiles` | `Map`< `string`, [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \> | All source files in the program, keyed by their file path. | -| `stateMaps` | `Map`< `symbol`, `StateMap` \> | - | -| `stateSets` | `Map`< `symbol`, `StateSet` \> | - | -| `tracer` | [`Tracer`](Interface.Tracer.md) | - | - -## Methods - -### getGlobalNamespaceType - -```ts -getGlobalNamespaceType(): Namespace -``` - -#### Returns - -[`Namespace`](Interface.Namespace.md) - -#### Inherited from - -[`Program`](Interface.Program.md).[`getGlobalNamespaceType`](Interface.Program.md#getglobalnamespacetype) - -*** - -### getOption - -```ts -getOption(key): undefined | string -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Inherited from - -[`Program`](Interface.Program.md).[`getOption`](Interface.Program.md#getoption) - -*** - -### getSourceFileLocationContext - -```ts -getSourceFileLocationContext(sourceFile): LocationContext -``` - -Return location context of the given source file. - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `sourceFile` | [`SourceFile`](Interface.SourceFile.md) | - -#### Returns - -[`LocationContext`](Type.LocationContext.md) - -#### Inherited from - -[`Program`](Interface.Program.md).[`getSourceFileLocationContext`](Interface.Program.md#getsourcefilelocationcontext) - -*** - -### hasError - -```ts -hasError(): boolean -``` - -#### Returns - -`boolean` - -#### Inherited from - -[`Program`](Interface.Program.md).[`hasError`](Interface.Program.md#haserror) - -*** - -### loadTypeSpecScript - -```ts -loadTypeSpecScript(typespecScript): Promise< TypeSpecScriptNode > -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `typespecScript` | [`SourceFile`](Interface.SourceFile.md) | - -#### Returns - -`Promise`< [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \> - -#### Inherited from - -[`Program`](Interface.Program.md).[`loadTypeSpecScript`](Interface.Program.md#loadtypespecscript) - -*** - -### onValidate - -```ts -onValidate(cb, LibraryMetadata): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `cb` | (`program`) => `void` \| `Promise`< `void` \> | -| `LibraryMetadata` | [`LibraryMetadata`](Type.LibraryMetadata.md) | - -#### Returns - -`void` - -#### Inherited from - -[`Program`](Interface.Program.md).[`onValidate`](Interface.Program.md#onvalidate) - -*** - -### reportDiagnostic - -```ts -reportDiagnostic(diagnostic): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diagnostic` | [`Diagnostic`](Interface.Diagnostic.md) | - -#### Returns - -`void` - -#### Inherited from - -[`Program`](Interface.Program.md).[`reportDiagnostic`](Interface.Program.md#reportdiagnostic) - -*** - -### reportDiagnostics - -```ts -reportDiagnostics(diagnostics): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | - -#### Returns - -`void` - -#### Inherited from - -[`Program`](Interface.Program.md).[`reportDiagnostics`](Interface.Program.md#reportdiagnostics) - -*** - -### reportDuplicateSymbols - -```ts -reportDuplicateSymbols(symbols): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `symbols` | `undefined` \| `SymbolTable` | - -#### Returns - -`void` - -#### Inherited from - -[`Program`](Interface.Program.md).[`reportDuplicateSymbols`](Interface.Program.md#reportduplicatesymbols) - -*** - -### resolveTypeReference - -```ts -resolveTypeReference(reference): [undefined | Type, readonly Diagnostic[]] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `reference` | `string` | - -#### Returns - -[`undefined` \| [`Type`](Type.Type.md), *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] - -#### Inherited from - -[`Program`](Interface.Program.md).[`resolveTypeReference`](Interface.Program.md#resolvetypereference) - -*** - -### stateMap - -```ts -stateMap(key): Map< Type, any > -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `key` | `symbol` | - -#### Returns - -`Map`< [`Type`](Type.Type.md), `any` \> - -#### Inherited from - -[`Program`](Interface.Program.md).[`stateMap`](Interface.Program.md#statemap) - -*** - -### stateSet - -```ts -stateSet(key): Set< Type > -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `key` | `symbol` | - -#### Returns - -`Set`< [`Type`](Type.Type.md) \> - -#### Inherited from - -[`Program`](Interface.Program.md).[`stateSet`](Interface.Program.md#stateset) - -*** - -### trace - -```ts -trace(area, message): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `area` | `string` | -| `message` | `string` | - -#### Returns - -`void` - -#### Inherited from - -[`Program`](Interface.Program.md).[`trace`](Interface.Program.md#trace) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projection.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projection.md deleted file mode 100644 index a5d0712386..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projection.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -jsApi: true -title: "[I] Projection" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Projection"` | - | -| `node` | `undefined` | - | -| `nodeByKind` | `Map`< `string`, [`ProjectionStatementNode`](Interface.ProjectionStatementNode.md) \> | - | -| `nodeByType` | `Map`< [`Type`](Type.Type.md), [`ProjectionStatementNode`](Interface.ProjectionStatementNode.md) \> | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionApplication.md deleted file mode 100644 index 903c79966f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionApplication.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionApplication" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `arguments` | [`DecoratorArgumentValue`](Type.DecoratorArgumentValue.md)[] | -| `direction`? | `"to"` \| `"from"` | -| `projectionName` | `string` | -| `scope`? | [`Type`](Type.Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionArithmeticExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionArithmeticExpressionNode.md deleted file mode 100644 index 18ea6df36c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionArithmeticExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionArithmeticExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionArithmeticExpression`](Enumeration.SyntaxKind.md#projectionarithmeticexpression) | - | -| `readonly` `left` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | -| `readonly` `op` | `"+"` \| `"-"` \| `"*"` \| `"/"` | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `right` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionBlockExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionBlockExpressionNode.md deleted file mode 100644 index a7197a56a9..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionBlockExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionBlockExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionBlockExpression`](Enumeration.SyntaxKind.md#projectionblockexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `statements` | [`ProjectionExpressionStatementNode`](Interface.ProjectionExpressionStatementNode.md)[] | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionCallExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionCallExpressionNode.md deleted file mode 100644 index 115515b5f3..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionCallExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionCallExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `arguments` | [`ProjectionExpression`](Type.ProjectionExpression.md)[] | - | -| `readonly` `callKind` | `"method"` \| `"template"` | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionCallExpression`](Enumeration.SyntaxKind.md#projectioncallexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionDecoratorReferenceExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionDecoratorReferenceExpressionNode.md deleted file mode 100644 index b0ca698c5a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionDecoratorReferenceExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionDecoratorReferenceExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionDecoratorReferenceExpression`](Enumeration.SyntaxKind.md#projectiondecoratorreferenceexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumMemberSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumMemberSelectorNode.md deleted file mode 100644 index b39b395298..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumMemberSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionEnumMemberSelectorNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionEnumMemberSelector`](Enumeration.SyntaxKind.md#projectionenummemberselector) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumSelectorNode.md deleted file mode 100644 index 96b6aa1453..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEnumSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionEnumSelectorNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionEnumSelector`](Enumeration.SyntaxKind.md#projectionenumselector) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEqualityExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEqualityExpressionNode.md deleted file mode 100644 index ca849a2a0a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionEqualityExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionEqualityExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionEqualityExpression`](Enumeration.SyntaxKind.md#projectionequalityexpression) | - | -| `readonly` `left` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | -| `readonly` `op` | `"=="` \| `"!="` | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `right` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionExpressionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionExpressionStatementNode.md deleted file mode 100644 index 8411221e52..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionExpressionStatementNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionExpressionStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `expr` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionExpressionStatement`](Enumeration.SyntaxKind.md#projectionexpressionstatement) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionIfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionIfExpressionNode.md deleted file mode 100644 index 3d3ab686f6..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionIfExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionIfExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `alternate`? | [`ProjectionIfExpressionNode`](Interface.ProjectionIfExpressionNode.md) \| [`ProjectionBlockExpressionNode`](Interface.ProjectionBlockExpressionNode.md) | - | -| `readonly` `consequent` | [`ProjectionBlockExpressionNode`](Interface.ProjectionBlockExpressionNode.md) | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionIfExpression`](Enumeration.SyntaxKind.md#projectionifexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `test` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionInterfaceSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionInterfaceSelectorNode.md deleted file mode 100644 index fd10db3868..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionInterfaceSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionInterfaceSelectorNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionInterfaceSelector`](Enumeration.SyntaxKind.md#projectioninterfaceselector) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLambdaExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLambdaExpressionNode.md deleted file mode 100644 index f14e519137..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLambdaExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionLambdaExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `body` | [`ProjectionBlockExpressionNode`](Interface.ProjectionBlockExpressionNode.md) | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionLambdaExpression`](Enumeration.SyntaxKind.md#projectionlambdaexpression) | - | -| `locals`? | `SymbolTable` | - | -| `readonly` `parameters` | *readonly* [`ProjectionLambdaParameterDeclarationNode`](Interface.ProjectionLambdaParameterDeclarationNode.md)[] | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLambdaParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLambdaParameterDeclarationNode.md deleted file mode 100644 index 2a14d424d4..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLambdaParameterDeclarationNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionLambdaParameterDeclarationNode" - ---- -## Extends - -- [`DeclarationNode`](Interface.DeclarationNode.md).[`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`ProjectionLambdaParameterDeclaration`](Enumeration.SyntaxKind.md#projectionlambdaparameterdeclaration) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLogicalExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLogicalExpressionNode.md deleted file mode 100644 index 7fa453116c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionLogicalExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionLogicalExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionLogicalExpression`](Enumeration.SyntaxKind.md#projectionlogicalexpression) | - | -| `readonly` `left` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | -| `readonly` `op` | "\|\|" \| `"&&"` | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `right` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionMemberExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionMemberExpressionNode.md deleted file mode 100644 index 7fd144f5e0..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionMemberExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionMemberExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `base` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`ProjectionMemberExpression`](Enumeration.SyntaxKind.md#projectionmemberexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `selector` | `"."` \| `"::"` | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelExpressionNode.md deleted file mode 100644 index 0ce855ad02..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionModelExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionModelExpression`](Enumeration.SyntaxKind.md#projectionmodelexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `properties` | ([`ProjectionModelPropertyNode`](Interface.ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](Interface.ProjectionModelSpreadPropertyNode.md))[] | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertyNode.md deleted file mode 100644 index 36d349386f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertyNode.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionModelPropertyNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | -| `default`? | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`ProjectionModelProperty`](Enumeration.SyntaxKind.md#projectionmodelproperty) | - | -| `readonly` `optional` | `boolean` | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `value` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertySelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertySelectorNode.md deleted file mode 100644 index 824360a1e4..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelPropertySelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionModelPropertySelectorNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionModelPropertySelector`](Enumeration.SyntaxKind.md#projectionmodelpropertyselector) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelSelectorNode.md deleted file mode 100644 index 6a3d4d8e85..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionModelSelectorNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionModelSelector`](Enumeration.SyntaxKind.md#projectionmodelselector) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelSpreadPropertyNode.md deleted file mode 100644 index 777a085596..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionModelSpreadPropertyNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionModelSpreadPropertyNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionModelSpreadProperty`](Enumeration.SyntaxKind.md#projectionmodelspreadproperty) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionNode.md deleted file mode 100644 index de8291a6ea..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionNode.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `body` | *readonly* [`ProjectionExpressionStatementNode`](Interface.ProjectionExpressionStatementNode.md)[] | - | -| `readonly` `direction` | `"to"` \| `"from"` \| `"pre_to"` \| `"pre_from"` \| `""` | - | -| `readonly` `directionId` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`Projection`](Enumeration.SyntaxKind.md#projection) | - | -| `locals`? | `SymbolTable` | - | -| `readonly` `modifierIds` | *readonly* [`IdentifierNode`](Interface.IdentifierNode.md)[] | - | -| `readonly` `parameters` | [`ProjectionParameterDeclarationNode`](Interface.ProjectionParameterDeclarationNode.md)[] | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionOperationSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionOperationSelectorNode.md deleted file mode 100644 index 7fc8178bfc..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionOperationSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionOperationSelectorNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionOperationSelector`](Enumeration.SyntaxKind.md#projectionoperationselector) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionParameterDeclarationNode.md deleted file mode 100644 index 0fcfd1a397..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionParameterDeclarationNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionParameterDeclarationNode" - ---- -## Extends - -- [`DeclarationNode`](Interface.DeclarationNode.md).[`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`ProjectionParameterDeclaration`](Enumeration.SyntaxKind.md#projectionparameterdeclaration) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionReferenceNode.md deleted file mode 100644 index 2b5b5d34a5..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionReferenceNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionReferenceNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `arguments` | *readonly* [`Expression`](Type.Expression.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionReference`](Enumeration.SyntaxKind.md#projectionreference) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionRelationalExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionRelationalExpressionNode.md deleted file mode 100644 index 90cb2e503f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionRelationalExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionRelationalExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionRelationalExpression`](Enumeration.SyntaxKind.md#projectionrelationalexpression) | - | -| `readonly` `left` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | -| `readonly` `op` | `"<="` \| `">="` \| `"<"` \| `">"` | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `right` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionStatementNode.md deleted file mode 100644 index ecd01e3fd9..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionStatementNode.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `from`? | [`ProjectionNode`](Interface.ProjectionNode.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`ProjectionStatement`](Enumeration.SyntaxKind.md#projectionstatement) | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `preFrom`? | [`ProjectionNode`](Interface.ProjectionNode.md) | - | -| `preTo`? | [`ProjectionNode`](Interface.ProjectionNode.md) | - | -| `readonly` `projections` | *readonly* [`ProjectionNode`](Interface.ProjectionNode.md)[] | - | -| `readonly` `selector` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) \| [`ProjectionModelSelectorNode`](Interface.ProjectionModelSelectorNode.md) \| [`ProjectionModelPropertySelectorNode`](Interface.ProjectionModelPropertySelectorNode.md) \| [`ProjectionInterfaceSelectorNode`](Interface.ProjectionInterfaceSelectorNode.md) \| [`ProjectionOperationSelectorNode`](Interface.ProjectionOperationSelectorNode.md) \| [`ProjectionEnumSelectorNode`](Interface.ProjectionEnumSelectorNode.md) \| [`ProjectionEnumMemberSelectorNode`](Interface.ProjectionEnumMemberSelectorNode.md) \| [`ProjectionUnionSelectorNode`](Interface.ProjectionUnionSelectorNode.md) \| [`ProjectionUnionVariantSelectorNode`](Interface.ProjectionUnionVariantSelectorNode.md) | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `to`? | [`ProjectionNode`](Interface.ProjectionNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionTupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionTupleExpressionNode.md deleted file mode 100644 index 557a8b4564..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionTupleExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionTupleExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionTupleExpression`](Enumeration.SyntaxKind.md#projectiontupleexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `values` | [`ProjectionExpression`](Type.ProjectionExpression.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnaryExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnaryExpressionNode.md deleted file mode 100644 index 003e574543..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnaryExpressionNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionUnaryExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionUnaryExpression`](Enumeration.SyntaxKind.md#projectionunaryexpression) | - | -| `readonly` `op` | `"!"` | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionSelectorNode.md deleted file mode 100644 index 71a5107fbd..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionUnionSelectorNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionUnionSelector`](Enumeration.SyntaxKind.md#projectionunionselector) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionVariantSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionVariantSelectorNode.md deleted file mode 100644 index 033d5bd636..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectionUnionVariantSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionUnionVariantSelectorNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ProjectionUnionVariantSelector`](Enumeration.SyntaxKind.md#projectionunionvariantselector) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projector.md deleted file mode 100644 index d4514e5a9f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Projector.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -jsApi: true -title: "[I] Projector" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `parentProjector`? | [`Projector`](Interface.Projector.md) | -| `projectedGlobalNamespace`? | [`Namespace`](Interface.Namespace.md) | -| `projectedStartNode`? | [`Type`](Type.Type.md) | -| `projectedTypes` | `Map`< [`Type`](Type.Type.md), [`Type`](Type.Type.md) \> | -| `projections` | [`ProjectionApplication`](Interface.ProjectionApplication.md)[] | - -## Methods - -### projectType - -```ts -projectType(type): Type -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Type`](Type.Type.md) | - -#### Returns - -[`Type`](Type.Type.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RecordModelType.md deleted file mode 100644 index 0e7ba7d9b6..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RecordModelType.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -jsApi: true -title: "[I] RecordModelType" - ---- -## Extends - -- [`Model`](Interface.Model.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `baseModel`? | [`Model`](Interface.Model.md) | Model this model extends. This represent inheritance. | -| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | -| `derivedModels` | [`Model`](Interface.Model.md)[] | Direct children. This is the reverse relation of [baseModel](Interface.ArrayModelType.md#basemodel) | -| `indexer` | `object` | - | -| `indexer.key` | [`Scalar`](Interface.Scalar.md) | - | -| `indexer.value` | [`Type`](Type.Type.md) | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Model"` | - | -| `name` | `string` | - | -| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | -| `node`? | [`ModelStatementNode`](Interface.ModelStatementNode.md) \| [`ModelExpressionNode`](Interface.ModelExpressionNode.md) \| [`IntersectionExpressionNode`](Interface.IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](Interface.ProjectionModelExpressionNode.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `properties` | `RekeyableMap`< `string`, [`ModelProperty`](Interface.ModelProperty.md) \> | The properties of the model.

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

Properties inherited via `model extends` are not included. Use
[walkPropertiesInherited](Function.walkPropertiesInherited.md) to enumerate all properties in the
inheritance hierarchy. | -| `sourceModel`? | [`Model`](Interface.Model.md) | The model that is referenced via `model is`. | -| `symbol`? | [`Sym`](Interface.Sym.md) | Late-bound symbol of this model type. | -| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

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

**Default**

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

**Default**

` process.env ` | -| `overrides`? | `Partial`< `TypeSpecConfig` \> | Compiler options to override the config | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedFile.md deleted file mode 100644 index 23b4709d7c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedFile.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] ResolvedFile" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `path` | `string` | -| `type` | `"file"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnExpressionNode.md deleted file mode 100644 index 4fecbbb63d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ReturnExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`Return`](Enumeration.SyntaxKind.md#return) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `value` | [`ProjectionExpression`](Type.ProjectionExpression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnRecord.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnRecord.md deleted file mode 100644 index f6b70bdb3d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ReturnRecord.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] ReturnRecord" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `kind` | `"Return"` | -| `value` | [`Type`](Type.Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scalar.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scalar.md deleted file mode 100644 index b4d81a60f9..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scalar.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -jsApi: true -title: "[I] Scalar" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md).[`TemplatedTypeBase`](Interface.TemplatedTypeBase.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `baseScalar`? | [`Scalar`](Interface.Scalar.md) | Scalar this scalar extends. | -| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | -| `derivedScalars` | [`Scalar`](Interface.Scalar.md)[] | Direct children. This is the reverse relation of

**See**

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

use templateMapper instead. | -| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | -| `templateNode`? | [`Node`](Type.Node.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ScalarStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ScalarStatementNode.md deleted file mode 100644 index 21df4763e5..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ScalarStatementNode.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[I] ScalarStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md).[`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `extends`? | [`TypeReferenceNode`](Interface.TypeReferenceNode.md) | - | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`ScalarStatement`](Enumeration.SyntaxKind.md#scalarstatement) | - | -| `locals`? | `SymbolTable` | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scanner.md deleted file mode 100644 index 3eb9cca8b0..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Scanner.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -jsApi: true -title: "[I] Scanner" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `file` | [`SourceFile`](Interface.SourceFile.md) | The source code being scanned. | -| `readonly` `position` | `number` | The offset in UTF-16 code units to the current position at the start of the next token. | -| `readonly` `token` | [`Token`](Enumeration.Token.md) | The current token | -| `readonly` `tokenFlags` | [`TokenFlags`](Enumeration.TokenFlags.md) | The flags on the current token. | -| `readonly` `tokenPosition` | `number` | The offset in UTF-16 code units to the start of the current token. | - -## Methods - -### eof - -```ts -eof(): boolean -``` - -Determine if the scanner has reached the end of the input. - -#### Returns - -`boolean` - -*** - -### getTokenText - -```ts -getTokenText(): string -``` - -The exact spelling of the current token. - -#### Returns - -`string` - -*** - -### getTokenValue - -```ts -getTokenValue(): string -``` - -The value of the current token. - -String literals are escaped and unquoted, identifiers are normalized, -and all other tokens return their exact spelling sames as -getTokenText(). - -#### Returns - -`string` - -*** - -### scan - -```ts -scan(): Token -``` - -Advance one token. - -#### Returns - -[`Token`](Enumeration.Token.md) - -*** - -### scanDoc - -```ts -scanDoc(): DocToken -``` - -Advance one token inside DocComment. Use inside [scanRange](Interface.Scanner.md#scanrange) callback over DocComment range. - -#### Returns - -[`DocToken`](Type.DocToken.md) - -*** - -### scanRange - -```ts -scanRange(range, callback): T -``` - -Reset the scanner to the given start and end positions, invoke the callback, and then restore scanner state. - -#### Type parameters - -| Parameter | -| :------ | -| `T` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `range` | [`TextRange`](Interface.TextRange.md) | -| `callback` | () => `T` | - -#### Returns - -`T` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SemanticToken.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SemanticToken.md deleted file mode 100644 index 6f4c30c0ce..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SemanticToken.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] SemanticToken" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `end` | `number` | -| `kind` | [`SemanticTokenKind`](Enumeration.SemanticTokenKind.md) | -| `pos` | `number` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerSourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerSourceFile.md deleted file mode 100644 index 952a8d3bce..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerSourceFile.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -jsApi: true -title: "[I] ServerSourceFile" - ---- -## Extends - -- [`SourceFile`](Interface.SourceFile.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `document`? | `TextDocument` | - | -| `readonly` `path` | `string` | The source file path.

This is used only for diagnostics. The command line compiler will populate
it with the actual path from which the file was read, but it can actually
be an arbitrary name for other scenarios. | -| `readonly` `text` | `string` | The source code text. | - -## Methods - -### getLineAndCharacterOfPosition - -```ts -getLineAndCharacterOfPosition(position): LineAndCharacter -``` - -Converts a one-dimensional position in the document (measured in UTF-16 -code units) to line number and offset from line start. - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `position` | `number` | - -#### Returns - -[`LineAndCharacter`](Interface.LineAndCharacter.md) - -#### Inherited from - -[`SourceFile`](Interface.SourceFile.md).[`getLineAndCharacterOfPosition`](Interface.SourceFile.md#getlineandcharacterofposition) - -*** - -### getLineStarts - -```ts -getLineStarts(): readonly number[] -``` - -Array of positions in the text where each line begins. There is one entry -per line, in order of lines, and each entry represents the offset in UTF-16 -code units from the start of the document to the beginning of the line. - -#### Returns - -*readonly* `number`[] - -#### Inherited from - -[`SourceFile`](Interface.SourceFile.md).[`getLineStarts`](Interface.SourceFile.md#getlinestarts) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceLocation.md deleted file mode 100644 index f010155f2e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceLocation.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -jsApi: true -title: "[I] SourceLocation" - ---- -## Extends - -- [`TextRange`](Interface.TextRange.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `file` | [`SourceFile`](Interface.SourceFile.md) | - | -| `isSynthetic`? | `boolean` | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteral.md deleted file mode 100644 index 62f6722416..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteral.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] StringLiteral" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"String"` | - | -| `node`? | [`StringLiteralNode`](Interface.StringLiteralNode.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `value` | `string` | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteralNode.md deleted file mode 100644 index 08c49255a9..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.StringLiteralNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] StringLiteralNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`StringLiteral`](Enumeration.SyntaxKind.md#stringliteral) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `value` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SuppressDirective.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SuppressDirective.md deleted file mode 100644 index 90e8591928..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SuppressDirective.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -jsApi: true -title: "[I] SuppressDirective" - ---- -## Extends - -- [`DirectiveBase`](Interface.DirectiveBase.md) - -## Properties - -| Property | Type | -| :------ | :------ | -| `code` | `string` | -| `message` | `string` | -| `name` | `"suppress"` | -| `node` | [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Sym.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Sym.md deleted file mode 100644 index 0440f53151..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Sym.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[I] Sym" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `declarations` | *readonly* [`Node`](Type.Node.md)[] | Nodes which contribute to this declaration | -| `exports`? | `SymbolTable` | Externally visible symbols contained inside this symbol. E.g. all declarations
in a namespace, or members of an enum. | -| `readonly` `flags` | [`SymbolFlags`](Enumeration.SymbolFlags.md) | - | -| `id`? | `number` | A unique identifier for this symbol. Used to look up the symbol links. | -| `members`? | `SymbolTable` | Symbols for members of this symbol which must be referenced off the parent symbol
and cannot be referenced by other means (i.e. by unqualified lookup of the symbol
name). | -| `metatypeMembers`? | `SymbolTable` | Symbol table | -| `readonly` `name` | `string` | The name of the symbol | -| `parent`? | [`Sym`](Interface.Sym.md) | The symbol containing this symbol, if any. E.g. for things declared in
a namespace, this refers to the namespace. | -| `symbolSource`? | [`Sym`](Interface.Sym.md) | For using symbols, this is the used symbol. | -| `type`? | [`Type`](Type.Type.md) | For late-bound symbols, this is the type referenced by the symbol. | -| `value`? | (...`args`) => `any` | For decorator and function symbols, this is the JS function implementation. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SymbolLinks.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SymbolLinks.md deleted file mode 100644 index 18bbfa8110..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SymbolLinks.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] SymbolLinks" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `declaredType`? | [`Type`](Type.Type.md) | -| `instantiations`? | [`TypeInstantiationMap`](Interface.TypeInstantiationMap.md) | -| `type`? | [`Type`](Type.Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateDeclarationNode.md deleted file mode 100644 index e1f84cd95c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateDeclarationNode.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[I] TemplateDeclarationNode" - ---- -## Extended By - -- [`OperationStatementNode`](Interface.OperationStatementNode.md) -- [`ModelStatementNode`](Interface.ModelStatementNode.md) -- [`ScalarStatementNode`](Interface.ScalarStatementNode.md) -- [`InterfaceStatementNode`](Interface.InterfaceStatementNode.md) -- [`UnionStatementNode`](Interface.UnionStatementNode.md) -- [`AliasStatementNode`](Interface.AliasStatementNode.md) - -## Properties - -| Property | Type | -| :------ | :------ | -| `locals`? | `SymbolTable` | -| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameter.md deleted file mode 100644 index ca5486435f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameter.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -jsApi: true -title: "[I] TemplateParameter" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `constraint`? | [`Type`](Type.Type.md) \| [`ValueType`](Interface.ValueType.md) | - | -| `default`? | [`Type`](Type.Type.md) | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"TemplateParameter"` | - | -| `node` | [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameterDeclarationNode.md deleted file mode 100644 index 62c6c2a285..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplateParameterDeclarationNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] TemplateParameterDeclarationNode" - ---- -## Extends - -- [`DeclarationNode`](Interface.DeclarationNode.md).[`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `constraint`? | [`Expression`](Type.Expression.md) | - | -| `default`? | [`Expression`](Type.Expression.md) | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`TemplateParameterDeclaration`](Enumeration.SyntaxKind.md#templateparameterdeclaration) | - | -| `parent`? | [`TemplateableNode`](Type.TemplateableNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplatedTypeBase.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplatedTypeBase.md deleted file mode 100644 index 1a9b6dc248..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TemplatedTypeBase.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[I] TemplatedTypeBase" - ---- -## Extended By - -- [`Model`](Interface.Model.md) -- [`Scalar`](Interface.Scalar.md) -- [`Interface`](Interface.Interface.md) -- [`Operation`](Interface.Operation.md) -- [`Union`](Interface.Union.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `templateArguments`? | [`Type`](Type.Type.md)[] | **Deprecated**

use templateMapper instead. | -| `templateMapper`? | [`TypeMapper`](Interface.TypeMapper.md) | - | -| `templateNode`? | [`Node`](Type.Node.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TextRange.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TextRange.md deleted file mode 100644 index 6ebdc8f6ee..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TextRange.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[I] TextRange" - ---- -## Extended By - -- [`BaseNode`](Interface.BaseNode.md) -- [`LineComment`](Interface.LineComment.md) -- [`BlockComment`](Interface.BlockComment.md) -- [`SourceLocation`](Interface.SourceLocation.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TracerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TracerOptions.md deleted file mode 100644 index b95aac96e5..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TracerOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] TracerOptions" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `filter`? | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tuple.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tuple.md deleted file mode 100644 index f9e9c1fbcd..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tuple.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] Tuple" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Tuple"` | - | -| `node` | [`TupleExpressionNode`](Interface.TupleExpressionNode.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `values` | [`Type`](Type.Type.md)[] | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TupleExpressionNode.md deleted file mode 100644 index e3ecba2fa1..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TupleExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] TupleExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`TupleExpression`](Enumeration.SyntaxKind.md#tupleexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `values` | *readonly* [`Expression`](Type.Expression.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeMapper.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeMapper.md deleted file mode 100644 index 23a18a72c0..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeMapper.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -jsApi: true -title: "[I] TypeMapper" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `args` | *readonly* [`Type`](Type.Type.md)[] | -| `map` | `Map`< [`TemplateParameter`](Interface.TemplateParameter.md), [`Type`](Type.Type.md) \> | -| `partial` | `boolean` | - -## Methods - -### getMappedType - -```ts -getMappedType(type): Type -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`TemplateParameter`](Interface.TemplateParameter.md) | - -#### Returns - -[`Type`](Type.Type.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeNameOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeNameOptions.md deleted file mode 100644 index 85ef0e9cb9..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeNameOptions.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] TypeNameOptions" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `namespaceFilter`? | (`ns`) => `boolean` | -| `printable`? | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeReferenceNode.md deleted file mode 100644 index 117561c33a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeReferenceNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] TypeReferenceNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `arguments` | *readonly* [`Expression`](Type.Expression.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`TypeReference`](Enumeration.SyntaxKind.md#typereference) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibrary.md deleted file mode 100644 index 63a406b39c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibrary.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -jsApi: true -title: "[I] TypeSpecLibrary" - ---- -Definition of a TypeSpec library - -## Extends - -- [`TypeSpecLibraryDef`](Interface.TypeSpecLibraryDef.md)< `T`, `E` \> - -## Type parameters - -| Parameter | Default | -| :------ | :------ | -| `T` *extends* \{} | - | -| `E` *extends* `Record`< `string`, `any` \> | `Record`< `string`, `never` \> | - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `diagnostics` | [`DiagnosticMap`](Type.DiagnosticMap.md)< `T` \> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | -| `emitter`? | `object` | Emitter configuration if library is an emitter. | -| `emitter.options`? | [`JSONSchemaType`](Type.JSONSchemaType.md)< `E` \> | - | -| `emitterOptionValidator`? | [`JSONSchemaValidator`](Interface.JSONSchemaValidator.md) | JSON Schema validator for emitter options | -| `linter`? | [`LinterDefinition`](Interface.LinterDefinition.md) | Configuration if library is providing linting rules/rulesets. | -| `readonly` `name` | `string` | Name of the library. Must match the package.json name. | -| `requireImports`? | *readonly* `string`[] | List of other library that should be imported when this is used as an emitter.
Compiler will emit an error if the libraries are not explicitly imported. | - -## Methods - -### createDiagnostic - -```ts -createDiagnostic(diag): Diagnostic -``` - -#### Type parameters - -| Parameter | -| :------ | -| `C` *extends* `string` \| `number` \| `symbol` | -| `M` *extends* `string` \| `number` \| `symbol` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diag` | [`DiagnosticReport`](Type.DiagnosticReport.md)< `T`, `C`, `M` \> | - -#### Returns - -[`Diagnostic`](Interface.Diagnostic.md) - -*** - -### createStateSymbol - -```ts -createStateSymbol(name): symbol -``` - -Get or create a symbol with the given name unique for that library. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `name` | `string` | Symbol name scoped with the library name. | - -#### Returns - -`symbol` - -*** - -### getTracer - -```ts -getTracer(program): Tracer -``` - -Returns a tracer scopped to the current library. -All trace area logged via this tracer will be prefixed with the library name. - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | - -#### Returns - -[`Tracer`](Interface.Tracer.md) - -*** - -### reportDiagnostic - -```ts -reportDiagnostic(program, diag): void -``` - -#### Type parameters - -| Parameter | -| :------ | -| `C` *extends* `string` \| `number` \| `symbol` | -| `M` *extends* `string` \| `number` \| `symbol` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `diag` | [`DiagnosticReport`](Type.DiagnosticReport.md)< `T`, `C`, `M` \> | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibraryDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibraryDef.md deleted file mode 100644 index 221cd24502..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecLibraryDef.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -jsApi: true -title: "[I] TypeSpecLibraryDef" - ---- -Definition of a TypeSpec library - -## Extended By - -- [`TypeSpecLibrary`](Interface.TypeSpecLibrary.md) - -## Type parameters - -| Parameter | Default | -| :------ | :------ | -| `T` *extends* \{} | - | -| `E` *extends* `Record`< `string`, `any` \> | `Record`< `string`, `never` \> | - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `diagnostics` | [`DiagnosticMap`](Type.DiagnosticMap.md)< `T` \> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | -| `emitter`? | `object` | Emitter configuration if library is an emitter. | -| `emitter.options`? | [`JSONSchemaType`](Type.JSONSchemaType.md)< `E` \> | - | -| `linter`? | [`LinterDefinition`](Interface.LinterDefinition.md) | Configuration if library is providing linting rules/rulesets. | -| `readonly` `name` | `string` | Name of the library. Must match the package.json name. | -| `requireImports`? | *readonly* `string`[] | List of other library that should be imported when this is used as an emitter.
Compiler will emit an error if the libraries are not explicitly imported. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecScriptNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecScriptNode.md deleted file mode 100644 index 5055f8a9b1..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecScriptNode.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -jsApi: true -title: "[I] TypeSpecScriptNode" - ---- -## Extends - -- [`DeclarationNode`](Interface.DeclarationNode.md).[`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `comments` | *readonly* [`Comment`](Type.Comment.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `file` | [`SourceFile`](Interface.SourceFile.md) | - | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `inScopeNamespaces` | *readonly* [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md)[] | - | -| `readonly` `kind` | [`TypeSpecScript`](Enumeration.SyntaxKind.md#typespecscript) | - | -| `readonly` `locals` | `SymbolTable` | - | -| `readonly` `namespaces` | [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md)[] | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `parseDiagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | - | -| `readonly` `parseOptions` | [`ParseOptions`](Interface.ParseOptions.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `printable` | `boolean` | - | -| `readonly` `statements` | *readonly* [`Statement`](Type.Statement.md)[] | - | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `usings` | *readonly* [`UsingStatementNode`](Interface.UsingStatementNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Union.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Union.md deleted file mode 100644 index 4ef641c18a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Union.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -jsApi: true -title: "[I] Union" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md).[`TemplatedTypeBase`](Interface.TemplatedTypeBase.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | -| `expression` | `boolean` | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Union"` | - | -| `name`? | `string` | - | -| `namespace`? | [`Namespace`](Interface.Namespace.md) | - | -| `node` | [`UnionStatementNode`](Interface.UnionStatementNode.md) \| [`UnionExpressionNode`](Interface.UnionExpressionNode.md) | - | -| `readonly` `options` | [`Type`](Type.Type.md)[] | **Deprecated**

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

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

Variants are ordered in order that they appear in source. | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionExpressionNode.md deleted file mode 100644 index 72a5e4c967..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] UnionExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`UnionExpression`](Enumeration.SyntaxKind.md#unionexpression) | - | -| `readonly` `options` | *readonly* [`Expression`](Type.Expression.md)[] | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionStatementNode.md deleted file mode 100644 index dc886ca7e4..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionStatementNode.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[I] UnionStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md).[`DeclarationNode`](Interface.DeclarationNode.md).[`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`UnionStatement`](Enumeration.SyntaxKind.md#unionstatement) | - | -| `locals`? | `SymbolTable` | - | -| `readonly` `options` | *readonly* [`UnionVariantNode`](Interface.UnionVariantNode.md)[] | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `templateParameters` | *readonly* [`TemplateParameterDeclarationNode`](Interface.TemplateParameterDeclarationNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariant.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariant.md deleted file mode 100644 index 72b15fcc9c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariant.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -jsApi: true -title: "[I] UnionVariant" - ---- -## Extends - -- [`BaseType`](Interface.BaseType.md).[`DecoratedType`](Interface.DecoratedType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](Interface.DecoratorApplication.md)[] | - | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"UnionVariant"` | - | -| `name` | `string` \| `symbol` | - | -| `node` | `undefined` \| [`UnionVariantNode`](Interface.UnionVariantNode.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | -| `type` | [`Type`](Type.Type.md) | - | -| `union` | [`Union`](Interface.Union.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projections`](Interface.BaseType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](Interface.BaseType.md).[`projectionsByName`](Interface.BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariantNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariantNode.md deleted file mode 100644 index b3c80a3705..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnionVariantNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] UnionVariantNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `decorators` | *readonly* [`DecoratorExpressionNode`](Interface.DecoratorExpressionNode.md)[] | - | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `id`? | [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `readonly` `kind` | [`UnionVariant`](Enumeration.SyntaxKind.md#unionvariant) | - | -| `parent`? | [`UnionStatementNode`](Interface.UnionStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `value` | [`Expression`](Type.Expression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnknownType.md deleted file mode 100644 index 581bedf30a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UnknownType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] UnknownType" - ---- -## Extends - -- [`IntrinsicType`](Interface.IntrinsicType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Intrinsic"` | - | -| `name` | `"unknown"` | - | -| `node`? | [`Node`](Type.Node.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`IntrinsicType`](Interface.IntrinsicType.md).[`projections`](Interface.IntrinsicType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`IntrinsicType`](Interface.IntrinsicType.md).[`projectionsByName`](Interface.IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsageTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsageTracker.md deleted file mode 100644 index b8e5a277fc..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsageTracker.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -jsApi: true -title: "[I] UsageTracker" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `readonly` `types` | *readonly* [`TrackableType`](Type.TrackableType.md)[] | - -## Methods - -### isUsedAs - -```ts -isUsedAs(type, usage): boolean -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`TrackableType`](Type.TrackableType.md) | -| `usage` | [`UsageFlags`](Enumeration.UsageFlags.md) | - -#### Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsingStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsingStatementNode.md deleted file mode 100644 index 0517ce10cd..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.UsingStatementNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] UsingStatementNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`UsingStatement`](Enumeration.SyntaxKind.md#usingstatement) | - | -| `readonly` `name` | [`MemberExpressionNode`](Interface.MemberExpressionNode.md) \| [`IdentifierNode`](Interface.IdentifierNode.md) | - | -| `parent`? | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](Interface.NamespaceStatementNode.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueOfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueOfExpressionNode.md deleted file mode 100644 index 718b8ab38b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueOfExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ValueOfExpressionNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`ValueOfExpression`](Enumeration.SyntaxKind.md#valueofexpression) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | -| `readonly` `target` | [`Expression`](Type.Expression.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueType.md deleted file mode 100644 index ddf2435571..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ValueType.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] ValueType" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `kind` | `"Value"` | -| `target` | [`Type`](Type.Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidKeywordNode.md deleted file mode 100644 index e710ec4c01..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidKeywordNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] VoidKeywordNode" - ---- -## Extends - -- [`BaseNode`](Interface.BaseNode.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `directives`? | *readonly* [`DirectiveExpressionNode`](Interface.DirectiveExpressionNode.md)[] | - | -| `docs`? | *readonly* [`DocNode`](Interface.DocNode.md)[] | - | -| `readonly` `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `readonly` `flags` | [`NodeFlags`](Enumeration.NodeFlags.md) | - | -| `readonly` `kind` | [`VoidKeyword`](Enumeration.SyntaxKind.md#voidkeyword) | - | -| `parent`? | [`Node`](Type.Node.md) | - | -| `readonly` `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | -| `readonly` `symbol` | [`Sym`](Interface.Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidType.md deleted file mode 100644 index 3dd7b5b075..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.VoidType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] VoidType" - ---- -## Extends - -- [`IntrinsicType`](Interface.IntrinsicType.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `instantiationParameters`? | [`Type`](Type.Type.md)[] | - | -| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `kind` | `"Intrinsic"` | - | -| `name` | `"void"` | - | -| `node`? | [`Node`](Type.Node.md) | - | -| `projectionBase`? | [`Type`](Type.Type.md) | - | -| `projectionSource`? | [`Type`](Type.Type.md) | - | -| `projector`? | [`Projector`](Interface.Projector.md) | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Inherited from - -[`IntrinsicType`](Interface.IntrinsicType.md).[`projections`](Interface.IntrinsicType.md#projections) - -## Methods - -### projectionsByName - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](Interface.ProjectionStatementNode.md)[] - -#### Inherited from - -[`IntrinsicType`](Interface.IntrinsicType.md).[`projectionsByName`](Interface.IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$discriminator.md deleted file mode 100644 index 2ef3f559b1..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$discriminator.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $discriminator" - ---- -```ts -$discriminator( - context, - entity, - propertyName): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `entity` | [`Model`](Interface.Model.md) \| [`Union`](Interface.Union.md) | -| `propertyName` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$docFromComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$docFromComment.md deleted file mode 100644 index 7fa2d872ef..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$docFromComment.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] $docFromComment" - ---- -```ts -$docFromComment( - context, - target, - text): void -``` - -to be used to set the `@doc` from doc comment. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Type`](Type.Type.md) | -| `text` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$encode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$encode.md deleted file mode 100644 index 430bf45fee..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$encode.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] $encode" - ---- -```ts -$encode( - context, - target, - encoding, - encodeAs?): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | -| `encoding` | `string` \| [`EnumMember`](Interface.EnumMember.md) | -| `encodeAs`? | [`Scalar`](Interface.Scalar.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$friendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$friendlyName.md deleted file mode 100644 index 8874104e7e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$friendlyName.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] $friendlyName" - ---- -```ts -$friendlyName( - context, - target, - friendlyName, - sourceObject): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Type`](Type.Type.md) | -| `friendlyName` | `string` | -| `sourceObject` | `undefined` \| [`Type`](Type.Type.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$indexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$indexer.md deleted file mode 100644 index 49df971033..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$indexer.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] $indexer" - ---- -```ts -$indexer( - context, - target, - key, - value): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Type`](Type.Type.md) | -| `key` | [`Scalar`](Interface.Scalar.md) | -| `value` | [`Type`](Type.Type.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$list.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$list.md deleted file mode 100644 index 72d75b0dbf..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$list.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[F] $list" - ---- -```ts -$list( - context, - target, - listedType?): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Operation`](Interface.Operation.md) | -| `listedType`? | [`Type`](Type.Type.md) | - -## Returns - -`void` - -## Deprecated - -Use the `listsResource` decorator in `@typespec/rest` instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxItems.md deleted file mode 100644 index c749370960..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxItems.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $maxItems" - ---- -```ts -$maxItems( - context, - target, - maxItems): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Model`](Interface.Model.md) \| [`ModelProperty`](Interface.ModelProperty.md) | -| `maxItems` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxLength.md deleted file mode 100644 index 109eed5f96..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxLength.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $maxLength" - ---- -```ts -$maxLength( - context, - target, - maxLength): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | -| `maxLength` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValue.md deleted file mode 100644 index e2bf132991..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValue.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $maxValue" - ---- -```ts -$maxValue( - context, - target, - maxValue): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | -| `maxValue` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValueExclusive.md deleted file mode 100644 index 11651b1b84..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$maxValueExclusive.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $maxValueExclusive" - ---- -```ts -$maxValueExclusive( - context, - target, - maxValueExclusive): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | -| `maxValueExclusive` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minItems.md deleted file mode 100644 index 8700f45f89..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minItems.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $minItems" - ---- -```ts -$minItems( - context, - target, - minItems): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Model`](Interface.Model.md) \| [`ModelProperty`](Interface.ModelProperty.md) | -| `minItems` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minLength.md deleted file mode 100644 index a11a844c26..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minLength.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $minLength" - ---- -```ts -$minLength( - context, - target, - minLength): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | -| `minLength` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValue.md deleted file mode 100644 index 7202a9762d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValue.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $minValue" - ---- -```ts -$minValue( - context, - target, - minValue): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | -| `minValue` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValueExclusive.md deleted file mode 100644 index a52fcb6024..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$minValueExclusive.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $minValueExclusive" - ---- -```ts -$minValueExclusive( - context, - target, - minValueExclusive): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | -| `minValueExclusive` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$overload.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$overload.md deleted file mode 100644 index 99a14c1e5c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$overload.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] $overload" - ---- -```ts -$overload( - context, - target, - overloadBase): void -``` - -`@overload` - Indicate that the target overloads (specializes) the overloads type. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | DecoratorContext | -| `target` | [`Operation`](Interface.Operation.md) | The specializing operation declaration | -| `overloadBase` | [`Operation`](Interface.Operation.md) | The operation to be overloaded. | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$parameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$parameterVisibility.md deleted file mode 100644 index db571c27be..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$parameterVisibility.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $parameterVisibility" - ---- -```ts -$parameterVisibility( - context, - entity, - ...visibilities): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `entity` | [`Operation`](Interface.Operation.md) | -| ...`visibilities` | `string`[] | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$pattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$pattern.md deleted file mode 100644 index 1f3c9532be..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$pattern.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $pattern" - ---- -```ts -$pattern( - context, - target, - pattern): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | -| `pattern` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$returnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$returnTypeVisibility.md deleted file mode 100644 index 3499d00ccf..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$returnTypeVisibility.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $returnTypeVisibility" - ---- -```ts -$returnTypeVisibility( - context, - entity, - ...visibilities): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `entity` | [`Operation`](Interface.Operation.md) | -| ...`visibilities` | `string`[] | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$secret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$secret.md deleted file mode 100644 index 8d3a868e70..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$secret.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] $secret" - ---- -```ts -$secret(context, target): void -``` - -Mark a string as a secret value that should be treated carefully to avoid exposure - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | Decorator context | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | Decorator target, either a string model or a property with type string. | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$service.md deleted file mode 100644 index 7b83d2fbbe..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$service.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $service" - ---- -```ts -$service( - context, - target, - options?): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Namespace`](Interface.Namespace.md) | -| `options`? | [`Model`](Interface.Model.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$tag.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$tag.md deleted file mode 100644 index 4538600b46..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$tag.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $tag" - ---- -```ts -$tag( - context, - target, - tag): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Interface`](Interface.Interface.md) \| [`Namespace`](Interface.Namespace.md) \| [`Operation`](Interface.Operation.md) | -| `tag` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$visibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$visibility.md deleted file mode 100644 index 02bc1d1acb..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$visibility.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $visibility" - ---- -```ts -$visibility( - context, - target, - ...visibilities): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) | -| ...`visibilities` | `string`[] | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withVisibility.md deleted file mode 100644 index 1545bdafcb..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withVisibility.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $withVisibility" - ---- -```ts -$withVisibility( - context, - target, - ...visibilities): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Model`](Interface.Model.md) | -| ...`visibilities` | `string`[] | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withoutOmittedProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withoutOmittedProperties.md deleted file mode 100644 index da55ca3a84..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withoutOmittedProperties.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $withoutOmittedProperties" - ---- -```ts -$withoutOmittedProperties( - context, - target, - omitProperties): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Model`](Interface.Model.md) | -| `omitProperties` | [`StringLiteral`](Interface.StringLiteral.md) \| [`Union`](Interface.Union.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.addService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.addService.md deleted file mode 100644 index 0f2598349d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.addService.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] addService" - ---- -```ts -addService( - program, - namespace, - details = {}): void -``` - -Mark the given namespace as a service. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `namespace` | [`Namespace`](Interface.Namespace.md) | Namespace | -| `details` | [`ServiceDetails`](Namespace.decorators.Interface.ServiceDetails.md) | Service details | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getAllTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getAllTags.md deleted file mode 100644 index 8c20f9f218..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getAllTags.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getAllTags" - ---- -```ts -getAllTags(program, target): string[] | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Interface`](Interface.Interface.md) \| [`Namespace`](Interface.Namespace.md) \| [`Operation`](Interface.Operation.md) | - -## Returns - -`string`[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminatedTypes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminatedTypes.md deleted file mode 100644 index 010f94650d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminatedTypes.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] getDiscriminatedTypes" - ---- -```ts -getDiscriminatedTypes(program): [Model | Union, Discriminator][] -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | - -## Returns - -[[`Model`](Interface.Model.md) \| [`Union`](Interface.Union.md), [`Discriminator`](Namespace.decorators.Interface.Discriminator.md)][] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminator.md deleted file mode 100644 index d7c147425a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDiscriminator.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getDiscriminator" - ---- -```ts -getDiscriminator(program, entity): Discriminator | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `entity` | [`Type`](Type.Type.md) | - -## Returns - -[`Discriminator`](Namespace.decorators.Interface.Discriminator.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getEncode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getEncode.md deleted file mode 100644 index 59bb5473a7..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getEncode.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getEncode" - ---- -```ts -getEncode(program, target): EncodeData | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | - -## Returns - -[`EncodeData`](Namespace.decorators.Interface.EncodeData.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getKnownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getKnownValues.md deleted file mode 100644 index 429c2148f7..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getKnownValues.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getKnownValues" - ---- -```ts -getKnownValues(program, target): Enum | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | - -## Returns - -[`Enum`](Interface.Enum.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getProjectedNames.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getProjectedNames.md deleted file mode 100644 index 8c353c6ddc..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getProjectedNames.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] getProjectedNames" - ---- -```ts -getProjectedNames(program, target): ReadonlyMap< string, string > | undefined -``` - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `target` | [`Type`](Type.Type.md) | Target | - -## Returns - -`ReadonlyMap`< `string`, `string` \> \| `undefined` - -Map of the projected names for the given entity. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isNumericType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isNumericType.md deleted file mode 100644 index b10ba0bfcd..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isNumericType.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] isNumericType" - ---- -```ts -isNumericType(program, target): target is Scalar -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) \| [`ProjectedProgram`](Interface.ProjectedProgram.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`target is Scalar` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isStringType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isStringType.md deleted file mode 100644 index 990b2c8a6b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isStringType.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] isStringType" - ---- -```ts -isStringType(program, target): target is Scalar -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) \| [`ProjectedProgram`](Interface.ProjectedProgram.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`target is Scalar` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isVisible.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isVisible.md deleted file mode 100644 index f52bb88bbf..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isVisible.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] isVisible" - ---- -```ts -isVisible( - program, - property, - visibilities): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `property` | [`ModelProperty`](Interface.ModelProperty.md) | -| `visibilities` | *readonly* `string`[] | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Discriminator.md deleted file mode 100644 index 6aa4d020ba..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Discriminator.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] Discriminator" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `propertyName` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.DocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.DocData.md deleted file mode 100644 index d8a28107de..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.DocData.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] DocData" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `source` | `"comment"` \| `"@doc"` | How was the doc set.
- `@doc` means the `@doc` decorator was used
- `comment` means it was set from a `/** comment * /` | -| `value` | `string` | Doc value. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.EncodeData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.EncodeData.md deleted file mode 100644 index a2cccedf76..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.EncodeData.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] EncodeData" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `encoding` | `string` | -| `type` | [`Scalar`](Interface.Scalar.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Service.md deleted file mode 100644 index 3bc44f243d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.Service.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] Service" - ---- -## Extends - -- [`ServiceDetails`](Namespace.decorators.Interface.ServiceDetails.md) - -## Properties - -| Property | Type | -| :------ | :------ | -| `title`? | `string` | -| `type` | [`Namespace`](Interface.Namespace.md) | -| `version`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.ServiceDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.ServiceDetails.md deleted file mode 100644 index 943f43274b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Interface.ServiceDetails.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[I] ServiceDetails" - ---- -## Extended By - -- [`Service`](Namespace.decorators.Interface.Service.md) - -## Properties - -| Property | Type | -| :------ | :------ | -| `title`? | `string` | -| `version`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DateTimeKnownEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DateTimeKnownEncoding.md deleted file mode 100644 index efd2cf4782..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DateTimeKnownEncoding.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] DateTimeKnownEncoding" - ---- -```ts -DateTimeKnownEncoding: "rfc3339" | "rfc7231" | "unixTimestamp" -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Variable.namespace.md deleted file mode 100644 index c23ac94a88..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Variable.namespace.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] namespace" - ---- -```ts -const namespace: "TypeSpec" = "TypeSpec" -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.md deleted file mode 100644 index be533bfc34..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -jsApi: true -title: "[N] decorators" - ---- -## Index - -### Interfaces - -- [Discriminator](Namespace.decorators.Interface.Discriminator.md) -- [DocData](Namespace.decorators.Interface.DocData.md) -- [EncodeData](Namespace.decorators.Interface.EncodeData.md) -- [Service](Namespace.decorators.Interface.Service.md) -- [ServiceDetails](Namespace.decorators.Interface.ServiceDetails.md) - -### Type Aliases - -- [BytesKnownEncoding](Namespace.decorators.Type.BytesKnownEncoding.md) -- [DateTimeKnownEncoding](Namespace.decorators.Type.DateTimeKnownEncoding.md) -- [DurationKnownEncoding](Namespace.decorators.Type.DurationKnownEncoding.md) - -### Variables - -- [namespace](Namespace.decorators.Variable.namespace.md) - -### Functions - -- [$deprecated](Namespace.decorators.Function.$deprecated.md) -- [$discriminator](Namespace.decorators.Function.$discriminator.md) -- [$doc](Namespace.decorators.Function.$doc.md) -- [$docFromComment](Namespace.decorators.Function.$docFromComment.md) -- [$encode](Namespace.decorators.Function.$encode.md) -- [$error](Namespace.decorators.Function.$error.md) -- [$format](Namespace.decorators.Function.$format.md) -- [$friendlyName](Namespace.decorators.Function.$friendlyName.md) -- [$indexer](Namespace.decorators.Function.$indexer.md) -- [$inspectType](Namespace.decorators.Function.$inspectType.md) -- [$inspectTypeName](Namespace.decorators.Function.$inspectTypeName.md) -- [$key](Namespace.decorators.Function.$key.md) -- [$knownValues](Namespace.decorators.Function.$knownValues.md) -- [$list](Namespace.decorators.Function.$list.md) -- [$maxItems](Namespace.decorators.Function.$maxItems.md) -- [$maxLength](Namespace.decorators.Function.$maxLength.md) -- [$maxValue](Namespace.decorators.Function.$maxValue.md) -- [$maxValueExclusive](Namespace.decorators.Function.$maxValueExclusive.md) -- [$minItems](Namespace.decorators.Function.$minItems.md) -- [$minLength](Namespace.decorators.Function.$minLength.md) -- [$minValue](Namespace.decorators.Function.$minValue.md) -- [$minValueExclusive](Namespace.decorators.Function.$minValueExclusive.md) -- [$overload](Namespace.decorators.Function.$overload.md) -- [$parameterVisibility](Namespace.decorators.Function.$parameterVisibility.md) -- [$pattern](Namespace.decorators.Function.$pattern.md) -- [$projectedName](Namespace.decorators.Function.$projectedName.md) -- [$returnTypeVisibility](Namespace.decorators.Function.$returnTypeVisibility.md) -- [$secret](Namespace.decorators.Function.$secret.md) -- [$service](Namespace.decorators.Function.$service.md) -- [$summary](Namespace.decorators.Function.$summary.md) -- [$tag](Namespace.decorators.Function.$tag.md) -- [$visibility](Namespace.decorators.Function.$visibility.md) -- [$withDefaultKeyVisibility](Namespace.decorators.Function.$withDefaultKeyVisibility.md) -- [$withOptionalProperties](Namespace.decorators.Function.$withOptionalProperties.md) -- [$withUpdateableProperties](Namespace.decorators.Function.$withUpdateableProperties.md) -- [$withVisibility](Namespace.decorators.Function.$withVisibility.md) -- [$withoutDefaultValues](Namespace.decorators.Function.$withoutDefaultValues.md) -- [$withoutOmittedProperties](Namespace.decorators.Function.$withoutOmittedProperties.md) -- [addService](Namespace.decorators.Function.addService.md) -- [getAllTags](Namespace.decorators.Function.getAllTags.md) -- [getDeprecated](Namespace.decorators.Function.getDeprecated.md) -- [getDiscriminatedTypes](Namespace.decorators.Function.getDiscriminatedTypes.md) -- [getDiscriminator](Namespace.decorators.Function.getDiscriminator.md) -- [getDoc](Namespace.decorators.Function.getDoc.md) -- [getDocData](Namespace.decorators.Function.getDocData.md) -- [getEncode](Namespace.decorators.Function.getEncode.md) -- [getFormat](Namespace.decorators.Function.getFormat.md) -- [getFriendlyName](Namespace.decorators.Function.getFriendlyName.md) -- [getIndexer](Namespace.decorators.Function.getIndexer.md) -- [getKeyName](Namespace.decorators.Function.getKeyName.md) -- [getKnownValues](Namespace.decorators.Function.getKnownValues.md) -- [getListOperationType](Namespace.decorators.Function.getListOperationType.md) -- [getMaxItems](Namespace.decorators.Function.getMaxItems.md) -- [getMaxLength](Namespace.decorators.Function.getMaxLength.md) -- [getMaxValue](Namespace.decorators.Function.getMaxValue.md) -- [getMaxValueExclusive](Namespace.decorators.Function.getMaxValueExclusive.md) -- [getMinItems](Namespace.decorators.Function.getMinItems.md) -- [getMinLength](Namespace.decorators.Function.getMinLength.md) -- [getMinValue](Namespace.decorators.Function.getMinValue.md) -- [getMinValueExclusive](Namespace.decorators.Function.getMinValueExclusive.md) -- [getOverloadedOperation](Namespace.decorators.Function.getOverloadedOperation.md) -- [getOverloads](Namespace.decorators.Function.getOverloads.md) -- [getParameterVisibility](Namespace.decorators.Function.getParameterVisibility.md) -- [getPattern](Namespace.decorators.Function.getPattern.md) -- [getProjectedName](Namespace.decorators.Function.getProjectedName.md) -- [getProjectedNames](Namespace.decorators.Function.getProjectedNames.md) -- [getPropertyType](Namespace.decorators.Function.getPropertyType.md) -- [getReturnTypeVisibility](Namespace.decorators.Function.getReturnTypeVisibility.md) -- [getService](Namespace.decorators.Function.getService.md) -- [getSummary](Namespace.decorators.Function.getSummary.md) -- [getTags](Namespace.decorators.Function.getTags.md) -- [getVisibility](Namespace.decorators.Function.getVisibility.md) -- [hasProjectedName](Namespace.decorators.Function.hasProjectedName.md) -- [isArrayModelType](Namespace.decorators.Function.isArrayModelType.md) -- [isErrorModel](Namespace.decorators.Function.isErrorModel.md) -- [isKey](Namespace.decorators.Function.isKey.md) -- [isListOperation](Namespace.decorators.Function.isListOperation.md) -- [isNumericType](Namespace.decorators.Function.isNumericType.md) -- [isRecordModelType](Namespace.decorators.Function.isRecordModelType.md) -- [isSecret](Namespace.decorators.Function.isSecret.md) -- [isService](Namespace.decorators.Function.isService.md) -- [isStringType](Namespace.decorators.Function.isStringType.md) -- [isVisible](Namespace.decorators.Function.isVisible.md) -- [listServices](Namespace.decorators.Function.listServices.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CreateTypeProps.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CreateTypeProps.md deleted file mode 100644 index e0a96fa7d2..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CreateTypeProps.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] CreateTypeProps" - ---- -```ts -CreateTypeProps: Omit< Type, "isFinished" | keyof TypePrototype > -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Declaration.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Declaration.md deleted file mode 100644 index 1b4ee77950..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Declaration.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] Declaration" - ---- -```ts -Declaration: ModelStatementNode | ScalarStatementNode | InterfaceStatementNode | UnionStatementNode | NamespaceStatementNode | OperationStatementNode | TemplateParameterDeclarationNode | ProjectionStatementNode | ProjectionParameterDeclarationNode | ProjectionLambdaParameterDeclarationNode | EnumStatementNode | AliasStatementNode | DecoratorDeclarationStatementNode | FunctionDeclarationStatementNode -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticFormat.md deleted file mode 100644 index 9be50dfe29..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticFormat.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[T] DiagnosticFormat" - ---- -```ts -DiagnosticFormat: T[C][M] extends CallableMessage< infer A > ? {format: Record< A[number], string >;} : Record< string, unknown > -``` - -## Type parameters - -| Parameter | Default | -| :------ | :------ | -| `T` *extends* \{} | - | -| `C` *extends* *keyof* `T` | - | -| `M` *extends* *keyof* `T`[`C`] | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticMap.md deleted file mode 100644 index 2417175f3e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticMap.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[T] DiagnosticMap" - ---- -```ts -DiagnosticMap: { readonly [code in keyof T]: DiagnosticDefinition } -``` - -## Type parameters - -| Parameter | -| :------ | -| `T` *extends* \{} | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReport.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReport.md deleted file mode 100644 index 855900debe..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReport.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[T] DiagnosticReport" - ---- -```ts -DiagnosticReport: DiagnosticReportWithoutTarget< T, C, M > & {target: DiagnosticTarget | typeof NoTarget;} -``` - -| Member | Type | -| :------ | :------ | -| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) \| *typeof* [`NoTarget`](Variable.NoTarget.md) | - -## Type parameters - -| Parameter | Default | -| :------ | :------ | -| `T` *extends* \{} | - | -| `C` *extends* *keyof* `T` | - | -| `M` *extends* *keyof* `T`[`C`] | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReportWithoutTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReportWithoutTarget.md deleted file mode 100644 index 974c42e5b0..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticReportWithoutTarget.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[T] DiagnosticReportWithoutTarget" - ---- -```ts -DiagnosticReportWithoutTarget: {code: C; messageId: M;} & DiagnosticFormat< T, C, M > -``` - -| Member | Type | -| :------ | :------ | -| `code` | `C` | -| `messageId`? | `M` | - -## Type parameters - -| Parameter | Default | -| :------ | :------ | -| `T` *extends* \{} | - | -| `C` *extends* *keyof* `T` | - | -| `M` *extends* *keyof* `T`[`C`] | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticTarget.md deleted file mode 100644 index 5c2126b64a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticTarget.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] DiagnosticTarget" - ---- -```ts -DiagnosticTarget: TypeSpecDiagnosticTarget | SourceLocation -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Directive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Directive.md deleted file mode 100644 index fb06b360af..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Directive.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] Directive" - ---- -```ts -Directive: SuppressDirective | DeprecatedDirective -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocTag.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocTag.md deleted file mode 100644 index 81adaaefd5..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocTag.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] DocTag" - ---- -```ts -DocTag: DocReturnsTagNode | DocParamTagNode | DocTemplateTagNode | DocUnknownTagNode -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocToken.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocToken.md deleted file mode 100644 index dbab252f6f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocToken.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] DocToken" - ---- -```ts -DocToken: NewLine | Whitespace | ConflictMarker | Star | At | CloseBrace | Identifier | DocText | DocCodeSpan | DocCodeFenceDelimiter | EndOfFile -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitterFunc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitterFunc.md deleted file mode 100644 index 20398b74a1..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitterFunc.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[T] EmitterFunc" - ---- -```ts -EmitterFunc: (context) => Promise< void > | void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`EmitContext`](Interface.EmitContext.md) | - -## Returns - -`Promise`< `void` \> \| `void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Expression.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Expression.md deleted file mode 100644 index 5915fbcbeb..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Expression.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] Expression" - ---- -```ts -Expression: ArrayExpressionNode | MemberExpressionNode | ModelExpressionNode | TupleExpressionNode | UnionExpressionNode | IntersectionExpressionNode | TypeReferenceNode | ValueOfExpressionNode | IdentifierNode | StringLiteralNode | NumericLiteralNode | BooleanLiteralNode | VoidKeywordNode | NeverKeywordNode | AnyKeywordNode -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredTypeSpecValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredTypeSpecValue.md deleted file mode 100644 index 079c1b7a3d..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredTypeSpecValue.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[T] InferredTypeSpecValue" - ---- -```ts -InferredTypeSpecValue: K extends "Any" ? TypeSpecValue : K extends infer T[] ? InferredTypeSpecValue< T > : K extends "String" ? string : K extends "Number" ? number : K extends "Boolean" ? boolean : Type & {kind: K;} -``` - -## Type parameters - -| Parameter | -| :------ | -| `K` *extends* [`TypeKind`](Type.TypeKind.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.IntrinsicScalarName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.IntrinsicScalarName.md deleted file mode 100644 index 67ca70d482..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.IntrinsicScalarName.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] IntrinsicScalarName" - ---- -```ts -IntrinsicScalarName: "bytes" | "numeric" | "integer" | "float" | "int64" | "int32" | "int16" | "int8" | "uint64" | "uint32" | "uint16" | "uint8" | "safeint" | "float32" | "float64" | "decimal" | "decimal128" | "string" | "plainDate" | "plainTime" | "utcDateTime" | "offsetDateTime" | "duration" | "boolean" | "url" -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LibraryMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LibraryMetadata.md deleted file mode 100644 index 08ddb45dd4..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LibraryMetadata.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] LibraryMetadata" - ---- -```ts -LibraryMetadata: FileLibraryMetadata | ModuleLibraryMetadata -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticFormat.md deleted file mode 100644 index 05536b6743..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticFormat.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[T] LinterRuleDiagnosticFormat" - ---- -```ts -LinterRuleDiagnosticFormat: T[M] extends CallableMessage< infer A > ? {format: Record< A[number], string >;} : Record< string, unknown > -``` - -## Type parameters - -| Parameter | Default | -| :------ | :------ | -| `T` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | - | -| `M` *extends* *keyof* `T` | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReport.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReport.md deleted file mode 100644 index a45df833d7..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReport.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[T] LinterRuleDiagnosticReport" - ---- -```ts -LinterRuleDiagnosticReport: LinterRuleDiagnosticReportWithoutTarget< T, M > & {target: DiagnosticTarget | typeof NoTarget;} -``` - -| Member | Type | -| :------ | :------ | -| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) \| *typeof* [`NoTarget`](Variable.NoTarget.md) | - -## Type parameters - -| Parameter | Default | -| :------ | :------ | -| `T` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | - | -| `M` *extends* *keyof* `T` | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReportWithoutTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReportWithoutTarget.md deleted file mode 100644 index 1d573cc521..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LinterRuleDiagnosticReportWithoutTarget.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[T] LinterRuleDiagnosticReportWithoutTarget" - ---- -```ts -LinterRuleDiagnosticReportWithoutTarget: {messageId: M;} & LinterRuleDiagnosticFormat< T, M > -``` - -| Member | Type | -| :------ | :------ | -| `messageId`? | `M` | - -## Type parameters - -| Parameter | Default | -| :------ | :------ | -| `T` *extends* [`DiagnosticMessages`](Interface.DiagnosticMessages.md) | - | -| `M` *extends* *keyof* `T` | `"default"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralNode.md deleted file mode 100644 index 7f70f218ff..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralNode.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] LiteralNode" - ---- -```ts -LiteralNode: StringLiteralNode | NumericLiteralNode | BooleanLiteralNode -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralType.md deleted file mode 100644 index c3ea6d3e0e..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LiteralType.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] LiteralType" - ---- -```ts -LiteralType: StringLiteral | NumericLiteral | BooleanLiteral -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MarshalledValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MarshalledValue.md deleted file mode 100644 index 40ebf0e3b8..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MarshalledValue.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[T] MarshalledValue" - ---- -```ts -MarshalledValue: Type extends StringLiteral ? string : Type extends NumericLiteral ? number : Type extends BooleanLiteral ? boolean : Type -``` - -## Type parameters - -| Parameter | -| :------ | -| `Type` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerNode.md deleted file mode 100644 index 64107f9db4..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerNode.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[T] MemberContainerNode" - ---- -```ts -MemberContainerNode: ModelStatementNode | ModelExpressionNode | InterfaceStatementNode | EnumStatementNode | UnionStatementNode -``` - -Node types that can have referencable members diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberNode.md deleted file mode 100644 index 3ddef84ed8..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberNode.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] MemberNode" - ---- -```ts -MemberNode: ModelPropertyNode | EnumMemberNode | OperationStatementNode | UnionVariantNode -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModelIndexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModelIndexer.md deleted file mode 100644 index 3be50524dd..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModelIndexer.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[T] ModelIndexer" - ---- -```ts -ModelIndexer: object -``` - -## Type declaration - -| Member | Type | -| :------ | :------ | -| `key` | [`Scalar`](Interface.Scalar.md) | -| `value` | [`Type`](Type.Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NeverIndexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NeverIndexer.md deleted file mode 100644 index 7a60656117..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NeverIndexer.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[T] NeverIndexer" - ---- -```ts -NeverIndexer: object -``` - -## Type declaration - -| Member | Type | -| :------ | :------ | -| `key` | [`NeverType`](Interface.NeverType.md) | -| `value` | `undefined` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Node.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Node.md deleted file mode 100644 index bb3ad2945c..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Node.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] Node" - ---- -```ts -Node: TypeSpecScriptNode | JsSourceFileNode | JsNamespaceDeclarationNode | TemplateParameterDeclarationNode | ProjectionParameterDeclarationNode | ProjectionLambdaParameterDeclarationNode | ModelPropertyNode | UnionVariantNode | OperationStatementNode | OperationSignatureDeclarationNode | OperationSignatureReferenceNode | EnumMemberNode | EnumSpreadMemberNode | ModelSpreadPropertyNode | DecoratorExpressionNode | DirectiveExpressionNode | Statement | Expression | FunctionParameterNode | Modifier | DocNode | DocContent | DocTag | ProjectionStatementItem | ProjectionExpression | ProjectionModelSelectorNode | ProjectionModelPropertySelectorNode | ProjectionInterfaceSelectorNode | ProjectionOperationSelectorNode | ProjectionEnumSelectorNode | ProjectionEnumMemberSelectorNode | ProjectionUnionSelectorNode | ProjectionUnionVariantSelectorNode | ProjectionModelPropertyNode | ProjectionModelSpreadPropertyNode | ProjectionStatementNode | ProjectionNode -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationSignature.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationSignature.md deleted file mode 100644 index 2e36f80292..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationSignature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] OperationSignature" - ---- -```ts -OperationSignature: OperationSignatureDeclarationNode | OperationSignatureReferenceNode -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionExpression.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionExpression.md deleted file mode 100644 index 7252af632f..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionExpression.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] ProjectionExpression" - ---- -```ts -ProjectionExpression: ProjectionLogicalExpressionNode | ProjectionRelationalExpressionNode | ProjectionEqualityExpressionNode | ProjectionUnaryExpressionNode | ProjectionArithmeticExpressionNode | ProjectionCallExpressionNode | ProjectionMemberExpressionNode | ProjectionDecoratorReferenceExpressionNode | ProjectionTupleExpressionNode | ProjectionModelExpressionNode | ProjectionIfExpressionNode | ProjectionBlockExpressionNode | ProjectionLambdaExpressionNode | StringLiteralNode | NumericLiteralNode | BooleanLiteralNode | IdentifierNode | VoidKeywordNode | NeverKeywordNode | AnyKeywordNode | ReturnExpressionNode -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ReferenceExpression.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ReferenceExpression.md deleted file mode 100644 index b463c72ef6..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ReferenceExpression.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] ReferenceExpression" - ---- -```ts -ReferenceExpression: TypeReferenceNode | MemberExpressionNode | IdentifierNode | VoidKeywordNode | NeverKeywordNode -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ScopeNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ScopeNode.md deleted file mode 100644 index 1cb4e7edd7..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ScopeNode.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] ScopeNode" - ---- -```ts -ScopeNode: NamespaceStatementNode | ModelStatementNode | InterfaceStatementNode | AliasStatementNode | TypeSpecScriptNode | JsSourceFileNode | ProjectionLambdaExpressionNode | ProjectionNode -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SemanticNodeListener.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SemanticNodeListener.md deleted file mode 100644 index 79718ca902..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SemanticNodeListener.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[T] SemanticNodeListener" - ---- -```ts -SemanticNodeListener: {root: (context) => void | undefined;} & TypeListeners -``` - -| Member | Type | -| :------ | :------ | -| `root`? | (`context`) => `void` \| `undefined` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Statement.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Statement.md deleted file mode 100644 index 0b3e9db0e2..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Statement.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] Statement" - ---- -```ts -Statement: ImportStatementNode | ModelStatementNode | ScalarStatementNode | NamespaceStatementNode | InterfaceStatementNode | UnionStatementNode | UsingStatementNode | EnumStatementNode | AliasStatementNode | OperationStatementNode | DecoratorDeclarationStatementNode | FunctionDeclarationStatementNode | AugmentDecoratorStatementNode | EmptyStatementNode | InvalidStatementNode | ProjectionStatementNode -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypes.md deleted file mode 100644 index bc0596293b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypes.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[T] StdTypes" - ---- -```ts -StdTypes: {Array: Model; Record: Model;} & Record< IntrinsicScalarName, Scalar > -``` - -| Member | Type | -| :------ | :------ | -| `Array` | [`Model`](Interface.Model.md) | -| `Record` | [`Model`](Interface.Model.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplateableNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplateableNode.md deleted file mode 100644 index 560da38b19..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplateableNode.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[T] TemplateableNode" - ---- -```ts -TemplateableNode: ModelStatementNode | ScalarStatementNode | AliasStatementNode | InterfaceStatementNode | OperationStatementNode | UnionStatementNode -``` - -Node that can be used as template diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Type.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Type.md deleted file mode 100644 index dccdfc10b7..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Type.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] Type" - ---- -```ts -Type: Model | ModelProperty | Scalar | Interface | Enum | EnumMember | TemplateParameter | Namespace | Operation | StringLiteral | NumericLiteral | BooleanLiteral | Tuple | Union | UnionVariant | IntrinsicType | FunctionType | Decorator | FunctionParameter | ObjectType | Projection -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeListeners.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeListeners.md deleted file mode 100644 index 6000b1afda..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeListeners.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] TypeListeners" - ---- -```ts -TypeListeners: UnionToIntersection< ListenerForType< Type > > -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOfDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOfDiagnostics.md deleted file mode 100644 index 2705df5ada..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOfDiagnostics.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[T] TypeOfDiagnostics" - ---- -```ts -TypeOfDiagnostics: T extends DiagnosticMap< infer D > ? D : never -``` - -## Type parameters - -| Parameter | -| :------ | -| `T` *extends* [`DiagnosticMap`](Type.DiagnosticMap.md)< `any` \> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.Keywords.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.Keywords.md deleted file mode 100644 index fa2e31f623..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.Keywords.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] Keywords" - ---- -```ts -const Keywords: ReadonlyMap< string, Token > -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TokenDisplay.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TokenDisplay.md deleted file mode 100644 index 82d992f879..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TokenDisplay.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] TokenDisplay" - ---- -```ts -const TokenDisplay: readonly string[] -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.DuplicateTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md similarity index 55% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.DuplicateTracker.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md index dd58558caf..a07892d33b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.DuplicateTracker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md @@ -5,48 +5,40 @@ title: "[C] DuplicateTracker" --- Helper class to track duplicate instance -## Constructors - -### new DuplicateTracker - -```ts -new DuplicateTracker(): DuplicateTracker< K, V > -``` - -#### Type parameters +## Type parameters | Parameter | | :------ | | `K` | | `V` | -#### Returns +## Constructors + +### new DuplicateTracker() -[`DuplicateTracker`](Class.DuplicateTracker.md)< `K`, `V` \> +```ts +new DuplicateTracker(): DuplicateTracker +``` ## Properties -| Property | Type | -| :------ | :------ | -| `private` `#entries` | `Map`< `K`, `V`[] \> | +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `private` | `#entries` | `Map`<`K`, `V`[]\> | - | ## Methods -### entries +### entries() ```ts -entries(): Iterable< [K, V[]] > +entries(): Iterable<[K, V[]]> ``` Return iterator of all the duplicate entries. -#### Returns - -`Iterable`< [`K`, `V`[]] \> - *** -### track +### track() ```ts track(k, v): void @@ -60,7 +52,3 @@ Track usage of K. | :------ | :------ | :------ | | `k` | `K` | key that is being checked for duplicate. | | `v` | `V` | value that map to the key | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.EventEmitter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md similarity index 51% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.EventEmitter.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md index 3e1fb3632e..af2e755c59 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.EventEmitter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md @@ -3,33 +3,29 @@ jsApi: true title: "[C] EventEmitter" --- -## Constructors - -### new EventEmitter - -```ts -new EventEmitter(): EventEmitter< T > -``` - -#### Type parameters +## Type parameters | Parameter | | :------ | -| `T` *extends* \{} | +| `T` extends `object` | + +## Constructors -#### Returns +### new EventEmitter() -[`EventEmitter`](Class.EventEmitter.md)< `T` \> +```ts +new EventEmitter(): EventEmitter +``` ## Properties -| Property | Type | -| :------ | :------ | -| `private` `listeners` | `Map`< *keyof* `T`, (...`args`) => `any`[] \> | +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `private` | `listeners` | `Map` `any`[]\> | - | ## Methods -### emit +### emit() ```ts emit(name, ...args): void @@ -39,22 +35,18 @@ emit(name, ...args): void | Parameter | | :------ | -| `K` *extends* `string` \| `number` \| `symbol` | +| `K` extends `string` \| `number` \| `symbol` | #### Parameters | Parameter | Type | | :------ | :------ | | `name` | `K` | -| ...`args` | `Parameters`< `T`[`K`] \> | - -#### Returns - -`void` +| ...`args` | `Parameters`<`T`[`K`]\> | *** -### on +### on() ```ts on(name, listener): void @@ -64,7 +56,7 @@ on(name, listener): void | Parameter | | :------ | -| `K` *extends* `string` \| `number` \| `symbol` | +| `K` extends `string` \| `number` \| `symbol` | #### Parameters @@ -72,7 +64,3 @@ on(name, listener): void | :------ | :------ | | `name` | `K` | | `listener` | (...`args`) => `any` | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.InvalidEncodingError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/InvalidEncodingError.md similarity index 54% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.InvalidEncodingError.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/InvalidEncodingError.md index 83953f3eab..6afd92b983 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.InvalidEncodingError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/InvalidEncodingError.md @@ -9,7 +9,7 @@ title: "[C] InvalidEncodingError" ## Constructors -### new InvalidEncodingError +### new InvalidEncodingError(encoding) ```ts new InvalidEncodingError(encoding): InvalidEncodingError @@ -21,27 +21,23 @@ new InvalidEncodingError(encoding): InvalidEncodingError | :------ | :------ | | `encoding` | `string` | -#### Returns - -[`InvalidEncodingError`](Class.InvalidEncodingError.md) - #### Overrides Error.constructor ## Properties -| Property | Type | -| :------ | :------ | -| `message` | `string` | -| `name` | `string` | -| `stack`? | `string` | -| `prepareStackTrace`? | (`err`, `stackTraces`) => `any` | -| `static` `stackTraceLimit` | `number` | +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `public` | `message` | `string` | - | Error.message | +| `public` | `name` | `string` | - | Error.name | +| `public` | `stack?` | `string` | - | Error.stack | +| `static` | `prepareStackTrace?` | (`err`, `stackTraces`) => `any` | - | Error.prepareStackTrace | +| `static` | `stackTraceLimit` | `number` | - | Error.stackTraceLimit | ## Methods -### captureStackTrace +### captureStackTrace() ```ts static captureStackTrace(targetObject, constructorOpt?): void @@ -56,10 +52,6 @@ Create .stack property on a target object | `targetObject` | `object` | | `constructorOpt`? | `Function` | -#### Returns - -`void` - #### Inherited from Error.captureStackTrace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.ProjectionError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.ProjectionError.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md index 5a0f59940e..d2cb316c72 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.ProjectionError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md @@ -11,7 +11,7 @@ Represents a failure while interpreting a projection. ## Constructors -### new ProjectionError +### new ProjectionError(message) ```ts new ProjectionError(message): ProjectionError @@ -23,27 +23,23 @@ new ProjectionError(message): ProjectionError | :------ | :------ | | `message` | `string` | -#### Returns - -[`ProjectionError`](Class.ProjectionError.md) - #### Overrides Error.constructor ## Properties -| Property | Type | -| :------ | :------ | -| `message` | `string` | -| `name` | `string` | -| `stack`? | `string` | -| `prepareStackTrace`? | (`err`, `stackTraces`) => `any` | -| `static` `stackTraceLimit` | `number` | +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `public` | `message` | `string` | - | Error.message | +| `public` | `name` | `string` | - | Error.name | +| `public` | `stack?` | `string` | - | Error.stack | +| `static` | `prepareStackTrace?` | (`err`, `stackTraces`) => `any` | - | Error.prepareStackTrace | +| `static` | `stackTraceLimit` | `number` | - | Error.stackTraceLimit | ## Methods -### captureStackTrace +### captureStackTrace() ```ts static captureStackTrace(targetObject, constructorOpt?): void @@ -58,10 +54,6 @@ Create .stack property on a target object | `targetObject` | `object` | | `constructorOpt`? | `Function` | -#### Returns - -`void` - #### Inherited from Error.captureStackTrace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.Queue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md similarity index 54% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.Queue.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md index caf95126fb..30d0da9ac1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.Queue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md @@ -3,52 +3,44 @@ jsApi: true title: "[C] Queue" --- +## Type parameters + +| Parameter | +| :------ | +| `T` | + ## Constructors -### new Queue +### new Queue(elements) ```ts -new Queue(elements?): Queue< T > +new Queue(elements?): Queue ``` -#### Type parameters - -| Parameter | -| :------ | -| `T` | - #### Parameters | Parameter | Type | | :------ | :------ | | `elements`? | `T`[] | -#### Returns - -[`Queue`](Class.Queue.md)< `T` \> - ## Properties -| Property | Type | -| :------ | :------ | -| `private` `#elements` | `T`[] | -| `private` `#headIndex` | `number` | +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `private` | `#elements` | `T`[] | - | +| `private` | `#headIndex` | `number` | - | ## Methods -### dequeue +### dequeue() ```ts dequeue(): T ``` -#### Returns - -`T` - *** -### enqueue +### enqueue() ```ts enqueue(...items): void @@ -60,18 +52,10 @@ enqueue(...items): void | :------ | :------ | | ...`items` | `T`[] | -#### Returns - -`void` - *** -### isEmpty +### isEmpty() ```ts isEmpty(): boolean ``` - -#### Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.ResolveModuleError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md similarity index 53% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.ResolveModuleError.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md index ac67215754..414168ec57 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Class.ResolveModuleError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md @@ -9,7 +9,7 @@ title: "[C] ResolveModuleError" ## Constructors -### new ResolveModuleError +### new ResolveModuleError(code, message) ```ts new ResolveModuleError(code, message): ResolveModuleError @@ -22,28 +22,24 @@ new ResolveModuleError(code, message): ResolveModuleError | `code` | `ResolveModuleErrorCode` | | `message` | `string` | -#### Returns - -[`ResolveModuleError`](Class.ResolveModuleError.md) - #### Overrides Error.constructor ## Properties -| Property | Type | -| :------ | :------ | -| `code` | `ResolveModuleErrorCode` | -| `message` | `string` | -| `name` | `string` | -| `stack`? | `string` | -| `prepareStackTrace`? | (`err`, `stackTraces`) => `any` | -| `static` `stackTraceLimit` | `number` | +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `public` | `code` | `ResolveModuleErrorCode` | - | - | +| `public` | `message` | `string` | - | Error.message | +| `public` | `name` | `string` | - | Error.name | +| `public` | `stack?` | `string` | - | Error.stack | +| `static` | `prepareStackTrace?` | (`err`, `stackTraces`) => `any` | - | Error.prepareStackTrace | +| `static` | `stackTraceLimit` | `number` | - | Error.stackTraceLimit | ## Methods -### captureStackTrace +### captureStackTrace() ```ts static captureStackTrace(targetObject, constructorOpt?): void @@ -58,10 +54,6 @@ Create .stack property on a target object | `targetObject` | `object` | | `constructorOpt`? | `Function` | -#### Returns - -`void` - #### Inherited from Error.captureStackTrace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md new file mode 100644 index 0000000000..5c9ab67b62 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[E] IdentifierKind" + +--- +## Enumeration Members + +| Member | Value | +| :------ | :------ | +| `Declaration` | `4` | +| `Decorator` | `1` | +| `Function` | `2` | +| `Other` | `5` | +| `TypeReference` | `0` | +| `Using` | `3` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.ListenerFlow.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md similarity index 63% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.ListenerFlow.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md index 3f64466436..62fdcb1826 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.ListenerFlow.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md @@ -7,4 +7,4 @@ title: "[E] ListenerFlow" | Member | Value | Description | | :------ | :------ | :------ | -| `NoRecursion` | ``1`` | Do not navigate any containing or referenced type. | +| `NoRecursion` | `1` | Do not navigate any containing or referenced type. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.ModifierFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md similarity index 73% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.ModifierFlags.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md index 7e592bfb92..03ebdab22c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.ModifierFlags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md @@ -7,5 +7,5 @@ title: "[E] ModifierFlags" | Member | Value | | :------ | :------ | -| `Extern` | ``2`` | -| `None` | ``0`` | +| `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 new file mode 100644 index 0000000000..614d83eafd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[E] NodeFlags" + +--- +## Enumeration Members + +| Member | Value | Description | +| :------ | :------ | :------ | +| `DescendantErrorsExamined` | `1` | If this is set, the DescendantHasError bit can be trusted. If this not set,
children need to be visited still to see if DescendantHasError should be
set.

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

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

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

Use TypeSpecScript | +| `DecoratorDeclarationStatement` | `25` | - | +| `DecoratorExpression` | `5` | - | +| `DirectiveExpression` | `6` | - | +| `Doc` | `47` | - | +| `DocErrorsTag` | `51` | - | +| `DocParamTag` | `49` | - | +| `DocReturnsTag` | `50` | - | +| `DocTemplateTag` | `52` | - | +| `DocText` | `48` | - | +| `DocUnknownTag` | `53` | - | +| `EmptyStatement` | `43` | - | +| `EnumMember` | `22` | - | +| `EnumSpreadMember` | `23` | - | +| `EnumStatement` | `21` | - | +| `ExternKeyword` | `35` | - | +| `FunctionDeclarationStatement` | `26` | - | +| `FunctionParameter` | `27` | - | +| `Identifier` | `3` | - | +| `ImportStatement` | `2` | - | +| `InterfaceStatement` | `18` | - | +| `IntersectionExpression` | `29` | - | +| `InvalidStatement` | `44` | - | +| `JsNamespaceDeclaration` | `84` | - | +| `JsSourceFile` | `1` | - | +| `LineComment` | `45` | - | +| `MemberExpression` | `7` | - | +| `ModelExpression` | `14` | - | +| `ModelProperty` | `15` | - | +| `ModelSpreadProperty` | `16` | - | +| `ModelStatement` | `13` | - | +| `NamespaceStatement` | `8` | - | +| `NeverKeyword` | `37` | - | +| `NumericLiteral` | `33` | - | +| `OperationSignatureDeclaration` | `11` | - | +| `OperationSignatureReference` | `12` | - | +| `OperationStatement` | `10` | - | +| `Projection` | `54` | - | +| `ProjectionArithmeticExpression` | `72` | - | +| `ProjectionBlockExpression` | `66` | - | +| `ProjectionCallExpression` | `73` | - | +| `ProjectionDecoratorReferenceExpression` | `82` | - | +| `ProjectionEnumMemberSelector` | `63` | - | +| `ProjectionEnumSelector` | `62` | - | +| `ProjectionEqualityExpression` | `69` | - | +| `ProjectionExpressionStatement` | `64` | - | +| `ProjectionIfExpression` | `65` | - | +| `ProjectionInterfaceSelector` | `61` | - | +| `ProjectionLambdaExpression` | `74` | - | +| `ProjectionLambdaParameterDeclaration` | `75` | - | +| `ProjectionLogicalExpression` | `68` | - | +| `ProjectionMemberExpression` | `67` | - | +| `ProjectionModelExpression` | `76` | - | +| `ProjectionModelProperty` | `77` | - | +| `ProjectionModelPropertySelector` | `57` | - | +| `ProjectionModelSelector` | `56` | - | +| `ProjectionModelSpreadProperty` | `78` | - | +| `ProjectionOperationSelector` | `58` | - | +| `ProjectionParameterDeclaration` | `55` | - | +| `ProjectionReference` | `41` | - | +| `ProjectionRelationalExpression` | `71` | - | +| `ProjectionSpreadProperty` | `79` | - | +| `ProjectionStatement` | `81` | - | +| `ProjectionTupleExpression` | `80` | - | +| `ProjectionUnaryExpression` | `70` | - | +| `ProjectionUnionSelector` | `59` | - | +| `ProjectionUnionVariantSelector` | `60` | - | +| `Return` | `83` | - | +| `ScalarStatement` | `17` | - | +| `StringLiteral` | `32` | - | +| `TemplateParameterDeclaration` | `42` | - | +| `TupleExpression` | `30` | - | +| `TypeReference` | `40` | - | +| `TypeSpecScript` | `0` | - | +| `UnionExpression` | `28` | - | +| `UnionStatement` | `19` | - | +| `UnionVariant` | `20` | - | +| `UnknownKeyword` | `38` | - | +| `UsingStatement` | `9` | - | +| `ValueOfExpression` | `39` | - | +| `VoidKeyword` | `36` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md new file mode 100644 index 0000000000..243ce1b247 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md @@ -0,0 +1,81 @@ +--- +jsApi: true +title: "[E] Token" + +--- +## Enumeration Members + +| Member | Value | +| :------ | :------ | +| `AliasKeyword` | `54` | +| `Ampersand` | `27` | +| `AmpsersandAmpersand` | `42` | +| `At` | `32` | +| `AtAt` | `33` | +| `Bar` | `28` | +| `BarBar` | `43` | +| `CloseBrace` | `15` | +| `CloseBracket` | `19` | +| `CloseParen` | `17` | +| `Colon` | `30` | +| `ColonColon` | `31` | +| `Comma` | `23` | +| `ConflictMarker` | `10` | +| `DecKeyword` | `61` | +| `DocCodeFenceDelimiter` | `13` | +| `DocCodeSpan` | `12` | +| `DocText` | `11` | +| `Dot` | `20` | +| `Ellipsis` | `21` | +| `ElseKeyword` | `59` | +| `EndOfFile` | `2` | +| `EnumKeyword` | `53` | +| `Equals` | `26` | +| `EqualsEquals` | `44` | +| `EqualsGreaterThan` | `46` | +| `Exclamation` | `39` | +| `ExclamationEquals` | `45` | +| `ExtendsKeyword` | `65` | +| `ExternKeyword` | `64` | +| `FalseKeyword` | `67` | +| `FnKeyword` | `62` | +| `ForwardSlash` | `36` | +| `GreaterThan` | `25` | +| `GreaterThanEquals` | `41` | +| `Hash` | `34` | +| `Hyphen` | `38` | +| `Identifier` | `3` | +| `IfKeyword` | `60` | +| `ImportKeyword` | `47` | +| `InterfaceKeyword` | `56` | +| `Invalid` | `1` | +| `IsKeyword` | `55` | +| `LessThan` | `24` | +| `LessThanEquals` | `40` | +| `ModelKeyword` | `48` | +| `MultiLineComment` | `7` | +| `NamespaceKeyword` | `50` | +| `NeverKeyword` | `70` | +| `NewLine` | `8` | +| `None` | `0` | +| `NumericLiteral` | `4` | +| `OpKeyword` | `52` | +| `OpenBrace` | `14` | +| `OpenBracket` | `18` | +| `OpenParen` | `16` | +| `Plus` | `37` | +| `ProjectionKeyword` | `58` | +| `Question` | `29` | +| `ReturnKeyword` | `68` | +| `ScalarKeyword` | `49` | +| `Semicolon` | `22` | +| `SingleLineComment` | `6` | +| `Star` | `35` | +| `StringLiteral` | `5` | +| `TrueKeyword` | `66` | +| `UnionKeyword` | `57` | +| `UnknownKeyword` | `71` | +| `UsingKeyword` | `51` | +| `ValueOfKeyword` | `63` | +| `VoidKeyword` | `69` | +| `Whitespace` | `9` | 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 new file mode 100644 index 0000000000..8d7271c2f7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/TokenFlags.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[E] TokenFlags" + +--- +## Enumeration Members + +| Member | Value | +| :------ | :------ | +| `Backticked` | `32` | +| `DocComment` | `16` | +| `Escaped` | `1` | +| `NonAscii` | `8` | +| `None` | `0` | +| `TripleQuoted` | `2` | +| `Unterminated` | `4` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.UsageFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.UsageFlags.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md index e29c763762..7d619373bf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Enumeration.UsageFlags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md @@ -7,6 +7,6 @@ title: "[E] UsageFlags" | Member | Value | | :------ | :------ | -| `Input` | ``2`` | -| `None` | ``0`` | -| `Output` | ``4`` | +| `Input` | `2` | +| `None` | `0` | +| `Output` | `4` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$deprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md similarity index 61% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$deprecated.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md index 5a3bd1a992..1f236d3e36 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$deprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md @@ -5,9 +5,9 @@ title: "[F] $deprecated" --- ```ts $deprecated( - context, - target, - message): void + context, + target, + message): void ``` Mark a type as deprecated @@ -16,14 +16,12 @@ Mark a type as deprecated | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | DecoratorContext | -| `target` | [`Type`](Type.Type.md) | Decorator target | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | +| `target` | [`Type`](../type-aliases/Type.md) | Decorator target | | `message` | `string` | Deprecation target. | ## Returns -`void` - ## Example ``` @deprecated("Foo is deprecated, use Bar instead.") diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md new file mode 100644 index 0000000000..bdfe685d63 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $discriminator" + +--- +```ts +$discriminator( + context, + entity, + propertyName): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `entity` | [`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md) | +| `propertyName` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$doc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md similarity index 69% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$doc.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md index 7c51189dd3..475f730cad 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$doc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md @@ -5,25 +5,23 @@ title: "[F] $doc" --- ```ts $doc( - context, - target, - text, - sourceObject?): void + context, + target, + text, + sourceObject?): void ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Type`](Type.Type.md) | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.md) | | `text` | `string` | -| `sourceObject`? | [`Type`](Type.Type.md) | +| `sourceObject`? | [`Type`](../type-aliases/Type.md) | ## Returns -`void` - ## Doc attaches a documentation string. Works great with multi-line string literals. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md new file mode 100644 index 0000000000..d50bdac454 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] $encode" + +--- +```ts +$encode( + context, + target, + encoding, + encodeAs?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `encoding` | `string` \| [`EnumMember`](../interfaces/EnumMember.md) | +| `encodeAs`? | [`Scalar`](../interfaces/Scalar.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$error.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md similarity index 63% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$error.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md index 51f911bc37..71c3a59ccc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$error.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md @@ -15,9 +15,5 @@ $error(context, entity): void | Parameter | Type | | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `entity` | [`Model`](Interface.Model.md) | - -## Returns - -`void` +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `entity` | [`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 new file mode 100644 index 0000000000..f02027cde4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $errorsDoc" + +--- +```ts +$errorsDoc( + context, + target, + text): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | +| `text` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$format.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md similarity index 76% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$format.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md index 0a0ac0102d..aba42f8846 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$format.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md @@ -5,9 +5,9 @@ title: "[F] $format" --- ```ts $format( - context, - target, - format): void + context, + target, + format): void ``` `@format` - specify the data format hint for a string type @@ -26,10 +26,6 @@ https://github.com/OAI/OpenAPI-Specification/blob/3.0.3/versions/3.0.3.md#dataTy | Parameter | Type | | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `format` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md new file mode 100644 index 0000000000..6c5bd76f9e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] $friendlyName" + +--- +```ts +$friendlyName( + context, + target, + friendlyName, + sourceObject): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.md) | +| `friendlyName` | `string` | +| `sourceObject` | `undefined` \| [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$indexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$indexer.md new file mode 100644 index 0000000000..2791d63a5c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$indexer.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] $indexer" + +--- +```ts +$indexer( + context, + target, + key, + value): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.md) | +| `key` | [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$inspectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md similarity index 51% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$inspectType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md index efb118f95f..088d923ba7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$inspectType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md @@ -5,19 +5,15 @@ title: "[F] $inspectType" --- ```ts $inspectType( - program, - target, - text): void + program, + target, + text): void ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | | `text` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$inspectTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$inspectTypeName.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md index 997a9bc357..77018500f6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$inspectTypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md @@ -5,19 +5,15 @@ title: "[F] $inspectTypeName" --- ```ts $inspectTypeName( - program, - target, - text): void + program, + target, + text): void ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | | `text` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$key.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$key.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md index 02f9dadc8b..331d541f71 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$key.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md @@ -5,9 +5,9 @@ title: "[F] $key" --- ```ts $key( - context, - entity, - altName?): void + context, + entity, + altName?): void ``` `@key` - mark a model property as the key to identify instances of that type @@ -21,10 +21,6 @@ Otherwise, the name of the target property will be used. | Parameter | Type | | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `entity` | [`ModelProperty`](Interface.ModelProperty.md) | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `entity` | [`ModelProperty`](../interfaces/ModelProperty.md) | | `altName`? | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$knownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md similarity index 53% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$knownValues.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md index 66d72e679e..10a657b425 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$knownValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md @@ -5,9 +5,9 @@ title: "[F] $knownValues" --- ```ts $knownValues( - context, - target, - knownValues): void + context, + target, + knownValues): void ``` `@knownValues` marks a string type with an enum that contains all known values @@ -21,10 +21,6 @@ type accepts. | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | - | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | Decorator target. Must be a string. (model Foo extends string) | -| `knownValues` | [`Enum`](Interface.Enum.md) | Must be an enum. | - -## Returns - -`void` +| `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 new file mode 100644 index 0000000000..108472004d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $list" + +--- +```ts +$list( + context, + target, + listedType?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | +| `listedType`? | [`Type`](../type-aliases/Type.md) | + +## Returns + +## Deprecated + +Use the `listsResource` decorator in `@typespec/rest` instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md new file mode 100644 index 0000000000..0ca3445573 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $maxItems" + +--- +```ts +$maxItems( + context, + target, + maxItems): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `maxItems` | `number` | 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 new file mode 100644 index 0000000000..5d8ef8b159 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $maxLength" + +--- +```ts +$maxLength( + context, + target, + maxLength): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `maxLength` | `number` | 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 new file mode 100644 index 0000000000..82f4133734 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $maxValue" + +--- +```ts +$maxValue( + context, + target, + maxValue): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `maxValue` | `number` | 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 new file mode 100644 index 0000000000..ee5bf5cf7c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $maxValueExclusive" + +--- +```ts +$maxValueExclusive( + context, + target, + maxValueExclusive): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `maxValueExclusive` | `number` | 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 new file mode 100644 index 0000000000..f7e0b08453 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $minItems" + +--- +```ts +$minItems( + context, + target, + minItems): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `minItems` | `number` | 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 new file mode 100644 index 0000000000..830679e218 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $minLength" + +--- +```ts +$minLength( + context, + target, + minLength): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `minLength` | `number` | 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 new file mode 100644 index 0000000000..ec9f11ca69 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $minValue" + +--- +```ts +$minValue( + context, + target, + minValue): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `minValue` | `number` | 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 new file mode 100644 index 0000000000..f1561b20e7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $minValueExclusive" + +--- +```ts +$minValueExclusive( + context, + target, + minValueExclusive): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `minValueExclusive` | `number` | 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 new file mode 100644 index 0000000000..89b66fb489 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] $overload" + +--- +```ts +$overload( + context, + target, + overloadBase): void +``` + +`@overload` - Indicate that the target overloads (specializes) the overloads type. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | +| `target` | [`Operation`](../interfaces/Operation.md) | The specializing operation declaration | +| `overloadBase` | [`Operation`](../interfaces/Operation.md) | The operation to be overloaded. | 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 new file mode 100644 index 0000000000..aba0f8b70e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $parameterVisibility" + +--- +```ts +$parameterVisibility( + context, + entity, ... + visibilities): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `entity` | [`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 new file mode 100644 index 0000000000..c3fb9a3b9f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $pattern" + +--- +```ts +$pattern( + context, + target, + pattern): void +``` + +## 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/Namespace.decorators.Function.$projectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$projectedName.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md index c13ade31e2..169fb96647 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$projectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md @@ -5,10 +5,10 @@ title: "[F] $projectedName" --- ```ts $projectedName( - context, - target, - projectionName, - projectedName): void + context, + target, + projectionName, + projectedName): void ``` `@projectedName` - Indicate that this entity should be renamed according to the given projection. @@ -17,11 +17,7 @@ $projectedName( | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | DecoratorContext | -| `target` | [`Type`](Type.Type.md) | The that should have a different name. | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | +| `target` | [`Type`](../type-aliases/Type.md) | The that should have a different name. | | `projectionName` | `string` | Name of the projection (e.g. "toJson", "toCSharp") | | `projectedName` | `string` | Name of the type should have in the scope of the projection specified. | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md new file mode 100644 index 0000000000..35cc0598dd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $returnTypeVisibility" + +--- +```ts +$returnTypeVisibility( + context, + entity, ... + visibilities): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `entity` | [`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 new file mode 100644 index 0000000000..f7ed8de6ee --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $returnsDoc" + +--- +```ts +$returnsDoc( + context, + target, + text): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | +| `text` | `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 new file mode 100644 index 0000000000..cd98d638c6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[F] $secret" + +--- +```ts +$secret(context, target): void +``` + +Mark a string as a secret value that should be treated carefully to avoid exposure + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](../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 new file mode 100644 index 0000000000..52c1dec7dd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $service" + +--- +```ts +$service( + context, + target, + options?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Namespace`](../interfaces/Namespace.md) | +| `options`? | [`Model`](../interfaces/Model.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$summary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md similarity index 73% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$summary.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md index 945334ae80..f45349711e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$summary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md @@ -5,25 +5,23 @@ title: "[F] $summary" --- ```ts $summary( - context, - target, - text, - sourceObject): void + context, + target, + text, + sourceObject): void ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Type`](Type.Type.md) | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.md) | | `text` | `string` | -| `sourceObject` | [`Type`](Type.Type.md) | +| `sourceObject` | [`Type`](../type-aliases/Type.md) | ## Returns -`void` - ## Summary attaches a documentation string. It is typically used to give a short, single-line diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md new file mode 100644 index 0000000000..b83e33b273 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $tag" + +--- +```ts +$tag( + context, + target, + tag): void +``` + +## 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 new file mode 100644 index 0000000000..bc3da85509 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $visibility" + +--- +```ts +$visibility( + context, + target, ... + visibilities): void +``` + +## 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/Namespace.decorators.Function.$withDefaultKeyVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md similarity index 51% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withDefaultKeyVisibility.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md index 9267565d22..03da558d06 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withDefaultKeyVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md @@ -5,19 +5,15 @@ title: "[F] $withDefaultKeyVisibility" --- ```ts $withDefaultKeyVisibility( - context, - entity, - visibility): void + context, + entity, + visibility): void ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `entity` | [`Model`](Interface.Model.md) | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `entity` | [`Model`](../interfaces/Model.md) | | `visibility` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withOptionalProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withOptionalProperties.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md index 8fe0ce9684..6514fb752d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withOptionalProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md @@ -11,9 +11,5 @@ $withOptionalProperties(context, target): void | Parameter | Type | | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Model`](Interface.Model.md) | - -## Returns - -`void` +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withUpdateableProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md similarity index 58% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withUpdateableProperties.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md index dc783a77d0..5e56bf5553 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withUpdateableProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md @@ -11,9 +11,5 @@ $withUpdateableProperties(context, target): void | Parameter | Type | | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`void` +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.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 new file mode 100644 index 0000000000..ebb9ee34f2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $withVisibility" + +--- +```ts +$withVisibility( + context, + target, ... + visibilities): void +``` + +## 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/Namespace.decorators.Function.$withoutDefaultValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withoutDefaultValues.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md index 690d2cf11e..27aff6f317 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.$withoutDefaultValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md @@ -11,9 +11,5 @@ $withoutDefaultValues(context, target): void | Parameter | Type | | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | -| `target` | [`Model`](Interface.Model.md) | - -## Returns - -`void` +| `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 new file mode 100644 index 0000000000..7a56360362 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $withoutOmittedProperties" + +--- +```ts +$withoutOmittedProperties( + context, + target, + omitProperties): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) | +| `omitProperties` | [`StringLiteral`](../interfaces/StringLiteral.md) \| [`Union`](../interfaces/Union.md) | 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 new file mode 100644 index 0000000000..9cffe02485 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] addService" + +--- +```ts +addService( + program, + namespace, + details): void +``` + +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 new file mode 100644 index 0000000000..442c8893d8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md @@ -0,0 +1,48 @@ +--- +jsApi: true +title: "[F] assertType" + +--- +```ts +assertType( + typeDescription, + t, ... + kinds): asserts t is Object +``` + +Assert that the input type has one of the kinds provided + +## Type parameters + +| Parameter | +| :------ | +| `TKind` extends ( + \| `"Model"` + \| `"ModelProperty"` + \| `"Scalar"` + \| `"Interface"` + \| `"Enum"` + \| `"EnumMember"` + \| `"TemplateParameter"` + \| `"Namespace"` + \| `"Operation"` + \| `"String"` + \| `"Number"` + \| `"Boolean"` + \| `"Tuple"` + \| `"Union"` + \| `"UnionVariant"` + \| `"Intrinsic"` + \| `"Function"` + \| `"Decorator"` + \| `"FunctionParameter"` + \| `"Object"` + \| `"Projection"`)[] | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeDescription` | `string` | +| `t` | [`Type`](../type-aliases/Type.md) | +| ...`kinds` | `TKind` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.cadlTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md similarity index 60% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.cadlTypeToJson.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md index eb21757230..a60c9bd905 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.cadlTypeToJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md @@ -17,13 +17,11 @@ cadlTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] | Parameter | Type | | :------ | :------ | -| `typespecType` | [`TypeSpecValue`](Type.TypeSpecValue.md) | -| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | +| `typespecType` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | +| `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | ## Returns -[`T` \| `undefined`, [`Diagnostic`](Interface.Diagnostic.md)[]] - ## Deprecated use typespecTypeToJson diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.checkFormatCadl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md similarity index 72% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.checkFormatCadl.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md index 616efef818..afb4651df8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.checkFormatCadl.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md @@ -4,7 +4,7 @@ title: "[F] checkFormatCadl" --- ```ts -checkFormatCadl(code, prettierConfig?): Promise< boolean > +checkFormatCadl(code, prettierConfig?): Promise ``` ## Parameters @@ -16,8 +16,6 @@ checkFormatCadl(code, prettierConfig?): Promise< boolean > ## Returns -`Promise`< `boolean` \> - ## Deprecated use checkFormatTypeSpec diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.checkFormatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md similarity index 75% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.checkFormatTypeSpec.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md index 97e661516b..5f196128a0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.checkFormatTypeSpec.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md @@ -4,7 +4,7 @@ title: "[F] checkFormatTypeSpec" --- ```ts -checkFormatTypeSpec(code, prettierConfig?): Promise< boolean > +checkFormatTypeSpec(code, prettierConfig?): Promise ``` Check the given is correctly formatted. @@ -18,6 +18,4 @@ Check the given is correctly formatted. ## Returns -`Promise`< `boolean` \> - true if code is formatted correctly. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md new file mode 100644 index 0000000000..a9f1628c04 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] compile" + +--- +```ts +compile( + host, + mainFile, + options, +oldProgram?): Promise +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `host` | [`CompilerHost`](../interfaces/CompilerHost.md) | +| `mainFile` | `string` | +| `options` | [`CompilerOptions`](../interfaces/CompilerOptions.md) | +| `oldProgram`? | [`Program`](../interfaces/Program.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compilerAssert.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compilerAssert.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md index 6b83a39a91..8b6ece8ba4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.compilerAssert.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md @@ -5,9 +5,9 @@ title: "[F] compilerAssert" --- ```ts compilerAssert( - condition, - message, - target?): asserts condition + condition, + message, + target?): asserts condition ``` Use this to report bugs in the compiler, and not errors in the source code @@ -19,8 +19,4 @@ being compiled. | :------ | :------ | :------ | | `condition` | `any` | Throw if this is not true. | | `message` | `string` | Error message. | -| `target`? | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | Optional location in source code that might give a clue about
what got the compiler off track. | - -## Returns - -`asserts condition` +| `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | Optional location in source code that might give a clue about
what got the compiler off track. | 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 new file mode 100644 index 0000000000..17b0bff948 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] createCadlLibrary" + +--- +```ts +createCadlLibrary(lib): TypeSpecLibrary +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` extends `object` | +| `E` extends `Record`<`string`, `any`\> | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `lib` | `Readonly`<[`TypeSpecLibraryDef`](../interfaces/TypeSpecLibraryDef.md)<`T`, `E`\>\> | + +## Returns + +## Deprecated + +use createTypeSpecLibrary diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createChecker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md similarity index 60% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createChecker.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md index 3210bda969..144c3dd536 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createChecker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md @@ -11,8 +11,4 @@ createChecker(program): Checker | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | - -## Returns - -[`Checker`](Interface.Checker.md) +| `program` | [`Program`](../interfaces/Program.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md new file mode 100644 index 0000000000..cddf71aca0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] createDecoratorDefinition" + +--- +```ts +createDecoratorDefinition(definition): DecoratorValidator +``` + +## Type parameters + +| 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)\> | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `definition` | [`DecoratorDefinition`](../interfaces/DecoratorDefinition.md)<`T`, `P`, `S`\> | + +## Returns + +## Deprecated + +use extern dec definition in typespec instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDiagnosticCollector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md similarity index 76% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDiagnosticCollector.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md index c933f17748..f870b155aa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDiagnosticCollector.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md @@ -11,8 +11,6 @@ Create a new instance of the ## Returns -[`DiagnosticCollector`](Interface.DiagnosticCollector.md) - ## See DiagnosticCollector. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDiagnosticCreator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCreator.md similarity index 67% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDiagnosticCreator.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCreator.md index 965c011b8f..175c187fb3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createDiagnosticCreator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCreator.md @@ -4,7 +4,7 @@ title: "[F] createDiagnosticCreator" --- ```ts -createDiagnosticCreator(diagnostics, libraryName?): DiagnosticCreator< T > +createDiagnosticCreator(diagnostics, libraryName?): DiagnosticCreator ``` Create a new diagnostics creator. @@ -13,19 +13,17 @@ Create a new diagnostics creator. | Parameter | | :------ | -| `T` *extends* \{} | +| `T` extends `object` | ## Parameters | Parameter | Type | Description | | :------ | :------ | :------ | -| `diagnostics` | [`DiagnosticMap`](Type.DiagnosticMap.md)< `T` \> | Map of the potential diagnostics. | +| `diagnostics` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | Map of the potential diagnostics. | | `libraryName`? | `string` | Optional name of the library if in the scope of a library. | ## Returns -[`DiagnosticCreator`](Interface.DiagnosticCreator.md)< `T` \> - ## See DiagnosticCreator diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createProjectedNameProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md similarity index 76% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createProjectedNameProgram.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md index 7f46e7288c..ba640225c0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createProjectedNameProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md @@ -13,11 +13,9 @@ Create an helper to manager project names. | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | +| `program` | [`Program`](../interfaces/Program.md) | Program | | `target` | `string` | Name of the projected name target(e.g. json, csharp, etc.) | ## Returns -[`ProjectedNameView`](Interface.ProjectedNameView.md) - ProjectedNameView diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRekeyableMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRekeyableMap.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md index c88363e637..14c7931fc2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createRekeyableMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md @@ -4,7 +4,7 @@ title: "[F] createRekeyableMap" --- ```ts -createRekeyableMap(entries?): RekeyableMap< K, V > +createRekeyableMap(entries?): RekeyableMap ``` ## Type parameters @@ -19,7 +19,3 @@ createRekeyableMap(entries?): RekeyableMap< K, V > | Parameter | Type | | :------ | :------ | | `entries`? | [`K`, `V`][] | - -## Returns - -`RekeyableMap`< `K`, `V` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md new file mode 100644 index 0000000000..9b37791fab --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] createRule" + +--- +```ts +createRule(definition): LinterRuleDefinition +``` + +Create a new linter rule. + +## Type parameters + +| Parameter | +| :------ | +| `N` extends `string` | +| `T` extends [`DiagnosticMessages`](../interfaces/DiagnosticMessages.md) | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `definition` | [`LinterRuleDefinition`](../interfaces/LinterRuleDefinition.md)<`N`, `T`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md new file mode 100644 index 0000000000..dc2fe545df --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] createScanner" + +--- +```ts +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/Function.createServer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md similarity index 59% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createServer.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md index cd4d7ac87b..78f5971e55 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createServer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md @@ -11,8 +11,4 @@ createServer(host): Server | Parameter | Type | | :------ | :------ | -| `host` | [`ServerHost`](Interface.ServerHost.md) | - -## Returns - -[`Server`](Interface.Server.md) +| `host` | [`ServerHost`](../interfaces/ServerHost.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createSourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createSourceFile.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md index 3ba5c62dc7..ca075aa5b0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createSourceFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md @@ -13,7 +13,3 @@ createSourceFile(text, path): SourceFile | :------ | :------ | | `text` | `string` | | `path` | `string` | - -## Returns - -[`SourceFile`](Interface.SourceFile.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.md new file mode 100644 index 0000000000..15b436490e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] createStateAccessors" + +--- +```ts +createStateAccessors( + stateMaps, + stateSets, + projector?): object +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `stateMaps` | `Map`<`symbol`, `StateMap`\> | +| `stateSets` | `Map`<`symbol`, `StateSet`\> | +| `projector`? | [`Projector`](../interfaces/Projector.md) | + +## Returns + +> | Member | Type | Description | +> | :------ | :------ | :------ | +> | `stateMap` | <`T`\>(`key`) => `StateMapView`<`T`\> | - | +> | `stateSet` | (`key`) => `StateSetView` | - | +> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createTypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createTypeSpecLibrary.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md index fcf9f3855f..0a1733d425 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.createTypeSpecLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md @@ -4,7 +4,7 @@ title: "[F] createTypeSpecLibrary" --- ```ts -createTypeSpecLibrary(lib): TypeSpecLibrary< T, E > +createTypeSpecLibrary(lib): TypeSpecLibrary ``` Create a new TypeSpec library definition. @@ -13,19 +13,17 @@ Create a new TypeSpec library definition. | Parameter | | :------ | -| `T` *extends* \{} | -| `E` *extends* `Record`< `string`, `any` \> | +| `T` extends `object` | +| `E` extends `Record`<`string`, `any`\> | ## Parameters | Parameter | Type | Description | | :------ | :------ | :------ | -| `lib` | `Readonly`< [`TypeSpecLibraryDef`](Interface.TypeSpecLibraryDef.md)< `T`, `E` \> \> | Library definition. | +| `lib` | `Readonly`<[`TypeSpecLibraryDef`](../interfaces/TypeSpecLibraryDef.md)<`T`, `E`\>\> | Library definition. | ## Returns -[`TypeSpecLibrary`](Interface.TypeSpecLibrary.md)< `T`, `E` \> - Library with utility functions. ## Tutorial diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md new file mode 100644 index 0000000000..1d93bf262d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[F] emitFile" + +--- +```ts +emitFile(program, options): Promise +``` + +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/Function.ensureTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ensureTrailingDirectorySeparator.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md index 12e9afcd7c..cb8b71253a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ensureTrailingDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md @@ -12,7 +12,3 @@ ensureTrailingDirectorySeparator(path): string | Parameter | Type | | :------ | :------ | | `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.filterModelProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.filterModelProperties.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md index e481d5c69e..761b39fffa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.filterModelProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md @@ -5,9 +5,9 @@ title: "[F] filterModelProperties" --- ```ts filterModelProperties( - program, - model, - filter): Model + program, + model, + filter): Model ``` Applies a filter to the properties of a given type. If no properties @@ -18,10 +18,6 @@ a new anonymous model with only the filtered properties. | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) \| [`ProjectedProgram`](Interface.ProjectedProgram.md) | - | -| `model` | [`Model`](Interface.Model.md) | The input model to filter. | +| `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | - | +| `model` | [`Model`](../interfaces/Model.md) | The input model to filter. | | `filter` | (`property`) => `boolean` | The filter to apply. Properties are kept when this returns true. | - -## Returns - -[`Model`](Interface.Model.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.finishTypeForProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.finishTypeForProgram.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md index a0986d9f25..5ad29fb270 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.finishTypeForProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md @@ -11,15 +11,11 @@ finishTypeForProgram(program, typeDef): T | Parameter | | :------ | -| `T` *extends* [`Type`](Type.Type.md) | +| `T` extends [`Type`](../type-aliases/Type.md) | ## Parameters | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | +| `program` | [`Program`](../interfaces/Program.md) | | `typeDef` | `T` | - -## Returns - -`T` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatDiagnostic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md similarity index 65% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatDiagnostic.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md index cf8eb54094..6547ba8c69 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatDiagnostic.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md @@ -11,8 +11,4 @@ formatDiagnostic(diagnostic): string | Parameter | Type | | :------ | :------ | -| `diagnostic` | [`Diagnostic`](Interface.Diagnostic.md) | - -## Returns - -`string` +| `diagnostic` | [`Diagnostic`](../interfaces/Diagnostic.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatIdentifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md similarity index 88% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatIdentifier.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md index 484f24d9be..5d9b2fb07b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatIdentifier.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md @@ -12,7 +12,3 @@ formatIdentifier(sv): string | Parameter | Type | | :------ | :------ | | `sv` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md similarity index 65% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatTypeSpec.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md index 4448ae18d6..192a98bad0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.formatTypeSpec.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md @@ -4,7 +4,7 @@ title: "[F] formatTypeSpec" --- ```ts -formatTypeSpec(code, prettierConfig?): Promise< string > +formatTypeSpec(code, prettierConfig?): Promise ``` ## Parameters @@ -13,7 +13,3 @@ formatTypeSpec(code, prettierConfig?): Promise< string > | :------ | :------ | | `code` | `string` | | `prettierConfig`? | `Options` | - -## Returns - -`Promise`< `string` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md new file mode 100644 index 0000000000..84842b3203 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] getAllTags" + +--- +```ts +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/Function.getAnyExtensionFromPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md similarity index 95% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getAnyExtensionFromPath.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md index 47d49049a0..926dfc20bb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getAnyExtensionFromPath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md @@ -22,7 +22,3 @@ getAnyExtensionFromPath("/path/to.ext/file") === "" | Parameter | Type | | :------ | :------ | | `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getBaseFileName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md similarity index 98% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getBaseFileName.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md index aa73d5729e..098a86d805 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getBaseFileName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md @@ -40,7 +40,3 @@ getBaseFileName("file://") === "" | Parameter | Type | | :------ | :------ | | `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDeprecated.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md index fd9acc9311..e4892a5c03 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md @@ -13,9 +13,5 @@ Return the deprecated message or undefined if not deprecated | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `type` | [`Type`](Type.Type.md) | Type | - -## Returns - -`string` \| `undefined` +| `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/Function.getDeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md similarity index 53% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDeprecationDetails.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md index a9a9efbcc0..20c3d97981 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDeprecationDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md @@ -13,9 +13,5 @@ Returns complete deprecation details for the given type or node | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `typeOrNode` | [`Node`](Type.Node.md) \| [`Type`](Type.Type.md) | A Type or Node to check for deprecation | - -## Returns - -[`DeprecationDetails`](Interface.DeprecationDetails.md) \| `undefined` +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `typeOrNode` | [`Node`](../type-aliases/Node.md) \| [`Type`](../type-aliases/Type.md) | A Type or Node to check for deprecation | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDirectoryPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md similarity index 88% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDirectoryPath.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md index 07d5e1a5a9..09e9fb5c6d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getDirectoryPath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md @@ -12,7 +12,3 @@ getDirectoryPath(path): string | Parameter | Type | | :------ | :------ | | `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md new file mode 100644 index 0000000000..7a83bf4fa8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[F] getDiscriminatedTypes" + +--- +```ts +getDiscriminatedTypes(program): [Model | Union, Discriminator][] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md new file mode 100644 index 0000000000..c36f6f8f93 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] getDiscriminatedUnion" + +--- +```ts +getDiscriminatedUnion(type, discriminator): [DiscriminatedUnion, readonly Diagnostic[]] +``` + +## 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 new file mode 100644 index 0000000000..1724d156b9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] getDiscriminator" + +--- +```ts +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/Namespace.decorators.Function.getDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md similarity index 66% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDoc.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md index 75ba1fd04a..2b08b48af4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md @@ -13,11 +13,9 @@ Get the documentation string for the given type. | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `target` | [`Type`](Type.Type.md) | Type | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Type`](../type-aliases/Type.md) | Type | ## Returns -`string` \| `undefined` - Documentation value diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md similarity index 53% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDocData.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md index 2ff77ded31..900ff26995 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getDocData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md @@ -7,17 +7,15 @@ title: "[F] getDocData" getDocData(program, target): DocData | undefined ``` -Get the documentation information for the given type. In most cases you probably just want to use [getDoc](Namespace.decorators.Function.getDoc.md) +Get the documentation information for the given type. In most cases you probably just want to use [getDoc](getDoc.md) ## Parameters | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `target` | [`Type`](Type.Type.md) | Type | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Type`](../type-aliases/Type.md) | Type | ## Returns -[`DocData`](Namespace.decorators.Interface.DocData.md) \| `undefined` - Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.md new file mode 100644 index 0000000000..c73a26414a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] getDocDataInternal" + +--- +```ts +getDocDataInternal( + program, + target, + key): DocData | undefined +``` + +Get the documentation information for the given type. In most cases you probably just want to use [getDoc](getDoc.md) + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Type`](../type-aliases/Type.md) | Type | +| `key` | `DocTarget` | - | + +## Returns + +Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getEffectiveModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md similarity index 81% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getEffectiveModelType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md index cf27613ea0..2d275dcb46 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getEffectiveModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md @@ -5,9 +5,9 @@ title: "[F] getEffectiveModelType" --- ```ts getEffectiveModelType( - program, - model, - filter?): Model + program, + model, + filter?): Model ``` If the input is anonymous (or the provided filter removes properties) @@ -25,10 +25,6 @@ best name for the remaining properties is `SomeName`. | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | - | -| `model` | [`Model`](Interface.Model.md) | The input model | +| `program` | [`Program`](../interfaces/Program.md) | - | +| `model` | [`Model`](../interfaces/Model.md) | The input model | | `filter`? | (`property`) => `boolean` | An optional filter to apply to the input model's
properties. | - -## Returns - -[`Model`](Interface.Model.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md new file mode 100644 index 0000000000..5ecc32b123 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] getEncode" + +--- +```ts +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/getErrorsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md new file mode 100644 index 0000000000..b378e4f8a0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getErrorsDoc" + +--- +```ts +getErrorsDoc(program, target): string | undefined +``` + +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 | + +## Returns + +Documentation value diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md new file mode 100644 index 0000000000..8195cd85be --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getErrorsDocData" + +--- +```ts +getErrorsDocData(program, target): DocData | undefined +``` + +Get the documentation information for the return errors types of an operation. In most cases you probably just want to use [getErrorsDoc](getErrorsDoc.md) + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Operation`](../interfaces/Operation.md) | Type | + +## Returns + +Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getFirstAncestor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getFirstAncestor.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md index 6747712295..9693bad1a2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getFirstAncestor.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md @@ -11,9 +11,5 @@ getFirstAncestor(node, test): Node | undefined | Parameter | Type | | :------ | :------ | -| `node` | [`Node`](Type.Node.md) | -| `test` | [`NodeCallback`](Type.NodeCallback.md)< `boolean` \> | - -## Returns - -[`Node`](Type.Node.md) \| `undefined` +| `node` | [`Node`](../type-aliases/Node.md) | +| `test` | [`NodeCallback`](../type-aliases/NodeCallback.md)<`boolean`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getFormat.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md index 8b88111615..fa56fe4d5b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getFormat.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md @@ -11,9 +11,5 @@ getFormat(program, target): string | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`string` \| `undefined` +| `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/Namespace.decorators.Function.getFriendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md similarity index 59% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getFriendlyName.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md index bd3521c0d1..e4505f13ff 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getFriendlyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md @@ -11,9 +11,5 @@ getFriendlyName(program, target): string | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`string` +| `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/Function.getFullyQualifiedSymbolName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getFullyQualifiedSymbolName.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md index c909a6b6a7..401e425dc3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getFullyQualifiedSymbolName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md @@ -11,10 +11,6 @@ getFullyQualifiedSymbolName(sym, options?): string | Parameter | Type | | :------ | :------ | -| `sym` | `undefined` \| [`Sym`](Interface.Sym.md) | +| `sym` | `undefined` \| [`Sym`](../interfaces/Sym.md) | | `options`? | `object` | | `options.useGlobalPrefixAtTopLevel`? | `boolean` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getIdentifierContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md similarity index 57% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getIdentifierContext.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md index 98912a8d24..e3ca1cce9e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getIdentifierContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md @@ -11,8 +11,4 @@ getIdentifierContext(id): IdentifierContext | Parameter | Type | | :------ | :------ | -| `id` | [`IdentifierNode`](Interface.IdentifierNode.md) | - -## Returns - -[`IdentifierContext`](Interface.IdentifierContext.md) +| `id` | [`IdentifierNode`](../interfaces/IdentifierNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getIndexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIndexer.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getIndexer.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIndexer.md index faa83b1a59..4863028569 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getIndexer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIndexer.md @@ -11,9 +11,5 @@ getIndexer(program, target): ModelIndexer | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -[`ModelIndexer`](Type.ModelIndexer.md) \| `undefined` +| `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/Namespace.decorators.Function.getKeyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getKeyName.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md index 39f8adf52c..e2a70b9377 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getKeyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md @@ -11,9 +11,5 @@ getKeyName(program, property): string | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `property` | [`ModelProperty`](Interface.ModelProperty.md) | - -## Returns - -`string` +| `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 new file mode 100644 index 0000000000..cbd810f433 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] getKnownValues" + +--- +```ts +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/Namespace.decorators.Function.getListOperationType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md similarity index 67% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getListOperationType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md index e787aa0161..1fe0e816cd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getListOperationType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md @@ -11,13 +11,11 @@ getListOperationType(program, target): Model | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | ## Returns -[`Model`](Interface.Model.md) \| `undefined` - ## Deprecated This function is unused and will be removed in a future release. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md similarity index 50% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getLocationContext.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md index 0a11bb3488..777afc5f40 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md @@ -11,9 +11,5 @@ getLocationContext(program, type): LocationContext | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `type` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | - -## Returns - -[`LocationContext`](Type.LocationContext.md) +| `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/Namespace.decorators.Function.getMaxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxItems.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md index 83972eb67e..7cb3e4d67d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md @@ -11,9 +11,5 @@ getMaxItems(program, target): number | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`number` \| `undefined` +| `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/Namespace.decorators.Function.getMaxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md similarity index 57% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxLength.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md index abe61ac08d..a50ec1b3df 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md @@ -11,9 +11,5 @@ getMaxLength(program, target): number | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`number` \| `undefined` +| `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/Namespace.decorators.Function.getMaxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxValue.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md index 10b64f280a..2d479ac26b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md @@ -11,9 +11,5 @@ getMaxValue(program, target): number | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`number` \| `undefined` +| `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/Namespace.decorators.Function.getMaxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md similarity index 59% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxValueExclusive.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md index 03b40a26ba..959c9a34cc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMaxValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md @@ -11,9 +11,5 @@ getMaxValueExclusive(program, target): number | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`number` \| `undefined` +| `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/Namespace.decorators.Function.getMinItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinItems.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md index cf2d940da6..7870992962 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md @@ -11,9 +11,5 @@ getMinItems(program, target): number | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`number` \| `undefined` +| `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/Namespace.decorators.Function.getMinLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md similarity index 57% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinLength.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md index b1eee89b45..c9744ceb9b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md @@ -11,9 +11,5 @@ getMinLength(program, target): number | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`number` \| `undefined` +| `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/Namespace.decorators.Function.getMinValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinValue.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md index c80dc57e78..207797213c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md @@ -11,9 +11,5 @@ getMinValue(program, target): number | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`number` \| `undefined` +| `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/Namespace.decorators.Function.getMinValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md similarity index 59% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinValueExclusive.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md index d2f63bd2dc..4757f840bb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getMinValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md @@ -11,9 +11,5 @@ getMinValueExclusive(program, target): number | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`number` \| `undefined` +| `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/Function.getNamespaceFullName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md similarity index 63% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNamespaceFullName.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md index 59a3232f20..082647b9f4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNamespaceFullName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md @@ -13,9 +13,7 @@ Return the full name of the namespace(e.g. "Foo.Bar") | Parameter | Type | Description | | :------ | :------ | :------ | -| `type` | [`Namespace`](Interface.Namespace.md) | namespace type | -| `options`? | [`TypeNameOptions`](Interface.TypeNameOptions.md) | | +| `type` | [`Namespace`](../interfaces/Namespace.md) | namespace type | +| `options`? | [`TypeNameOptions`](../interfaces/TypeNameOptions.md) | | ## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNodeAtPosition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNodeAtPosition.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md index ad9349f97c..1f6ad69ebb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNodeAtPosition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md @@ -3,48 +3,44 @@ jsApi: true title: "[F] getNodeAtPosition" --- +## getNodeAtPosition(script, position, filter) + ```ts getNodeAtPosition( - script, - position, - filter?): Node | undefined + script, + position, + filter?): Node | undefined ``` Resolve the node in the syntax tree that that is at the given position. -## Parameters +### Parameters | Parameter | Type | Description | | :------ | :------ | :------ | -| `script` | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | TypeSpec Script node | +| `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | TypeSpec Script node | | `position` | `number` | Position | | `filter`? | (`node`) => `boolean` | Filter if wanting to return a parent containing node early. | -## Returns - -[`Node`](Type.Node.md) \| `undefined` +## getNodeAtPosition(script, position, filter) ```ts getNodeAtPosition( - script, - position, - filter): T | undefined + script, + position, + filter): T | undefined ``` -## Type parameters +### Type parameters | Parameter | | :------ | -| `T` *extends* [`Node`](Type.Node.md) | +| `T` extends [`Node`](../type-aliases/Node.md) | -## Parameters +### Parameters | Parameter | Type | | :------ | :------ | -| `script` | [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) | +| `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | | `position` | `number` | | `filter` | (`node`) => `node is T` | - -## Returns - -`T` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedAbsolutePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md similarity index 92% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedAbsolutePath.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md index d3bc953a88..b99530643f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedAbsolutePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md @@ -13,7 +13,3 @@ getNormalizedAbsolutePath(fileName, currentDirectory): string | :------ | :------ | | `fileName` | `string` | | `currentDirectory` | `undefined` \| `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedAbsolutePathWithoutRoot.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md similarity index 92% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedAbsolutePathWithoutRoot.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md index 7c149fe73e..775cb25199 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedAbsolutePathWithoutRoot.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md @@ -13,7 +13,3 @@ getNormalizedAbsolutePathWithoutRoot(fileName, currentDirectory): string | :------ | :------ | | `fileName` | `string` | | `currentDirectory` | `undefined` \| `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md similarity index 96% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedPathComponents.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md index 24d43d93f9..ba4aa440f8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getNormalizedPathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md @@ -22,7 +22,3 @@ getNormalizedPathComponents("to/dir/../file.ext", "/path/") === ["/", "path", "t | :------ | :------ | | `path` | `string` | | `currentDirectory` | `undefined` \| `string` | - -## Returns - -`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getOverloadedOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md similarity index 61% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getOverloadedOperation.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md index 4dd8aa5cdc..44a24c99ba 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getOverloadedOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md @@ -13,11 +13,9 @@ If the given operation overloads another operation, return that operation. | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `operation` | [`Operation`](Interface.Operation.md) | The operation to check for an overload target. | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `operation` | [`Operation`](../interfaces/Operation.md) | The operation to check for an overload target. | ## Returns -[`Operation`](Interface.Operation.md) \| `undefined` - The operation this operation overloads, if any. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getOverloads.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getOverloads.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md index d7a0a7c7d0..82cc080bd7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getOverloads.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md @@ -13,11 +13,9 @@ Get all operations that are marked as overloads of the given operation | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `operation` | [`Operation`](Interface.Operation.md) | Operation | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `operation` | [`Operation`](../interfaces/Operation.md) | Operation | ## Returns -[`Operation`](Interface.Operation.md)[] \| `undefined` - An array of operations that overload the given operation. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getOverriddenProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md similarity index 67% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getOverriddenProperty.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md index 7a59d55698..cb2984a2aa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getOverriddenProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md @@ -14,8 +14,4 @@ given property, if any. | Parameter | Type | | :------ | :------ | -| `property` | [`ModelProperty`](Interface.ModelProperty.md) | - -## Returns - -[`ModelProperty`](Interface.ModelProperty.md) \| `undefined` +| `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getParameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md similarity index 60% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getParameterVisibility.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md index 625682597e..47ea057c94 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getParameterVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md @@ -13,13 +13,11 @@ Returns the visibilities of the parameters of the given operation, if provided w | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `entity` | [`Operation`](Interface.Operation.md) | +| `program` | [`Program`](../interfaces/Program.md) | +| `entity` | [`Operation`](../interfaces/Operation.md) | ## Returns -`string`[] \| `undefined` - ## See -[$parameterVisibility](Namespace.decorators.Function.$parameterVisibility.md) +[$parameterVisibility]($parameterVisibility.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getParentTemplateNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md similarity index 66% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getParentTemplateNode.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md index 38206d1e43..6018d40cec 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getParentTemplateNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md @@ -13,10 +13,8 @@ Lookup and find the node | Parameter | Type | Description | | :------ | :------ | :------ | -| `node` | [`Node`](Type.Node.md) | Node | +| `node` | [`Node`](../type-aliases/Node.md) | Node | ## Returns -[`Node`](Type.Node.md) & [`TemplateDeclarationNode`](Interface.TemplateDeclarationNode.md) \| `undefined` - Template Parent node if applicable diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md similarity index 95% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getPathComponents.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md index 8a47e958d3..311769b9f8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getPathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md @@ -4,7 +4,7 @@ title: "[F] getPathComponents" --- ```ts -getPathComponents(path, currentDirectory = ""): string[] +getPathComponents(path, currentDirectory): string[] ``` Parse a path into an array containing a root component (at index 0) and zero or more path @@ -43,7 +43,3 @@ getPathComponents("file://") === ["file://"] | :------ | :------ | :------ | | `path` | `string` | `undefined` | | `currentDirectory` | `string` | `""` | - -## Returns - -`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getPathFromPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md similarity index 85% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getPathFromPathComponents.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md index a4deec30ed..5a94cdbcc3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getPathFromPathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md @@ -18,8 +18,4 @@ getPathFromPathComponents(["/", "path", "to", "file.ext"]) === "/path/to/file.ex | Parameter | Type | | :------ | :------ | -| `pathComponents` | *readonly* `string`[] | - -## Returns - -`string` +| `pathComponents` | readonly `string`[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getPattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getPattern.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md index be61239a5d..a576476ddc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getPattern.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md @@ -11,9 +11,5 @@ getPattern(program, target): string | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`string` \| `undefined` +| `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/Namespace.decorators.Function.getProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md similarity index 62% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getProjectedName.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md index 68a1e47a8c..4ec1c9bdd7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getProjectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md @@ -5,9 +5,9 @@ title: "[F] getProjectedName" --- ```ts getProjectedName( - program, - target, - projectionName): string | undefined + program, + target, + projectionName): string | undefined ``` Get the projected name of the given entity for the given projection. @@ -16,12 +16,10 @@ Get the projected name of the given entity for the given projection. | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `target` | [`Type`](Type.Type.md) | Target | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Type`](../type-aliases/Type.md) | Target | | `projectionName` | `string` | - | ## Returns -`string` \| `undefined` - Projected name for the given projection diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md new file mode 100644 index 0000000000..d0148033fb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getProjectedNames" + +--- +```ts +getProjectedNames(program, target): ReadonlyMap | undefined +``` + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Type`](../type-aliases/Type.md) | Target | + +## Returns + +Map of the projected names for the given entity. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md similarity index 63% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getProperty.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md index cbfd42c2fb..4f0e4322e5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md @@ -11,9 +11,5 @@ getProperty(type, propertyName): ModelProperty | undefined | Parameter | Type | | :------ | :------ | -| `type` | [`Model`](Interface.Model.md) | +| `type` | [`Model`](../interfaces/Model.md) | | `propertyName` | `string` | - -## Returns - -[`ModelProperty`](Interface.ModelProperty.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getPropertyType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md similarity index 60% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getPropertyType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md index 9b82067b77..07dcdac223 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getPropertyType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md @@ -13,8 +13,4 @@ Return the type of the property or the model itself. | Parameter | Type | | :------ | :------ | -| `target` | [`ModelProperty`](Interface.ModelProperty.md) \| [`Scalar`](Interface.Scalar.md) | - -## Returns - -[`Type`](Type.Type.md) +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getRelativePathFromDirectory.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getRelativePathFromDirectory.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md index 94249fba31..9543c34627 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getRelativePathFromDirectory.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md @@ -3,16 +3,18 @@ jsApi: true title: "[F] getRelativePathFromDirectory" --- +## getRelativePathFromDirectory(from, to, ignoreCase) + ```ts getRelativePathFromDirectory( - from, - to, - ignoreCase): string + from, + to, + ignoreCase): string ``` Gets a relative path that can be used to traverse between `from` and `to`. -## Parameters +### Parameters | Parameter | Type | | :------ | :------ | @@ -20,27 +22,21 @@ Gets a relative path that can be used to traverse between `from` and `to`. | `to` | `string` | | `ignoreCase` | `boolean` | -## Returns - -`string` +## getRelativePathFromDirectory(fromDirectory, to, getCanonicalFileName) ```ts getRelativePathFromDirectory( - fromDirectory, - to, - getCanonicalFileName): string + fromDirectory, + to, + getCanonicalFileName): string ``` Gets a relative path that can be used to traverse between `from` and `to`. -## Parameters +### Parameters | Parameter | Type | | :------ | :------ | | `fromDirectory` | `string` | | `to` | `string` | | `getCanonicalFileName` | `GetCanonicalFileName` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getReturnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md similarity index 60% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getReturnTypeVisibility.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md index 5673d6495c..d9b693307b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getReturnTypeVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md @@ -13,13 +13,11 @@ Returns the visibilities of the return type of the given operation, if provided | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `entity` | [`Operation`](Interface.Operation.md) | +| `program` | [`Program`](../interfaces/Program.md) | +| `entity` | [`Operation`](../interfaces/Operation.md) | ## Returns -`string`[] \| `undefined` - ## See -[$returnTypeVisibility](Namespace.decorators.Function.$returnTypeVisibility.md) +[$returnTypeVisibility]($returnTypeVisibility.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md new file mode 100644 index 0000000000..57cbc718ae --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getReturnsDoc" + +--- +```ts +getReturnsDoc(program, target): string | undefined +``` + +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 | + +## Returns + +Documentation value diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md new file mode 100644 index 0000000000..dfb32ab10d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getReturnsDocData" + +--- +```ts +getReturnsDocData(program, target): DocData | undefined +``` + +Get the documentation information for the return success types of an operation. In most cases you probably just want to use [getReturnsDoc](getReturnsDoc.md) + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Operation`](../interfaces/Operation.md) | Type | + +## Returns + +Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getRootLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md similarity index 98% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getRootLength.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md index de62b4b5ab..146e8f71c4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getRootLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md @@ -36,7 +36,3 @@ getRootLength("http://server/path") === 14 // "http://server/" | Parameter | Type | | :------ | :------ | | `path` | `string` | - -## Returns - -`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md similarity index 61% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getService.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md index 8e96397c94..dac6220099 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md @@ -13,11 +13,9 @@ Get the service information for the given namespace. | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `namespace` | [`Namespace`](Interface.Namespace.md) | Service namespace | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `namespace` | [`Namespace`](../interfaces/Namespace.md) | Service namespace | ## Returns -[`Service`](Namespace.decorators.Interface.Service.md) \| `undefined` - Service information or undefined if namespace is not a service namespace. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceFileKindFromExt.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md similarity index 74% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceFileKindFromExt.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md index 9a0a0edeef..0519c5c2e0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.getSourceFileKindFromExt.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md @@ -12,7 +12,3 @@ getSourceFileKindFromExt(path): SourceFileKind | undefined | Parameter | Type | | :------ | :------ | | `path` | `string` | - -## Returns - -[`SourceFileKind`](Type.SourceFileKind.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md new file mode 100644 index 0000000000..8715826c64 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md @@ -0,0 +1,43 @@ +--- +jsApi: true +title: "[F] getSourceLocation" + +--- +## getSourceLocation(target, options) + +```ts +getSourceLocation(target, options?): SourceLocation +``` + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | +| `options`? | [`SourceLocationOptions`](../interfaces/SourceLocationOptions.md) | + +## getSourceLocation(target, options) + +```ts +getSourceLocation(target, options?): undefined +``` + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | `undefined` \| *typeof* [`NoTarget`](../variables/NoTarget.md) | +| `options`? | [`SourceLocationOptions`](../interfaces/SourceLocationOptions.md) | + +## getSourceLocation(target, options) + +```ts +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/Namespace.decorators.Function.getSummary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getSummary.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md index 617350f6b6..2d75b04224 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getSummary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md @@ -11,9 +11,5 @@ getSummary(program, type): string | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `type` | [`Type`](Type.Type.md) | - -## Returns - -`string` \| `undefined` +| `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/Namespace.decorators.Function.getTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getTags.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md index afb2bc5f14..5abc746d9f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getTags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md @@ -11,9 +11,5 @@ getTags(program, target): string[] | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`string`[] +| `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 new file mode 100644 index 0000000000..f0afc39009 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] getTypeName" + +--- +```ts +getTypeName(type, options?): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](../type-aliases/Type.md) \| [`ValueType`](../interfaces/ValueType.md) | +| `options`? | [`TypeNameOptions`](../interfaces/TypeNameOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md similarity index 57% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getVisibility.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md index 071b0b7d4e..d1f4c4ff4a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.getVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md @@ -11,9 +11,5 @@ getVisibility(program, target): string[] | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`string`[] \| `undefined` +| `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/Function.hasParseError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md similarity index 69% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.hasParseError.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md index 84b05293e3..a79a0b6c81 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.hasParseError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md @@ -11,8 +11,4 @@ hasParseError(node): number | true | Parameter | Type | | :------ | :------ | -| `node` | [`Node`](Type.Node.md) | - -## Returns - -`number` \| `true` +| `node` | [`Node`](../type-aliases/Node.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.hasProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.hasProjectedName.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md index c868a22f2d..d4adfd20dd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.hasProjectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md @@ -5,9 +5,9 @@ title: "[F] hasProjectedName" --- ```ts hasProjectedName( - program, - target, - projectionName): boolean + program, + target, + projectionName): boolean ``` Get the projected name of the given entity for the given projection. @@ -16,12 +16,10 @@ Get the projected name of the given entity for the given projection. | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `target` | [`Type`](Type.Type.md) | Target | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Type`](../type-aliases/Type.md) | Target | | `projectionName` | `string` | - | ## Returns -`boolean` - Projected name for the given projection diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.hasTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md similarity index 92% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.hasTrailingDirectorySeparator.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md index 58c9568e47..9c12615003 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.hasTrailingDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md @@ -14,7 +14,3 @@ Determines whether a path has a trailing separator (`/` or `\\`). | Parameter | Type | | :------ | :------ | | `path` | `string` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ignoreDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md similarity index 81% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ignoreDiagnostics.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md index ab8e47c7f5..cce487fbd2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.ignoreDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md @@ -19,10 +19,8 @@ Ignore the diagnostics emitted by the diagnostic accessor pattern and just retur | Parameter | Type | | :------ | :------ | -| `result` | [`DiagnosticResult`](Type.DiagnosticResult.md)< `T` \> | +| `result` | [`DiagnosticResult`](../type-aliases/DiagnosticResult.md)<`T`\> | ## Returns -`T` - Actual result. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.interpolatePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.interpolatePath.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md index dd81676052..313652ce1b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.interpolatePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md @@ -14,8 +14,6 @@ Interpolate a path template | Parameter | Type | Description | | :------ | :------ | :------ | | `pathTemplate` | `string` | Path template | -| `predefinedVariables` | `Record`< `string`, `undefined` \| `string` \> | Variables that can be used in the path template. | +| `predefinedVariables` | `Record`<`string`, `undefined` \| `string`\> | Variables that can be used in the path template. | ## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isAnyDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isAnyDirectorySeparator.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md index abee4537eb..409e3f1606 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isAnyDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md @@ -14,7 +14,3 @@ Determines whether a charCode corresponds to `/` or ``. | Parameter | Type | | :------ | :------ | | `charCode` | `number` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isArrayModelType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md index f2d3143d66..b9217fa59c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isArrayModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md @@ -7,15 +7,9 @@ title: "[F] isArrayModelType" isArrayModelType(program, type): type is ArrayModelType ``` -Check if a model is an array type. - ## Parameters | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | - | -| `type` | [`Model`](Interface.Model.md) | Model type | - -## Returns - -`type is ArrayModelType` +| `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/Function.isCadlValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md similarity index 61% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isCadlValueTypeOf.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md index 1db32bb116..54f967b04e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isCadlValueTypeOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md @@ -11,19 +11,17 @@ isCadlValueTypeOf(target, expectedType): target is InferredTypeSpecValue | Parameter | | :------ | -| `K` *extends* [`TypeKind`](Type.TypeKind.md) | +| `K` extends [`TypeKind`](../type-aliases/TypeKind.md) | ## Parameters | Parameter | Type | | :------ | :------ | -| `target` | [`TypeSpecValue`](Type.TypeSpecValue.md) | -| `expectedType` | `K` \| *readonly* `K`[] | +| `target` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | +| `expectedType` | `K` \| readonly `K`[] | ## Returns -`target is InferredTypeSpecValue` - ## Deprecated use isTypeSpecValueTypeOf diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md similarity index 66% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isComment.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md index ab7cb04c4d..3d2236928e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isComment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md @@ -11,8 +11,4 @@ isComment(token): boolean | Parameter | Type | | :------ | :------ | -| `token` | [`Token`](Enumeration.Token.md) | - -## Returns - -`boolean` +| `token` | [`Token`](../enumerations/Token.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeclaredInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md similarity index 50% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeclaredInNamespace.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md index fded18d7be..d801e0f281 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeclaredInNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md @@ -5,9 +5,9 @@ title: "[F] isDeclaredInNamespace" --- ```ts isDeclaredInNamespace( - type, - namespace, - options = ...): boolean + type, + namespace, + options): boolean ``` Check if the given type is declared in the specified namespace or, optionally, its child namespaces. @@ -16,11 +16,9 @@ Check if the given type is declared in the specified namespace or, optionally, i | Parameter | Type | Description | | :------ | :------ | :------ | -| `type` | [`Model`](Interface.Model.md) \| [`Interface`](Interface.Interface.md) \| [`Enum`](Interface.Enum.md) \| [`Namespace`](Interface.Namespace.md) \| [`Operation`](Interface.Operation.md) | Type | -| `namespace` | [`Namespace`](Interface.Namespace.md) | Namespace | +| `type` | \| [`Model`](../interfaces/Model.md) \| [`Interface`](../interfaces/Interface.md) \| [`Enum`](../interfaces/Enum.md) \| [`Namespace`](../interfaces/Namespace.md) \| [`Operation`](../interfaces/Operation.md) | Type | +| `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | | `options` | `object` | - | | `options.recursive`? | `boolean` | - | ## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeclaredType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeclaredType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md index 611446b4d0..f8a99abd28 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeclaredType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md @@ -15,8 +15,4 @@ Check if the type is a declared type. This include: | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](Type.Type.md) | - -## Returns - -`boolean` +| `type` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md similarity index 63% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeprecated.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md index 8d5e4a38e5..e18babc8df 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md @@ -13,9 +13,5 @@ Check if the given type is deprecated | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `type` | [`Type`](Type.Type.md) | Type | - -## Returns - -`boolean` +| `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/Namespace.decorators.Function.isErrorModel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md similarity index 58% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isErrorModel.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md index 2b75a17442..d518300a41 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isErrorModel.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md @@ -11,9 +11,5 @@ isErrorModel(program, target): boolean | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`boolean` +| `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/Function.isErrorType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isErrorType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md index 22727a9ca7..7d7dbfe785 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isErrorType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md @@ -11,8 +11,4 @@ isErrorType(type): type is ErrorType | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](Type.Type.md) | - -## Returns - -`type is ErrorType` +| `type` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isGlobalNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md similarity index 63% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isGlobalNamespace.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md index 996e5bb6b7..e7585f42b9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isGlobalNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md @@ -13,9 +13,7 @@ Check if the given namespace is the global namespace | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `namespace` | [`Namespace`](Interface.Namespace.md) | Namespace | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | ## Returns - -`namespace is Namespace & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isImportStatement.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isImportStatement.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md index 1319d23d0b..15c4f80906 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isImportStatement.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md @@ -11,8 +11,4 @@ isImportStatement(node): node is ImportStatementNode | Parameter | Type | | :------ | :------ | -| `node` | [`Node`](Type.Node.md) | - -## Returns - -`node is ImportStatementNode` +| `node` | [`Node`](../type-aliases/Node.md) | 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 new file mode 100644 index 0000000000..1de7bd9afa --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isIntrinsicType" + +--- +```ts +isIntrinsicType( + program, + type, + kind): boolean +``` + +## 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/Namespace.decorators.Function.isKey.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md similarity index 51% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isKey.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md index eca22a4ce8..b0e2c670e4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md @@ -11,9 +11,5 @@ isKey(program, property): boolean | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `property` | [`ModelProperty`](Interface.ModelProperty.md) | - -## Returns - -`boolean` +| `program` | [`Program`](../interfaces/Program.md) | +| `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md similarity index 66% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isKeyword.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md index 3094bd2234..e15e18440b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isKeyword.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md @@ -11,8 +11,4 @@ isKeyword(token): boolean | Parameter | Type | | :------ | :------ | -| `token` | [`Token`](Enumeration.Token.md) | - -## Returns - -`boolean` +| `token` | [`Token`](../enumerations/Token.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isListOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md similarity index 67% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isListOperation.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md index 95f487d76a..a694ab1a7a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isListOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md @@ -11,13 +11,11 @@ isListOperation(program, target): boolean | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Operation`](Interface.Operation.md) | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | ## Returns -`boolean` - ## Deprecated Use `isListOperation` in `@typespec/rest` instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isModifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md similarity index 67% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isModifier.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md index f9f9ec8b16..de8bf19e0e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isModifier.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md @@ -11,8 +11,4 @@ isModifier(token): boolean | Parameter | Type | | :------ | :------ | -| `token` | [`Token`](Enumeration.Token.md) | - -## Returns - -`boolean` +| `token` | [`Token`](../enumerations/Token.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isNeverType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isNeverType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md index 3756b17980..a0736e7b10 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isNeverType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md @@ -11,8 +11,4 @@ isNeverType(type): type is NeverType | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](Type.Type.md) | - -## Returns - -`type is NeverType` +| `type` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isNullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isNullType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md index 1d3a246a34..33d1d99183 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isNullType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md @@ -11,8 +11,4 @@ isNullType(type): type is NullType | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](Type.Type.md) | - -## Returns - -`type is NullType` +| `type` | [`Type`](../type-aliases/Type.md) | 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 new file mode 100644 index 0000000000..4d8ca679a7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] isNumericType" + +--- +```ts +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/Function.isPathAbsolute.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md similarity index 88% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isPathAbsolute.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md index 21e4b9b286..ceb4586309 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isPathAbsolute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md @@ -12,7 +12,3 @@ isPathAbsolute(path): boolean | Parameter | Type | | :------ | :------ | | `path` | `string` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md similarity index 54% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isProjectedProgram.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md index 647ffda542..51e055c943 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isProjectedProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md @@ -11,8 +11,4 @@ isProjectedProgram(program): program is ProjectedProgram | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) \| [`ProjectedProgram`](Interface.ProjectedProgram.md) | - -## Returns - -`program is ProjectedProgram` +| `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isPunctuation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isPunctuation.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md index b50014e830..5661e7072e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isPunctuation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md @@ -11,8 +11,4 @@ isPunctuation(token): boolean | Parameter | Type | | :------ | :------ | -| `token` | [`Token`](Enumeration.Token.md) | - -## Returns - -`boolean` +| `token` | [`Token`](../enumerations/Token.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isRecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md similarity index 61% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isRecordModelType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md index 36d412c3dc..96d0f644fe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isRecordModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md @@ -13,9 +13,5 @@ Check if a model is an array type. | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | - | -| `type` | [`Model`](Interface.Model.md) | Model type | - -## Returns - -`type is ArrayModelType` +| `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/Namespace.decorators.Function.isSecret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md similarity index 55% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isSecret.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md index cc0fbc38fe..ae5e2b48a6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isSecret.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md @@ -11,9 +11,5 @@ isSecret(program, target): boolean | undefined | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | -| `target` | [`Type`](Type.Type.md) | - -## Returns - -`boolean` \| `undefined` +| `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/Namespace.decorators.Function.isService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md similarity index 63% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isService.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md index 6ba2bffa6d..8a9f0b3960 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.isService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md @@ -13,11 +13,9 @@ Check if the namespace is defined as a service. | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | -| `namespace` | [`Namespace`](Interface.Namespace.md) | Namespace | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | ## Returns -`boolean` - Boolean diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isStatementKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md similarity index 69% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isStatementKeyword.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md index 83027ef030..3bec936aee 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isStatementKeyword.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md @@ -11,8 +11,4 @@ isStatementKeyword(token): boolean | Parameter | Type | | :------ | :------ | -| `token` | [`Token`](Enumeration.Token.md) | - -## Returns - -`boolean` +| `token` | [`Token`](../enumerations/Token.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isStdNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md similarity index 65% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isStdNamespace.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md index a5b6c35885..80924c73d1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isStdNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md @@ -11,8 +11,4 @@ isStdNamespace(namespace): boolean | Parameter | Type | | :------ | :------ | -| `namespace` | [`Namespace`](Interface.Namespace.md) | - -## Returns - -`boolean` +| `namespace` | [`Namespace`](../interfaces/Namespace.md) | 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 new file mode 100644 index 0000000000..efd49ecc3b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] isStringType" + +--- +```ts +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/Function.isTemplateDeclaration.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md similarity index 75% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateDeclaration.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md index a67ca5cd17..517ed31640 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateDeclaration.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md @@ -13,8 +13,4 @@ Resolve if the type is a template type declaration(Non initialized template type | Parameter | Type | | :------ | :------ | -| `type` | [`TemplatedType`](Type.TemplatedType.md) | - -## Returns - -`type is Object` +| `type` | [`TemplatedType`](../type-aliases/TemplatedType.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateDeclarationOrInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateDeclarationOrInstance.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md index b7626dd0c9..24d5c94d55 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateDeclarationOrInstance.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md @@ -13,8 +13,4 @@ Resolve if the type was created from a template type or is a template type decla | Parameter | Type | | :------ | :------ | -| `type` | [`TemplatedType`](Type.TemplatedType.md) | - -## Returns - -`boolean` +| `type` | [`TemplatedType`](../type-aliases/TemplatedType.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md similarity index 76% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateInstance.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md index ab32176643..06a1f65608 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTemplateInstance.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md @@ -13,8 +13,4 @@ Check the given type is a finished template instance. | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](Type.Type.md) | - -## Returns - -`type is Object` +| `type` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md similarity index 66% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTrivia.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md index 24d2cbed7f..6b02bc0f08 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTrivia.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md @@ -11,8 +11,4 @@ isTrivia(token): boolean | Parameter | Type | | :------ | :------ | -| `token` | [`Token`](Enumeration.Token.md) | - -## Returns - -`boolean` +| `token` | [`Token`](../enumerations/Token.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTypeSpecValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md similarity index 61% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTypeSpecValueTypeOf.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md index 84d5d6b652..87e9641e04 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isTypeSpecValueTypeOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md @@ -13,17 +13,15 @@ Check if the given target is of any of the typespec types. | Parameter | | :------ | -| `K` *extends* [`TypeKind`](Type.TypeKind.md) | +| `K` extends [`TypeKind`](../type-aliases/TypeKind.md) | ## Parameters | Parameter | Type | Description | | :------ | :------ | :------ | -| `target` | [`TypeSpecValue`](Type.TypeSpecValue.md) | Target to validate. | -| `expectedType` | `K` \| *readonly* `K`[] | One or multiple allowed typespec types. | +| `target` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | Target to validate. | +| `expectedType` | `K` \| readonly `K`[] | One or multiple allowed typespec types. | ## Returns -`target is InferredTypeSpecValue` - boolean if the target is of one of the allowed types. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isUnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isUnknownType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md index ca5bfc65d2..39fa7cfefc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isUnknownType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md @@ -11,8 +11,4 @@ isUnknownType(type): type is UnknownType | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](Type.Type.md) | - -## Returns - -`type is UnknownType` +| `type` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isUrl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isUrl.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md index fac8b27849..670d518d6b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isUrl.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md @@ -14,7 +14,3 @@ Determines whether a path starts with a URL scheme (e.g. starts with `http://`, | Parameter | Type | | :------ | :------ | | `path` | `string` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md new file mode 100644 index 0000000000..116add3394 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isVisible" + +--- +```ts +isVisible( + program, + property, + visibilities): boolean +``` + +## 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/Function.isVoidType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isVoidType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md index 5eeead8949..f8e9b3083f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.isVoidType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md @@ -11,8 +11,4 @@ isVoidType(type): type is VoidType | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](Type.Type.md) | - -## Returns - -`type is VoidType` +| `type` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.joinPaths.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md similarity index 97% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.joinPaths.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md index e78d9eea75..761a23b6c7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.joinPaths.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md @@ -30,7 +30,3 @@ joinPaths("file:///path", "file:///to", "file.ext") === "file:///to/file.ext" | :------ | :------ | | `path` | `string` | | ...`paths` | (`undefined` \| `string`)[] | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md new file mode 100644 index 0000000000..7d35fa7450 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[F] listOperationsIn" + +--- +```ts +listOperationsIn(container, options): Operation[] +``` + +List operations in the given container. Will list operation recursively by default(Check subnamespaces.) + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `container` | [`Interface`](../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/Namespace.decorators.Function.listServices.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.listServices.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md index 006e71ba53..c1c8ac3dec 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Function.listServices.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md @@ -13,10 +13,8 @@ List all the services defined in the typespec program | Parameter | Type | Description | | :------ | :------ | :------ | -| `program` | [`Program`](Interface.Program.md) | Program | +| `program` | [`Program`](../interfaces/Program.md) | Program | ## Returns -[`Service`](Namespace.decorators.Interface.Service.md)[] - List of service. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.logDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.logDiagnostics.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md index 5dbd22a645..99216e7ad4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.logDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md @@ -11,9 +11,5 @@ logDiagnostics(diagnostics, logger): void | Parameter | Type | | :------ | :------ | -| `diagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | -| `logger` | [`LogSink`](Interface.LogSink.md) | - -## Returns - -`void` +| `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/Function.logVerboseTestOutput.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md similarity index 96% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.logVerboseTestOutput.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md index cd6d715306..064ff7e617 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.logVerboseTestOutput.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md @@ -20,7 +20,3 @@ when verbose output is disabled. | Parameter | Type | | :------ | :------ | | `messageOrCallback` | `string` \| (`log`) => `void` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.mapEventEmitterToNodeListener.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md similarity index 62% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.mapEventEmitterToNodeListener.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md index bd244a405c..1d8cdc6aae 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.mapEventEmitterToNodeListener.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md @@ -13,10 +13,8 @@ Create a Semantic node listener from an event emitter. | Parameter | Type | Description | | :------ | :------ | :------ | -| `eventEmitter` | [`EventEmitter`](Class.EventEmitter.md)< [`SemanticNodeListener`](Type.SemanticNodeListener.md) \> | Event emitter. | +| `eventEmitter` | [`EventEmitter`](../classes/EventEmitter.md)<[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md)\> | Event emitter. | ## Returns -[`SemanticNodeListener`](Type.SemanticNodeListener.md) - Semantic node listener. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md new file mode 100644 index 0000000000..c65ddb6121 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] markDeprecated" + +--- +```ts +markDeprecated( + program, + type, + details): void +``` + +Mark the given type as deprecated with the provided details. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../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 new file mode 100644 index 0000000000..6f3fdc9654 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] navigateProgram" + +--- +```ts +navigateProgram( + program, + listeners, + options): void +``` + +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 new file mode 100644 index 0000000000..c9d47f66b2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] navigateType" + +--- +```ts +navigateType( + type, + listeners, + options): void +``` + +Navigate the given type and all the types that are used in it. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `type` | [`Type`](../type-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 new file mode 100644 index 0000000000..c827c67660 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] navigateTypesInNamespace" + +--- +```ts +navigateTypesInNamespace( + namespace, + listeners, + options): void +``` + +## 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` | +| `options` | [`NamespaceNavigationOptions`](../interfaces/NamespaceNavigationOptions.md) & [`NavigationOptions`](../interfaces/NavigationOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.normalizePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md similarity index 88% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.normalizePath.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md index 5f3c85b47a..74a9fceadf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.normalizePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md @@ -12,7 +12,3 @@ normalizePath(path): string | Parameter | Type | | :------ | :------ | | `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.normalizeSlashes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.normalizeSlashes.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md index f57cabe09d..9ed7a2775e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.normalizeSlashes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md @@ -14,7 +14,3 @@ Normalize path separators, converting `\` into `/`. | Parameter | Type | | :------ | :------ | | `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md new file mode 100644 index 0000000000..e75e773936 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] paramMessage" + +--- +```ts +paramMessage(strings, ...keys): CallableMessage +``` + +## Type parameters + +| 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 new file mode 100644 index 0000000000..07ce67685c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] parse" + +--- +```ts +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/Function.parseStandaloneTypeReference.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.parseStandaloneTypeReference.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md index fe64e53161..9f01d158d4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.parseStandaloneTypeReference.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md @@ -11,8 +11,4 @@ parseStandaloneTypeReference(code): [TypeReferenceNode, readonly Diagnostic[]] | Parameter | Type | | :------ | :------ | -| `code` | `string` \| [`SourceFile`](Interface.SourceFile.md) | - -## Returns - -[[`TypeReferenceNode`](Interface.TypeReferenceNode.md), *readonly* [`Diagnostic`](Interface.Diagnostic.md)[]] +| `code` | `string` \| [`SourceFile`](../interfaces/SourceFile.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 new file mode 100644 index 0000000000..7ce0f39a58 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] projectProgram" + +--- +```ts +projectProgram( + program, + projections, + startNode?): ProjectedProgram +``` + +## 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/Function.reducePathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md similarity index 81% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.reducePathComponents.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md index 1580ff3e53..d1c1773efe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.reducePathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md @@ -14,8 +14,4 @@ Reduce an array of path components to a more simplified path by navigating any | Parameter | Type | | :------ | :------ | -| `components` | *readonly* `string`[] | - -## Returns - -`string`[] +| `components` | readonly `string`[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.removeTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md similarity index 95% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.removeTrailingDirectorySeparator.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md index 277ef723b7..63b171f7dd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.removeTrailingDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md @@ -19,7 +19,3 @@ removeTrailingDirectorySeparator("/path/to/file.ext/") === "/path/to/file.ext" | Parameter | Type | | :------ | :------ | | `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md new file mode 100644 index 0000000000..77840af0f3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] reportDeprecated" + +--- +```ts +reportDeprecated( + program, + message, + target): void +``` + +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 new file mode 100644 index 0000000000..b8db05d492 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[F] resolveCompilerOptions" + +--- +```ts +resolveCompilerOptions(host, options): Promise<[CompilerOptions, readonly Diagnostic[]]> +``` + +Resolve the compiler options for the given entrypoint by resolving the tspconfig.yaml. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `host` | [`CompilerHost`](../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/resolveModule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md new file mode 100644 index 0000000000..4f233e9c6b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] resolveModule" + +--- +```ts +resolveModule( + host, + name, +options): Promise +``` + +Resolve a module + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `host` | [`ResolveModuleHost`](../interfaces/ResolveModuleHost.md) | | +| `name` | `string` | | +| `options` | [`ResolveModuleOptions`](../interfaces/ResolveModuleOptions.md) | | + +## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolvePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md similarity index 96% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolvePath.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md index cb260f4ffd..b9c37cfbdd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolvePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md @@ -22,7 +22,3 @@ resolvePath("/path", "dir", "..", "to", "file.ext") === "path/to/file.ext" | :------ | :------ | | `path` | `string` | | ...`paths` | (`undefined` \| `string`)[] | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveUsages.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md similarity index 62% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveUsages.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md index 0c8bf1e093..8e45b17886 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.resolveUsages.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md @@ -14,10 +14,8 @@ Will recursively scan all namespace, interfaces and operations contained inside | Parameter | Type | Description | | :------ | :------ | :------ | -| `types` | [`OperationContainer`](Type.OperationContainer.md) \| [`OperationContainer`](Type.OperationContainer.md)[] | Entrypoint(s) namespace, interface or operations to get usage from. | +| `types` | [`OperationContainer`](../type-aliases/OperationContainer.md) \| [`OperationContainer`](../type-aliases/OperationContainer.md)[] | Entrypoint(s) namespace, interface or operations to get usage from. | ## Returns -[`UsageTracker`](Interface.UsageTracker.md) - Map of types to usage. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md new file mode 100644 index 0000000000..2cb3d7998a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md @@ -0,0 +1,31 @@ +--- +jsApi: true +title: "[F] scopeNavigationToNamespace" + +--- +```ts +scopeNavigationToNamespace( + namespace, + listeners, + options): T +``` + +Scope the current navigation to the given namespace. + +## Type parameters + +| Parameter | +| :------ | +| `T` extends `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 | + +## Returns + +wrapped listeners that that can be used with `navigateType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.setCadlNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md similarity index 97% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.setCadlNamespace.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md index db6837821f..b72dd7e61f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.setCadlNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md @@ -16,8 +16,6 @@ setCadlNamespace(namespace, ...functions): void ## Returns -`void` - ## Deprecated use setTypeSpecNamespace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.setTypeSpecNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md similarity index 94% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.setTypeSpecNamespace.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md index 2d54e87e46..c136758acf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.setTypeSpecNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md @@ -15,7 +15,3 @@ Set the TypeSpec namespace for that function. | :------ | :------ | :------ | | `namespace` | `string` | Namespace string (e.g. "Foo.Bar") | | ...`functions` | (...`args`) => `any`[] | Functions | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.skipTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.skipTrivia.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md index 787eac72ad..aa72c70d31 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.skipTrivia.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md @@ -5,9 +5,9 @@ title: "[F] skipTrivia" --- ```ts skipTrivia( - input, - position, - endPosition = input.length): number + input, + position, + endPosition): number ``` ## Parameters @@ -17,7 +17,3 @@ skipTrivia( | `input` | `string` | `undefined` | | `position` | `number` | `undefined` | | `endPosition` | `number` | `input.length` | - -## Returns - -`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.skipWhiteSpace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.skipWhiteSpace.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md index 89e0a843a8..d4c22456b7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.skipWhiteSpace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md @@ -5,9 +5,9 @@ title: "[F] skipWhiteSpace" --- ```ts skipWhiteSpace( - input, - position, - endPosition = input.length): number + input, + position, + endPosition): number ``` ## Parameters @@ -17,7 +17,3 @@ skipWhiteSpace( | `input` | `string` | `undefined` | | `position` | `number` | `undefined` | | `endPosition` | `number` | `input.length` | - -## Returns - -`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.typespecTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md similarity index 57% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.typespecTypeToJson.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md index 40cb0b6541..5dcd158e9c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.typespecTypeToJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md @@ -20,9 +20,5 @@ Emits diagnostics if the given type is invalid | Parameter | Type | Description | | :------ | :------ | :------ | -| `typespecType` | [`TypeSpecValue`](Type.TypeSpecValue.md) | The type to convert to Json data | -| `target` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | The diagnostic target in case of errors. | - -## Returns - -[`T` \| `undefined`, [`Diagnostic`](Interface.Diagnostic.md)[]] +| `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 new file mode 100644 index 0000000000..9cb27e6dcc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] validateDecoratorNotOnType" + +--- +```ts +validateDecoratorNotOnType( + context, + type, + badDecorator, + givenDecorator): boolean +``` + +Validate that a given decorator is not on a type or any of its base types. +Useful to check for decorator usage that conflicts with another decorator. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](../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 | +| `givenDecorator` | [`DecoratorFunction`](../interfaces/DecoratorFunction.md) | The decorator that is the reason why we don't want the bad decorator present | + +## Returns + +Whether the decorator application is valid diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamCount.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamCount.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md index c755597bde..444c244585 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.validateDecoratorParamCount.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md @@ -5,21 +5,17 @@ title: "[F] validateDecoratorParamCount" --- ```ts validateDecoratorParamCount( - context, - min, - max, - parameters): boolean + context, + min, + max, + parameters): boolean ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `context` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `min` | `number` | | `max` | `undefined` \| `number` | | `parameters` | `unknown`[] | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md new file mode 100644 index 0000000000..ee03f0ec48 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md @@ -0,0 +1,62 @@ +--- +jsApi: true +title: "[F] validateDecoratorParamType" + +--- +```ts +validateDecoratorParamType( + program, + target, + value, + expectedType): value is InferredTypeSpecValue +``` + +Validate a decorator parameter has the correct type. + +## Type parameters + +| Parameter | +| :------ | +| `K` extends + \| `"Model"` + \| `"ModelProperty"` + \| `"Scalar"` + \| `"Interface"` + \| `"Enum"` + \| `"EnumMember"` + \| `"TemplateParameter"` + \| `"Namespace"` + \| `"Operation"` + \| `"String"` + \| `"Number"` + \| `"Boolean"` + \| `"Tuple"` + \| `"Union"` + \| `"UnionVariant"` + \| `"Intrinsic"` + \| `"Function"` + \| `"Decorator"` + \| `"FunctionParameter"` + \| `"Object"` + \| `"Projection"` | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Type`](../type-aliases/Type.md) | Decorator target | +| `value` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | Value of the parameter. | +| `expectedType` | `K` \| `K`[] | Expected type or list of expected type | + +## Returns + +true if the value is of one of the type in the list of expected types. If not emit a diagnostic. + +## Deprecated + +use + +## See + +createDecoratorDefinition#validate instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md new file mode 100644 index 0000000000..a19d37a2c6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md @@ -0,0 +1,31 @@ +--- +jsApi: true +title: "[F] validateDecoratorTarget" + +--- +```ts +validateDecoratorTarget( + context, + target, + decoratorName, + expectedType): target is K extends "Any" ? Type : Object +``` + +Validate the decorator target is matching the expected value. + +## Type parameters + +| Parameter | +| :------ | +| `K` extends [`TypeKind`](../type-aliases/TypeKind.md) | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | - | +| `target` | [`Type`](../type-aliases/Type.md) | | +| `decoratorName` | `string` | | +| `expectedType` | `K` \| readonly `K`[] | | + +## Returns 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 new file mode 100644 index 0000000000..a9712bc109 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] validateDecoratorTargetIntrinsic" + +--- +```ts +validateDecoratorTargetIntrinsic( + context, + target, + decoratorName, + expectedType): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `decoratorName` | `string` | +| `expectedType` | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md)[] | + +## Returns + +## Deprecated + +this function is deprecated use decorator definition in typespec instead or check assignability directly. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md new file mode 100644 index 0000000000..a69903de5c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] validateDecoratorUniqueOnNode" + +--- +```ts +validateDecoratorUniqueOnNode( + context, + type, + decorator): boolean +``` + +## 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/Function.visitChildren.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md similarity index 62% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.visitChildren.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md index 7ffc5c77b5..6dee1450e0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.visitChildren.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md @@ -17,9 +17,5 @@ visitChildren(node, cb): T | undefined | Parameter | Type | | :------ | :------ | -| `node` | [`Node`](Type.Node.md) | -| `cb` | [`NodeCallback`](Type.NodeCallback.md)< `T` \> | - -## Returns - -`T` \| `undefined` +| `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/Function.walkPropertiesInherited.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md similarity index 62% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.walkPropertiesInherited.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md index e2dd546af2..76771e5930 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Function.walkPropertiesInherited.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md @@ -4,7 +4,7 @@ title: "[F] walkPropertiesInherited" --- ```ts -walkPropertiesInherited(model): Generator< ModelProperty, void, unknown > +walkPropertiesInherited(model): Generator ``` Enumerates the properties declared by model or inherited from its base. @@ -18,8 +18,4 @@ Properties that are overridden are not enumerated. | Parameter | Type | | :------ | :------ | -| `model` | [`Model`](Interface.Model.md) | - -## Returns - -`Generator`< [`ModelProperty`](Interface.ModelProperty.md), `void`, `unknown` \> +| `model` | [`Model`](../interfaces/Model.md) | 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 df7ef0b201..e43e6e9225 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,1378 +3,539 @@ jsApi: true title: "[P] JS Api" --- -## Index - -### Namespaces - -- [decorators](Namespace.decorators.md) +## Exports ### Enumerations -- [IdentifierKind](Enumeration.IdentifierKind.md) -- [KeywordLimit](Enumeration.KeywordLimit.md) -- [ListenerFlow](Enumeration.ListenerFlow.md) -- [ModifierFlags](Enumeration.ModifierFlags.md) -- [NodeFlags](Enumeration.NodeFlags.md) -- [SemanticTokenKind](Enumeration.SemanticTokenKind.md) -- [SymbolFlags](Enumeration.SymbolFlags.md) -- [SyntaxKind](Enumeration.SyntaxKind.md) -- [Token](Enumeration.Token.md) -- [TokenFlags](Enumeration.TokenFlags.md) -- [UsageFlags](Enumeration.UsageFlags.md) +- [IdentifierKind](enumerations/IdentifierKind.md) +- [ListenerFlow](enumerations/ListenerFlow.md) +- [ModifierFlags](enumerations/ModifierFlags.md) +- [NodeFlags](enumerations/NodeFlags.md) +- [SemanticTokenKind](enumerations/SemanticTokenKind.md) +- [SymbolFlags](enumerations/SymbolFlags.md) +- [SyntaxKind](enumerations/SyntaxKind.md) +- [Token](enumerations/Token.md) +- [TokenFlags](enumerations/TokenFlags.md) +- [UsageFlags](enumerations/UsageFlags.md) ### Classes -- [DuplicateTracker](Class.DuplicateTracker.md) -- [EventEmitter](Class.EventEmitter.md) -- [InvalidEncodingError](Class.InvalidEncodingError.md) -- [ProjectionError](Class.ProjectionError.md) -- [Queue](Class.Queue.md) -- [ResolveModuleError](Class.ResolveModuleError.md) +- [DuplicateTracker](classes/DuplicateTracker.md) +- [EventEmitter](classes/EventEmitter.md) +- [InvalidEncodingError](classes/InvalidEncodingError.md) +- [ProjectionError](classes/ProjectionError.md) +- [Queue](classes/Queue.md) +- [ResolveModuleError](classes/ResolveModuleError.md) ### Interfaces -- [AliasStatementNode](Interface.AliasStatementNode.md) -- [AnyKeywordNode](Interface.AnyKeywordNode.md) -- [ArrayExpressionNode](Interface.ArrayExpressionNode.md) -- [ArrayModelType](Interface.ArrayModelType.md) -- [AugmentDecoratorStatementNode](Interface.AugmentDecoratorStatementNode.md) -- [BaseNode](Interface.BaseNode.md) -- [BaseType](Interface.BaseType.md) -- [BlockComment](Interface.BlockComment.md) -- [BooleanLiteral](Interface.BooleanLiteral.md) -- [BooleanLiteralNode](Interface.BooleanLiteralNode.md) -- [CallableMessage](Interface.CallableMessage.md) -- [Checker](Interface.Checker.md) -- [CompilerHost](Interface.CompilerHost.md) -- [CompilerLocationContext](Interface.CompilerLocationContext.md) -- [CompilerOptions](Interface.CompilerOptions.md) -- [DeclarationNode](Interface.DeclarationNode.md) -- [DecoratedType](Interface.DecoratedType.md) -- [Decorator](Interface.Decorator.md) -- [DecoratorApplication](Interface.DecoratorApplication.md) -- [DecoratorArgument](Interface.DecoratorArgument.md) -- [DecoratorContext](Interface.DecoratorContext.md) -- [DecoratorDeclarationStatementNode](Interface.DecoratorDeclarationStatementNode.md) -- [DecoratorDefinition](Interface.DecoratorDefinition.md) -- [DecoratorExpressionNode](Interface.DecoratorExpressionNode.md) -- [DecoratorFunction](Interface.DecoratorFunction.md) -- [DecoratorParamDefinition](Interface.DecoratorParamDefinition.md) -- [DecoratorValidator](Interface.DecoratorValidator.md) -- [DeprecatedDirective](Interface.DeprecatedDirective.md) -- [DeprecationDetails](Interface.DeprecationDetails.md) -- [Diagnostic](Interface.Diagnostic.md) -- [DiagnosticCollector](Interface.DiagnosticCollector.md) -- [DiagnosticCreator](Interface.DiagnosticCreator.md) -- [DiagnosticDefinition](Interface.DiagnosticDefinition.md) -- [DiagnosticMessages](Interface.DiagnosticMessages.md) -- [DirectiveBase](Interface.DirectiveBase.md) -- [DirectiveExpressionNode](Interface.DirectiveExpressionNode.md) -- [Dirent](Interface.Dirent.md) -- [DiscriminatedUnion](Interface.DiscriminatedUnion.md) -- [DocNode](Interface.DocNode.md) -- [DocParamTagNode](Interface.DocParamTagNode.md) -- [DocReturnsTagNode](Interface.DocReturnsTagNode.md) -- [DocTagBaseNode](Interface.DocTagBaseNode.md) -- [DocTemplateTagNode](Interface.DocTemplateTagNode.md) -- [DocTextNode](Interface.DocTextNode.md) -- [DocUnknownTagNode](Interface.DocUnknownTagNode.md) -- [EmitContext](Interface.EmitContext.md) -- [EmitFileOptions](Interface.EmitFileOptions.md) -- [EmptyStatementNode](Interface.EmptyStatementNode.md) -- [Enum](Interface.Enum.md) -- [EnumMember](Interface.EnumMember.md) -- [EnumMemberNode](Interface.EnumMemberNode.md) -- [EnumSpreadMemberNode](Interface.EnumSpreadMemberNode.md) -- [EnumStatementNode](Interface.EnumStatementNode.md) -- [ErrorType](Interface.ErrorType.md) -- [ExternKeywordNode](Interface.ExternKeywordNode.md) -- [FileLibraryMetadata](Interface.FileLibraryMetadata.md) -- [FunctionDeclarationStatementNode](Interface.FunctionDeclarationStatementNode.md) -- [FunctionParameter](Interface.FunctionParameter.md) -- [FunctionParameterNode](Interface.FunctionParameterNode.md) -- [FunctionType](Interface.FunctionType.md) -- [IdentifierContext](Interface.IdentifierContext.md) -- [IdentifierNode](Interface.IdentifierNode.md) -- [ImportStatementNode](Interface.ImportStatementNode.md) -- [Interface](Interface.Interface.md) -- [InterfaceStatementNode](Interface.InterfaceStatementNode.md) -- [IntersectionExpressionNode](Interface.IntersectionExpressionNode.md) -- [IntrinsicType](Interface.IntrinsicType.md) -- [InvalidStatementNode](Interface.InvalidStatementNode.md) -- [JSONSchemaValidator](Interface.JSONSchemaValidator.md) -- [JsNamespaceDeclarationNode](Interface.JsNamespaceDeclarationNode.md) -- [JsSourceFileNode](Interface.JsSourceFileNode.md) -- [LibraryInstance](Interface.LibraryInstance.md) -- [LibraryLocationContext](Interface.LibraryLocationContext.md) -- [LineAndCharacter](Interface.LineAndCharacter.md) -- [LineComment](Interface.LineComment.md) -- [LinterDefinition](Interface.LinterDefinition.md) -- [LinterRule](Interface.LinterRule.md) -- [LinterRuleContext](Interface.LinterRuleContext.md) -- [LinterRuleDefinition](Interface.LinterRuleDefinition.md) -- [LinterRuleSet](Interface.LinterRuleSet.md) -- [ListOperationOptions](Interface.ListOperationOptions.md) -- [LogInfo](Interface.LogInfo.md) -- [LogSink](Interface.LogSink.md) -- [Logger](Interface.Logger.md) -- [MemberExpressionNode](Interface.MemberExpressionNode.md) -- [Model](Interface.Model.md) -- [ModelExpressionNode](Interface.ModelExpressionNode.md) -- [ModelProperty](Interface.ModelProperty.md) -- [ModelPropertyNode](Interface.ModelPropertyNode.md) -- [ModelSpreadPropertyNode](Interface.ModelSpreadPropertyNode.md) -- [ModelStatementNode](Interface.ModelStatementNode.md) -- [ModuleLibraryMetadata](Interface.ModuleLibraryMetadata.md) -- [Namespace](Interface.Namespace.md) -- [NamespaceNavigationOptions](Interface.NamespaceNavigationOptions.md) -- [NamespaceStatementNode](Interface.NamespaceStatementNode.md) -- [NavigationOptions](Interface.NavigationOptions.md) -- [NeverKeywordNode](Interface.NeverKeywordNode.md) -- [NeverType](Interface.NeverType.md) -- [NodePackage](Interface.NodePackage.md) -- [NullType](Interface.NullType.md) -- [NumericLiteral](Interface.NumericLiteral.md) -- [NumericLiteralNode](Interface.NumericLiteralNode.md) -- [ObjectType](Interface.ObjectType.md) -- [Operation](Interface.Operation.md) -- [OperationSignatureDeclarationNode](Interface.OperationSignatureDeclarationNode.md) -- [OperationSignatureReferenceNode](Interface.OperationSignatureReferenceNode.md) -- [OperationStatementNode](Interface.OperationStatementNode.md) -- [ParseOptions](Interface.ParseOptions.md) -- [ProcessedLog](Interface.ProcessedLog.md) -- [Program](Interface.Program.md) -- [ProjectLocationContext](Interface.ProjectLocationContext.md) -- [ProjectedNameView](Interface.ProjectedNameView.md) -- [ProjectedProgram](Interface.ProjectedProgram.md) -- [Projection](Interface.Projection.md) -- [ProjectionApplication](Interface.ProjectionApplication.md) -- [ProjectionArithmeticExpressionNode](Interface.ProjectionArithmeticExpressionNode.md) -- [ProjectionBlockExpressionNode](Interface.ProjectionBlockExpressionNode.md) -- [ProjectionCallExpressionNode](Interface.ProjectionCallExpressionNode.md) -- [ProjectionDecoratorReferenceExpressionNode](Interface.ProjectionDecoratorReferenceExpressionNode.md) -- [ProjectionEnumMemberSelectorNode](Interface.ProjectionEnumMemberSelectorNode.md) -- [ProjectionEnumSelectorNode](Interface.ProjectionEnumSelectorNode.md) -- [ProjectionEqualityExpressionNode](Interface.ProjectionEqualityExpressionNode.md) -- [ProjectionExpressionStatementNode](Interface.ProjectionExpressionStatementNode.md) -- [ProjectionIfExpressionNode](Interface.ProjectionIfExpressionNode.md) -- [ProjectionInterfaceSelectorNode](Interface.ProjectionInterfaceSelectorNode.md) -- [ProjectionLambdaExpressionNode](Interface.ProjectionLambdaExpressionNode.md) -- [ProjectionLambdaParameterDeclarationNode](Interface.ProjectionLambdaParameterDeclarationNode.md) -- [ProjectionLogicalExpressionNode](Interface.ProjectionLogicalExpressionNode.md) -- [ProjectionMemberExpressionNode](Interface.ProjectionMemberExpressionNode.md) -- [ProjectionModelExpressionNode](Interface.ProjectionModelExpressionNode.md) -- [ProjectionModelPropertyNode](Interface.ProjectionModelPropertyNode.md) -- [ProjectionModelPropertySelectorNode](Interface.ProjectionModelPropertySelectorNode.md) -- [ProjectionModelSelectorNode](Interface.ProjectionModelSelectorNode.md) -- [ProjectionModelSpreadPropertyNode](Interface.ProjectionModelSpreadPropertyNode.md) -- [ProjectionNode](Interface.ProjectionNode.md) -- [ProjectionOperationSelectorNode](Interface.ProjectionOperationSelectorNode.md) -- [ProjectionParameterDeclarationNode](Interface.ProjectionParameterDeclarationNode.md) -- [ProjectionReferenceNode](Interface.ProjectionReferenceNode.md) -- [ProjectionRelationalExpressionNode](Interface.ProjectionRelationalExpressionNode.md) -- [ProjectionStatementNode](Interface.ProjectionStatementNode.md) -- [ProjectionTupleExpressionNode](Interface.ProjectionTupleExpressionNode.md) -- [ProjectionUnaryExpressionNode](Interface.ProjectionUnaryExpressionNode.md) -- [ProjectionUnionSelectorNode](Interface.ProjectionUnionSelectorNode.md) -- [ProjectionUnionVariantSelectorNode](Interface.ProjectionUnionVariantSelectorNode.md) -- [Projector](Interface.Projector.md) -- [RecordModelType](Interface.RecordModelType.md) -- [ResolveCompilerOptionsOptions](Interface.ResolveCompilerOptionsOptions.md) -- [ResolveModuleHost](Interface.ResolveModuleHost.md) -- [ResolveModuleOptions](Interface.ResolveModuleOptions.md) -- [ResolvedFile](Interface.ResolvedFile.md) -- [ResolvedModule](Interface.ResolvedModule.md) -- [ReturnExpressionNode](Interface.ReturnExpressionNode.md) -- [ReturnRecord](Interface.ReturnRecord.md) -- [RmOptions](Interface.RmOptions.md) -- [Scalar](Interface.Scalar.md) -- [ScalarStatementNode](Interface.ScalarStatementNode.md) -- [Scanner](Interface.Scanner.md) -- [SemanticToken](Interface.SemanticToken.md) -- [Server](Interface.Server.md) -- [ServerHost](Interface.ServerHost.md) -- [ServerSourceFile](Interface.ServerSourceFile.md) -- [ServerWorkspaceFolder](Interface.ServerWorkspaceFolder.md) -- [SourceFile](Interface.SourceFile.md) -- [SourceLocation](Interface.SourceLocation.md) -- [SourceLocationOptions](Interface.SourceLocationOptions.md) -- [StringLiteral](Interface.StringLiteral.md) -- [StringLiteralNode](Interface.StringLiteralNode.md) -- [SuppressDirective](Interface.SuppressDirective.md) -- [Sym](Interface.Sym.md) -- [SymbolLinks](Interface.SymbolLinks.md) -- [SyntheticLocationContext](Interface.SyntheticLocationContext.md) -- [TemplateDeclarationNode](Interface.TemplateDeclarationNode.md) -- [TemplateParameter](Interface.TemplateParameter.md) -- [TemplateParameterDeclarationNode](Interface.TemplateParameterDeclarationNode.md) -- [TemplatedTypeBase](Interface.TemplatedTypeBase.md) -- [TextRange](Interface.TextRange.md) -- [Tracer](Interface.Tracer.md) -- [TracerOptions](Interface.TracerOptions.md) -- [Tuple](Interface.Tuple.md) -- [TupleExpressionNode](Interface.TupleExpressionNode.md) -- [TypeInstantiationMap](Interface.TypeInstantiationMap.md) -- [TypeMapper](Interface.TypeMapper.md) -- [TypeNameOptions](Interface.TypeNameOptions.md) -- [TypeReferenceNode](Interface.TypeReferenceNode.md) -- [TypeSpecCompletionItem](Interface.TypeSpecCompletionItem.md) -- [TypeSpecLibrary](Interface.TypeSpecLibrary.md) -- [TypeSpecLibraryDef](Interface.TypeSpecLibraryDef.md) -- [TypeSpecManifest](Interface.TypeSpecManifest.md) -- [TypeSpecScriptNode](Interface.TypeSpecScriptNode.md) -- [Union](Interface.Union.md) -- [UnionExpressionNode](Interface.UnionExpressionNode.md) -- [UnionStatementNode](Interface.UnionStatementNode.md) -- [UnionVariant](Interface.UnionVariant.md) -- [UnionVariantNode](Interface.UnionVariantNode.md) -- [UnknownType](Interface.UnknownType.md) -- [UsageTracker](Interface.UsageTracker.md) -- [UsingStatementNode](Interface.UsingStatementNode.md) -- [ValueOfExpressionNode](Interface.ValueOfExpressionNode.md) -- [ValueType](Interface.ValueType.md) -- [VoidKeywordNode](Interface.VoidKeywordNode.md) -- [VoidType](Interface.VoidType.md) +- [AliasStatementNode](interfaces/AliasStatementNode.md) +- [AnyKeywordNode](interfaces/AnyKeywordNode.md) +- [ArrayExpressionNode](interfaces/ArrayExpressionNode.md) +- [ArrayModelType](interfaces/ArrayModelType.md) +- [AugmentDecoratorStatementNode](interfaces/AugmentDecoratorStatementNode.md) +- [BaseNode](interfaces/BaseNode.md) +- [BaseType](interfaces/BaseType.md) +- [BlockComment](interfaces/BlockComment.md) +- [BooleanLiteral](interfaces/BooleanLiteral.md) +- [BooleanLiteralNode](interfaces/BooleanLiteralNode.md) +- [CallableMessage](interfaces/CallableMessage.md) +- [Checker](interfaces/Checker.md) +- [CompilerHost](interfaces/CompilerHost.md) +- [CompilerLocationContext](interfaces/CompilerLocationContext.md) +- [CompilerOptions](interfaces/CompilerOptions.md) +- [DeclarationNode](interfaces/DeclarationNode.md) +- [DecoratedType](interfaces/DecoratedType.md) +- [Decorator](interfaces/Decorator.md) +- [DecoratorApplication](interfaces/DecoratorApplication.md) +- [DecoratorArgument](interfaces/DecoratorArgument.md) +- [DecoratorContext](interfaces/DecoratorContext.md) +- [DecoratorDeclarationStatementNode](interfaces/DecoratorDeclarationStatementNode.md) +- [DecoratorDefinition](interfaces/DecoratorDefinition.md) +- [DecoratorExpressionNode](interfaces/DecoratorExpressionNode.md) +- [DecoratorFunction](interfaces/DecoratorFunction.md) +- [DecoratorParamDefinition](interfaces/DecoratorParamDefinition.md) +- [DecoratorValidator](interfaces/DecoratorValidator.md) +- [DeprecatedDirective](interfaces/DeprecatedDirective.md) +- [DeprecationDetails](interfaces/DeprecationDetails.md) +- [Diagnostic](interfaces/Diagnostic.md) +- [DiagnosticCollector](interfaces/DiagnosticCollector.md) +- [DiagnosticCreator](interfaces/DiagnosticCreator.md) +- [DiagnosticDefinition](interfaces/DiagnosticDefinition.md) +- [DiagnosticMessages](interfaces/DiagnosticMessages.md) +- [DirectiveBase](interfaces/DirectiveBase.md) +- [DirectiveExpressionNode](interfaces/DirectiveExpressionNode.md) +- [Dirent](interfaces/Dirent.md) +- [DiscriminatedUnion](interfaces/DiscriminatedUnion.md) +- [Discriminator](interfaces/Discriminator.md) +- [DocData](interfaces/DocData.md) +- [DocErrorsTagNode](interfaces/DocErrorsTagNode.md) +- [DocNode](interfaces/DocNode.md) +- [DocParamTagNode](interfaces/DocParamTagNode.md) +- [DocReturnsTagNode](interfaces/DocReturnsTagNode.md) +- [DocTagBaseNode](interfaces/DocTagBaseNode.md) +- [DocTemplateTagNode](interfaces/DocTemplateTagNode.md) +- [DocTextNode](interfaces/DocTextNode.md) +- [DocUnknownTagNode](interfaces/DocUnknownTagNode.md) +- [EmitContext](interfaces/EmitContext.md) +- [EmitFileOptions](interfaces/EmitFileOptions.md) +- [EmptyStatementNode](interfaces/EmptyStatementNode.md) +- [EncodeData](interfaces/EncodeData.md) +- [Enum](interfaces/Enum.md) +- [EnumMember](interfaces/EnumMember.md) +- [EnumMemberNode](interfaces/EnumMemberNode.md) +- [EnumSpreadMemberNode](interfaces/EnumSpreadMemberNode.md) +- [EnumStatementNode](interfaces/EnumStatementNode.md) +- [ErrorType](interfaces/ErrorType.md) +- [ExternKeywordNode](interfaces/ExternKeywordNode.md) +- [FileLibraryMetadata](interfaces/FileLibraryMetadata.md) +- [FunctionDeclarationStatementNode](interfaces/FunctionDeclarationStatementNode.md) +- [FunctionParameter](interfaces/FunctionParameter.md) +- [FunctionParameterNode](interfaces/FunctionParameterNode.md) +- [FunctionType](interfaces/FunctionType.md) +- [IdentifierContext](interfaces/IdentifierContext.md) +- [IdentifierNode](interfaces/IdentifierNode.md) +- [ImportStatementNode](interfaces/ImportStatementNode.md) +- [Interface](interfaces/Interface.md) +- [InterfaceStatementNode](interfaces/InterfaceStatementNode.md) +- [IntersectionExpressionNode](interfaces/IntersectionExpressionNode.md) +- [IntrinsicType](interfaces/IntrinsicType.md) +- [InvalidStatementNode](interfaces/InvalidStatementNode.md) +- [JSONSchemaValidator](interfaces/JSONSchemaValidator.md) +- [JsNamespaceDeclarationNode](interfaces/JsNamespaceDeclarationNode.md) +- [JsSourceFileNode](interfaces/JsSourceFileNode.md) +- [LibraryInstance](interfaces/LibraryInstance.md) +- [LibraryLocationContext](interfaces/LibraryLocationContext.md) +- [LineAndCharacter](interfaces/LineAndCharacter.md) +- [LineComment](interfaces/LineComment.md) +- [LinterDefinition](interfaces/LinterDefinition.md) +- [LinterRule](interfaces/LinterRule.md) +- [LinterRuleContext](interfaces/LinterRuleContext.md) +- [LinterRuleDefinition](interfaces/LinterRuleDefinition.md) +- [LinterRuleSet](interfaces/LinterRuleSet.md) +- [ListOperationOptions](interfaces/ListOperationOptions.md) +- [LogInfo](interfaces/LogInfo.md) +- [LogSink](interfaces/LogSink.md) +- [Logger](interfaces/Logger.md) +- [MemberExpressionNode](interfaces/MemberExpressionNode.md) +- [Model](interfaces/Model.md) +- [ModelExpressionNode](interfaces/ModelExpressionNode.md) +- [ModelProperty](interfaces/ModelProperty.md) +- [ModelPropertyNode](interfaces/ModelPropertyNode.md) +- [ModelSpreadPropertyNode](interfaces/ModelSpreadPropertyNode.md) +- [ModelStatementNode](interfaces/ModelStatementNode.md) +- [ModuleLibraryMetadata](interfaces/ModuleLibraryMetadata.md) +- [Namespace](interfaces/Namespace.md) +- [NamespaceNavigationOptions](interfaces/NamespaceNavigationOptions.md) +- [NamespaceStatementNode](interfaces/NamespaceStatementNode.md) +- [NavigationOptions](interfaces/NavigationOptions.md) +- [NeverKeywordNode](interfaces/NeverKeywordNode.md) +- [NeverType](interfaces/NeverType.md) +- [NodePackage](interfaces/NodePackage.md) +- [NullType](interfaces/NullType.md) +- [NumericLiteral](interfaces/NumericLiteral.md) +- [NumericLiteralNode](interfaces/NumericLiteralNode.md) +- [ObjectType](interfaces/ObjectType.md) +- [Operation](interfaces/Operation.md) +- [OperationSignatureDeclarationNode](interfaces/OperationSignatureDeclarationNode.md) +- [OperationSignatureReferenceNode](interfaces/OperationSignatureReferenceNode.md) +- [OperationStatementNode](interfaces/OperationStatementNode.md) +- [ParseOptions](interfaces/ParseOptions.md) +- [ProcessedLog](interfaces/ProcessedLog.md) +- [Program](interfaces/Program.md) +- [ProjectLocationContext](interfaces/ProjectLocationContext.md) +- [ProjectedNameView](interfaces/ProjectedNameView.md) +- [ProjectedProgram](interfaces/ProjectedProgram.md) +- [Projection](interfaces/Projection.md) +- [ProjectionApplication](interfaces/ProjectionApplication.md) +- [ProjectionArithmeticExpressionNode](interfaces/ProjectionArithmeticExpressionNode.md) +- [ProjectionBlockExpressionNode](interfaces/ProjectionBlockExpressionNode.md) +- [ProjectionCallExpressionNode](interfaces/ProjectionCallExpressionNode.md) +- [ProjectionDecoratorReferenceExpressionNode](interfaces/ProjectionDecoratorReferenceExpressionNode.md) +- [ProjectionEnumMemberSelectorNode](interfaces/ProjectionEnumMemberSelectorNode.md) +- [ProjectionEnumSelectorNode](interfaces/ProjectionEnumSelectorNode.md) +- [ProjectionEqualityExpressionNode](interfaces/ProjectionEqualityExpressionNode.md) +- [ProjectionExpressionStatementNode](interfaces/ProjectionExpressionStatementNode.md) +- [ProjectionIfExpressionNode](interfaces/ProjectionIfExpressionNode.md) +- [ProjectionInterfaceSelectorNode](interfaces/ProjectionInterfaceSelectorNode.md) +- [ProjectionLambdaExpressionNode](interfaces/ProjectionLambdaExpressionNode.md) +- [ProjectionLambdaParameterDeclarationNode](interfaces/ProjectionLambdaParameterDeclarationNode.md) +- [ProjectionLogicalExpressionNode](interfaces/ProjectionLogicalExpressionNode.md) +- [ProjectionMemberExpressionNode](interfaces/ProjectionMemberExpressionNode.md) +- [ProjectionModelExpressionNode](interfaces/ProjectionModelExpressionNode.md) +- [ProjectionModelPropertyNode](interfaces/ProjectionModelPropertyNode.md) +- [ProjectionModelPropertySelectorNode](interfaces/ProjectionModelPropertySelectorNode.md) +- [ProjectionModelSelectorNode](interfaces/ProjectionModelSelectorNode.md) +- [ProjectionModelSpreadPropertyNode](interfaces/ProjectionModelSpreadPropertyNode.md) +- [ProjectionNode](interfaces/ProjectionNode.md) +- [ProjectionOperationSelectorNode](interfaces/ProjectionOperationSelectorNode.md) +- [ProjectionParameterDeclarationNode](interfaces/ProjectionParameterDeclarationNode.md) +- [ProjectionReferenceNode](interfaces/ProjectionReferenceNode.md) +- [ProjectionRelationalExpressionNode](interfaces/ProjectionRelationalExpressionNode.md) +- [ProjectionStatementNode](interfaces/ProjectionStatementNode.md) +- [ProjectionTupleExpressionNode](interfaces/ProjectionTupleExpressionNode.md) +- [ProjectionUnaryExpressionNode](interfaces/ProjectionUnaryExpressionNode.md) +- [ProjectionUnionSelectorNode](interfaces/ProjectionUnionSelectorNode.md) +- [ProjectionUnionVariantSelectorNode](interfaces/ProjectionUnionVariantSelectorNode.md) +- [Projector](interfaces/Projector.md) +- [RecordModelType](interfaces/RecordModelType.md) +- [ResolveCompilerOptionsOptions](interfaces/ResolveCompilerOptionsOptions.md) +- [ResolveModuleHost](interfaces/ResolveModuleHost.md) +- [ResolveModuleOptions](interfaces/ResolveModuleOptions.md) +- [ResolvedFile](interfaces/ResolvedFile.md) +- [ResolvedModule](interfaces/ResolvedModule.md) +- [ReturnExpressionNode](interfaces/ReturnExpressionNode.md) +- [ReturnRecord](interfaces/ReturnRecord.md) +- [RmOptions](interfaces/RmOptions.md) +- [Scalar](interfaces/Scalar.md) +- [ScalarStatementNode](interfaces/ScalarStatementNode.md) +- [Scanner](interfaces/Scanner.md) +- [SemanticToken](interfaces/SemanticToken.md) +- [Server](interfaces/Server.md) +- [ServerHost](interfaces/ServerHost.md) +- [ServerSourceFile](interfaces/ServerSourceFile.md) +- [ServerWorkspaceFolder](interfaces/ServerWorkspaceFolder.md) +- [Service](interfaces/Service.md) +- [ServiceDetails](interfaces/ServiceDetails.md) +- [SourceFile](interfaces/SourceFile.md) +- [SourceLocation](interfaces/SourceLocation.md) +- [SourceLocationOptions](interfaces/SourceLocationOptions.md) +- [StringLiteral](interfaces/StringLiteral.md) +- [StringLiteralNode](interfaces/StringLiteralNode.md) +- [SuppressDirective](interfaces/SuppressDirective.md) +- [Sym](interfaces/Sym.md) +- [SymbolLinks](interfaces/SymbolLinks.md) +- [SyntheticLocationContext](interfaces/SyntheticLocationContext.md) +- [TemplateDeclarationNode](interfaces/TemplateDeclarationNode.md) +- [TemplateParameter](interfaces/TemplateParameter.md) +- [TemplateParameterDeclarationNode](interfaces/TemplateParameterDeclarationNode.md) +- [TemplatedTypeBase](interfaces/TemplatedTypeBase.md) +- [TextRange](interfaces/TextRange.md) +- [Tracer](interfaces/Tracer.md) +- [TracerOptions](interfaces/TracerOptions.md) +- [Tuple](interfaces/Tuple.md) +- [TupleExpressionNode](interfaces/TupleExpressionNode.md) +- [TypeInstantiationMap](interfaces/TypeInstantiationMap.md) +- [TypeMapper](interfaces/TypeMapper.md) +- [TypeNameOptions](interfaces/TypeNameOptions.md) +- [TypeReferenceNode](interfaces/TypeReferenceNode.md) +- [TypeSpecCompletionItem](interfaces/TypeSpecCompletionItem.md) +- [TypeSpecLibrary](interfaces/TypeSpecLibrary.md) +- [TypeSpecLibraryDef](interfaces/TypeSpecLibraryDef.md) +- [TypeSpecManifest](interfaces/TypeSpecManifest.md) +- [TypeSpecScriptNode](interfaces/TypeSpecScriptNode.md) +- [Union](interfaces/Union.md) +- [UnionExpressionNode](interfaces/UnionExpressionNode.md) +- [UnionStatementNode](interfaces/UnionStatementNode.md) +- [UnionVariant](interfaces/UnionVariant.md) +- [UnionVariantNode](interfaces/UnionVariantNode.md) +- [UnknownType](interfaces/UnknownType.md) +- [UsageTracker](interfaces/UsageTracker.md) +- [UsingStatementNode](interfaces/UsingStatementNode.md) +- [ValueOfExpressionNode](interfaces/ValueOfExpressionNode.md) +- [ValueType](interfaces/ValueType.md) +- [VoidKeywordNode](interfaces/VoidKeywordNode.md) +- [VoidType](interfaces/VoidType.md) ### Type Aliases -- [CadlCompletionItem](Type.CadlCompletionItem.md) -- [CadlLibrary](Type.CadlLibrary.md) -- [CadlLibraryDef](Type.CadlLibraryDef.md) -- [CadlManifest](Type.CadlManifest.md) -- [CadlScriptNode](Type.CadlScriptNode.md) -- [CadlValue](Type.CadlValue.md) -- [Comment](Type.Comment.md) -- [CreateTypeProps](Type.CreateTypeProps.md) -- [Declaration](Type.Declaration.md) -- [DecoratorArgumentValue](Type.DecoratorArgumentValue.md) -- [DiagnosticFormat](Type.DiagnosticFormat.md) -- [DiagnosticHandler](Type.DiagnosticHandler.md) -- [DiagnosticMap](Type.DiagnosticMap.md) -- [DiagnosticReport](Type.DiagnosticReport.md) -- [DiagnosticReportWithoutTarget](Type.DiagnosticReportWithoutTarget.md) -- [DiagnosticResult](Type.DiagnosticResult.md) -- [DiagnosticSeverity](Type.DiagnosticSeverity.md) -- [DiagnosticTarget](Type.DiagnosticTarget.md) -- [Directive](Type.Directive.md) -- [DirectiveArgument](Type.DirectiveArgument.md) -- [DocContent](Type.DocContent.md) -- [DocTag](Type.DocTag.md) -- [DocToken](Type.DocToken.md) -- [EmitOptionsFor](Type.EmitOptionsFor.md) -- [EmitterFunc](Type.EmitterFunc.md) -- [Expression](Type.Expression.md) -- [InferredCadlValue](Type.InferredCadlValue.md) -- [InferredTypeSpecValue](Type.InferredTypeSpecValue.md) -- [IntrinsicScalarName](Type.IntrinsicScalarName.md) -- [JSONSchemaType](Type.JSONSchemaType.md) -- [LibraryMetadata](Type.LibraryMetadata.md) -- [LinterRuleDiagnosticFormat](Type.LinterRuleDiagnosticFormat.md) -- [LinterRuleDiagnosticReport](Type.LinterRuleDiagnosticReport.md) -- [LinterRuleDiagnosticReportWithoutTarget](Type.LinterRuleDiagnosticReportWithoutTarget.md) -- [LiteralNode](Type.LiteralNode.md) -- [LiteralType](Type.LiteralType.md) -- [LocationContext](Type.LocationContext.md) -- [LogLevel](Type.LogLevel.md) -- [MarshalledValue](Type.MarshalledValue.md) -- [MemberContainerNode](Type.MemberContainerNode.md) -- [MemberContainerType](Type.MemberContainerType.md) -- [MemberNode](Type.MemberNode.md) -- [MemberType](Type.MemberType.md) -- [ModelIndexer](Type.ModelIndexer.md) -- [Modifier](Type.Modifier.md) -- [ModuleResolutionResult](Type.ModuleResolutionResult.md) -- [NeverIndexer](Type.NeverIndexer.md) -- [NewLine](Type.NewLine.md) -- [Node](Type.Node.md) -- [NodeCallback](Type.NodeCallback.md) -- [OperationContainer](Type.OperationContainer.md) -- [OperationSignature](Type.OperationSignature.md) -- [ProjectionExpression](Type.ProjectionExpression.md) -- [ProjectionStatementItem](Type.ProjectionStatementItem.md) -- [ReferenceExpression](Type.ReferenceExpression.md) -- [RuleRef](Type.RuleRef.md) -- [ScopeNode](Type.ScopeNode.md) -- [SemanticNodeListener](Type.SemanticNodeListener.md) -- [SourceFileKind](Type.SourceFileKind.md) -- [Statement](Type.Statement.md) -- [StdTypeName](Type.StdTypeName.md) -- [StdTypes](Type.StdTypes.md) -- [TemplateableNode](Type.TemplateableNode.md) -- [TemplatedType](Type.TemplatedType.md) -- [TrackableType](Type.TrackableType.md) -- [Type](Type.Type.md) -- [TypeKind](Type.TypeKind.md) -- [TypeListeners](Type.TypeListeners.md) -- [TypeOfDiagnostics](Type.TypeOfDiagnostics.md) -- [TypeOrReturnRecord](Type.TypeOrReturnRecord.md) -- [TypeSpecDiagnosticTarget](Type.TypeSpecDiagnosticTarget.md) -- [TypeSpecValue](Type.TypeSpecValue.md) -- [WriteLine](Type.WriteLine.md) +- [BytesKnownEncoding](type-aliases/BytesKnownEncoding.md) +- [CadlCompletionItem](type-aliases/CadlCompletionItem.md) +- [CadlLibrary](type-aliases/CadlLibrary.md) +- [CadlLibraryDef](type-aliases/CadlLibraryDef.md) +- [CadlManifest](type-aliases/CadlManifest.md) +- [CadlScriptNode](type-aliases/CadlScriptNode.md) +- [CadlValue](type-aliases/CadlValue.md) +- [Comment](type-aliases/Comment.md) +- [CreateTypeProps](type-aliases/CreateTypeProps.md) +- [DateTimeKnownEncoding](type-aliases/DateTimeKnownEncoding.md) +- [Declaration](type-aliases/Declaration.md) +- [DecoratorArgumentValue](type-aliases/DecoratorArgumentValue.md) +- [DiagnosticFormat](type-aliases/DiagnosticFormat.md) +- [DiagnosticHandler](type-aliases/DiagnosticHandler.md) +- [DiagnosticMap](type-aliases/DiagnosticMap.md) +- [DiagnosticReport](type-aliases/DiagnosticReport.md) +- [DiagnosticReportWithoutTarget](type-aliases/DiagnosticReportWithoutTarget.md) +- [DiagnosticResult](type-aliases/DiagnosticResult.md) +- [DiagnosticSeverity](type-aliases/DiagnosticSeverity.md) +- [DiagnosticTarget](type-aliases/DiagnosticTarget.md) +- [Directive](type-aliases/Directive.md) +- [DirectiveArgument](type-aliases/DirectiveArgument.md) +- [DocContent](type-aliases/DocContent.md) +- [DocTag](type-aliases/DocTag.md) +- [DocToken](type-aliases/DocToken.md) +- [DurationKnownEncoding](type-aliases/DurationKnownEncoding.md) +- [EmitOptionsFor](type-aliases/EmitOptionsFor.md) +- [EmitterFunc](type-aliases/EmitterFunc.md) +- [Expression](type-aliases/Expression.md) +- [InferredCadlValue](type-aliases/InferredCadlValue.md) +- [InferredTypeSpecValue](type-aliases/InferredTypeSpecValue.md) +- [IntrinsicScalarName](type-aliases/IntrinsicScalarName.md) +- [JSONSchemaType](type-aliases/JSONSchemaType.md) +- [LibraryMetadata](type-aliases/LibraryMetadata.md) +- [LinterRuleDiagnosticFormat](type-aliases/LinterRuleDiagnosticFormat.md) +- [LinterRuleDiagnosticReport](type-aliases/LinterRuleDiagnosticReport.md) +- [LinterRuleDiagnosticReportWithoutTarget](type-aliases/LinterRuleDiagnosticReportWithoutTarget.md) +- [LiteralNode](type-aliases/LiteralNode.md) +- [LiteralType](type-aliases/LiteralType.md) +- [LocationContext](type-aliases/LocationContext.md) +- [LogLevel](type-aliases/LogLevel.md) +- [MarshalledValue](type-aliases/MarshalledValue.md) +- [MemberContainerNode](type-aliases/MemberContainerNode.md) +- [MemberContainerType](type-aliases/MemberContainerType.md) +- [MemberNode](type-aliases/MemberNode.md) +- [MemberType](type-aliases/MemberType.md) +- [ModelIndexer](type-aliases/ModelIndexer.md) +- [Modifier](type-aliases/Modifier.md) +- [ModuleResolutionResult](type-aliases/ModuleResolutionResult.md) +- [NeverIndexer](type-aliases/NeverIndexer.md) +- [NewLine](type-aliases/NewLine.md) +- [Node](type-aliases/Node.md) +- [NodeCallback](type-aliases/NodeCallback.md) +- [OperationContainer](type-aliases/OperationContainer.md) +- [OperationSignature](type-aliases/OperationSignature.md) +- [ProjectionExpression](type-aliases/ProjectionExpression.md) +- [ProjectionStatementItem](type-aliases/ProjectionStatementItem.md) +- [ReferenceExpression](type-aliases/ReferenceExpression.md) +- [RuleRef](type-aliases/RuleRef.md) +- [ScopeNode](type-aliases/ScopeNode.md) +- [SemanticNodeListener](type-aliases/SemanticNodeListener.md) +- [SourceFileKind](type-aliases/SourceFileKind.md) +- [Statement](type-aliases/Statement.md) +- [StdTypeName](type-aliases/StdTypeName.md) +- [StdTypes](type-aliases/StdTypes.md) +- [TemplateableNode](type-aliases/TemplateableNode.md) +- [TemplatedType](type-aliases/TemplatedType.md) +- [TrackableType](type-aliases/TrackableType.md) +- [Type](type-aliases/Type.md) +- [TypeKind](type-aliases/TypeKind.md) +- [TypeListeners](type-aliases/TypeListeners.md) +- [TypeOfDiagnostics](type-aliases/TypeOfDiagnostics.md) +- [TypeOrReturnRecord](type-aliases/TypeOrReturnRecord.md) +- [TypeSpecDiagnosticTarget](type-aliases/TypeSpecDiagnosticTarget.md) +- [TypeSpecValue](type-aliases/TypeSpecValue.md) +- [WriteLine](type-aliases/WriteLine.md) ### Variables -- [CadlPrettierPlugin](Variable.CadlPrettierPlugin.md) -- [Keywords](Variable.Keywords.md) -- [MANIFEST](Variable.MANIFEST.md) -- [NoTarget](Variable.NoTarget.md) -- [NodeHost](Variable.NodeHost.md) -- [TokenDisplay](Variable.TokenDisplay.md) -- [TypeSpecPrettierPlugin](Variable.TypeSpecPrettierPlugin.md) -- [altDirectorySeparator](Variable.altDirectorySeparator.md) -- [cadlVersion](Variable.cadlVersion.md) -- [directorySeparator](Variable.directorySeparator.md) -- [typespecVersion](Variable.typespecVersion.md) +- [CadlPrettierPlugin](variables/CadlPrettierPlugin.md) +- [MANIFEST](variables/MANIFEST.md) +- [NoTarget](variables/NoTarget.md) +- [NodeHost](variables/NodeHost.md) +- [TypeSpecPrettierPlugin](variables/TypeSpecPrettierPlugin.md) +- [altDirectorySeparator](variables/altDirectorySeparator.md) +- [cadlVersion](variables/cadlVersion.md) +- [directorySeparator](variables/directorySeparator.md) +- [namespace](variables/namespace.md) +- [typespecVersion](variables/typespecVersion.md) ### Functions -- [assertType](Function.assertType.md) -- [cadlTypeToJson](Function.cadlTypeToJson.md) -- [checkFormatCadl](Function.checkFormatCadl.md) -- [checkFormatTypeSpec](Function.checkFormatTypeSpec.md) -- [compile](Function.compile.md) -- [compilerAssert](Function.compilerAssert.md) -- [createCadlLibrary](Function.createCadlLibrary.md) -- [createChecker](Function.createChecker.md) -- [createDecoratorDefinition](Function.createDecoratorDefinition.md) -- [createDiagnosticCollector](Function.createDiagnosticCollector.md) -- [createDiagnosticCreator](Function.createDiagnosticCreator.md) -- [createProjectedNameProgram](Function.createProjectedNameProgram.md) -- [createRekeyableMap](Function.createRekeyableMap.md) -- [createRule](Function.createRule.md) -- [createScanner](Function.createScanner.md) -- [createServer](Function.createServer.md) -- [createSourceFile](Function.createSourceFile.md) -- [createStateAccessors](Function.createStateAccessors.md) -- [createTypeSpecLibrary](Function.createTypeSpecLibrary.md) -- [emitFile](Function.emitFile.md) -- [ensurePathIsNonModuleName](Function.ensurePathIsNonModuleName.md) -- [ensureTrailingDirectorySeparator](Function.ensureTrailingDirectorySeparator.md) -- [filterModelProperties](Function.filterModelProperties.md) -- [finishTypeForProgram](Function.finishTypeForProgram.md) -- [formatDiagnostic](Function.formatDiagnostic.md) -- [formatIdentifier](Function.formatIdentifier.md) -- [formatTypeSpec](Function.formatTypeSpec.md) -- [getAnyExtensionFromPath](Function.getAnyExtensionFromPath.md) -- [getBaseFileName](Function.getBaseFileName.md) -- [getCompletionNodeAtPosition](Function.getCompletionNodeAtPosition.md) -- [getDeprecationDetails](Function.getDeprecationDetails.md) -- [getDirectoryPath](Function.getDirectoryPath.md) -- [getDiscriminatedUnion](Function.getDiscriminatedUnion.md) -- [getEffectiveModelType](Function.getEffectiveModelType.md) -- [getFirstAncestor](Function.getFirstAncestor.md) -- [getFullyQualifiedSymbolName](Function.getFullyQualifiedSymbolName.md) -- [getIdentifierContext](Function.getIdentifierContext.md) -- [getLocationContext](Function.getLocationContext.md) -- [getNamespaceFullName](Function.getNamespaceFullName.md) -- [getNodeAtPosition](Function.getNodeAtPosition.md) -- [getNormalizedAbsolutePath](Function.getNormalizedAbsolutePath.md) -- [getNormalizedAbsolutePathWithoutRoot](Function.getNormalizedAbsolutePathWithoutRoot.md) -- [getNormalizedPathComponents](Function.getNormalizedPathComponents.md) -- [getOverriddenProperty](Function.getOverriddenProperty.md) -- [getParentTemplateNode](Function.getParentTemplateNode.md) -- [getPathComponents](Function.getPathComponents.md) -- [getPathFromPathComponents](Function.getPathFromPathComponents.md) -- [getProperty](Function.getProperty.md) -- [getRelativePathFromDirectory](Function.getRelativePathFromDirectory.md) -- [getRootLength](Function.getRootLength.md) -- [getSourceFileKindFromExt](Function.getSourceFileKindFromExt.md) -- [getSourceLocation](Function.getSourceLocation.md) -- [getTypeName](Function.getTypeName.md) -- [hasParseError](Function.hasParseError.md) -- [hasTrailingDirectorySeparator](Function.hasTrailingDirectorySeparator.md) -- [ignoreDiagnostics](Function.ignoreDiagnostics.md) -- [interpolatePath](Function.interpolatePath.md) -- [isAnyDirectorySeparator](Function.isAnyDirectorySeparator.md) -- [isCadlValueTypeOf](Function.isCadlValueTypeOf.md) -- [isComment](Function.isComment.md) -- [isDeclaredInNamespace](Function.isDeclaredInNamespace.md) -- [isDeclaredType](Function.isDeclaredType.md) -- [isDeprecated](Function.isDeprecated.md) -- [isErrorType](Function.isErrorType.md) -- [isGlobalNamespace](Function.isGlobalNamespace.md) -- [isImportStatement](Function.isImportStatement.md) -- [isIntrinsicType](Function.isIntrinsicType.md) -- [isKeyword](Function.isKeyword.md) -- [isModifier](Function.isModifier.md) -- [isNeverType](Function.isNeverType.md) -- [isNullType](Function.isNullType.md) -- [isPathAbsolute](Function.isPathAbsolute.md) -- [isProjectedProgram](Function.isProjectedProgram.md) -- [isPunctuation](Function.isPunctuation.md) -- [isStatementKeyword](Function.isStatementKeyword.md) -- [isStdNamespace](Function.isStdNamespace.md) -- [isTemplateDeclaration](Function.isTemplateDeclaration.md) -- [isTemplateDeclarationOrInstance](Function.isTemplateDeclarationOrInstance.md) -- [isTemplateInstance](Function.isTemplateInstance.md) -- [isTrivia](Function.isTrivia.md) -- [isTypeSpecValueTypeOf](Function.isTypeSpecValueTypeOf.md) -- [isUnknownType](Function.isUnknownType.md) -- [isUrl](Function.isUrl.md) -- [isVoidType](Function.isVoidType.md) -- [joinPaths](Function.joinPaths.md) -- [listOperationsIn](Function.listOperationsIn.md) -- [logDiagnostics](Function.logDiagnostics.md) -- [logVerboseTestOutput](Function.logVerboseTestOutput.md) -- [mapEventEmitterToNodeListener](Function.mapEventEmitterToNodeListener.md) -- [markDeprecated](Function.markDeprecated.md) -- [navigateProgram](Function.navigateProgram.md) -- [navigateType](Function.navigateType.md) -- [navigateTypesInNamespace](Function.navigateTypesInNamespace.md) -- [normalizePath](Function.normalizePath.md) -- [normalizeSlashes](Function.normalizeSlashes.md) -- [paramMessage](Function.paramMessage.md) -- [parse](Function.parse.md) -- [parseStandaloneTypeReference](Function.parseStandaloneTypeReference.md) -- [projectProgram](Function.projectProgram.md) -- [reducePathComponents](Function.reducePathComponents.md) -- [removeTrailingDirectorySeparator](Function.removeTrailingDirectorySeparator.md) -- [reportDeprecated](Function.reportDeprecated.md) -- [resolveCompilerOptions](Function.resolveCompilerOptions.md) -- [resolveModule](Function.resolveModule.md) -- [resolvePath](Function.resolvePath.md) -- [resolveUsages](Function.resolveUsages.md) -- [scopeNavigationToNamespace](Function.scopeNavigationToNamespace.md) -- [setCadlNamespace](Function.setCadlNamespace.md) -- [setTypeSpecNamespace](Function.setTypeSpecNamespace.md) -- [skipTrivia](Function.skipTrivia.md) -- [skipWhiteSpace](Function.skipWhiteSpace.md) -- [typespecTypeToJson](Function.typespecTypeToJson.md) -- [validateDecoratorNotOnType](Function.validateDecoratorNotOnType.md) -- [validateDecoratorParamCount](Function.validateDecoratorParamCount.md) -- [validateDecoratorParamType](Function.validateDecoratorParamType.md) -- [validateDecoratorTarget](Function.validateDecoratorTarget.md) -- [validateDecoratorTargetIntrinsic](Function.validateDecoratorTargetIntrinsic.md) -- [validateDecoratorUniqueOnNode](Function.validateDecoratorUniqueOnNode.md) -- [visitChildren](Function.visitChildren.md) -- [walkPropertiesInherited](Function.walkPropertiesInherited.md) - -## References - -### $deprecated - -Re-exports [$deprecated](Namespace.decorators.Function.$deprecated.md) - -```ts -$deprecated -``` - -*** - -### $discriminator - -Re-exports [$discriminator](Namespace.decorators.Function.$discriminator.md) - -```ts -$discriminator -``` - -*** - -### $doc - -Re-exports [$doc](Namespace.decorators.Function.$doc.md) - -```ts -$doc -``` - -*** - -### $docFromComment - -Re-exports [$docFromComment](Namespace.decorators.Function.$docFromComment.md) - -```ts -$docFromComment -``` - -*** - -### $encode - -Re-exports [$encode](Namespace.decorators.Function.$encode.md) - -```ts -$encode -``` - -*** - -### $error - -Re-exports [$error](Namespace.decorators.Function.$error.md) - -```ts -$error -``` - -*** - -### $format - -Re-exports [$format](Namespace.decorators.Function.$format.md) - -```ts -$format -``` - -*** - -### $friendlyName - -Re-exports [$friendlyName](Namespace.decorators.Function.$friendlyName.md) - -```ts -$friendlyName -``` - -*** - -### $indexer - -Re-exports [$indexer](Namespace.decorators.Function.$indexer.md) - -```ts -$indexer -``` - -*** - -### $inspectType - -Re-exports [$inspectType](Namespace.decorators.Function.$inspectType.md) - -```ts -$inspectType -``` - -*** - -### $inspectTypeName - -Re-exports [$inspectTypeName](Namespace.decorators.Function.$inspectTypeName.md) - -```ts -$inspectTypeName -``` - -*** - -### $key - -Re-exports [$key](Namespace.decorators.Function.$key.md) - -```ts -$key -``` - -*** - -### $knownValues - -Re-exports [$knownValues](Namespace.decorators.Function.$knownValues.md) - -```ts -$knownValues -``` - -*** - -### $list - -Re-exports [$list](Namespace.decorators.Function.$list.md) - -```ts -$list -``` - -*** - -### $maxItems - -Re-exports [$maxItems](Namespace.decorators.Function.$maxItems.md) - -```ts -$maxItems -``` - -*** - -### $maxLength - -Re-exports [$maxLength](Namespace.decorators.Function.$maxLength.md) - -```ts -$maxLength -``` - -*** - -### $maxValue - -Re-exports [$maxValue](Namespace.decorators.Function.$maxValue.md) - -```ts -$maxValue -``` - -*** - -### $maxValueExclusive - -Re-exports [$maxValueExclusive](Namespace.decorators.Function.$maxValueExclusive.md) - -```ts -$maxValueExclusive -``` - -*** - -### $minItems - -Re-exports [$minItems](Namespace.decorators.Function.$minItems.md) - -```ts -$minItems -``` - -*** - -### $minLength - -Re-exports [$minLength](Namespace.decorators.Function.$minLength.md) - -```ts -$minLength -``` - -*** - -### $minValue - -Re-exports [$minValue](Namespace.decorators.Function.$minValue.md) - -```ts -$minValue -``` - -*** - -### $minValueExclusive - -Re-exports [$minValueExclusive](Namespace.decorators.Function.$minValueExclusive.md) - -```ts -$minValueExclusive -``` - -*** - -### $overload - -Re-exports [$overload](Namespace.decorators.Function.$overload.md) - -```ts -$overload -``` - -*** - -### $parameterVisibility - -Re-exports [$parameterVisibility](Namespace.decorators.Function.$parameterVisibility.md) - -```ts -$parameterVisibility -``` - -*** - -### $pattern - -Re-exports [$pattern](Namespace.decorators.Function.$pattern.md) - -```ts -$pattern -``` - -*** - -### $projectedName - -Re-exports [$projectedName](Namespace.decorators.Function.$projectedName.md) - -```ts -$projectedName -``` - -*** - -### $returnTypeVisibility - -Re-exports [$returnTypeVisibility](Namespace.decorators.Function.$returnTypeVisibility.md) - -```ts -$returnTypeVisibility -``` - -*** - -### $secret - -Re-exports [$secret](Namespace.decorators.Function.$secret.md) - -```ts -$secret -``` - -*** - -### $service - -Re-exports [$service](Namespace.decorators.Function.$service.md) - -```ts -$service -``` - -*** - -### $summary - -Re-exports [$summary](Namespace.decorators.Function.$summary.md) - -```ts -$summary -``` - -*** - -### $tag - -Re-exports [$tag](Namespace.decorators.Function.$tag.md) - -```ts -$tag -``` - -*** - -### $visibility - -Re-exports [$visibility](Namespace.decorators.Function.$visibility.md) - -```ts -$visibility -``` - -*** - -### $withDefaultKeyVisibility - -Re-exports [$withDefaultKeyVisibility](Namespace.decorators.Function.$withDefaultKeyVisibility.md) - -```ts -$withDefaultKeyVisibility -``` - -*** - -### $withOptionalProperties - -Re-exports [$withOptionalProperties](Namespace.decorators.Function.$withOptionalProperties.md) - -```ts -$withOptionalProperties -``` - -*** - -### $withUpdateableProperties - -Re-exports [$withUpdateableProperties](Namespace.decorators.Function.$withUpdateableProperties.md) - -```ts -$withUpdateableProperties -``` - -*** - -### $withVisibility - -Re-exports [$withVisibility](Namespace.decorators.Function.$withVisibility.md) - -```ts -$withVisibility -``` - -*** - -### $withoutDefaultValues - -Re-exports [$withoutDefaultValues](Namespace.decorators.Function.$withoutDefaultValues.md) - -```ts -$withoutDefaultValues -``` - -*** - -### $withoutOmittedProperties - -Re-exports [$withoutOmittedProperties](Namespace.decorators.Function.$withoutOmittedProperties.md) - -```ts -$withoutOmittedProperties -``` - -*** - -### BytesKnownEncoding - -Re-exports [BytesKnownEncoding](Namespace.decorators.Type.BytesKnownEncoding.md) - -```ts -BytesKnownEncoding -``` - -*** - -### DateTimeKnownEncoding - -Re-exports [DateTimeKnownEncoding](Namespace.decorators.Type.DateTimeKnownEncoding.md) - -```ts -DateTimeKnownEncoding -``` - -*** - -### Discriminator - -Re-exports [Discriminator](Namespace.decorators.Interface.Discriminator.md) - -```ts -Discriminator -``` - -*** - -### DocData - -Re-exports [DocData](Namespace.decorators.Interface.DocData.md) - -```ts -DocData -``` - -*** - -### DurationKnownEncoding - -Re-exports [DurationKnownEncoding](Namespace.decorators.Type.DurationKnownEncoding.md) - -```ts -DurationKnownEncoding -``` - -*** - -### EncodeData - -Re-exports [EncodeData](Namespace.decorators.Interface.EncodeData.md) - -```ts -EncodeData -``` - -*** - -### Service - -Re-exports [Service](Namespace.decorators.Interface.Service.md) - -```ts -Service -``` - -*** - -### ServiceDetails - -Re-exports [ServiceDetails](Namespace.decorators.Interface.ServiceDetails.md) - -```ts -ServiceDetails -``` - -*** - -### addService - -Re-exports [addService](Namespace.decorators.Function.addService.md) - -```ts -addService -``` - -*** - -### getAllTags - -Re-exports [getAllTags](Namespace.decorators.Function.getAllTags.md) - -```ts -getAllTags -``` - -*** - -### getDeprecated - -Re-exports [getDeprecated](Namespace.decorators.Function.getDeprecated.md) - -```ts -getDeprecated -``` - -*** - -### getDiscriminatedTypes - -Re-exports [getDiscriminatedTypes](Namespace.decorators.Function.getDiscriminatedTypes.md) - -```ts -getDiscriminatedTypes -``` - -*** - -### getDiscriminator - -Re-exports [getDiscriminator](Namespace.decorators.Function.getDiscriminator.md) - -```ts -getDiscriminator -``` - -*** - -### getDoc - -Re-exports [getDoc](Namespace.decorators.Function.getDoc.md) - -```ts -getDoc -``` - -*** - -### getDocData - -Re-exports [getDocData](Namespace.decorators.Function.getDocData.md) - -```ts -getDocData -``` - -*** - -### getEncode - -Re-exports [getEncode](Namespace.decorators.Function.getEncode.md) - -```ts -getEncode -``` - -*** - -### getFormat - -Re-exports [getFormat](Namespace.decorators.Function.getFormat.md) - -```ts -getFormat -``` - -*** - -### getFriendlyName - -Re-exports [getFriendlyName](Namespace.decorators.Function.getFriendlyName.md) - -```ts -getFriendlyName -``` - -*** - -### getIndexer - -Re-exports [getIndexer](Namespace.decorators.Function.getIndexer.md) - -```ts -getIndexer -``` - -*** - -### getKeyName - -Re-exports [getKeyName](Namespace.decorators.Function.getKeyName.md) - -```ts -getKeyName -``` - -*** - -### getKnownValues - -Re-exports [getKnownValues](Namespace.decorators.Function.getKnownValues.md) - -```ts -getKnownValues -``` - -*** - -### getListOperationType - -Re-exports [getListOperationType](Namespace.decorators.Function.getListOperationType.md) - -```ts -getListOperationType -``` - -*** - -### getMaxItems - -Re-exports [getMaxItems](Namespace.decorators.Function.getMaxItems.md) - -```ts -getMaxItems -``` - -*** - -### getMaxLength - -Re-exports [getMaxLength](Namespace.decorators.Function.getMaxLength.md) - -```ts -getMaxLength -``` - -*** - -### getMaxValue - -Re-exports [getMaxValue](Namespace.decorators.Function.getMaxValue.md) - -```ts -getMaxValue -``` - -*** - -### getMaxValueExclusive - -Re-exports [getMaxValueExclusive](Namespace.decorators.Function.getMaxValueExclusive.md) - -```ts -getMaxValueExclusive -``` - -*** - -### getMinItems - -Re-exports [getMinItems](Namespace.decorators.Function.getMinItems.md) - -```ts -getMinItems -``` - -*** - -### getMinLength - -Re-exports [getMinLength](Namespace.decorators.Function.getMinLength.md) - -```ts -getMinLength -``` - -*** - -### getMinValue - -Re-exports [getMinValue](Namespace.decorators.Function.getMinValue.md) - -```ts -getMinValue -``` - -*** - -### getMinValueExclusive - -Re-exports [getMinValueExclusive](Namespace.decorators.Function.getMinValueExclusive.md) - -```ts -getMinValueExclusive -``` - -*** - -### getOverloadedOperation - -Re-exports [getOverloadedOperation](Namespace.decorators.Function.getOverloadedOperation.md) - -```ts -getOverloadedOperation -``` - -*** - -### getOverloads - -Re-exports [getOverloads](Namespace.decorators.Function.getOverloads.md) - -```ts -getOverloads -``` - -*** - -### getParameterVisibility - -Re-exports [getParameterVisibility](Namespace.decorators.Function.getParameterVisibility.md) - -```ts -getParameterVisibility -``` - -*** - -### getPattern - -Re-exports [getPattern](Namespace.decorators.Function.getPattern.md) - -```ts -getPattern -``` - -*** - -### getProjectedName - -Re-exports [getProjectedName](Namespace.decorators.Function.getProjectedName.md) - -```ts -getProjectedName -``` - -*** - -### getProjectedNames - -Re-exports [getProjectedNames](Namespace.decorators.Function.getProjectedNames.md) - -```ts -getProjectedNames -``` - -*** - -### getPropertyType - -Re-exports [getPropertyType](Namespace.decorators.Function.getPropertyType.md) - -```ts -getPropertyType -``` - -*** - -### getReturnTypeVisibility - -Re-exports [getReturnTypeVisibility](Namespace.decorators.Function.getReturnTypeVisibility.md) - -```ts -getReturnTypeVisibility -``` - -*** - -### getService - -Re-exports [getService](Namespace.decorators.Function.getService.md) - -```ts -getService -``` - -*** - -### getSummary - -Re-exports [getSummary](Namespace.decorators.Function.getSummary.md) - -```ts -getSummary -``` - -*** - -### getTags - -Re-exports [getTags](Namespace.decorators.Function.getTags.md) - -```ts -getTags -``` - -*** - -### getVisibility - -Re-exports [getVisibility](Namespace.decorators.Function.getVisibility.md) - -```ts -getVisibility -``` - -*** - -### hasProjectedName - -Re-exports [hasProjectedName](Namespace.decorators.Function.hasProjectedName.md) - -```ts -hasProjectedName -``` - -*** - -### isArrayModelType - -Re-exports [isArrayModelType](Namespace.decorators.Function.isArrayModelType.md) - -```ts -isArrayModelType -``` - -*** - -### isErrorModel - -Re-exports [isErrorModel](Namespace.decorators.Function.isErrorModel.md) - -```ts -isErrorModel -``` - -*** - -### isKey - -Re-exports [isKey](Namespace.decorators.Function.isKey.md) - -```ts -isKey -``` - -*** - -### isListOperation - -Re-exports [isListOperation](Namespace.decorators.Function.isListOperation.md) - -```ts -isListOperation -``` - -*** - -### isNumericType - -Re-exports [isNumericType](Namespace.decorators.Function.isNumericType.md) - -```ts -isNumericType -``` - -*** - -### isRecordModelType - -Re-exports [isRecordModelType](Namespace.decorators.Function.isRecordModelType.md) - -```ts -isRecordModelType -``` - -*** - -### isSecret - -Re-exports [isSecret](Namespace.decorators.Function.isSecret.md) - -```ts -isSecret -``` - -*** - -### isService - -Re-exports [isService](Namespace.decorators.Function.isService.md) - -```ts -isService -``` - -*** - -### isStringType - -Re-exports [isStringType](Namespace.decorators.Function.isStringType.md) - -```ts -isStringType -``` - -*** - -### isVisible - -Re-exports [isVisible](Namespace.decorators.Function.isVisible.md) - -```ts -isVisible -``` - -*** - -### listServices - -Re-exports [listServices](Namespace.decorators.Function.listServices.md) - -```ts -listServices -``` - -*** - -### namespace - -Re-exports [namespace](Namespace.decorators.Variable.namespace.md) - -```ts -namespace -``` +- [$deprecated](functions/$deprecated.md) +- [$discriminator](functions/$discriminator.md) +- [$doc](functions/$doc.md) +- [$encode](functions/$encode.md) +- [$error](functions/$error.md) +- [$errorsDoc](functions/$errorsDoc.md) +- [$format](functions/$format.md) +- [$friendlyName](functions/$friendlyName.md) +- [$indexer](functions/$indexer.md) +- [$inspectType](functions/$inspectType.md) +- [$inspectTypeName](functions/$inspectTypeName.md) +- [$key](functions/$key.md) +- [$knownValues](functions/$knownValues.md) +- [$list](functions/$list.md) +- [$maxItems](functions/$maxItems.md) +- [$maxLength](functions/$maxLength.md) +- [$maxValue](functions/$maxValue.md) +- [$maxValueExclusive](functions/$maxValueExclusive.md) +- [$minItems](functions/$minItems.md) +- [$minLength](functions/$minLength.md) +- [$minValue](functions/$minValue.md) +- [$minValueExclusive](functions/$minValueExclusive.md) +- [$overload](functions/$overload.md) +- [$parameterVisibility](functions/$parameterVisibility.md) +- [$pattern](functions/$pattern.md) +- [$projectedName](functions/$projectedName.md) +- [$returnTypeVisibility](functions/$returnTypeVisibility.md) +- [$returnsDoc](functions/$returnsDoc.md) +- [$secret](functions/$secret.md) +- [$service](functions/$service.md) +- [$summary](functions/$summary.md) +- [$tag](functions/$tag.md) +- [$visibility](functions/$visibility.md) +- [$withDefaultKeyVisibility](functions/$withDefaultKeyVisibility.md) +- [$withOptionalProperties](functions/$withOptionalProperties.md) +- [$withUpdateableProperties](functions/$withUpdateableProperties.md) +- [$withVisibility](functions/$withVisibility.md) +- [$withoutDefaultValues](functions/$withoutDefaultValues.md) +- [$withoutOmittedProperties](functions/$withoutOmittedProperties.md) +- [addService](functions/addService.md) +- [assertType](functions/assertType.md) +- [cadlTypeToJson](functions/cadlTypeToJson.md) +- [checkFormatCadl](functions/checkFormatCadl.md) +- [checkFormatTypeSpec](functions/checkFormatTypeSpec.md) +- [compile](functions/compile.md) +- [compilerAssert](functions/compilerAssert.md) +- [createCadlLibrary](functions/createCadlLibrary.md) +- [createChecker](functions/createChecker.md) +- [createDecoratorDefinition](functions/createDecoratorDefinition.md) +- [createDiagnosticCollector](functions/createDiagnosticCollector.md) +- [createDiagnosticCreator](functions/createDiagnosticCreator.md) +- [createProjectedNameProgram](functions/createProjectedNameProgram.md) +- [createRekeyableMap](functions/createRekeyableMap.md) +- [createRule](functions/createRule.md) +- [createScanner](functions/createScanner.md) +- [createServer](functions/createServer.md) +- [createSourceFile](functions/createSourceFile.md) +- [createStateAccessors](functions/createStateAccessors.md) +- [createTypeSpecLibrary](functions/createTypeSpecLibrary.md) +- [emitFile](functions/emitFile.md) +- [ensureTrailingDirectorySeparator](functions/ensureTrailingDirectorySeparator.md) +- [filterModelProperties](functions/filterModelProperties.md) +- [finishTypeForProgram](functions/finishTypeForProgram.md) +- [formatDiagnostic](functions/formatDiagnostic.md) +- [formatIdentifier](functions/formatIdentifier.md) +- [formatTypeSpec](functions/formatTypeSpec.md) +- [getAllTags](functions/getAllTags.md) +- [getAnyExtensionFromPath](functions/getAnyExtensionFromPath.md) +- [getBaseFileName](functions/getBaseFileName.md) +- [getDeprecated](functions/getDeprecated.md) +- [getDeprecationDetails](functions/getDeprecationDetails.md) +- [getDirectoryPath](functions/getDirectoryPath.md) +- [getDiscriminatedTypes](functions/getDiscriminatedTypes.md) +- [getDiscriminatedUnion](functions/getDiscriminatedUnion.md) +- [getDiscriminator](functions/getDiscriminator.md) +- [getDoc](functions/getDoc.md) +- [getDocData](functions/getDocData.md) +- [getDocDataInternal](functions/getDocDataInternal.md) +- [getEffectiveModelType](functions/getEffectiveModelType.md) +- [getEncode](functions/getEncode.md) +- [getErrorsDoc](functions/getErrorsDoc.md) +- [getErrorsDocData](functions/getErrorsDocData.md) +- [getFirstAncestor](functions/getFirstAncestor.md) +- [getFormat](functions/getFormat.md) +- [getFriendlyName](functions/getFriendlyName.md) +- [getFullyQualifiedSymbolName](functions/getFullyQualifiedSymbolName.md) +- [getIdentifierContext](functions/getIdentifierContext.md) +- [getIndexer](functions/getIndexer.md) +- [getKeyName](functions/getKeyName.md) +- [getKnownValues](functions/getKnownValues.md) +- [getListOperationType](functions/getListOperationType.md) +- [getLocationContext](functions/getLocationContext.md) +- [getMaxItems](functions/getMaxItems.md) +- [getMaxLength](functions/getMaxLength.md) +- [getMaxValue](functions/getMaxValue.md) +- [getMaxValueExclusive](functions/getMaxValueExclusive.md) +- [getMinItems](functions/getMinItems.md) +- [getMinLength](functions/getMinLength.md) +- [getMinValue](functions/getMinValue.md) +- [getMinValueExclusive](functions/getMinValueExclusive.md) +- [getNamespaceFullName](functions/getNamespaceFullName.md) +- [getNodeAtPosition](functions/getNodeAtPosition.md) +- [getNormalizedAbsolutePath](functions/getNormalizedAbsolutePath.md) +- [getNormalizedAbsolutePathWithoutRoot](functions/getNormalizedAbsolutePathWithoutRoot.md) +- [getNormalizedPathComponents](functions/getNormalizedPathComponents.md) +- [getOverloadedOperation](functions/getOverloadedOperation.md) +- [getOverloads](functions/getOverloads.md) +- [getOverriddenProperty](functions/getOverriddenProperty.md) +- [getParameterVisibility](functions/getParameterVisibility.md) +- [getParentTemplateNode](functions/getParentTemplateNode.md) +- [getPathComponents](functions/getPathComponents.md) +- [getPathFromPathComponents](functions/getPathFromPathComponents.md) +- [getPattern](functions/getPattern.md) +- [getProjectedName](functions/getProjectedName.md) +- [getProjectedNames](functions/getProjectedNames.md) +- [getProperty](functions/getProperty.md) +- [getPropertyType](functions/getPropertyType.md) +- [getRelativePathFromDirectory](functions/getRelativePathFromDirectory.md) +- [getReturnTypeVisibility](functions/getReturnTypeVisibility.md) +- [getReturnsDoc](functions/getReturnsDoc.md) +- [getReturnsDocData](functions/getReturnsDocData.md) +- [getRootLength](functions/getRootLength.md) +- [getService](functions/getService.md) +- [getSourceFileKindFromExt](functions/getSourceFileKindFromExt.md) +- [getSourceLocation](functions/getSourceLocation.md) +- [getSummary](functions/getSummary.md) +- [getTags](functions/getTags.md) +- [getTypeName](functions/getTypeName.md) +- [getVisibility](functions/getVisibility.md) +- [hasParseError](functions/hasParseError.md) +- [hasProjectedName](functions/hasProjectedName.md) +- [hasTrailingDirectorySeparator](functions/hasTrailingDirectorySeparator.md) +- [ignoreDiagnostics](functions/ignoreDiagnostics.md) +- [interpolatePath](functions/interpolatePath.md) +- [isAnyDirectorySeparator](functions/isAnyDirectorySeparator.md) +- [isArrayModelType](functions/isArrayModelType.md) +- [isCadlValueTypeOf](functions/isCadlValueTypeOf.md) +- [isComment](functions/isComment.md) +- [isDeclaredInNamespace](functions/isDeclaredInNamespace.md) +- [isDeclaredType](functions/isDeclaredType.md) +- [isDeprecated](functions/isDeprecated.md) +- [isErrorModel](functions/isErrorModel.md) +- [isErrorType](functions/isErrorType.md) +- [isGlobalNamespace](functions/isGlobalNamespace.md) +- [isImportStatement](functions/isImportStatement.md) +- [isIntrinsicType](functions/isIntrinsicType.md) +- [isKey](functions/isKey.md) +- [isKeyword](functions/isKeyword.md) +- [isListOperation](functions/isListOperation.md) +- [isModifier](functions/isModifier.md) +- [isNeverType](functions/isNeverType.md) +- [isNullType](functions/isNullType.md) +- [isNumericType](functions/isNumericType.md) +- [isPathAbsolute](functions/isPathAbsolute.md) +- [isProjectedProgram](functions/isProjectedProgram.md) +- [isPunctuation](functions/isPunctuation.md) +- [isRecordModelType](functions/isRecordModelType.md) +- [isSecret](functions/isSecret.md) +- [isService](functions/isService.md) +- [isStatementKeyword](functions/isStatementKeyword.md) +- [isStdNamespace](functions/isStdNamespace.md) +- [isStringType](functions/isStringType.md) +- [isTemplateDeclaration](functions/isTemplateDeclaration.md) +- [isTemplateDeclarationOrInstance](functions/isTemplateDeclarationOrInstance.md) +- [isTemplateInstance](functions/isTemplateInstance.md) +- [isTrivia](functions/isTrivia.md) +- [isTypeSpecValueTypeOf](functions/isTypeSpecValueTypeOf.md) +- [isUnknownType](functions/isUnknownType.md) +- [isUrl](functions/isUrl.md) +- [isVisible](functions/isVisible.md) +- [isVoidType](functions/isVoidType.md) +- [joinPaths](functions/joinPaths.md) +- [listOperationsIn](functions/listOperationsIn.md) +- [listServices](functions/listServices.md) +- [logDiagnostics](functions/logDiagnostics.md) +- [logVerboseTestOutput](functions/logVerboseTestOutput.md) +- [mapEventEmitterToNodeListener](functions/mapEventEmitterToNodeListener.md) +- [markDeprecated](functions/markDeprecated.md) +- [navigateProgram](functions/navigateProgram.md) +- [navigateType](functions/navigateType.md) +- [navigateTypesInNamespace](functions/navigateTypesInNamespace.md) +- [normalizePath](functions/normalizePath.md) +- [normalizeSlashes](functions/normalizeSlashes.md) +- [paramMessage](functions/paramMessage.md) +- [parse](functions/parse.md) +- [parseStandaloneTypeReference](functions/parseStandaloneTypeReference.md) +- [projectProgram](functions/projectProgram.md) +- [reducePathComponents](functions/reducePathComponents.md) +- [removeTrailingDirectorySeparator](functions/removeTrailingDirectorySeparator.md) +- [reportDeprecated](functions/reportDeprecated.md) +- [resolveCompilerOptions](functions/resolveCompilerOptions.md) +- [resolveModule](functions/resolveModule.md) +- [resolvePath](functions/resolvePath.md) +- [resolveUsages](functions/resolveUsages.md) +- [scopeNavigationToNamespace](functions/scopeNavigationToNamespace.md) +- [setCadlNamespace](functions/setCadlNamespace.md) +- [setTypeSpecNamespace](functions/setTypeSpecNamespace.md) +- [skipTrivia](functions/skipTrivia.md) +- [skipWhiteSpace](functions/skipWhiteSpace.md) +- [typespecTypeToJson](functions/typespecTypeToJson.md) +- [validateDecoratorNotOnType](functions/validateDecoratorNotOnType.md) +- [validateDecoratorParamCount](functions/validateDecoratorParamCount.md) +- [validateDecoratorParamType](functions/validateDecoratorParamType.md) +- [validateDecoratorTarget](functions/validateDecoratorTarget.md) +- [validateDecoratorTargetIntrinsic](functions/validateDecoratorTargetIntrinsic.md) +- [validateDecoratorUniqueOnNode](functions/validateDecoratorUniqueOnNode.md) +- [visitChildren](functions/visitChildren.md) +- [walkPropertiesInherited](functions/walkPropertiesInherited.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 new file mode 100644 index 0000000000..8af7218489 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[I] AliasStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `readonly` | `kind` | `AliasStatement` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `locals?` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `templateParameters` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `readonly` | `value` | [`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 new file mode 100644 index 0000000000..cfa67c80a6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] AnyKeywordNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `UnknownKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md new file mode 100644 index 0000000000..2f35c81548 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ArrayExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `elementType` | [`Expression`](../type-aliases/Expression.md) | - | - | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ArrayExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md new file mode 100644 index 0000000000..ce4daf5ef1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md @@ -0,0 +1,59 @@ +--- +jsApi: true +title: "[I] ArrayModelType" + +--- +## Extends + +- [`Model`](Model.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `baseModel?` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | [`Model`](Model.md).`baseModel` | +| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`Model`](Model.md).`decorators` | +| `derivedModels` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](ArrayModelType.md) | [`Model`](Model.md).`derivedModels` | +| `indexer` | `object` | - | [`Model`](Model.md).`indexer` | +| `indexer.key` | [`Scalar`](Scalar.md) | - | - | +| `indexer.value` | [`Type`](../type-aliases/Type.md) | - | - | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`Model`](Model.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`Model`](Model.md).`isFinished` | +| `kind` | `"Model"` | - | [`Model`](Model.md).`kind` | +| `name` | `string` | - | [`Model`](Model.md).`name` | +| `namespace?` | [`Namespace`](Namespace.md) | - | [`Model`](Model.md).`namespace` | +| `node?` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`Model`](Model.md).`node` | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionBase` | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionSource` | +| `projector?` | [`Projector`](Projector.md) | - | [`Model`](Model.md).`projector` | +| `properties` | `RekeyableMap`<`string`, [`ModelProperty`](ModelProperty.md)\> | The properties of the model.

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

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

use templateMapper instead. | [`Model`](Model.md).`templateArguments` | +| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`Model`](Model.md).`templateMapper` | +| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`Model`](Model.md).`templateNode` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`Model`](Model.md).[`projectionsByName`](Model.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md new file mode 100644 index 0000000000..0c6bbffcb2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] AugmentDecoratorStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `arguments` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `AugmentDecoratorStatement` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `target` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | +| `readonly` | `targetType` | [`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 new file mode 100644 index 0000000000..1f5cc1b7b7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] BaseNode" + +--- +## Extends + +- [`TextRange`](TextRange.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | - | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`TextRange`](TextRange.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | +| `readonly` | `kind` | [`SyntaxKind`](../enumerations/SyntaxKind.md) | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | - | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md new file mode 100644 index 0000000000..d1d90d6eb1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md @@ -0,0 +1,62 @@ +--- +jsApi: true +title: "[I] BaseType" + +--- +## Extended By + +- [`ObjectType`](ObjectType.md) +- [`Projection`](Projection.md) +- [`IntrinsicType`](IntrinsicType.md) +- [`Model`](Model.md) +- [`ModelProperty`](ModelProperty.md) +- [`Scalar`](Scalar.md) +- [`Interface`](Interface.md) +- [`Enum`](Enum.md) +- [`EnumMember`](EnumMember.md) +- [`Operation`](Operation.md) +- [`Namespace`](Namespace.md) +- [`StringLiteral`](StringLiteral.md) +- [`NumericLiteral`](NumericLiteral.md) +- [`BooleanLiteral`](BooleanLiteral.md) +- [`Tuple`](Tuple.md) +- [`Union`](Union.md) +- [`UnionVariant`](UnionVariant.md) +- [`TemplateParameter`](TemplateParameter.md) +- [`Decorator`](Decorator.md) +- [`FunctionType`](FunctionType.md) +- [`FunctionParameter`](FunctionParameter.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | +| `kind` | `string` | - | +| `node?` | [`Node`](../type-aliases/Node.md) | - | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | +| `projector?` | [`Projector`](Projector.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | 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 new file mode 100644 index 0000000000..fdb2e5f012 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] BlockComment" + +--- +## Extends + +- [`TextRange`](TextRange.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`TextRange`](TextRange.md).`end` | +| `readonly` | `kind` | `BlockComment` | - | - | +| `readonly` | `parsedAsDocs?` | `boolean` | If that comment was parsed as a doc comment. If parserOptions.docs=false this will always be false. | - | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md new file mode 100644 index 0000000000..80425018cc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md @@ -0,0 +1,47 @@ +--- +jsApi: true +title: "[I] BooleanLiteral" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `"Boolean"` | - | [`BaseType`](BaseType.md).`kind` | +| `node?` | [`BooleanLiteralNode`](BooleanLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `value` | `boolean` | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md new file mode 100644 index 0000000000..c62e5b765a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] BooleanLiteralNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `BooleanLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `value` | `boolean` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CallableMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CallableMessage.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md index 7e6ebcb3ad..07283ef526 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CallableMessage.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md @@ -7,7 +7,7 @@ title: "[I] CallableMessage" | Parameter | | :------ | -| `T` *extends* `string`[] | +| `T` extends `string`[] | ```ts CallableMessage(dict): string @@ -17,14 +17,10 @@ CallableMessage(dict): string | Parameter | Type | | :------ | :------ | -| `dict` | `Record`< `T`[`number`], `string` \> | - -## Returns - -`string` +| `dict` | `Record`<`T`[`number`], `string`\> | ## Properties -| Property | Type | -| :------ | :------ | -| `keys` | `T` | +| Property | Type | Description | +| :------ | :------ | :------ | +| `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 new file mode 100644 index 0000000000..2e88a02ee9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md @@ -0,0 +1,531 @@ +--- +jsApi: true +title: "[I] Checker" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `anyType` | [`UnknownType`](UnknownType.md) | - | +| `errorType` | [`ErrorType`](ErrorType.md) | - | +| `neverType` | [`NeverType`](NeverType.md) | - | +| `typePrototype` | `TypePrototype` | - | +| `voidType` | [`VoidType`](VoidType.md) | - | + +## Methods + +### checkProgram() + +```ts +checkProgram(): void +``` + +*** + +### checkSourceFile() + +```ts +checkSourceFile(file): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | + +*** + +### cloneType() + +```ts +cloneType(type, additionalProps?): T +``` + +#### Type parameters + +| Parameter | +| :------ | +| `T` extends [`Type`](../type-aliases/Type.md) | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | `T` | +| `additionalProps`? | `{ [P in string | number | symbol]?: T[P] }` | + +*** + +### createAndFinishType() + +```ts +createAndFinishType(typeDef): T & TypePrototype +``` + +#### Type parameters + +| Parameter | +| :------ | +| `T` extends [`CreateTypeProps`](../type-aliases/CreateTypeProps.md) | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeDef` | `T` | + +*** + +### createFunctionType() + +```ts +createFunctionType(fn): FunctionType +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `fn` | (...`args`) => [`Type`](../type-aliases/Type.md) | + +*** + +### createLiteralType() + +#### createLiteralType(value, node) + +```ts +createLiteralType(value, node?): StringLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `string` | +| `node`? | [`StringLiteralNode`](StringLiteralNode.md) | + +#### createLiteralType(value, node) + +```ts +createLiteralType(value, node?): NumericLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `number` | +| `node`? | [`NumericLiteralNode`](NumericLiteralNode.md) | + +#### createLiteralType(value, node) + +```ts +createLiteralType(value, node?): BooleanLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `boolean` | +| `node`? | [`BooleanLiteralNode`](BooleanLiteralNode.md) | + +#### createLiteralType(value, node) + +```ts +createLiteralType(value, node?): StringLiteral | NumericLiteral | BooleanLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `string` \| `number` \| `boolean` | +| `node`? | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) \| [`BooleanLiteralNode`](BooleanLiteralNode.md) | + +#### createLiteralType(value, node) + +```ts +createLiteralType(value, node?): StringLiteral | NumericLiteral | BooleanLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `string` \| `number` \| `boolean` | +| `node`? | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) \| [`BooleanLiteralNode`](BooleanLiteralNode.md) | + +*** + +### createType() + +```ts +createType(typeDef): T & TypePrototype & object +``` + +#### Type parameters + +| Parameter | +| :------ | +| `T` extends [`CreateTypeProps`](../type-aliases/CreateTypeProps.md) | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeDef` | `T` | + +*** + +### evalProjection() + +```ts +evalProjection( + node, + target, + args): Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`ProjectionNode`](ProjectionNode.md) | +| `target` | [`Type`](../type-aliases/Type.md) | +| `args` | [`Type`](../type-aliases/Type.md)[] | + +*** + +### finishType() + +```ts +finishType(typeDef): T +``` + +#### Type parameters + +| Parameter | +| :------ | +| `T` extends [`Type`](../type-aliases/Type.md) | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeDef` | `T` | + +*** + +### getGlobalNamespaceNode() + +```ts +getGlobalNamespaceNode(): NamespaceStatementNode +``` + +*** + +### getGlobalNamespaceType() + +```ts +getGlobalNamespaceType(): Namespace +``` + +*** + +### getLiteralType() + +#### getLiteralType(node) + +```ts +getLiteralType(node): StringLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`StringLiteralNode`](StringLiteralNode.md) | + +#### getLiteralType(node) + +```ts +getLiteralType(node): NumericLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`NumericLiteralNode`](NumericLiteralNode.md) | + +#### getLiteralType(node) + +```ts +getLiteralType(node): BooleanLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`BooleanLiteralNode`](BooleanLiteralNode.md) | + +#### getLiteralType(node) + +```ts +getLiteralType(node): LiteralType +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`LiteralNode`](../type-aliases/LiteralNode.md) | + +*** + +### getMergedSymbol() + +```ts +getMergedSymbol(sym): undefined | Sym +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `sym` | `undefined` \| [`Sym`](Sym.md) | + +*** + +### getNamespaceString() + +```ts +getNamespaceString(type, options?): string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | `undefined` \| [`Namespace`](Namespace.md) | +| `options`? | [`TypeNameOptions`](TypeNameOptions.md) | + +#### Returns + +#### Deprecated + +use `import { getNamespaceFullName } from "@typespec/compiler";` + +*** + +### getStdType() + +```ts +getStdType(name): StdTypes[T] +``` + +Std type + +#### Type parameters + +| Parameter | +| :------ | +| `T` extends [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| `"Array"` \| `"Record"` | + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `name` | `T` | Name | + +*** + +### getTypeForNode() + +```ts +getTypeForNode(node): Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`Node`](../type-aliases/Node.md) | + +*** + +### getTypeName() + +```ts +getTypeName(type, options?): string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](../type-aliases/Type.md) | +| `options`? | [`TypeNameOptions`](TypeNameOptions.md) | + +#### Returns + +#### Deprecated + +use `import { getTypeName } from "@typespec/compiler";` + +*** + +### isStdType() + +#### isStdType(type, stdType) + +```ts +isStdType(type, stdType?): type is Scalar & Object +``` + +Check if the given type is one of the built-in standard TypeSpec Types. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `type` | [`Scalar`](Scalar.md) | Type to check | +| `stdType`? | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) | If provided check is that standard type | + +#### isStdType(type, stdType) + +```ts +isStdType(type, stdType?): type is Type & Object +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](../type-aliases/Type.md) | +| `stdType`? | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| `"Array"` \| `"Record"` | + +*** + +### isTypeAssignableTo() + +```ts +isTypeAssignableTo( + source, + target, + diagnosticTarget): [boolean, readonly Diagnostic[]] +``` + +Check if the source type can be assigned to the target type. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `source` | [`Type`](../type-aliases/Type.md) \| [`ValueType`](ValueType.md) | Source type, should be assignable to the target. | +| `target` | [`Type`](../type-aliases/Type.md) \| [`ValueType`](ValueType.md) | Target type | +| `diagnosticTarget` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | Target for the diagnostic, unless something better can be inferred. | + +#### Returns + +[related, list of diagnostics] + +*** + +### mergeSourceFile() + +```ts +mergeSourceFile(file): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`JsSourceFileNode`](JsSourceFileNode.md) | + +*** + +### project() + +```ts +project( + target, + projection, + args?): Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | [`Type`](../type-aliases/Type.md) | +| `projection` | [`ProjectionNode`](ProjectionNode.md) | +| `args`? | (`string` \| `number` \| `boolean` \| [`Type`](../type-aliases/Type.md))[] | + +*** + +### resolveCompletions() + +```ts +resolveCompletions(node): Map +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`IdentifierNode`](IdentifierNode.md) | + +*** + +### resolveIdentifier() + +```ts +resolveIdentifier(node): undefined | Sym +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`IdentifierNode`](IdentifierNode.md) | + +*** + +### resolveTypeReference() + +```ts +resolveTypeReference(node): [undefined | Type, readonly Diagnostic[]] +``` + +Check and resolve a type for the given type reference node. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `node` | [`TypeReferenceNode`](TypeReferenceNode.md) | Node. | + +#### Returns + +Resolved type and diagnostics if there was an error. + +*** + +### setUsingsForFile() + +```ts +setUsingsForFile(file): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerHost.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md index d7220ec5c8..11d7861967 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.CompilerHost.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md @@ -7,12 +7,12 @@ title: "[I] CompilerHost" | Property | Type | Description | | :------ | :------ | :------ | -| `logSink` | [`LogSink`](Interface.LogSink.md) | - | -| `parseCache`? | `WeakMap`< [`SourceFile`](Interface.SourceFile.md), [`TypeSpecScriptNode`](Interface.TypeSpecScriptNode.md) \> | Optional cache to reuse the results of parsing and binding across programs. | +| `logSink` | [`LogSink`](LogSink.md) | - | +| `parseCache?` | `WeakMap`<[`SourceFile`](SourceFile.md), [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | Optional cache to reuse the results of parsing and binding across programs. | ## Methods -### fileURLToPath +### fileURLToPath() ```ts fileURLToPath(url): string @@ -24,28 +24,20 @@ fileURLToPath(url): string | :------ | :------ | | `url` | `string` | -#### Returns - -`string` - *** -### getExecutionRoot +### getExecutionRoot() ```ts getExecutionRoot(): string ``` -#### Returns - -`string` - *** -### getJsImport +### getJsImport() ```ts -getJsImport(path): Promise< Record< string, any > > +getJsImport(path): Promise> ``` #### Parameters @@ -54,25 +46,17 @@ getJsImport(path): Promise< Record< string, any > > | :------ | :------ | | `path` | `string` | -#### Returns - -`Promise`< `Record`< `string`, `any` \> \> - *** -### getLibDirs +### getLibDirs() ```ts getLibDirs(): string[] ``` -#### Returns - -`string`[] - *** -### getSourceFileKind +### getSourceFileKind() ```ts getSourceFileKind(path): undefined | SourceFileKind @@ -84,16 +68,12 @@ getSourceFileKind(path): undefined | SourceFileKind | :------ | :------ | | `path` | `string` | -#### Returns - -`undefined` \| [`SourceFileKind`](Type.SourceFileKind.md) - *** -### mkdirp +### mkdirp() ```ts -mkdirp(path): Promise< undefined | string > +mkdirp(path): Promise ``` create directory recursively. @@ -104,13 +84,9 @@ create directory recursively. | :------ | :------ | :------ | | `path` | `string` | Path to the directory. | -#### Returns - -`Promise`< `undefined` \| `string` \> - *** -### pathToFileURL +### pathToFileURL() ```ts pathToFileURL(path): string @@ -122,16 +98,12 @@ pathToFileURL(path): string | :------ | :------ | | `path` | `string` | -#### Returns - -`string` - *** -### readDir +### readDir() ```ts -readDir(dir): Promise< string[] > +readDir(dir): Promise ``` Read directory. @@ -144,16 +116,14 @@ Read directory. #### Returns -`Promise`< `string`[] \> - list of file/directory in the given directory. Returns the name not the full path. *** -### readFile +### readFile() ```ts -readFile(path): Promise< SourceFile > +readFile(path): Promise ``` read a utf-8 or utf-8 with bom encoded file @@ -164,16 +134,12 @@ read a utf-8 or utf-8 with bom encoded file | :------ | :------ | | `path` | `string` | -#### Returns - -`Promise`< [`SourceFile`](Interface.SourceFile.md) \> - *** -### readUrl +### readUrl() ```ts -readUrl(url): Promise< SourceFile > +readUrl(url): Promise ``` read a file at the given url. @@ -184,16 +150,12 @@ read a file at the given url. | :------ | :------ | | `url` | `string` | -#### Returns - -`Promise`< [`SourceFile`](Interface.SourceFile.md) \> - *** -### realpath +### realpath() ```ts -realpath(path): Promise< string > +realpath(path): Promise ``` #### Parameters @@ -202,16 +164,12 @@ realpath(path): Promise< string > | :------ | :------ | | `path` | `string` | -#### Returns - -`Promise`< `string` \> - *** -### rm +### rm() ```ts -rm(path, options?): Promise< void > +rm(path, options?): Promise ``` Deletes a directory or file. @@ -221,18 +179,14 @@ Deletes a directory or file. | Parameter | Type | Description | | :------ | :------ | :------ | | `path` | `string` | Path to the directory or file. | -| `options`? | [`RmOptions`](Interface.RmOptions.md) | - | - -#### Returns - -`Promise`< `void` \> +| `options`? | [`RmOptions`](RmOptions.md) | - | *** -### stat +### stat() ```ts -stat(path): Promise< {isDirectory: ; isFile: ;} > +stat(path): Promise ``` #### Parameters @@ -241,16 +195,12 @@ stat(path): Promise< {isDirectory: ; isFile: ;} > | :------ | :------ | | `path` | `string` | -#### Returns - -`Promise`< \{`isDirectory`: ; `isFile`: ;} \> - *** -### writeFile +### writeFile() ```ts -writeFile(path, content): Promise< void > +writeFile(path, content): Promise ``` Write the file. @@ -261,7 +211,3 @@ Write the file. | :------ | :------ | :------ | | `path` | `string` | Path to the file. | | `content` | `string` | Content of the file. | - -#### Returns - -`Promise`< `void` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md new file mode 100644 index 0000000000..5f6b0e0433 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] CompilerLocationContext" + +--- +Built-in + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `type` | `"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 new file mode 100644 index 0000000000..9ca4cd6625 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[I] CompilerOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `additionalImports?` | `string`[] | - | +| `config?` | `string` | Path to config YAML file or folder in which to search for default tspconfig.yaml file. | +| `designTimeBuild?` | `boolean` | When true, indicates that a compilation is being performed for live
analysis in the language server. | +| `emit?` | `string`[] | List or path to emitters to use. | +| `emitters?` | `Record`<`string`, `EmitterOptions`\> | **Deprecated**

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

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

**Default**

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

use outputDir. | +| `parseOptions?` | [`ParseOptions`](ParseOptions.md) | - | +| `trace?` | `string`[] | Trace area to enable. | +| `warningAsError?` | `boolean` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md new file mode 100644 index 0000000000..cb1f3bb4aa --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[I] DeclarationNode" + +--- +## Extended By + +- [`TypeSpecScriptNode`](TypeSpecScriptNode.md) +- [`NamespaceStatementNode`](NamespaceStatementNode.md) +- [`OperationStatementNode`](OperationStatementNode.md) +- [`ModelStatementNode`](ModelStatementNode.md) +- [`ScalarStatementNode`](ScalarStatementNode.md) +- [`InterfaceStatementNode`](InterfaceStatementNode.md) +- [`UnionStatementNode`](UnionStatementNode.md) +- [`EnumStatementNode`](EnumStatementNode.md) +- [`AliasStatementNode`](AliasStatementNode.md) +- [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md) +- [`DecoratorDeclarationStatementNode`](DecoratorDeclarationStatementNode.md) +- [`FunctionDeclarationStatementNode`](FunctionDeclarationStatementNode.md) +- [`ProjectionParameterDeclarationNode`](ProjectionParameterDeclarationNode.md) +- [`ProjectionLambdaParameterDeclarationNode`](ProjectionLambdaParameterDeclarationNode.md) +- [`ProjectionStatementNode`](ProjectionStatementNode.md) +- [`JsSourceFileNode`](JsSourceFileNode.md) +- [`JsNamespaceDeclarationNode`](JsNamespaceDeclarationNode.md) + +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `id` | [`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 new file mode 100644 index 0000000000..deec49240e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratedType.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DecoratedType" + +--- +## Extended By + +- [`Model`](Model.md) +- [`ModelProperty`](ModelProperty.md) +- [`Scalar`](Scalar.md) +- [`Interface`](Interface.md) +- [`Enum`](Enum.md) +- [`EnumMember`](EnumMember.md) +- [`Operation`](Operation.md) +- [`Namespace`](Namespace.md) +- [`Union`](Union.md) +- [`UnionVariant`](UnionVariant.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `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 new file mode 100644 index 0000000000..c85ef6409f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md @@ -0,0 +1,51 @@ +--- +jsApi: true +title: "[I] Decorator" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `implementation` | (...`args`) => `void` | - | - | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `"Decorator"` | - | [`BaseType`](BaseType.md).`kind` | +| `name` | \`@${string}\` | - | - | +| `namespace` | [`Namespace`](Namespace.md) | - | - | +| `node` | [`DecoratorDeclarationStatementNode`](DecoratorDeclarationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | +| `parameters` | [`FunctionParameter`](FunctionParameter.md)[] | - | - | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `target` | [`FunctionParameter`](FunctionParameter.md) | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md new file mode 100644 index 0000000000..610312d64d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] DecoratorApplication" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `args` | [`DecoratorArgument`](DecoratorArgument.md)[] | - | +| `decorator` | [`DecoratorFunction`](DecoratorFunction.md) | - | +| `definition?` | [`Decorator`](Decorator.md) | - | +| `node?` | [`DecoratorExpressionNode`](DecoratorExpressionNode.md) \| [`AugmentDecoratorStatementNode`](AugmentDecoratorStatementNode.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md new file mode 100644 index 0000000000..1b43175dc5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] DecoratorArgument" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `jsValue` | `string` \| `number` \| `boolean` \| [`Type`](../type-aliases/Type.md) | Marshalled value for use in Javascript. | +| `node?` | [`Node`](../type-aliases/Node.md) | - | +| `value` | [`Type`](../type-aliases/Type.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md similarity index 73% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorContext.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md index 358c104ae0..24e6f39e37 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md @@ -7,18 +7,18 @@ title: "[I] DecoratorContext" | Property | Type | Description | | :------ | :------ | :------ | -| `decoratorTarget` | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | Point to the decorator target | -| `program` | [`Program`](Interface.Program.md) | - | +| `decoratorTarget` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | Point to the decorator target | +| `program` | [`Program`](Program.md) | - | ## Methods -### call +### call() ```ts call( - decorator, - target, - ...args): R + decorator, + target, ... + args): R ``` Helper to call out to another decorator @@ -27,8 +27,8 @@ Helper to call out to another decorator | Parameter | | :------ | -| `T` *extends* [`Type`](Type.Type.md) | -| `A` *extends* `any`[] | +| `T` extends [`Type`](../type-aliases/Type.md) | +| `A` extends `any`[] | | `R` | #### Parameters @@ -39,13 +39,9 @@ Helper to call out to another decorator | `target` | `T` | - | | ...`args` | `A` | Args to pass to other decorator function | -#### Returns - -`R` - *** -### getArgumentTarget +### getArgumentTarget() ```ts getArgumentTarget(paramIndex): undefined | DiagnosticTarget @@ -61,8 +57,6 @@ Function that can be used to retrieve the target for a parameter at the given in #### Returns -`undefined` \| [`DiagnosticTarget`](Type.DiagnosticTarget.md) - #### Example ```ts diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md new file mode 100644 index 0000000000..5560aefc58 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md @@ -0,0 +1,34 @@ +--- +jsApi: true +title: "[I] DecoratorDeclarationStatementNode" + +--- +Represent a decorator declaration + +## Example + +```typespec +extern dec doc(target: Type, value: valueof string); +``` + +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `readonly` | `kind` | `DecoratorDeclarationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `modifierFlags` | [`ModifierFlags`](../enumerations/ModifierFlags.md) | - | - | +| `readonly` | `modifiers` | readonly [`ExternKeywordNode`](ExternKeywordNode.md)[] | - | - | +| `readonly` | `parameters` | [`FunctionParameterNode`](FunctionParameterNode.md)[] | Additional parameters | - | +| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `target` | [`FunctionParameterNode`](FunctionParameterNode.md) | Decorator target. First parameter. | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md new file mode 100644 index 0000000000..73b25848c6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] DecoratorDefinition" + +--- +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `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` | + +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `args` | `P` | List of positional arguments in the function. | +| `readonly` | `name` | `string` | Name of the decorator. | +| `readonly` | `spreadArgs?` | `S` | **Optional**

Type of the spread args at the end of the function if applicable. | +| `readonly` | `target` | `T` \| readonly `T`[] | Decorator target. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md new file mode 100644 index 0000000000..60f9f274cf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DecoratorExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `arguments` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `DecoratorExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `target` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorFunction.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md similarity index 50% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorFunction.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md index 0209eb7e6d..6a95ad3f69 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DecoratorFunction.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md @@ -5,25 +5,21 @@ title: "[I] DecoratorFunction" --- ```ts DecoratorFunction( - program, - target, - ...customArgs): void + program, + target, ... + customArgs): void ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `program` | [`DecoratorContext`](Interface.DecoratorContext.md) | +| `program` | [`DecoratorContext`](DecoratorContext.md) | | `target` | `any` | | ...`customArgs` | `any`[] | -## Returns - -`void` - ## Properties -| Property | Type | -| :------ | :------ | -| `namespace`? | `string` | +| Property | Type | Description | +| :------ | :------ | :------ | +| `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 new file mode 100644 index 0000000000..a677ca5bcf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] DecoratorParamDefinition" + +--- +## Type parameters + +| Parameter | +| :------ | +| `K` extends [`TypeKind`](../type-aliases/TypeKind.md) | + +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `kind` | `K` \| readonly `K`[] | Kind of the parameter | +| `readonly` | `optional?` | `boolean` | Is the parameter optional. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md new file mode 100644 index 0000000000..3ae5c968cd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md @@ -0,0 +1,31 @@ +--- +jsApi: true +title: "[I] DecoratorValidator" + +--- +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `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` | + +## Methods + +### validate() + +```ts +validate( + context, + target, + parameters): boolean +``` + +#### 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 new file mode 100644 index 0000000000..b5558b58ed --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecatedDirective.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] DeprecatedDirective" + +--- +## Extends + +- [`DirectiveBase`](DirectiveBase.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `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/Interface.DeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md similarity index 100% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DeprecationDetails.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md 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 new file mode 100644 index 0000000000..b4e0fa22e0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] Diagnostic" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | `string` | - | +| `message` | `string` | - | +| `severity` | [`DiagnosticSeverity`](../type-aliases/DiagnosticSeverity.md) | - | +| `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCollector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md similarity index 67% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCollector.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md index 2ba901a037..40ff22dacf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.DiagnosticCollector.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md @@ -7,13 +7,13 @@ Helper object to collect diagnostics from function following the diagnostics acc ## Properties -| Property | Type | -| :------ | :------ | -| `readonly` `diagnostics` | *readonly* [`Diagnostic`](Interface.Diagnostic.md)[] | +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `diagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | - | ## Methods -### add +### add() ```ts add(diagnostic): void @@ -25,15 +25,11 @@ Add a diagnostic to the collection | Parameter | Type | Description | | :------ | :------ | :------ | -| `diagnostic` | [`Diagnostic`](Interface.Diagnostic.md) | Diagnostic to add. | - -#### Returns - -`void` +| `diagnostic` | [`Diagnostic`](Diagnostic.md) | Diagnostic to add. | *** -### pipe +### pipe() ```ts pipe(result): T @@ -51,18 +47,14 @@ Unwrap the Diagnostic result, add all the diagnostics and return the data. | Parameter | Type | Description | | :------ | :------ | :------ | -| `result` | [`DiagnosticResult`](Type.DiagnosticResult.md)< `T` \> | Accessor diagnostic result | - -#### Returns - -`T` +| `result` | [`DiagnosticResult`](../type-aliases/DiagnosticResult.md)<`T`\> | Accessor diagnostic result | *** -### wrap +### wrap() ```ts -wrap(value): DiagnosticResult< T > +wrap(value): DiagnosticResult ``` Wrap the given value in a tuple including the diagnostics following the TypeSpec accessor pattern. @@ -81,8 +73,6 @@ Wrap the given value in a tuple including the diagnostics following the TypeSpec #### Returns -[`DiagnosticResult`](Type.DiagnosticResult.md)< `T` \> - #### Example ```ts diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md new file mode 100644 index 0000000000..30e7130973 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md @@ -0,0 +1,60 @@ +--- +jsApi: true +title: "[I] DiagnosticCreator" + +--- +## Type parameters + +| Parameter | +| :------ | +| `T` extends `object` | + +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `diagnostics` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | - | +| `readonly` | `type` | `T` | - | + +## Methods + +### createDiagnostic() + +```ts +createDiagnostic(diag): Diagnostic +``` + +#### Type parameters + +| Parameter | Default | +| :------ | :------ | +| `C` extends `string` \| `number` \| `symbol` | - | +| `M` extends `string` \| `number` \| `symbol` | `"default"` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | + +*** + +### reportDiagnostic() + +```ts +reportDiagnostic(program, diag): void +``` + +#### Type parameters + +| Parameter | Default | +| :------ | :------ | +| `C` extends `string` \| `number` \| `symbol` | - | +| `M` extends `string` \| `number` \| `symbol` | `"default"` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](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 new file mode 100644 index 0000000000..166fc62a3c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] DiagnosticDefinition" + +--- +## Type parameters + +| Parameter | +| :------ | +| `M` extends [`DiagnosticMessages`](DiagnosticMessages.md) | + +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `messages` | `M` | - | +| `readonly` | `severity` | `"error"` \| `"warning"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticMessages.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticMessages.md new file mode 100644 index 0000000000..55a0d323be --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticMessages.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[I] DiagnosticMessages" + +--- +## Indexable + + \[`messageId`: `string`\]: `string` \| [`CallableMessage`](CallableMessage.md)<`string`[]\> 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 new file mode 100644 index 0000000000..9e41fea0dc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveBase.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[I] DirectiveBase" + +--- +## Extended By + +- [`SuppressDirective`](SuppressDirective.md) +- [`DeprecatedDirective`](DeprecatedDirective.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `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 new file mode 100644 index 0000000000..f67f8eca79 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DirectiveExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `arguments` | readonly [`DirectiveArgument`](../type-aliases/DirectiveArgument.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `DirectiveExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `target` | [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md new file mode 100644 index 0000000000..71bb214e94 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[I] Dirent" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | - | + +## Methods + +### isDirectory() + +```ts +isDirectory(): boolean +``` + +*** + +### isFile() + +```ts +isFile(): boolean +``` 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 new file mode 100644 index 0000000000..47d11187ca --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiscriminatedUnion.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] DiscriminatedUnion" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `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 new file mode 100644 index 0000000000..6fa4551106 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Discriminator.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] Discriminator" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `propertyName` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocData.md new file mode 100644 index 0000000000..3ceaf1de98 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocData.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] DocData" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `source` | `"decorator"` \| `"comment"` | How was the doc set.
- `@doc` means the `@doc` decorator was used
- `comment` means it was set from a `/** comment * /` | +| `value` | `string` | Doc value. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md new file mode 100644 index 0000000000..62d380541a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DocErrorsTagNode" + +--- +## Extends + +- [`DocTagBaseNode`](DocTagBaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `readonly` | `kind` | `DocErrorsTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `readonly` | `tagName` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md new file mode 100644 index 0000000000..74a7db2828 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DocNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `Doc` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `tags` | readonly [`DocTag`](../type-aliases/DocTag.md)[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md new file mode 100644 index 0000000000..7f437e1275 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] DocParamTagNode" + +--- +## Extends + +- [`DocTagBaseNode`](DocTagBaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `readonly` | `kind` | `DocParamTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| `readonly` | `paramName` | [`IdentifierNode`](IdentifierNode.md) | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `readonly` | `tagName` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md new file mode 100644 index 0000000000..fb5cf9bb3a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DocReturnsTagNode" + +--- +## Extends + +- [`DocTagBaseNode`](DocTagBaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `readonly` | `kind` | `DocReturnsTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `readonly` | `tagName` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md new file mode 100644 index 0000000000..95265ee0dc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DocTagBaseNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | [`SyntaxKind`](../enumerations/SyntaxKind.md) | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `tagName` | [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md new file mode 100644 index 0000000000..5a682f117d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] DocTemplateTagNode" + +--- +## Extends + +- [`DocTagBaseNode`](DocTagBaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `readonly` | `kind` | `DocTemplateTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| `readonly` | `paramName` | [`IdentifierNode`](IdentifierNode.md) | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `readonly` | `tagName` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md new file mode 100644 index 0000000000..a23d1b4ebd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] DocTextNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `DocText` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `text` | `string` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md new file mode 100644 index 0000000000..59b330fbb7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] DocUnknownTagNode" + +--- +## Extends + +- [`DocTagBaseNode`](DocTagBaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `content` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `readonly` | `kind` | `DocUnknownTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `readonly` | `tagName` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmitContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md similarity index 73% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmitContext.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md index 134eaf985f..ce610523cc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.EmitContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md @@ -7,7 +7,7 @@ title: "[I] EmitContext" | Parameter | Default | | :------ | :------ | -| `TOptions` *extends* `object` | `Record`< `string`, `never` \> | +| `TOptions` extends `object` | `Record`<`string`, `never`\> | ## Properties @@ -15,14 +15,14 @@ title: "[I] EmitContext" | :------ | :------ | :------ | | `emitterOutputDir` | `string` | Configured output dir for the emitter. Emitter should emit all output under that directory. | | `options` | `TOptions` | Emitter custom options defined in createTypeSpecLibrary | -| `program` | [`Program`](Interface.Program.md) | TypeSpec Program. | +| `program` | [`Program`](Program.md) | TypeSpec Program. | ## Methods -### getAssetEmitter +### getAssetEmitter() ```ts -getAssetEmitter(TypeEmitterClass): AssetEmitter< T, TOptions > +getAssetEmitter(TypeEmitterClass): AssetEmitter ``` Get an asset emitter to write emitted output to disk using a TypeEmitter @@ -38,7 +38,3 @@ Get an asset emitter to write emitted output to disk using a TypeEmitter | Parameter | Type | Description | | :------ | :------ | :------ | | `TypeEmitterClass` | *typeof* `TypeEmitter` | The TypeEmitter to construct your emitted output | - -#### Returns - -`AssetEmitter`< `T`, `TOptions` \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md new file mode 100644 index 0000000000..21c9a670f4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] EmitFileOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `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 new file mode 100644 index 0000000000..6deaa371f0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] EmptyStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `EmptyStatement` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EncodeData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EncodeData.md new file mode 100644 index 0000000000..fe9cbabff8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EncodeData.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] EncodeData" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `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 new file mode 100644 index 0000000000..6762c5e474 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md @@ -0,0 +1,50 @@ +--- +jsApi: true +title: "[I] Enum" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `"Enum"` | - | [`BaseType`](BaseType.md).`kind` | +| `members` | `RekeyableMap`<`string`, [`EnumMember`](EnumMember.md)\> | The members of the enum.

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

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

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

use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md new file mode 100644 index 0000000000..f3a992398d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[I] InterfaceStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `extends` | readonly [`TypeReferenceNode`](TypeReferenceNode.md)[] | - | - | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `readonly` | `kind` | `InterfaceStatement` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `locals?` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `readonly` | `operations` | readonly [`OperationStatementNode`](OperationStatementNode.md)[] | - | - | +| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `templateParameters` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md new file mode 100644 index 0000000000..f2ebd1f482 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] IntersectionExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `IntersectionExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `options` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md new file mode 100644 index 0000000000..619457528e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md @@ -0,0 +1,47 @@ +--- +jsApi: true +title: "[I] IntrinsicType" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `"Intrinsic"` | - | [`BaseType`](BaseType.md).`kind` | +| `name` | \| `"unknown"` \| `"never"` \| `"null"` \| `"void"` \| `"ErrorType"` | - | - | +| `node?` | [`Node`](../type-aliases/Node.md) | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md new file mode 100644 index 0000000000..3f47cdc128 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] InvalidStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `InvalidStatement` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JSONSchemaValidator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JSONSchemaValidator.md similarity index 63% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JSONSchemaValidator.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JSONSchemaValidator.md index c327a58cef..34ad2abc1a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.JSONSchemaValidator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JSONSchemaValidator.md @@ -5,7 +5,7 @@ title: "[I] JSONSchemaValidator" --- ## Methods -### validate +### validate() ```ts validate(config, target): Diagnostic[] @@ -18,10 +18,8 @@ Validate the configuration against its JSON Schema. | Parameter | Type | Description | | :------ | :------ | :------ | | `config` | `unknown` | Configuration to validate. | -| `target` | [`SourceFile`](Interface.SourceFile.md) \| `YamlScript` \| *typeof* [`NoTarget`](Variable.NoTarget.md) | Source file target to use for diagnostics. | +| `target` | [`SourceFile`](SourceFile.md) \| `YamlScript` \| *typeof* [`NoTarget`](../variables/NoTarget.md) | Source file target to use for diagnostics. | #### Returns -[`Diagnostic`](Interface.Diagnostic.md)[] - Diagnostics produced by schema validation of the configuration. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md new file mode 100644 index 0000000000..e67fca43ef --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] JsNamespaceDeclarationNode" + +--- +## Extends + +- [`DeclarationNode`](DeclarationNode.md).[`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `readonly` | `kind` | `JsNamespaceDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md new file mode 100644 index 0000000000..a8af98851b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[I] JsSourceFileNode" + +--- +## Extends + +- [`DeclarationNode`](DeclarationNode.md).[`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `esmExports` | `any` | - | - | +| `readonly` | `file` | [`SourceFile`](SourceFile.md) | - | - | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `readonly` | `kind` | `JsSourceFile` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `namespaceSymbols` | [`Sym`](Sym.md)[] | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md new file mode 100644 index 0000000000..b1d2e4d71d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] LibraryInstance" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `definition?` | [`TypeSpecLibrary`](TypeSpecLibrary.md)<`any`, `Record`<`string`, `never`\>\> | - | +| `entrypoint` | `undefined` \| [`JsSourceFileNode`](JsSourceFileNode.md) | - | +| `metadata` | [`LibraryMetadata`](../type-aliases/LibraryMetadata.md) | - | +| `module` | [`ModuleResolutionResult`](../type-aliases/ModuleResolutionResult.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md new file mode 100644 index 0000000000..278ecf3d50 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] LibraryLocationContext" + +--- +Defined in a library. + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `metadata` | [`ModuleLibraryMetadata`](ModuleLibraryMetadata.md) | - | +| `type` | `"library"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LineAndCharacter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md similarity index 100% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.LineAndCharacter.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md 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 new file mode 100644 index 0000000000..bc04dd4ba8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] LineComment" + +--- +## Extends + +- [`TextRange`](TextRange.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`TextRange`](TextRange.md).`end` | +| `readonly` | `kind` | `LineComment` | - | - | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md new file mode 100644 index 0000000000..e6df6493b6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] LinterDefinition" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `ruleSets?` | `Record`<`string`, [`LinterRuleSet`](LinterRuleSet.md)\> | - | +| `rules` | [`LinterRuleDefinition`](LinterRuleDefinition.md)<`string`, [`DiagnosticMessages`](DiagnosticMessages.md)\>[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md new file mode 100644 index 0000000000..dd898a4a68 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md @@ -0,0 +1,45 @@ +--- +jsApi: true +title: "[I] LinterRule" + +--- +Resolved instance of a linter rule that will run. + +## Extends + +- [`LinterRuleDefinition`](LinterRuleDefinition.md)<`N`, `DM`\> + +## Type parameters + +| Parameter | +| :------ | +| `N` extends `string` | +| `DM` extends [`DiagnosticMessages`](DiagnosticMessages.md) | + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `description` | `string` | - | [`LinterRuleDefinition`](LinterRuleDefinition.md).`description` | +| `id` | `string` | Expanded rule id in format `:` | - | +| `messages` | `DM` | - | [`LinterRuleDefinition`](LinterRuleDefinition.md).`messages` | +| `name` | `N` | - | [`LinterRuleDefinition`](LinterRuleDefinition.md).`name` | +| `severity` | `"warning"` | - | [`LinterRuleDefinition`](LinterRuleDefinition.md).`severity` | + +## Methods + +### create() + +```ts +create(context): SemanticNodeListener +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`LinterRuleContext`](LinterRuleContext.md)<`DM`\> | + +#### Inherited from + +[`LinterRuleDefinition`](LinterRuleDefinition.md).[`create`](LinterRuleDefinition.md#create) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md new file mode 100644 index 0000000000..65a96be11b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md @@ -0,0 +1,36 @@ +--- +jsApi: true +title: "[I] LinterRuleContext" + +--- +## Type parameters + +| Parameter | +| :------ | +| `DM` extends [`DiagnosticMessages`](DiagnosticMessages.md) | + +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `program` | [`Program`](Program.md) | - | + +## Methods + +### reportDiagnostic() + +```ts +reportDiagnostic(diag): void +``` + +#### Type parameters + +| Parameter | +| :------ | +| `M` extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diag` | [`LinterRuleDiagnosticReport`](../type-aliases/LinterRuleDiagnosticReport.md)<`DM`, `M`\> | 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 new file mode 100644 index 0000000000..105294cd00 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md @@ -0,0 +1,38 @@ +--- +jsApi: true +title: "[I] LinterRuleDefinition" + +--- +## Extended By + +- [`LinterRule`](LinterRule.md) + +## Type parameters + +| Parameter | +| :------ | +| `N` extends `string` | +| `DM` extends [`DiagnosticMessages`](DiagnosticMessages.md) | + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `description` | `string` | - | +| `messages` | `DM` | - | +| `name` | `N` | - | +| `severity` | `"warning"` | - | + +## Methods + +### create() + +```ts +create(context): SemanticNodeListener +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`LinterRuleContext`](LinterRuleContext.md)<`DM`\> | 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 new file mode 100644 index 0000000000..2c2e36aab3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] LinterRuleSet" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `disable?` | `Record`<\`${string}/${string}\`, `string`\> | Rules to disable. A rule CANNOT be in enable and disable map. | +| `enable?` | `Record`<\`${string}/${string}\`, `boolean`\> | Rules to enable/configure | +| `extends?` | \`${string}/${string}\`[] | Other ruleset this ruleset extends | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ListOperationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ListOperationOptions.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md index 86c678fe2c..d6db33c018 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ListOperationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md @@ -7,4 +7,4 @@ title: "[I] ListOperationOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `recursive`? | `boolean` | If the container is a namespace look for operation in sub namespaces.

**Default**

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

**Default**

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

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

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

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

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

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

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

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

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

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

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

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

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

**Default**

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

**Default**

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

use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md new file mode 100644 index 0000000000..9c315a01b3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] OperationSignatureDeclarationNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `OperationSignatureDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parameters` | [`ModelExpressionNode`](ModelExpressionNode.md) | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `returnType` | [`Expression`](../type-aliases/Expression.md) | - | - | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md new file mode 100644 index 0000000000..bb74214901 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] OperationSignatureReferenceNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `baseOperation` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `OperationSignatureReference` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md new file mode 100644 index 0000000000..70e71b1070 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[I] OperationStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `readonly` | `kind` | `OperationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `locals?` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) \| [`InterfaceStatementNode`](InterfaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `signature` | [`OperationSignature`](../type-aliases/OperationSignature.md) | - | - | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `templateParameters` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md new file mode 100644 index 0000000000..dc69b899be --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] ParseOptions" + +--- +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `comments?` | `boolean` | When true, collect comment ranges in [TypeSpecScriptNode.comments](TypeSpecScriptNode.md). | +| `readonly` | `docs?` | `boolean` | When true, parse doc comments into [Node.docs](BaseNode.md). | 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 new file mode 100644 index 0000000000..4716d55258 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] ProcessedLog" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `code?` | `string` | - | +| `level` | [`LogLevel`](../type-aliases/LogLevel.md) | - | +| `message` | `string` | - | +| `sourceLocation?` | [`SourceLocation`](SourceLocation.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md new file mode 100644 index 0000000000..37521c68a3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md @@ -0,0 +1,200 @@ +--- +jsApi: true +title: "[I] Program" + +--- +## Extended By + +- [`ProjectedProgram`](ProjectedProgram.md) + +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `public` | `checker` | [`Checker`](Checker.md) | - | +| `public` | `compilerOptions` | [`CompilerOptions`](CompilerOptions.md) | - | +| `readonly` | `diagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | - | +| `public` | `emitters` | `EmitterRef`[] | - | +| `public` | `host` | [`CompilerHost`](CompilerHost.md) | - | +| `public` | `jsSourceFiles` | `Map`<`string`, [`JsSourceFileNode`](JsSourceFileNode.md)\> | - | +| `public` | `literalTypes` | `Map`<`string` \| `number` \| `boolean`, [`LiteralType`](../type-aliases/LiteralType.md)\> | - | +| `public` | `mainFile?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | +| `readonly` | `projectRoot` | `string` | Project root. If a tsconfig was found/specified this is the directory for the tsconfig.json. Otherwise directory where the entrypoint is located. | +| `public` | `sourceFiles` | `Map`<`string`, [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | All source files in the program, keyed by their file path. | +| `public` | `stateMaps` | `Map`<`symbol`, `StateMap`\> | - | +| `public` | `stateSets` | `Map`<`symbol`, `StateSet`\> | - | +| `public` | `tracer` | [`Tracer`](Tracer.md) | - | + +## Methods + +### getGlobalNamespaceType() + +```ts +getGlobalNamespaceType(): Namespace +``` + +*** + +### getOption() + +```ts +getOption(key): undefined | string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `string` | + +*** + +### getSourceFileLocationContext() + +```ts +getSourceFileLocationContext(sourceFile): LocationContext +``` + +Return location context of the given source file. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `sourceFile` | [`SourceFile`](SourceFile.md) | + +*** + +### hasError() + +```ts +hasError(): boolean +``` + +*** + +### loadTypeSpecScript() + +```ts +loadTypeSpecScript(typespecScript): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typespecScript` | [`SourceFile`](SourceFile.md) | + +*** + +### onValidate() + +```ts +onValidate(cb, LibraryMetadata): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `cb` | (`program`) => `void` \| `Promise`<`void`\> | +| `LibraryMetadata` | [`LibraryMetadata`](../type-aliases/LibraryMetadata.md) | + +*** + +### reportDiagnostic() + +```ts +reportDiagnostic(diagnostic): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostic` | [`Diagnostic`](Diagnostic.md) | + +*** + +### reportDiagnostics() + +```ts +reportDiagnostics(diagnostics): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | + +*** + +### reportDuplicateSymbols() + +```ts +reportDuplicateSymbols(symbols): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `symbols` | `undefined` \| `SymbolTable` | + +*** + +### resolveTypeReference() + +```ts +resolveTypeReference(reference): [undefined | Type, readonly Diagnostic[]] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `reference` | `string` | + +*** + +### stateMap() + +```ts +stateMap(key): Map +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `symbol` | + +*** + +### stateSet() + +```ts +stateSet(key): Set +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `symbol` | + +*** + +### trace() + +```ts +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/Interface.ProjectLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md similarity index 51% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectLocationContext.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md index 7af9129aa4..4ab05797d3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md @@ -7,6 +7,6 @@ Defined in the user project. ## Properties -| Property | Type | -| :------ | :------ | -| `type` | `"project"` | +| Property | Type | Description | +| :------ | :------ | :------ | +| `type` | `"project"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedNameView.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedNameView.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md index 8524c9571d..57becaa013 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ProjectedNameView.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md @@ -5,13 +5,13 @@ title: "[I] ProjectedNameView" --- ## Properties -| Property | Type | -| :------ | :------ | -| `program` | [`ProjectedProgram`](Interface.ProjectedProgram.md) | +| Property | Type | Description | +| :------ | :------ | :------ | +| `program` | [`ProjectedProgram`](ProjectedProgram.md) | - | ## Methods -### getProjectedName +### getProjectedName() ```ts getProjectedName(target): string @@ -25,7 +25,3 @@ If there is a projected name it returns that one otherwise return the original n | Parameter | Type | | :------ | :------ | | `target` | `Object` | - -#### Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md new file mode 100644 index 0000000000..84f3d1db8f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md @@ -0,0 +1,253 @@ +--- +jsApi: true +title: "[I] ProjectedProgram" + +--- +## Extends + +- [`Program`](Program.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `public` | `checker` | [`Checker`](Checker.md) | - | [`Program`](Program.md).`checker` | +| `public` | `compilerOptions` | [`CompilerOptions`](CompilerOptions.md) | - | [`Program`](Program.md).`compilerOptions` | +| `readonly` | `diagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | - | [`Program`](Program.md).`diagnostics` | +| `public` | `emitters` | `EmitterRef`[] | - | [`Program`](Program.md).`emitters` | +| `public` | `host` | [`CompilerHost`](CompilerHost.md) | - | [`Program`](Program.md).`host` | +| `public` | `jsSourceFiles` | `Map`<`string`, [`JsSourceFileNode`](JsSourceFileNode.md)\> | - | [`Program`](Program.md).`jsSourceFiles` | +| `public` | `literalTypes` | `Map`<`string` \| `number` \| `boolean`, [`LiteralType`](../type-aliases/LiteralType.md)\> | - | [`Program`](Program.md).`literalTypes` | +| `public` | `mainFile?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | [`Program`](Program.md).`mainFile` | +| `readonly` | `projectRoot` | `string` | Project root. If a tsconfig was found/specified this is the directory for the tsconfig.json. Otherwise directory where the entrypoint is located. | [`Program`](Program.md).`projectRoot` | +| `public` | `projector` | [`Projector`](Projector.md) | - | - | +| `public` | `sourceFiles` | `Map`<`string`, [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | All source files in the program, keyed by their file path. | [`Program`](Program.md).`sourceFiles` | +| `public` | `stateMaps` | `Map`<`symbol`, `StateMap`\> | - | [`Program`](Program.md).`stateMaps` | +| `public` | `stateSets` | `Map`<`symbol`, `StateSet`\> | - | [`Program`](Program.md).`stateSets` | +| `public` | `tracer` | [`Tracer`](Tracer.md) | - | [`Program`](Program.md).`tracer` | + +## Methods + +### getGlobalNamespaceType() + +```ts +getGlobalNamespaceType(): Namespace +``` + +#### Inherited from + +[`Program`](Program.md).[`getGlobalNamespaceType`](Program.md#getglobalnamespacetype) + +*** + +### getOption() + +```ts +getOption(key): undefined | string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `string` | + +#### Inherited from + +[`Program`](Program.md).[`getOption`](Program.md#getoption) + +*** + +### getSourceFileLocationContext() + +```ts +getSourceFileLocationContext(sourceFile): LocationContext +``` + +Return location context of the given source file. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `sourceFile` | [`SourceFile`](SourceFile.md) | + +#### Inherited from + +[`Program`](Program.md).[`getSourceFileLocationContext`](Program.md#getsourcefilelocationcontext) + +*** + +### hasError() + +```ts +hasError(): boolean +``` + +#### Inherited from + +[`Program`](Program.md).[`hasError`](Program.md#haserror) + +*** + +### loadTypeSpecScript() + +```ts +loadTypeSpecScript(typespecScript): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typespecScript` | [`SourceFile`](SourceFile.md) | + +#### Inherited from + +[`Program`](Program.md).[`loadTypeSpecScript`](Program.md#loadtypespecscript) + +*** + +### onValidate() + +```ts +onValidate(cb, LibraryMetadata): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `cb` | (`program`) => `void` \| `Promise`<`void`\> | +| `LibraryMetadata` | [`LibraryMetadata`](../type-aliases/LibraryMetadata.md) | + +#### Inherited from + +[`Program`](Program.md).[`onValidate`](Program.md#onvalidate) + +*** + +### reportDiagnostic() + +```ts +reportDiagnostic(diagnostic): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostic` | [`Diagnostic`](Diagnostic.md) | + +#### Inherited from + +[`Program`](Program.md).[`reportDiagnostic`](Program.md#reportdiagnostic) + +*** + +### reportDiagnostics() + +```ts +reportDiagnostics(diagnostics): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | + +#### Inherited from + +[`Program`](Program.md).[`reportDiagnostics`](Program.md#reportdiagnostics) + +*** + +### reportDuplicateSymbols() + +```ts +reportDuplicateSymbols(symbols): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `symbols` | `undefined` \| `SymbolTable` | + +#### Inherited from + +[`Program`](Program.md).[`reportDuplicateSymbols`](Program.md#reportduplicatesymbols) + +*** + +### resolveTypeReference() + +```ts +resolveTypeReference(reference): [undefined | Type, readonly Diagnostic[]] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `reference` | `string` | + +#### Inherited from + +[`Program`](Program.md).[`resolveTypeReference`](Program.md#resolvetypereference) + +*** + +### stateMap() + +```ts +stateMap(key): Map +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `symbol` | + +#### Inherited from + +[`Program`](Program.md).[`stateMap`](Program.md#statemap) + +*** + +### stateSet() + +```ts +stateSet(key): Set +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `symbol` | + +#### Inherited from + +[`Program`](Program.md).[`stateSet`](Program.md#stateset) + +*** + +### trace() + +```ts +trace(area, message): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `area` | `string` | +| `message` | `string` | + +#### Inherited from + +[`Program`](Program.md).[`trace`](Program.md#trace) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md new file mode 100644 index 0000000000..70137039a5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md @@ -0,0 +1,48 @@ +--- +jsApi: true +title: "[I] Projection" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `"Projection"` | - | [`BaseType`](BaseType.md).`kind` | +| `node` | `undefined` | - | [`BaseType`](BaseType.md).`node` | +| `nodeByKind` | `Map`<`string`, [`ProjectionStatementNode`](ProjectionStatementNode.md)\> | - | - | +| `nodeByType` | `Map`<[`Type`](../type-aliases/Type.md), [`ProjectionStatementNode`](ProjectionStatementNode.md)\> | - | - | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md new file mode 100644 index 0000000000..d7f7018e6a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] ProjectionApplication" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `arguments` | [`DecoratorArgumentValue`](../type-aliases/DecoratorArgumentValue.md)[] | - | +| `direction?` | `"to"` \| `"from"` | - | +| `projectionName` | `string` | - | +| `scope?` | [`Type`](../type-aliases/Type.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md new file mode 100644 index 0000000000..dbabf3f1f6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionArithmeticExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionArithmeticExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `left` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | +| `readonly` | `op` | `"+"` \| `"-"` \| `"*"` \| `"/"` | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `right` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md new file mode 100644 index 0000000000..3cd344a2d3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionBlockExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionBlockExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `statements` | [`ProjectionExpressionStatementNode`](ProjectionExpressionStatementNode.md)[] | - | - | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md new file mode 100644 index 0000000000..07e1dd56d6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionCallExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `arguments` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md)[] | - | - | +| `readonly` | `callKind` | `"method"` \| `"template"` | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionCallExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `target` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md new file mode 100644 index 0000000000..ecbf88c818 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionDecoratorReferenceExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionDecoratorReferenceExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `target` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md new file mode 100644 index 0000000000..77b794d67d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionEnumMemberSelectorNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionEnumMemberSelector` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md new file mode 100644 index 0000000000..fd423cd7a0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionEnumSelectorNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionEnumSelector` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md new file mode 100644 index 0000000000..ffab6af2ec --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionEqualityExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionEqualityExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `left` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | +| `readonly` | `op` | `"=="` \| `"!="` | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `right` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md new file mode 100644 index 0000000000..48ceddd074 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionExpressionStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `expr` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionExpressionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md new file mode 100644 index 0000000000..5709c2bd7a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionIfExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `alternate?` | [`ProjectionIfExpressionNode`](ProjectionIfExpressionNode.md) \| [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | +| `readonly` | `consequent` | [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionIfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `test` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md new file mode 100644 index 0000000000..6d4ba90aa4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionInterfaceSelectorNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionInterfaceSelector` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md new file mode 100644 index 0000000000..ec3f666c25 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionLambdaExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `body` | [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionLambdaExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `locals?` | `SymbolTable` | - | - | +| `readonly` | `parameters` | readonly [`ProjectionLambdaParameterDeclarationNode`](ProjectionLambdaParameterDeclarationNode.md)[] | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md new file mode 100644 index 0000000000..dfd6838af1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionLambdaParameterDeclarationNode" + +--- +## Extends + +- [`DeclarationNode`](DeclarationNode.md).[`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `readonly` | `kind` | `ProjectionLambdaParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md new file mode 100644 index 0000000000..1d6769f693 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionLogicalExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionLogicalExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `left` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | +| `readonly` | `op` | `"||"` \| `"&&"` | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `right` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md new file mode 100644 index 0000000000..d2470b7bd6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionMemberExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `base` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | - | +| `readonly` | `kind` | `ProjectionMemberExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `selector` | `"."` \| `"::"` | - | - | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md new file mode 100644 index 0000000000..12953310a6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionModelExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionModelExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `properties` | ([`ProjectionModelPropertyNode`](ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](ProjectionModelSpreadPropertyNode.md))[] | - | - | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md new file mode 100644 index 0000000000..662c717103 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[I] ProjectionModelPropertyNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | +| `readonly` | `default?` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | - | +| `readonly` | `kind` | `ProjectionModelProperty` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `optional` | `boolean` | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `value` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md new file mode 100644 index 0000000000..17da083af1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionModelPropertySelectorNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionModelPropertySelector` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md new file mode 100644 index 0000000000..82f3d98218 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionModelSelectorNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionModelSelector` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md new file mode 100644 index 0000000000..3cde0520c6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionModelSpreadPropertyNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionModelSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `target` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md new file mode 100644 index 0000000000..7a5f624c20 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[I] ProjectionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `body` | readonly [`ProjectionExpressionStatementNode`](ProjectionExpressionStatementNode.md)[] | - | - | +| `readonly` | `direction` | \| `"to"` \| `"from"` \| `"pre_to"` \| `"pre_from"` \| `""` | - | - | +| `readonly` | `directionId` | [`IdentifierNode`](IdentifierNode.md) | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `Projection` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `locals?` | `SymbolTable` | - | - | +| `readonly` | `modifierIds` | readonly [`IdentifierNode`](IdentifierNode.md)[] | - | - | +| `readonly` | `parameters` | [`ProjectionParameterDeclarationNode`](ProjectionParameterDeclarationNode.md)[] | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md new file mode 100644 index 0000000000..188a022208 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionOperationSelectorNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionOperationSelector` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md new file mode 100644 index 0000000000..28340cac97 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionParameterDeclarationNode" + +--- +## Extends + +- [`DeclarationNode`](DeclarationNode.md).[`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `readonly` | `kind` | `ProjectionParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md new file mode 100644 index 0000000000..c85e901603 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] ProjectionReferenceNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `arguments` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionReference` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `target` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md new file mode 100644 index 0000000000..d79122b315 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ProjectionRelationalExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionRelationalExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `left` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | +| `readonly` | `op` | `"<="` \| `">="` \| `"<"` \| `">"` | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `right` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md new file mode 100644 index 0000000000..d7fa6316aa --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[I] ProjectionStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `from?` | [`ProjectionNode`](ProjectionNode.md) | - | - | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `readonly` | `kind` | `ProjectionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `preFrom?` | [`ProjectionNode`](ProjectionNode.md) | - | - | +| `readonly` | `preTo?` | [`ProjectionNode`](ProjectionNode.md) | - | - | +| `readonly` | `projections` | readonly [`ProjectionNode`](ProjectionNode.md)[] | - | - | +| `readonly` | `selector` | \| [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) \| [`ProjectionModelSelectorNode`](ProjectionModelSelectorNode.md) \| [`ProjectionModelPropertySelectorNode`](ProjectionModelPropertySelectorNode.md) \| [`ProjectionInterfaceSelectorNode`](ProjectionInterfaceSelectorNode.md) \| [`ProjectionOperationSelectorNode`](ProjectionOperationSelectorNode.md) \| [`ProjectionEnumSelectorNode`](ProjectionEnumSelectorNode.md) \| [`ProjectionEnumMemberSelectorNode`](ProjectionEnumMemberSelectorNode.md) \| [`ProjectionUnionSelectorNode`](ProjectionUnionSelectorNode.md) \| [`ProjectionUnionVariantSelectorNode`](ProjectionUnionVariantSelectorNode.md) | - | - | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `to?` | [`ProjectionNode`](ProjectionNode.md) | - | - | 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 new file mode 100644 index 0000000000..872452c7bc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ProjectionTupleExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionTupleExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `values` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md)[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md new file mode 100644 index 0000000000..958f09466e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] ProjectionUnaryExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionUnaryExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `op` | `"!"` | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `target` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md new file mode 100644 index 0000000000..b3abf4cc23 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionUnionSelectorNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionUnionSelector` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md new file mode 100644 index 0000000000..5f05eecedc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionUnionVariantSelectorNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ProjectionUnionVariantSelector` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md new file mode 100644 index 0000000000..d4e048c656 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[I] Projector" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `parentProjector?` | [`Projector`](Projector.md) | - | +| `projectedGlobalNamespace?` | [`Namespace`](Namespace.md) | - | +| `projectedStartNode?` | [`Type`](../type-aliases/Type.md) | - | +| `projectedTypes` | `Map`<[`Type`](../type-aliases/Type.md), [`Type`](../type-aliases/Type.md)\> | - | +| `projections` | [`ProjectionApplication`](ProjectionApplication.md)[] | - | + +## Methods + +### projectType() + +```ts +projectType(type): Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md new file mode 100644 index 0000000000..293139afb8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md @@ -0,0 +1,59 @@ +--- +jsApi: true +title: "[I] RecordModelType" + +--- +## Extends + +- [`Model`](Model.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `baseModel?` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | [`Model`](Model.md).`baseModel` | +| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`Model`](Model.md).`decorators` | +| `derivedModels` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](ArrayModelType.md) | [`Model`](Model.md).`derivedModels` | +| `indexer` | `object` | - | [`Model`](Model.md).`indexer` | +| `indexer.key` | [`Scalar`](Scalar.md) | - | - | +| `indexer.value` | [`Type`](../type-aliases/Type.md) | - | - | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`Model`](Model.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`Model`](Model.md).`isFinished` | +| `kind` | `"Model"` | - | [`Model`](Model.md).`kind` | +| `name` | `string` | - | [`Model`](Model.md).`name` | +| `namespace?` | [`Namespace`](Namespace.md) | - | [`Model`](Model.md).`namespace` | +| `node?` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`Model`](Model.md).`node` | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionBase` | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionSource` | +| `projector?` | [`Projector`](Projector.md) | - | [`Model`](Model.md).`projector` | +| `properties` | `RekeyableMap`<`string`, [`ModelProperty`](ModelProperty.md)\> | The properties of the model.

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

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

use templateMapper instead. | [`Model`](Model.md).`templateArguments` | +| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`Model`](Model.md).`templateMapper` | +| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`Model`](Model.md).`templateNode` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`Model`](Model.md).[`projectionsByName`](Model.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md new file mode 100644 index 0000000000..28cdf7a4c6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[I] ResolveCompilerOptionsOptions" + +--- +## Extends + +- `ConfigToOptionsOptions` + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `args?` | `Record`<`string`, `string`\> | Any arguments to interpolate the config. | ConfigToOptionsOptions.args | +| `configPath?` | `string` | Explicit config path. | - | +| `cwd` | `string` | Current working directory. This will be used to interpolate `{cwd}` in the config. | ConfigToOptionsOptions.cwd | +| `entrypoint` | `string` | Absolute entrypoint path | - | +| `env?` | `Record`<`string`, `undefined` \| `string`\> | Environment variables. | ConfigToOptionsOptions.env | +| `overrides?` | `Partial`<`TypeSpecConfig`\> | Compiler options to override the config | ConfigToOptionsOptions.overrides | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveModuleHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md similarity index 61% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveModuleHost.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md index 47795a4fde..078679676d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveModuleHost.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md @@ -5,10 +5,10 @@ title: "[I] ResolveModuleHost" --- ## Methods -### readFile +### readFile() ```ts -readFile(path): Promise< string > +readFile(path): Promise ``` Read a utf-8 encoded file. @@ -19,16 +19,12 @@ Read a utf-8 encoded file. | :------ | :------ | | `path` | `string` | -#### Returns - -`Promise`< `string` \> - *** -### realpath +### realpath() ```ts -realpath(path): Promise< string > +realpath(path): Promise ``` Resolve the real path for the current host. @@ -39,16 +35,12 @@ Resolve the real path for the current host. | :------ | :------ | | `path` | `string` | -#### Returns - -`Promise`< `string` \> - *** -### stat +### stat() ```ts -stat(path): Promise< {isDirectory: ; isFile: ;} > +stat(path): Promise ``` Get information about the given path @@ -58,7 +50,3 @@ Get information about the given path | Parameter | Type | | :------ | :------ | | `path` | `string` | - -#### Returns - -`Promise`< \{`isDirectory`: ; `isFile`: ;} \> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveModuleOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveModuleOptions.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md index 664c9f1eda..51aa932045 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolveModuleOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md @@ -8,5 +8,5 @@ title: "[I] ResolveModuleOptions" | Property | Type | Description | | :------ | :------ | :------ | | `baseDir` | `string` | - | -| `directoryIndexFiles`? | `string`[] | When resolution reach a directory without package.json look for those files to load in order.

**Default**

` ["index.mjs", "index.js"] ` | -| `resolveMain`? | (`pkg`) => `string` | 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`) => `string` | - | 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 new file mode 100644 index 0000000000..371c9095d4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedFile.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] ResolvedFile" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `path` | `string` | - | +| `type` | `"file"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedModule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedModule.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md index 86b152549c..15f57df7ad 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ResolvedModule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md @@ -8,6 +8,6 @@ title: "[I] ResolvedModule" | Property | Type | Description | | :------ | :------ | :------ | | `mainFile` | `string` | Resolved main file for the module. | -| `manifest` | [`NodePackage`](Interface.NodePackage.md) | Value of package.json. | +| `manifest` | [`NodePackage`](NodePackage.md) | Value of package.json. | | `path` | `string` | Root of the package. (Same level as package.json) | | `type` | `"module"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md new file mode 100644 index 0000000000..54c1f0736f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ReturnExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `Return` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `value` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md new file mode 100644 index 0000000000..5b0340c8eb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] ReturnRecord" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `kind` | `"Return"` | - | +| `value` | [`Type`](../type-aliases/Type.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RmOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md similarity index 82% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RmOptions.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md index 7599309b27..4633ef9b42 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.RmOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md @@ -7,4 +7,4 @@ title: "[I] RmOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `recursive`? | `boolean` | If `true`, perform a recursive directory removal. In
recursive mode, errors are not reported if `path` does not exist, and
operations are retried on failure.

**Default**

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

**Default**

` false ` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md new file mode 100644 index 0000000000..839d509377 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md @@ -0,0 +1,54 @@ +--- +jsApi: true +title: "[I] Scalar" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `baseScalar?` | [`Scalar`](Scalar.md) | Scalar this scalar extends. | - | +| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| `derivedScalars` | [`Scalar`](Scalar.md)[] | Direct children. This is the reverse relation of

**See**

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

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

This is used only for diagnostics. The command line compiler will populate
it with the actual path from which the file was read, but it can actually
be an arbitrary name for other scenarios. | [`SourceFile`](SourceFile.md).`path` | +| `readonly` | `text` | `string` | The source code text. | [`SourceFile`](SourceFile.md).`text` | + +## Methods + +### getLineAndCharacterOfPosition() + +```ts +getLineAndCharacterOfPosition(position): LineAndCharacter +``` + +Converts a one-dimensional position in the document (measured in UTF-16 +code units) to line number and offset from line start. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `position` | `number` | + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getLineAndCharacterOfPosition`](SourceFile.md#getlineandcharacterofposition) + +*** + +### getLineStarts() + +```ts +getLineStarts(): readonly number[] +``` + +Array of positions in the text where each line begins. There is one entry +per line, in order of lines, and each entry represents the offset in UTF-16 +code units from the start of the document to the beginning of the line. + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getLineStarts`](SourceFile.md#getlinestarts) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerWorkspaceFolder.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md similarity index 50% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerWorkspaceFolder.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md index 223df23330..982da160b0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.ServerWorkspaceFolder.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md @@ -9,8 +9,8 @@ title: "[I] ServerWorkspaceFolder" ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `name` | `string` | The name of the workspace folder. Used to refer to this
workspace folder in the user interface. | -| `path` | `string` | - | -| `uri` | `string` | The associated URI for this workspace folder. | +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `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 new file mode 100644 index 0000000000..c5895d499e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] Service" + +--- +## Extends + +- [`ServiceDetails`](ServiceDetails.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `title?` | `string` | - | [`ServiceDetails`](ServiceDetails.md).`title` | +| `type` | [`Namespace`](Namespace.md) | - | - | +| `version?` | `string` | - | [`ServiceDetails`](ServiceDetails.md).`version` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md new file mode 100644 index 0000000000..c6af2118ae --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[I] ServiceDetails" + +--- +## Extended By + +- [`Service`](Service.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `title?` | `string` | - | +| `version?` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md similarity index 51% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceFile.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md index ac03f2d94e..96ecc3a7de 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md @@ -5,18 +5,18 @@ title: "[I] SourceFile" --- ## Extended By -- [`ServerSourceFile`](Interface.ServerSourceFile.md) +- [`ServerSourceFile`](ServerSourceFile.md) ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `readonly` `path` | `string` | The source file path.

This is used only for diagnostics. The command line compiler will populate
it with the actual path from which the file was read, but it can actually
be an arbitrary name for other scenarios. | -| `readonly` `text` | `string` | The source code text. | +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `path` | `string` | The source file path.

This is used only for diagnostics. The command line compiler will populate
it with the actual path from which the file was read, but it can actually
be an arbitrary name for other scenarios. | +| `readonly` | `text` | `string` | The source code text. | ## Methods -### getLineAndCharacterOfPosition +### getLineAndCharacterOfPosition() ```ts getLineAndCharacterOfPosition(position): LineAndCharacter @@ -31,13 +31,9 @@ code units) to line number and offset from line start. | :------ | :------ | | `position` | `number` | -#### Returns - -[`LineAndCharacter`](Interface.LineAndCharacter.md) - *** -### getLineStarts +### getLineStarts() ```ts getLineStarts(): readonly number[] @@ -46,7 +42,3 @@ getLineStarts(): readonly number[] Array of positions in the text where each line begins. There is one entry per line, in order of lines, and each entry represents the offset in UTF-16 code units from the start of the document to the beginning of the line. - -#### Returns - -*readonly* `number`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md new file mode 100644 index 0000000000..f017413ccf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] SourceLocation" + +--- +## Extends + +- [`TextRange`](TextRange.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`TextRange`](TextRange.md).`end` | +| `public` | `file` | [`SourceFile`](SourceFile.md) | - | - | +| `public` | `isSynthetic?` | `boolean` | - | - | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceLocationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md similarity index 82% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceLocationOptions.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md index 2ca6fef013..3cd8d892df 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SourceLocationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md @@ -7,4 +7,4 @@ title: "[I] SourceLocationOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `locateId`? | `boolean` | If trying to resolve the location of a type with an ID, show the location of the ID node instead of the entire type.
This makes sure that the location range is not too large and hard to read. | +| `locateId?` | `boolean` | If trying to resolve the location of a type with an ID, show the location of the ID node instead of the entire type.
This makes sure that the location range is not too large and hard to read. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md new file mode 100644 index 0000000000..78db796f29 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md @@ -0,0 +1,47 @@ +--- +jsApi: true +title: "[I] StringLiteral" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `"String"` | - | [`BaseType`](BaseType.md).`kind` | +| `node?` | [`StringLiteralNode`](StringLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `value` | `string` | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md new file mode 100644 index 0000000000..90140a9794 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] StringLiteralNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `StringLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `value` | `string` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SuppressDirective.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SuppressDirective.md new file mode 100644 index 0000000000..b578a32134 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SuppressDirective.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] SuppressDirective" + +--- +## Extends + +- [`DirectiveBase`](DirectiveBase.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `code` | `string` | - | - | +| `message` | `string` | - | - | +| `name` | `"suppress"` | - | - | +| `node` | [`DirectiveExpressionNode`](DirectiveExpressionNode.md) | - | [`DirectiveBase`](DirectiveBase.md).`node` | 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 new file mode 100644 index 0000000000..06e634f494 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[I] Sym" + +--- +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `declarations` | readonly [`Node`](../type-aliases/Node.md)[] | Nodes which contribute to this declaration | +| `readonly` | `exports?` | `SymbolTable` | Externally visible symbols contained inside this symbol. E.g. all declarations
in a namespace, or members of an enum. | +| `readonly` | `flags` | [`SymbolFlags`](../enumerations/SymbolFlags.md) | - | +| `readonly` | `id?` | `number` | A unique identifier for this symbol. Used to look up the symbol links. | +| `readonly` | `members?` | `SymbolTable` | Symbols for members of this symbol which must be referenced off the parent symbol
and cannot be referenced by other means (i.e. by unqualified lookup of the symbol
name). | +| `readonly` | `metatypeMembers?` | `SymbolTable` | Symbol table | +| `readonly` | `name` | `string` | The name of the symbol | +| `readonly` | `parent?` | [`Sym`](Sym.md) | The symbol containing this symbol, if any. E.g. for things declared in
a namespace, this refers to the namespace. | +| `readonly` | `symbolSource?` | [`Sym`](Sym.md) | For using symbols, this is the used symbol. | +| `readonly` | `type?` | [`Type`](../type-aliases/Type.md) | For late-bound symbols, this is the type referenced by the symbol. | +| `readonly` | `value?` | (...`args`) => `any` | - | 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 new file mode 100644 index 0000000000..e36931875f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] SymbolLinks" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `declaredType?` | [`Type`](../type-aliases/Type.md) | - | +| `instantiations?` | [`TypeInstantiationMap`](TypeInstantiationMap.md) | - | +| `type?` | [`Type`](../type-aliases/Type.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SyntheticLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md similarity index 55% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SyntheticLocationContext.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md index 8fd539e649..a45cd6cad5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.SyntheticLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md @@ -7,6 +7,6 @@ Refer to a type that was not declared in a file ## Properties -| Property | Type | -| :------ | :------ | -| `type` | `"synthetic"` | +| Property | Type | Description | +| :------ | :------ | :------ | +| `type` | `"synthetic"` | - | 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 new file mode 100644 index 0000000000..8167575c7c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[I] TemplateDeclarationNode" + +--- +## Extended By + +- [`OperationStatementNode`](OperationStatementNode.md) +- [`ModelStatementNode`](ModelStatementNode.md) +- [`ScalarStatementNode`](ScalarStatementNode.md) +- [`InterfaceStatementNode`](InterfaceStatementNode.md) +- [`UnionStatementNode`](UnionStatementNode.md) +- [`AliasStatementNode`](AliasStatementNode.md) + +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `locals?` | `SymbolTable` | - | +| `readonly` | `templateParameters` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md new file mode 100644 index 0000000000..c9b333f356 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md @@ -0,0 +1,48 @@ +--- +jsApi: true +title: "[I] TemplateParameter" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `constraint?` | [`Type`](../type-aliases/Type.md) \| [`ValueType`](ValueType.md) | - | - | +| `default?` | [`Type`](../type-aliases/Type.md) | - | - | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `"TemplateParameter"` | - | [`BaseType`](BaseType.md).`kind` | +| `node` | [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md) | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md new file mode 100644 index 0000000000..2ac7bb59d3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] TemplateParameterDeclarationNode" + +--- +## Extends + +- [`DeclarationNode`](DeclarationNode.md).[`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `constraint?` | [`Expression`](../type-aliases/Expression.md) | - | - | +| `readonly` | `default?` | [`Expression`](../type-aliases/Expression.md) | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `readonly` | `kind` | `TemplateParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`TemplateableNode`](../type-aliases/TemplateableNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md new file mode 100644 index 0000000000..987e48f7a6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[I] TemplatedTypeBase" + +--- +## Extended By + +- [`Model`](Model.md) +- [`Scalar`](Scalar.md) +- [`Interface`](Interface.md) +- [`Operation`](Operation.md) +- [`Union`](Union.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `templateArguments?` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

use templateMapper instead. | +| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | +| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md new file mode 100644 index 0000000000..cabae13e55 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] TextRange" + +--- +## Extended By + +- [`BaseNode`](BaseNode.md) +- [`LineComment`](LineComment.md) +- [`BlockComment`](BlockComment.md) +- [`SourceLocation`](SourceLocation.md) + +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tracer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tracer.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md index 27331e65a7..3a3f9861be 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.Tracer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md @@ -5,7 +5,7 @@ title: "[I] Tracer" --- ## Methods -### sub +### sub() ```ts sub(subarea): Tracer @@ -17,19 +17,15 @@ sub(subarea): Tracer | :------ | :------ | | `subarea` | `string` | -#### Returns - -[`Tracer`](Interface.Tracer.md) - *** -### trace +### trace() ```ts trace( - area, - message, - target?): void + area, + message, + target?): void ``` Trace @@ -40,8 +36,4 @@ Trace | :------ | :------ | :------ | | `area` | `string` | | | `message` | `string` | | -| `target`? | [`DiagnosticTarget`](Type.DiagnosticTarget.md) | - | - -#### Returns - -`void` +| `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 new file mode 100644 index 0000000000..145b6400fb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] TracerOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `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 new file mode 100644 index 0000000000..2fceb725ba --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md @@ -0,0 +1,47 @@ +--- +jsApi: true +title: "[I] Tuple" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `"Tuple"` | - | [`BaseType`](BaseType.md).`kind` | +| `node` | [`TupleExpressionNode`](TupleExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `values` | [`Type`](../type-aliases/Type.md)[] | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md new file mode 100644 index 0000000000..3a0251e246 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] TupleExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `TupleExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `values` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeInstantiationMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md similarity index 57% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeInstantiationMap.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md index dd2665c337..23d9ed98f8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeInstantiationMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md @@ -7,7 +7,7 @@ Maps type arguments to instantiated type. ## Methods -### get +### get() ```ts get(args): undefined | Type @@ -17,15 +17,11 @@ get(args): undefined | Type | Parameter | Type | | :------ | :------ | -| `args` | *readonly* [`Type`](Type.Type.md)[] | - -#### Returns - -`undefined` \| [`Type`](Type.Type.md) +| `args` | readonly [`Type`](../type-aliases/Type.md)[] | *** -### set +### set() ```ts set(args, type): void @@ -35,9 +31,5 @@ set(args, type): void | Parameter | Type | | :------ | :------ | -| `args` | *readonly* [`Type`](Type.Type.md)[] | -| `type` | [`Type`](Type.Type.md) | - -#### Returns - -`void` +| `args` | readonly [`Type`](../type-aliases/Type.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 new file mode 100644 index 0000000000..974a74ff32 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[I] TypeMapper" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `args` | readonly [`Type`](../type-aliases/Type.md)[] | - | +| `partial` | `boolean` | - | + +## Methods + +### getMappedType() + +```ts +getMappedType(type): Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`TemplateParameter`](TemplateParameter.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md new file mode 100644 index 0000000000..8b4ff0574e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] TypeNameOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `namespaceFilter?` | (`ns`) => `boolean` | - | +| `printable?` | `boolean` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md new file mode 100644 index 0000000000..85a89e6b07 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] TypeReferenceNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `arguments` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `TypeReference` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `target` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecCompletionItem.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md similarity index 59% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecCompletionItem.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md index 811ed89111..ac1c10531e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecCompletionItem.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md @@ -7,5 +7,5 @@ title: "[I] TypeSpecCompletionItem" | Property | Type | Description | | :------ | :------ | :------ | -| `label`? | `string` | Optional label if different from the text to complete. | -| `sym` | [`Sym`](Interface.Sym.md) | - | +| `label?` | `string` | Optional label if different from the text to complete. | +| `sym` | [`Sym`](Sym.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md new file mode 100644 index 0000000000..13585f50c4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md @@ -0,0 +1,105 @@ +--- +jsApi: true +title: "[I] TypeSpecLibrary" + +--- +Definition of a TypeSpec library + +## Extends + +- [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md)<`T`, `E`\> + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` extends `object` | - | +| `E` extends `Record`<`string`, `any`\> | `Record`<`string`, `never`\> | + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `diagnostics` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`diagnostics` | +| `readonly` | `emitter?` | `object` | Emitter configuration if library is an emitter. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`emitter` | +| `readonly` | `emitter.options?` | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | - | +| `readonly` | `emitterOptionValidator?` | [`JSONSchemaValidator`](JSONSchemaValidator.md) | JSON Schema validator for emitter options | - | +| `readonly` | `linter?` | [`LinterDefinition`](LinterDefinition.md) | Configuration if library is providing linting rules/rulesets. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`linter` | +| `readonly` | `name` | `string` | Name of the library. Must match the package.json name. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`name` | +| `public` | `requireImports?` | readonly `string`[] | List of other library that should be imported when this is used as an emitter.
Compiler will emit an error if the libraries are not explicitly imported. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`requireImports` | + +## Methods + +### createDiagnostic() + +```ts +createDiagnostic(diag): Diagnostic +``` + +#### Type parameters + +| Parameter | +| :------ | +| `C` extends `string` \| `number` \| `symbol` | +| `M` extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | + +*** + +### createStateSymbol() + +```ts +createStateSymbol(name): symbol +``` + +Get or create a symbol with the given name unique for that library. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | Symbol name scoped with the library name. | + +*** + +### getTracer() + +```ts +getTracer(program): Tracer +``` + +Returns a tracer scopped to the current library. +All trace area logged via this tracer will be prefixed with the library name. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Program.md) | + +*** + +### reportDiagnostic() + +```ts +reportDiagnostic(program, diag): void +``` + +#### Type parameters + +| Parameter | +| :------ | +| `C` extends `string` \| `number` \| `symbol` | +| `M` extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](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 new file mode 100644 index 0000000000..f7fae3e4e6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[I] TypeSpecLibraryDef" + +--- +Definition of a TypeSpec library + +## Extended By + +- [`TypeSpecLibrary`](TypeSpecLibrary.md) + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` extends `object` | - | +| `E` extends `Record`<`string`, `any`\> | `Record`<`string`, `never`\> | + +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `diagnostics` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | +| `readonly` | `emitter?` | `object` | Emitter configuration if library is an emitter. | +| `readonly` | `emitter.options?` | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | +| `readonly` | `linter?` | [`LinterDefinition`](LinterDefinition.md) | Configuration if library is providing linting rules/rulesets. | +| `readonly` | `name` | `string` | Name of the library. Must match the package.json name. | +| `public` | `requireImports?` | readonly `string`[] | List of other library that should be imported when this is used as an emitter.
Compiler will emit an error if the libraries are not explicitly imported. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecManifest.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecManifest.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md index 9b5afeb568..67130a08b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Interface.TypeSpecManifest.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md @@ -8,5 +8,5 @@ title: "[I] TypeSpecManifest" | Property | Type | Description | | :------ | :------ | :------ | | `commit` | `string` | Full commit sha. | -| `pr`? | `number` | Number of the pull request, if the build was from a pull request. | +| `pr?` | `number` | Number of the pull request, if the build was from a pull request. | | `version` | `string` | Version of the tsp compiler. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md new file mode 100644 index 0000000000..b3ac438174 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md @@ -0,0 +1,32 @@ +--- +jsApi: true +title: "[I] TypeSpecScriptNode" + +--- +## Extends + +- [`DeclarationNode`](DeclarationNode.md).[`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `comments` | readonly [`Comment`](../type-aliases/Comment.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `file` | [`SourceFile`](SourceFile.md) | - | - | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `readonly` | `inScopeNamespaces` | readonly [`NamespaceStatementNode`](NamespaceStatementNode.md)[] | - | - | +| `readonly` | `kind` | `TypeSpecScript` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `locals` | `SymbolTable` | - | - | +| `readonly` | `namespaces` | [`NamespaceStatementNode`](NamespaceStatementNode.md)[] | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `parseDiagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | - | - | +| `readonly` | `parseOptions` | [`ParseOptions`](ParseOptions.md) | - | - | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `printable` | `boolean` | - | - | +| `readonly` | `statements` | readonly [`Statement`](../type-aliases/Statement.md)[] | - | - | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `usings` | 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 new file mode 100644 index 0000000000..1bcadb301d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[I] Union" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `public` | `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| `public` | `expression` | `boolean` | - | - | +| `public` | `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `public` | `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | +| `public` | `kind` | `"Union"` | - | [`BaseType`](BaseType.md).`kind` | +| `public` | `name?` | `string` | - | - | +| `public` | `namespace?` | [`Namespace`](Namespace.md) | - | - | +| `public` | `node` | [`UnionStatementNode`](UnionStatementNode.md) \| [`UnionExpressionNode`](UnionExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | +| `readonly` | `options` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**

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

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

Variants are ordered in order that they appear in source. | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md new file mode 100644 index 0000000000..14c5a5e550 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] UnionExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `UnionExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `options` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md new file mode 100644 index 0000000000..1220ada39c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[I] UnionStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | +| `readonly` | `kind` | `UnionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `locals?` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `readonly` | `options` | readonly [`UnionVariantNode`](UnionVariantNode.md)[] | - | - | +| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `templateParameters` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md new file mode 100644 index 0000000000..94aba8a4f6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md @@ -0,0 +1,50 @@ +--- +jsApi: true +title: "[I] UnionVariant" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `"UnionVariant"` | - | [`BaseType`](BaseType.md).`kind` | +| `name` | `string` \| `symbol` | - | - | +| `node` | `undefined` \| [`UnionVariantNode`](UnionVariantNode.md) | - | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | +| `type` | [`Type`](../type-aliases/Type.md) | - | - | +| `union` | [`Union`](Union.md) | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md new file mode 100644 index 0000000000..e592839947 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] UnionVariantNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `decorators` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `id?` | [`IdentifierNode`](IdentifierNode.md) | - | - | +| `readonly` | `kind` | `UnionVariant` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`UnionStatementNode`](UnionStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `value` | [`Expression`](../type-aliases/Expression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md new file mode 100644 index 0000000000..3fa09ba62b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md @@ -0,0 +1,47 @@ +--- +jsApi: true +title: "[I] UnknownType" + +--- +## Extends + +- [`IntrinsicType`](IntrinsicType.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`IntrinsicType`](IntrinsicType.md).`isFinished` | +| `kind` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | +| `name` | `"unknown"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | +| `node?` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector?` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md new file mode 100644 index 0000000000..777ceaa089 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[I] UsageTracker" + +--- +## Properties + +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `readonly` | `types` | readonly [`TrackableType`](../type-aliases/TrackableType.md)[] | - | + +## Methods + +### isUsedAs() + +```ts +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 new file mode 100644 index 0000000000..644117d12f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] UsingStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `UsingStatement` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `name` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | +| `readonly` | `parent?` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md new file mode 100644 index 0000000000..9c4c98a981 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ValueOfExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `ValueOfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `readonly` | `target` | [`Expression`](../type-aliases/Expression.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueType.md new file mode 100644 index 0000000000..894a39a776 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueType.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] ValueType" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `kind` | `"Value"` | - | +| `target` | [`Type`](../type-aliases/Type.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 new file mode 100644 index 0000000000..6035a0d3b7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] VoidKeywordNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Modifier | Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | :------ | +| `readonly` | `directives?` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `readonly` | `docs?` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `readonly` | `end` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `readonly` | `flags` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `readonly` | `kind` | `VoidKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | +| `readonly` | `parent?` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `readonly` | `pos` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `readonly` | `symbol` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md new file mode 100644 index 0000000000..79d22f6062 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md @@ -0,0 +1,47 @@ +--- +jsApi: true +title: "[I] VoidType" + +--- +## Extends + +- [`IntrinsicType`](IntrinsicType.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`IntrinsicType`](IntrinsicType.md).`isFinished` | +| `kind` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | +| `name` | `"void"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | +| `node?` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector?` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Inherited from + +[`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.BytesKnownEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/BytesKnownEncoding.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.BytesKnownEncoding.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/BytesKnownEncoding.md index edea522beb..d0d2a38d47 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.BytesKnownEncoding.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/BytesKnownEncoding.md @@ -4,5 +4,5 @@ title: "[T] BytesKnownEncoding" --- ```ts -BytesKnownEncoding: "base64" | "base64url" +type BytesKnownEncoding: "base64" | "base64url"; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlCompletionItem.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlCompletionItem.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlCompletionItem.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlCompletionItem.md index 15f4838d1e..3636164b4f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlCompletionItem.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlCompletionItem.md @@ -4,7 +4,7 @@ title: "[T] CadlCompletionItem" --- ```ts -CadlCompletionItem: TypeSpecCompletionItem +type CadlCompletionItem: TypeSpecCompletionItem; ``` ## Deprecated diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibrary.md similarity index 51% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlLibrary.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibrary.md index 1d47104c6c..439cb3d7a3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibrary.md @@ -4,7 +4,7 @@ title: "[T] CadlLibrary" --- ```ts -CadlLibrary: TypeSpecLibrary< T, E > +type CadlLibrary: TypeSpecLibrary; ``` ## Deprecated @@ -15,5 +15,5 @@ Use TypeSpecLibrary | Parameter | Default | | :------ | :------ | -| `T` *extends* \{} | - | -| `E` *extends* `Record`< `string`, `any` \> | `Record`< `string`, `never` \> | +| `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.CadlLibraryDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibraryDef.md similarity index 51% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlLibraryDef.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibraryDef.md index 4637b7885a..0406e7a139 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlLibraryDef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibraryDef.md @@ -4,7 +4,7 @@ title: "[T] CadlLibraryDef" --- ```ts -CadlLibraryDef: TypeSpecLibraryDef< T, E > +type CadlLibraryDef: TypeSpecLibraryDef; ``` ## Deprecated @@ -15,5 +15,5 @@ Use TypeSpecLibraryDef | Parameter | Default | | :------ | :------ | -| `T` *extends* \{} | - | -| `E` *extends* `Record`< `string`, `any` \> | `Record`< `string`, `never` \> | +| `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.CadlManifest.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlManifest.md similarity index 71% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlManifest.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlManifest.md index fd114a7fbb..8dbe5c70e6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlManifest.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlManifest.md @@ -4,7 +4,7 @@ title: "[T] CadlManifest" --- ```ts -CadlManifest: TypeSpecManifest +type CadlManifest: TypeSpecManifest; ``` ## Deprecated diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlScriptNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlScriptNode.md similarity index 70% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlScriptNode.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlScriptNode.md index 5650378e26..cc62bc8a92 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlScriptNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlScriptNode.md @@ -4,7 +4,7 @@ title: "[T] CadlScriptNode" --- ```ts -CadlScriptNode: TypeSpecScriptNode +type CadlScriptNode: TypeSpecScriptNode; ``` ## Deprecated diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlValue.md similarity index 73% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlValue.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlValue.md index 88d1ccde0d..7a0c2a0a20 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.CadlValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlValue.md @@ -4,7 +4,7 @@ title: "[T] CadlValue" --- ```ts -CadlValue: TypeSpecValue +type CadlValue: TypeSpecValue; ``` ## Deprecated diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Comment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Comment.md similarity index 55% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Comment.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Comment.md index ba32de2587..cb9d83c25d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Comment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Comment.md @@ -4,5 +4,5 @@ title: "[T] Comment" --- ```ts -Comment: LineComment | BlockComment +type Comment: LineComment | BlockComment; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CreateTypeProps.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CreateTypeProps.md new file mode 100644 index 0000000000..09077fab54 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CreateTypeProps.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] CreateTypeProps" + +--- +```ts +type CreateTypeProps: Omit; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DateTimeKnownEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DateTimeKnownEncoding.md new file mode 100644 index 0000000000..adb02250da --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DateTimeKnownEncoding.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] DateTimeKnownEncoding" + +--- +```ts +type DateTimeKnownEncoding: "rfc3339" | "rfc7231" | "unixTimestamp"; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Declaration.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Declaration.md new file mode 100644 index 0000000000..02ab5c9b0f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Declaration.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[T] Declaration" + +--- +```ts +type Declaration: + | ModelStatementNode + | ScalarStatementNode + | InterfaceStatementNode + | UnionStatementNode + | NamespaceStatementNode + | OperationStatementNode + | TemplateParameterDeclarationNode + | ProjectionStatementNode + | ProjectionParameterDeclarationNode + | ProjectionLambdaParameterDeclarationNode + | EnumStatementNode + | AliasStatementNode + | DecoratorDeclarationStatementNode + | FunctionDeclarationStatementNode; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DecoratorArgumentValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DecoratorArgumentValue.md similarity index 57% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DecoratorArgumentValue.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DecoratorArgumentValue.md index fa3a6d9843..08ae00dea0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DecoratorArgumentValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DecoratorArgumentValue.md @@ -4,7 +4,7 @@ title: "[T] DecoratorArgumentValue" --- ```ts -DecoratorArgumentValue: Type | number | string | boolean +type DecoratorArgumentValue: Type | number | string | boolean; ``` Type System types 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 new file mode 100644 index 0000000000..a8cda9bcb2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[T] DiagnosticFormat" + +--- +```ts +type DiagnosticFormat: T[C][M] extends CallableMessage ? object : Record; +``` + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `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.DiagnosticHandler.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticHandler.md similarity index 50% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticHandler.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticHandler.md index d0369b4ec7..08aa8b590d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticHandler.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticHandler.md @@ -4,15 +4,11 @@ title: "[T] DiagnosticHandler" --- ```ts -DiagnosticHandler: (diagnostic) => void +type DiagnosticHandler: (diagnostic) => void; ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `diagnostic` | [`Diagnostic`](Interface.Diagnostic.md) | - -## Returns - -`void` +| `diagnostic` | [`Diagnostic`](../interfaces/Diagnostic.md) | 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 new file mode 100644 index 0000000000..914e233943 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticMap.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] DiagnosticMap" + +--- +```ts +type DiagnosticMap: { readonly [code in keyof T]: DiagnosticDefinition }; +``` + +## Type parameters + +| 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 new file mode 100644 index 0000000000..4a3471badc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReport.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[T] DiagnosticReport" + +--- +```ts +type DiagnosticReport: DiagnosticReportWithoutTarget & object; +``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `target` | [`DiagnosticTarget`](DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | - | + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `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 new file mode 100644 index 0000000000..5f28ab15e6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[T] DiagnosticReportWithoutTarget" + +--- +```ts +type DiagnosticReportWithoutTarget: object & DiagnosticFormat; +``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `code` | `C` | - | +| `messageId` | `M` | - | + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `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.DiagnosticResult.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticResult.md similarity index 84% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticResult.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticResult.md index 338f9e4e2c..9f7bc17eeb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticResult.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticResult.md @@ -4,7 +4,7 @@ title: "[T] DiagnosticResult" --- ```ts -DiagnosticResult: [T, readonly Diagnostic[]] +type DiagnosticResult: [T, readonly Diagnostic[]]; ``` Return type of accessor functions in TypeSpec. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticSeverity.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticSeverity.md similarity index 57% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticSeverity.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticSeverity.md index 785708e4bd..cb099c51c1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DiagnosticSeverity.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticSeverity.md @@ -4,5 +4,5 @@ title: "[T] DiagnosticSeverity" --- ```ts -DiagnosticSeverity: "error" | "warning" +type DiagnosticSeverity: "error" | "warning"; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticTarget.md new file mode 100644 index 0000000000..186c4100a7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticTarget.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] DiagnosticTarget" + +--- +```ts +type DiagnosticTarget: TypeSpecDiagnosticTarget | SourceLocation; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Directive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Directive.md new file mode 100644 index 0000000000..b60793174b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Directive.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] Directive" + +--- +```ts +type Directive: SuppressDirective | DeprecatedDirective; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DirectiveArgument.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DirectiveArgument.md similarity index 50% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DirectiveArgument.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DirectiveArgument.md index 967a385cda..229b21308c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DirectiveArgument.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DirectiveArgument.md @@ -4,5 +4,5 @@ title: "[T] DirectiveArgument" --- ```ts -DirectiveArgument: StringLiteralNode | IdentifierNode +type DirectiveArgument: StringLiteralNode | IdentifierNode; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocContent.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DocContent.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocContent.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DocContent.md index cd72b386b0..2feb91bacc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.DocContent.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DocContent.md @@ -4,5 +4,5 @@ title: "[T] DocContent" --- ```ts -DocContent: DocTextNode +type DocContent: DocTextNode; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DocTag.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DocTag.md new file mode 100644 index 0000000000..63dab4fe8f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DocTag.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[T] DocTag" + +--- +```ts +type DocTag: + | DocReturnsTagNode + | DocErrorsTagNode + | DocParamTagNode + | DocTemplateTagNode + | DocUnknownTagNode; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DocToken.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DocToken.md new file mode 100644 index 0000000000..2c143a86cf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DocToken.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[T] DocToken" + +--- +```ts +type DocToken: + | Token.NewLine + | Token.Whitespace + | Token.ConflictMarker + | Token.Star + | Token.At + | Token.CloseBrace + | Token.Identifier + | Token.Hyphen + | Token.DocText + | Token.DocCodeSpan + | Token.DocCodeFenceDelimiter + | Token.EndOfFile; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DurationKnownEncoding.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DurationKnownEncoding.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DurationKnownEncoding.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DurationKnownEncoding.md index ae18050b51..e40ff8e007 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Namespace.decorators.Type.DurationKnownEncoding.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DurationKnownEncoding.md @@ -4,5 +4,5 @@ title: "[T] DurationKnownEncoding" --- ```ts -DurationKnownEncoding: "ISO8601" | "seconds" +type DurationKnownEncoding: "ISO8601" | "seconds"; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitOptionsFor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitOptionsFor.md similarity index 66% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitOptionsFor.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitOptionsFor.md index 35dc081778..50a0c41d5a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.EmitOptionsFor.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitOptionsFor.md @@ -4,7 +4,7 @@ title: "[T] EmitOptionsFor" --- ```ts -EmitOptionsFor: C extends TypeSpecLibrary< infer _T, infer E > ? E : never +type EmitOptionsFor: C extends TypeSpecLibrary ? E : never; ``` Get the options for the onEmit of this library. 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 new file mode 100644 index 0000000000..1c75463e4e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/EmitterFunc.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] EmitterFunc" + +--- +```ts +type EmitterFunc: (context) => Promise | void; +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`EmitContext`](../interfaces/EmitContext.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Expression.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Expression.md new file mode 100644 index 0000000000..eb40abc01e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Expression.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[T] Expression" + +--- +```ts +type Expression: + | ArrayExpressionNode + | MemberExpressionNode + | ModelExpressionNode + | TupleExpressionNode + | UnionExpressionNode + | IntersectionExpressionNode + | TypeReferenceNode + | ValueOfExpressionNode + | IdentifierNode + | StringLiteralNode + | NumericLiteralNode + | BooleanLiteralNode + | VoidKeywordNode + | NeverKeywordNode + | AnyKeywordNode; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredCadlValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredCadlValue.md similarity index 60% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredCadlValue.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredCadlValue.md index f97bfd770d..da265fb262 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.InferredCadlValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredCadlValue.md @@ -4,7 +4,7 @@ title: "[T] InferredCadlValue" --- ```ts -InferredCadlValue: InferredTypeSpecValue< K > +type InferredCadlValue: InferredTypeSpecValue; ``` ## Deprecated @@ -15,4 +15,4 @@ Use InferredTypeSpecValue | Parameter | | :------ | -| `K` *extends* [`TypeKind`](Type.TypeKind.md) | +| `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 new file mode 100644 index 0000000000..3f5fdccbed --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredTypeSpecValue.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] InferredTypeSpecValue" + +--- +```ts +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 + +| Parameter | +| :------ | +| `K` extends [`TypeKind`](TypeKind.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/IntrinsicScalarName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/IntrinsicScalarName.md new file mode 100644 index 0000000000..46387c05fd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/IntrinsicScalarName.md @@ -0,0 +1,33 @@ +--- +jsApi: true +title: "[T] IntrinsicScalarName" + +--- +```ts +type IntrinsicScalarName: + | "bytes" + | "numeric" + | "integer" + | "float" + | "int64" + | "int32" + | "int16" + | "int8" + | "uint64" + | "uint32" + | "uint16" + | "uint8" + | "safeint" + | "float32" + | "float64" + | "decimal" + | "decimal128" + | "string" + | "plainDate" + | "plainTime" + | "utcDateTime" + | "offsetDateTime" + | "duration" + | "boolean" + | "url"; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.JSONSchemaType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/JSONSchemaType.md similarity index 71% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.JSONSchemaType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/JSONSchemaType.md index a600f0b505..d1ede8cc96 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.JSONSchemaType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/JSONSchemaType.md @@ -4,7 +4,7 @@ title: "[T] JSONSchemaType" --- ```ts -JSONSchemaType: AjvJSONSchemaType< T > +type JSONSchemaType: AjvJSONSchemaType; ``` ## Type parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LibraryMetadata.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LibraryMetadata.md new file mode 100644 index 0000000000..e0887bf732 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LibraryMetadata.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] LibraryMetadata" + +--- +```ts +type LibraryMetadata: FileLibraryMetadata | ModuleLibraryMetadata; +``` 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 new file mode 100644 index 0000000000..2c6d055a69 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[T] LinterRuleDiagnosticFormat" + +--- +```ts +type LinterRuleDiagnosticFormat: T[M] extends CallableMessage ? object : Record; +``` + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `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 new file mode 100644 index 0000000000..6dcef34271 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReport.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[T] LinterRuleDiagnosticReport" + +--- +```ts +type LinterRuleDiagnosticReport: LinterRuleDiagnosticReportWithoutTarget & object; +``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `target` | [`DiagnosticTarget`](DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | - | + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `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/LinterRuleDiagnosticReportWithoutTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReportWithoutTarget.md new file mode 100644 index 0000000000..4b5c72a898 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReportWithoutTarget.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[T] LinterRuleDiagnosticReportWithoutTarget" + +--- +```ts +type LinterRuleDiagnosticReportWithoutTarget: object & LinterRuleDiagnosticFormat; +``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `messageId` | `M` | - | + +## Type parameters + +| Parameter | Default | +| :------ | :------ | +| `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/LiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LiteralNode.md new file mode 100644 index 0000000000..d140813d91 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LiteralNode.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] LiteralNode" + +--- +```ts +type LiteralNode: StringLiteralNode | NumericLiteralNode | BooleanLiteralNode; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LiteralType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LiteralType.md new file mode 100644 index 0000000000..0418cc26d6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LiteralType.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] LiteralType" + +--- +```ts +type LiteralType: StringLiteral | NumericLiteral | BooleanLiteral; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LocationContext.md similarity index 62% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LocationContext.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LocationContext.md index f52bb7b4ab..0b64651ee9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LocationContext.md @@ -4,7 +4,7 @@ title: "[T] LocationContext" --- ```ts -LocationContext: ProjectLocationContext | CompilerLocationContext | SyntheticLocationContext | LibraryLocationContext +type LocationContext: ProjectLocationContext | CompilerLocationContext | SyntheticLocationContext | LibraryLocationContext; ``` Represent a location context in the mind of the compiler. This can be: diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LogLevel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LogLevel.md similarity index 53% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LogLevel.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LogLevel.md index 113435ebcb..d7add61d1e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.LogLevel.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LogLevel.md @@ -4,5 +4,5 @@ title: "[T] LogLevel" --- ```ts -LogLevel: "trace" | "warning" | "error" +type LogLevel: "trace" | "warning" | "error"; ``` 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 new file mode 100644 index 0000000000..899b184703 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MarshalledValue.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] MarshalledValue" + +--- +```ts +type MarshalledValue: Type extends StringLiteral ? string : Type extends NumericLiteral ? number : Type extends BooleanLiteral ? boolean : Type; +``` + +## Type parameters + +| Parameter | +| :------ | +| `Type` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerNode.md new file mode 100644 index 0000000000..a2e623dab8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerNode.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[T] MemberContainerNode" + +--- +```ts +type MemberContainerNode: + | ModelStatementNode + | ModelExpressionNode + | InterfaceStatementNode + | EnumStatementNode + | UnionStatementNode; +``` + +Node types that can have referencable members diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerType.md similarity index 51% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerType.md index 74e929ff0f..f91bcc9915 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberContainerType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerType.md @@ -4,5 +4,5 @@ title: "[T] MemberContainerType" --- ```ts -MemberContainerType: Model | Enum | Interface | Union +type MemberContainerType: Model | Enum | Interface | Union; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberNode.md new file mode 100644 index 0000000000..c43ba0af08 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberNode.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] MemberNode" + +--- +```ts +type MemberNode: ModelPropertyNode | EnumMemberNode | OperationStatementNode | UnionVariantNode; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberType.md similarity index 60% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberType.md index 848b7e4de3..80140f981e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.MemberType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberType.md @@ -4,7 +4,7 @@ title: "[T] MemberType" --- ```ts -MemberType: ModelProperty | EnumMember | Operation | UnionVariant +type MemberType: ModelProperty | EnumMember | Operation | UnionVariant; ``` Type that can be used as members of a container type. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModelIndexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModelIndexer.md new file mode 100644 index 0000000000..e979ed290e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModelIndexer.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[T] ModelIndexer" + +--- +```ts +type ModelIndexer: object; +``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `key` | [`Scalar`](../interfaces/Scalar.md) | - | +| `value` | [`Type`](Type.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Modifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Modifier.md similarity index 60% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Modifier.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Modifier.md index b7494012d2..19ff00dcc4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.Modifier.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Modifier.md @@ -4,5 +4,5 @@ title: "[T] Modifier" --- ```ts -Modifier: ExternKeywordNode +type Modifier: ExternKeywordNode; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModuleResolutionResult.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModuleResolutionResult.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModuleResolutionResult.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModuleResolutionResult.md index 140911e6c1..a38c9ee663 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ModuleResolutionResult.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModuleResolutionResult.md @@ -4,5 +4,5 @@ title: "[T] ModuleResolutionResult" --- ```ts -ModuleResolutionResult: ResolvedFile | ResolvedModule +type ModuleResolutionResult: ResolvedFile | ResolvedModule; ``` 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 new file mode 100644 index 0000000000..49d9389265 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NeverIndexer.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[T] NeverIndexer" + +--- +```ts +type NeverIndexer: object; +``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `key` | [`NeverType`](../interfaces/NeverType.md) | - | +| `value` | `undefined` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NewLine.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NewLine.md similarity index 64% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NewLine.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NewLine.md index fdf9c963eb..9a00fe40cd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NewLine.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NewLine.md @@ -4,5 +4,5 @@ title: "[T] NewLine" --- ```ts -NewLine: "lf" | "crlf" +type NewLine: "lf" | "crlf"; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Node.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Node.md new file mode 100644 index 0000000000..82d14b0673 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Node.md @@ -0,0 +1,45 @@ +--- +jsApi: true +title: "[T] Node" + +--- +```ts +type Node: + | TypeSpecScriptNode + | JsSourceFileNode + | JsNamespaceDeclarationNode + | TemplateParameterDeclarationNode + | ProjectionParameterDeclarationNode + | ProjectionLambdaParameterDeclarationNode + | ModelPropertyNode + | UnionVariantNode + | OperationStatementNode + | OperationSignatureDeclarationNode + | OperationSignatureReferenceNode + | EnumMemberNode + | EnumSpreadMemberNode + | ModelSpreadPropertyNode + | DecoratorExpressionNode + | DirectiveExpressionNode + | Statement + | Expression + | FunctionParameterNode + | Modifier + | DocNode + | DocContent + | DocTag + | ProjectionStatementItem + | ProjectionExpression + | ProjectionModelSelectorNode + | ProjectionModelPropertySelectorNode + | ProjectionInterfaceSelectorNode + | ProjectionOperationSelectorNode + | ProjectionEnumSelectorNode + | ProjectionEnumMemberSelectorNode + | ProjectionUnionSelectorNode + | ProjectionUnionVariantSelectorNode + | ProjectionModelPropertyNode + | ProjectionModelSpreadPropertyNode + | ProjectionStatementNode + | ProjectionNode; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NodeCallback.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NodeCallback.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NodeCallback.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NodeCallback.md index 473d0dd781..d3ed4a633a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.NodeCallback.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NodeCallback.md @@ -4,7 +4,7 @@ title: "[T] NodeCallback" --- ```ts -NodeCallback: (c) => T +type NodeCallback: (c) => T; ``` ## Type parameters @@ -17,8 +17,4 @@ NodeCallback: (c) => T | Parameter | Type | | :------ | :------ | -| `c` | [`Node`](Type.Node.md) | - -## Returns - -`T` +| `c` | [`Node`](Node.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationContainer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/OperationContainer.md similarity index 51% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationContainer.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/OperationContainer.md index 1f76aaf743..67ffa61aa0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.OperationContainer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/OperationContainer.md @@ -4,5 +4,5 @@ title: "[T] OperationContainer" --- ```ts -OperationContainer: Namespace | Interface | Operation +type OperationContainer: Namespace | Interface | Operation; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/OperationSignature.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/OperationSignature.md new file mode 100644 index 0000000000..f6bcceb7ea --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/OperationSignature.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] OperationSignature" + +--- +```ts +type OperationSignature: OperationSignatureDeclarationNode | OperationSignatureReferenceNode; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ProjectionExpression.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ProjectionExpression.md new file mode 100644 index 0000000000..6ed8c1e44e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ProjectionExpression.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[T] ProjectionExpression" + +--- +```ts +type ProjectionExpression: + | ProjectionLogicalExpressionNode + | ProjectionRelationalExpressionNode + | ProjectionEqualityExpressionNode + | ProjectionUnaryExpressionNode + | ProjectionArithmeticExpressionNode + | ProjectionCallExpressionNode + | ProjectionMemberExpressionNode + | ProjectionDecoratorReferenceExpressionNode + | ProjectionTupleExpressionNode + | ProjectionModelExpressionNode + | ProjectionIfExpressionNode + | ProjectionBlockExpressionNode + | ProjectionLambdaExpressionNode + | StringLiteralNode + | NumericLiteralNode + | BooleanLiteralNode + | IdentifierNode + | VoidKeywordNode + | NeverKeywordNode + | AnyKeywordNode + | ReturnExpressionNode; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionStatementItem.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ProjectionStatementItem.md similarity index 51% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionStatementItem.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ProjectionStatementItem.md index e5b661c538..79861ce4f5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.ProjectionStatementItem.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ProjectionStatementItem.md @@ -4,5 +4,5 @@ title: "[T] ProjectionStatementItem" --- ```ts -ProjectionStatementItem: ProjectionExpressionStatementNode +type ProjectionStatementItem: ProjectionExpressionStatementNode; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ReferenceExpression.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ReferenceExpression.md new file mode 100644 index 0000000000..a255a58230 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ReferenceExpression.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[T] ReferenceExpression" + +--- +```ts +type ReferenceExpression: + | TypeReferenceNode + | MemberExpressionNode + | IdentifierNode + | VoidKeywordNode + | NeverKeywordNode; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.RuleRef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/RuleRef.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.RuleRef.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/RuleRef.md index 19f2475fb6..35404a94e3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.RuleRef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/RuleRef.md @@ -4,7 +4,7 @@ title: "[T] RuleRef" --- ```ts -RuleRef: \${string}/${string}\ +type RuleRef: \${string}/${string}\; ``` Reference to a rule. In this format `:` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ScopeNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ScopeNode.md new file mode 100644 index 0000000000..9572988303 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ScopeNode.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[T] ScopeNode" + +--- +```ts +type ScopeNode: + | NamespaceStatementNode + | ModelStatementNode + | InterfaceStatementNode + | AliasStatementNode + | TypeSpecScriptNode + | JsSourceFileNode + | ProjectionLambdaExpressionNode + | ProjectionNode; +``` 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 new file mode 100644 index 0000000000..2a762c98f0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] SemanticNodeListener" + +--- +```ts +type SemanticNodeListener: object & TypeListeners; +``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `root` | (`context`) => `void` \| `undefined` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SourceFileKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SourceFileKind.md similarity index 74% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SourceFileKind.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SourceFileKind.md index 7e2eb480e7..f487dbb863 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.SourceFileKind.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SourceFileKind.md @@ -4,7 +4,7 @@ title: "[T] SourceFileKind" --- ```ts -SourceFileKind: "typespec" | "js" +type SourceFileKind: "typespec" | "js"; ``` Type of the source file that can be loaded via typespec diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Statement.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Statement.md new file mode 100644 index 0000000000..7ced5c24fe --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Statement.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[T] Statement" + +--- +```ts +type Statement: + | ImportStatementNode + | ModelStatementNode + | ScalarStatementNode + | NamespaceStatementNode + | InterfaceStatementNode + | UnionStatementNode + | UsingStatementNode + | EnumStatementNode + | AliasStatementNode + | OperationStatementNode + | DecoratorDeclarationStatementNode + | FunctionDeclarationStatementNode + | AugmentDecoratorStatementNode + | EmptyStatementNode + | InvalidStatementNode + | ProjectionStatementNode; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypeName.md similarity index 62% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypeName.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypeName.md index f78f2b97bf..34bdd549ab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.StdTypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypeName.md @@ -4,5 +4,5 @@ title: "[T] StdTypeName" --- ```ts -StdTypeName: keyof StdTypes +type StdTypeName: keyof StdTypes; ``` 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 new file mode 100644 index 0000000000..be0108f4eb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypes.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[T] StdTypes" + +--- +```ts +type StdTypes: object & Record; +``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `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/TemplateableNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TemplateableNode.md new file mode 100644 index 0000000000..238c8df672 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TemplateableNode.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[T] TemplateableNode" + +--- +```ts +type TemplateableNode: + | ModelStatementNode + | ScalarStatementNode + | AliasStatementNode + | InterfaceStatementNode + | OperationStatementNode + | UnionStatementNode; +``` + +Node that can be used as template diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplatedType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TemplatedType.md similarity index 66% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplatedType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TemplatedType.md index 02002bbabb..bdd12a15b4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TemplatedType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TemplatedType.md @@ -4,7 +4,7 @@ title: "[T] TemplatedType" --- ```ts -TemplatedType: Model | Operation | Interface | Union +type TemplatedType: Model | Operation | Interface | Union; ``` Union of all the types that implement TemplatedTypeBase diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TrackableType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TrackableType.md similarity index 53% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TrackableType.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TrackableType.md index c2ec276360..2d33af62e6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TrackableType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TrackableType.md @@ -4,5 +4,5 @@ title: "[T] TrackableType" --- ```ts -TrackableType: Model | Enum | Union | Tuple +type TrackableType: Model | Enum | Union | Tuple; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Type.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Type.md new file mode 100644 index 0000000000..7a0d78772b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Type.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[T] Type" + +--- +```ts +type Type: + | Model + | ModelProperty + | Scalar + | Interface + | Enum + | EnumMember + | TemplateParameter + | Namespace + | Operation + | StringLiteral + | NumericLiteral + | BooleanLiteral + | Tuple + | Union + | UnionVariant + | IntrinsicType + | FunctionType + | Decorator + | FunctionParameter + | ObjectType + | Projection; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeKind.md similarity index 58% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeKind.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeKind.md index f6acdb5288..47f3dbd39e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeKind.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeKind.md @@ -4,5 +4,5 @@ title: "[T] TypeKind" --- ```ts -TypeKind: Type["kind"] | "Any" +type TypeKind: Type["kind"] | "Any"; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeListeners.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeListeners.md new file mode 100644 index 0000000000..48751a2117 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeListeners.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] TypeListeners" + +--- +```ts +type TypeListeners: UnionToIntersection>; +``` 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 new file mode 100644 index 0000000000..60f8ed84bc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOfDiagnostics.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] TypeOfDiagnostics" + +--- +```ts +type TypeOfDiagnostics: T extends DiagnosticMap ? D : never; +``` + +## Type parameters + +| Parameter | +| :------ | +| `T` extends [`DiagnosticMap`](DiagnosticMap.md)<`any`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOrReturnRecord.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOrReturnRecord.md similarity index 57% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOrReturnRecord.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOrReturnRecord.md index 0c4bc243fb..77849b7f48 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeOrReturnRecord.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOrReturnRecord.md @@ -4,5 +4,5 @@ title: "[T] TypeOrReturnRecord" --- ```ts -TypeOrReturnRecord: Type | ReturnRecord +type TypeOrReturnRecord: Type | ReturnRecord; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeSpecDiagnosticTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeSpecDiagnosticTarget.md similarity index 73% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeSpecDiagnosticTarget.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeSpecDiagnosticTarget.md index eb722cc033..d33434f295 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeSpecDiagnosticTarget.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeSpecDiagnosticTarget.md @@ -4,7 +4,7 @@ title: "[T] TypeSpecDiagnosticTarget" --- ```ts -TypeSpecDiagnosticTarget: Node | Type | Sym +type TypeSpecDiagnosticTarget: Node | Type | Sym; ``` Diagnostic target that can be used when working with TypeSpec types. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeSpecValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeSpecValue.md similarity index 51% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeSpecValue.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeSpecValue.md index 6b7daa5510..09800df195 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.TypeSpecValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeSpecValue.md @@ -4,5 +4,5 @@ title: "[T] TypeSpecValue" --- ```ts -TypeSpecValue: Type | string | number | boolean +type TypeSpecValue: Type | string | number | boolean; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.WriteLine.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/WriteLine.md similarity index 74% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.WriteLine.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/WriteLine.md index a84cc2a76b..359c880693 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Type.WriteLine.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/WriteLine.md @@ -4,7 +4,7 @@ title: "[T] WriteLine" --- ```ts -WriteLine: (text?) => void +type WriteLine: (text?) => void; ``` ## Parameters @@ -12,7 +12,3 @@ WriteLine: (text?) => void | Parameter | Type | | :------ | :------ | | `text`? | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.CadlPrettierPlugin.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/CadlPrettierPlugin.md similarity index 63% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.CadlPrettierPlugin.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/CadlPrettierPlugin.md index f504e22fca..56a2802bcd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.CadlPrettierPlugin.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/CadlPrettierPlugin.md @@ -4,7 +4,7 @@ title: "[V] CadlPrettierPlugin" --- ```ts -const CadlPrettierPlugin: __module = TypeSpecPrettierPlugin +const CadlPrettierPlugin: __module = TypeSpecPrettierPlugin; ``` ## Deprecated diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.MANIFEST.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/MANIFEST.md similarity index 54% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.MANIFEST.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/MANIFEST.md index cff969ba0c..66e2bed0a2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.MANIFEST.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/MANIFEST.md @@ -4,5 +4,5 @@ title: "[V] MANIFEST" --- ```ts -const MANIFEST: TypeSpecManifest = manifest +const MANIFEST: TypeSpecManifest = manifest; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.NoTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/NoTarget.md similarity index 76% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.NoTarget.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/NoTarget.md index ae7a069ea5..bdfc6f2016 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.NoTarget.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/NoTarget.md @@ -4,7 +4,7 @@ title: "[V] NoTarget" --- ```ts -const NoTarget: typeof NoTarget +const NoTarget: *typeof* NoTarget; ``` Used to explicitly specify that a diagnostic has no target. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.NodeHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/NodeHost.md similarity index 85% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.NodeHost.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/NodeHost.md index 6e8a80c785..7c3a174ffc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.NodeHost.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/NodeHost.md @@ -4,7 +4,7 @@ title: "[V] NodeHost" --- ```ts -const NodeHost: CompilerHost +const NodeHost: CompilerHost; ``` Implementation of the diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TypeSpecPrettierPlugin.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/TypeSpecPrettierPlugin.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TypeSpecPrettierPlugin.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/TypeSpecPrettierPlugin.md index f08ce9e9f0..141b137e60 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.TypeSpecPrettierPlugin.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/TypeSpecPrettierPlugin.md @@ -4,5 +4,5 @@ title: "[V] TypeSpecPrettierPlugin" --- ```ts -const TypeSpecPrettierPlugin: __module = formatter +const TypeSpecPrettierPlugin: __module = formatter; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.altDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/altDirectorySeparator.md similarity index 61% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.altDirectorySeparator.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/altDirectorySeparator.md index a6e3d2bb53..07ee28a1cb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.altDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/altDirectorySeparator.md @@ -4,5 +4,5 @@ title: "[V] altDirectorySeparator" --- ```ts -const altDirectorySeparator: "\\" = "\\" +const altDirectorySeparator: "\\" = "\\"; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.cadlVersion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/cadlVersion.md similarity index 68% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.cadlVersion.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/cadlVersion.md index 69db7c70a4..f72ab444e2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.cadlVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/cadlVersion.md @@ -4,7 +4,7 @@ title: "[V] cadlVersion" --- ```ts -const cadlVersion: any = typespecVersion +const cadlVersion: any = typespecVersion; ``` ## Deprecated diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.directorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/directorySeparator.md similarity index 88% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.directorySeparator.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/directorySeparator.md index 69aa833865..52fa3817c9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.directorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/directorySeparator.md @@ -4,7 +4,7 @@ title: "[V] directorySeparator" --- ```ts -const directorySeparator: "/" = "/" +const directorySeparator: "/" = "/"; ``` Internally, we represent paths as strings with '/' as the directory separator. diff --git a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/namespace.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.namespace.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/namespace.md index 47635e306f..4868929ecc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/openapi3/reference/js-api/Variable.namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/namespace.md @@ -4,5 +4,5 @@ title: "[V] namespace" --- ```ts -const namespace: "OpenAPI" = "OpenAPI" +const namespace: "TypeSpec" = "TypeSpec"; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.typespecVersion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/typespecVersion.md similarity index 56% rename from packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.typespecVersion.md rename to packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/typespecVersion.md index 2779326d17..3039c72099 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/Variable.typespecVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/typespecVersion.md @@ -4,5 +4,5 @@ title: "[V] typespecVersion" --- ```ts -const typespecVersion: any = manifest.version +const typespecVersion: any = manifest.version; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.AutoRouteOptions.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.AutoRouteOptions.md deleted file mode 100644 index 9281e49844..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.AutoRouteOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] AutoRouteOptions" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `routeParamFilter`? | (`op`, `param`) => `undefined` \| [`FilteredRouteParam`](Interface.FilteredRouteParam.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.FilteredRouteParam.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.FilteredRouteParam.md deleted file mode 100644 index 6a4a20575b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.FilteredRouteParam.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] FilteredRouteParam" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `excludeFromOperationParams`? | `boolean` | -| `routeParamString`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceKey.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceKey.md deleted file mode 100644 index a64a336659..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceKey.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] ResourceKey" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `keyProperty` | `ModelProperty` | -| `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceOperation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceOperation.md deleted file mode 100644 index 8a49966231..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ResourceOperation.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] ResourceOperation" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `operation` | `string` | -| `resourceType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Type.ResourceOperations.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Type.ResourceOperations.md deleted file mode 100644 index a686bfb4d6..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Type.ResourceOperations.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[T] ResourceOperations" - ---- -```ts -ResourceOperations: "read" | "create" | "createOrReplace" | "createOrUpdate" | "update" | "delete" | "list" -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Variable.namespace.md deleted file mode 100644 index e773eb7ea1..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Variable.namespace.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] namespace" - ---- -```ts -const namespace: "TypeSpec.Rest" = "TypeSpec.Rest" -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$action.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$action.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$action.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$action.md index 1c468312ac..b8c79cde6b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$action.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$action.md @@ -5,9 +5,9 @@ title: "[F] $action" --- ```ts $action( - context, - entity, - name?): void + context, + entity, + name?): void ``` ## Parameters @@ -17,7 +17,3 @@ $action( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `name`? | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSegment.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSegment.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSegment.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSegment.md index 28395ca1fc..608e9a438b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSegment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSegment.md @@ -5,9 +5,9 @@ title: "[F] $actionSegment" --- ```ts $actionSegment( - context, - entity, - name): void + context, + entity, + name): void ``` ## Parameters @@ -17,7 +17,3 @@ $actionSegment( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `name` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSeparator.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSeparator.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSeparator.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSeparator.md index d9f5b76671..2a8cb0f621 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$actionSeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$actionSeparator.md @@ -5,9 +5,9 @@ title: "[F] $actionSeparator" --- ```ts $actionSeparator( - context, - entity, - separator): void + context, + entity, + separator): void ``` `@actionSeparator` defines the separator string that is used to precede the action name @@ -22,7 +22,3 @@ $actionSeparator( | `context` | `DecoratorContext` | | `entity` | `Model` \| `ModelProperty` \| `Operation` | | `separator` | `"/"` \| `":"` \| `"/:"` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$autoRoute.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$autoRoute.md similarity index 96% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$autoRoute.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$autoRoute.md index 56c6bc5b29..f379e56a4c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$autoRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$autoRoute.md @@ -19,7 +19,3 @@ auto-generated routes. | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Interface` \| `Operation` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$collectionAction.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$collectionAction.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$collectionAction.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$collectionAction.md index f2d8fa47f5..a078bb5423 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$collectionAction.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$collectionAction.md @@ -5,10 +5,10 @@ title: "[F] $collectionAction" --- ```ts $collectionAction( - context, - entity, - resourceType, - name?): void + context, + entity, + resourceType, + name?): void ``` ## Parameters @@ -19,7 +19,3 @@ $collectionAction( | `entity` | `Operation` | | `resourceType` | `Model` | | `name`? | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$copyResourceKeyParameters.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$copyResourceKeyParameters.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$copyResourceKeyParameters.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$copyResourceKeyParameters.md index 50c31104f8..1d28121be9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$copyResourceKeyParameters.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$copyResourceKeyParameters.md @@ -5,9 +5,9 @@ title: "[F] $copyResourceKeyParameters" --- ```ts $copyResourceKeyParameters( - context, - entity, - filter?): void + context, + entity, + filter?): void ``` ## Parameters @@ -17,7 +17,3 @@ $copyResourceKeyParameters( | `context` | `DecoratorContext` | | `entity` | `Model` | | `filter`? | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrReplacesResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrReplacesResource.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrReplacesResource.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrReplacesResource.md index e285937ef4..aa1451cc01 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrReplacesResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrReplacesResource.md @@ -5,9 +5,9 @@ title: "[F] $createsOrReplacesResource" --- ```ts $createsOrReplacesResource( - context, - entity, - resourceType): void + context, + entity, + resourceType): void ``` ## Parameters @@ -17,7 +17,3 @@ $createsOrReplacesResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrUpdatesResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrUpdatesResource.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrUpdatesResource.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrUpdatesResource.md index c036f4c4a4..836b143410 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsOrUpdatesResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsOrUpdatesResource.md @@ -5,9 +5,9 @@ title: "[F] $createsOrUpdatesResource" --- ```ts $createsOrUpdatesResource( - context, - entity, - resourceType): void + context, + entity, + resourceType): void ``` ## Parameters @@ -17,7 +17,3 @@ $createsOrUpdatesResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsResource.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsResource.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsResource.md index 149c7d938b..24c285285c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$createsResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$createsResource.md @@ -5,9 +5,9 @@ title: "[F] $createsResource" --- ```ts $createsResource( - context, - entity, - resourceType): void + context, + entity, + resourceType): void ``` ## Parameters @@ -17,7 +17,3 @@ $createsResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$deletesResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$deletesResource.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$deletesResource.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$deletesResource.md index 1672feccae..ad1a79193d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$deletesResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$deletesResource.md @@ -5,9 +5,9 @@ title: "[F] $deletesResource" --- ```ts $deletesResource( - context, - entity, - resourceType): void + context, + entity, + resourceType): void ``` ## Parameters @@ -17,7 +17,3 @@ $deletesResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$listsResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$listsResource.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$listsResource.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$listsResource.md index e1498b3d8c..27e48d0d07 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$listsResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$listsResource.md @@ -5,9 +5,9 @@ title: "[F] $listsResource" --- ```ts $listsResource( - context, - entity, - resourceType): void + context, + entity, + resourceType): void ``` ## Parameters @@ -17,7 +17,3 @@ $listsResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$onValidate.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$onValidate.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$onValidate.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$onValidate.md index 212e92eb72..df5dda0051 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Function.$onValidate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$onValidate.md @@ -12,7 +12,3 @@ $onValidate(program): void | Parameter | Type | | :------ | :------ | | `program` | `Program` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$parentResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$parentResource.md similarity index 91% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$parentResource.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$parentResource.md index 601b4c33e7..e57db3d602 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$parentResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$parentResource.md @@ -5,9 +5,9 @@ title: "[F] $parentResource" --- ```ts $parentResource( - context, - entity, - parentType): void + context, + entity, + parentType): void ``` `@parentResource` marks a model with a reference to its parent resource type @@ -25,7 +25,3 @@ the target type to show up in operations of the `Resource*` interfaces define | `context` | `DecoratorContext` | | `entity` | `Type` | | `parentType` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$readsResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$readsResource.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$readsResource.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$readsResource.md index 5f6132505a..670763f28f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$readsResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$readsResource.md @@ -5,9 +5,9 @@ title: "[F] $readsResource" --- ```ts $readsResource( - context, - entity, - resourceType): void + context, + entity, + resourceType): void ``` ## Parameters @@ -17,7 +17,3 @@ $readsResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resource.md similarity index 87% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resource.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resource.md index 02fe95a956..c79bb590b5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resource.md @@ -5,9 +5,9 @@ title: "[F] $resource" --- ```ts $resource( - context, - entity, - collectionName): void + context, + entity, + collectionName): void ``` `@resource` marks a model as a resource type. @@ -25,7 +25,3 @@ name of `widgets`. | `context` | `DecoratorContext` | | `entity` | `Model` | | `collectionName` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceLocation.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceLocation.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceLocation.md index 12d1f0b8a3..008d4f2697 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceLocation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceLocation.md @@ -5,9 +5,9 @@ title: "[F] $resourceLocation" --- ```ts $resourceLocation( - context, - entity, - resourceType): void + context, + entity, + resourceType): void ``` ## Parameters @@ -17,7 +17,3 @@ $resourceLocation( | `context` | `DecoratorContext` | | `entity` | `Model` | | `resourceType` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceTypeForKeyParam.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceTypeForKeyParam.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceTypeForKeyParam.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceTypeForKeyParam.md index 04aa3cc85c..8aa67e2a52 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$resourceTypeForKeyParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$resourceTypeForKeyParam.md @@ -5,9 +5,9 @@ title: "[F] $resourceTypeForKeyParam" --- ```ts $resourceTypeForKeyParam( - context, - entity, - resourceType): void + context, + entity, + resourceType): void ``` ## Parameters @@ -17,7 +17,3 @@ $resourceTypeForKeyParam( | `context` | `DecoratorContext` | | `entity` | `Type` | | `resourceType` | `Type` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segment.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segment.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segment.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segment.md index 0562ef2f3c..46b4a3f89c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segment.md @@ -5,9 +5,9 @@ title: "[F] $segment" --- ```ts $segment( - context, - entity, - name): void + context, + entity, + name): void ``` `@segment` defines the preceding path segment for a `@path` parameter in auto-generated routes @@ -24,7 +24,3 @@ path parameter's name field. | `context` | `DecoratorContext` | | `entity` | `Model` \| `ModelProperty` \| `Operation` | | `name` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segmentOf.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segmentOf.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segmentOf.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segmentOf.md index c6912a9035..63972a9f8f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$segmentOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$segmentOf.md @@ -5,9 +5,9 @@ title: "[F] $segmentOf" --- ```ts $segmentOf( - context, - entity, - resourceType): void + context, + entity, + resourceType): void ``` ## Parameters @@ -17,7 +17,3 @@ $segmentOf( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$updatesResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$updatesResource.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$updatesResource.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$updatesResource.md index 22dba9def6..c81d7bd331 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$updatesResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/$updatesResource.md @@ -5,9 +5,9 @@ title: "[F] $updatesResource" --- ```ts $updatesResource( - context, - entity, - resourceType): void + context, + entity, + resourceType): void ``` ## Parameters @@ -17,7 +17,3 @@ $updatesResource( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getAction.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getAction.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getAction.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getAction.md index ff9533a06f..094e46508c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getAction.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getAction.md @@ -16,8 +16,6 @@ getAction(program, operation): string | null | undefined ## Returns -`string` \| `null` \| `undefined` - ## Deprecated Use getActionDetails instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionDetails.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionDetails.md similarity index 82% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionDetails.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionDetails.md index 2553d3238d..e7514c1146 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionDetails.md @@ -15,7 +15,3 @@ Gets the ActionDetails for the specified operation if it has previously been mar | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | - -## Returns - -[`ActionDetails`](Interface.ActionDetails.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSegment.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSegment.md similarity index 85% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSegment.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSegment.md index 4a67666f95..697444b0bc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSegment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSegment.md @@ -13,7 +13,3 @@ getActionSegment(program, entity): string | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSeparator.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSeparator.md similarity index 93% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSeparator.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSeparator.md index ad10e29315..696b47f937 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getActionSeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getActionSeparator.md @@ -16,6 +16,4 @@ getActionSeparator(program, entity): string | undefined ## Returns -`string` \| `undefined` - the action separator string diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionAction.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionAction.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionAction.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionAction.md index d1641f55e9..875637d6c6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionAction.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionAction.md @@ -16,8 +16,6 @@ getCollectionAction(program, operation): string | null | undefined ## Returns -`string` \| `null` \| `undefined` - ## Deprecated Use getCollectionActionDetails instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionActionDetails.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionActionDetails.md similarity index 83% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionActionDetails.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionActionDetails.md index 616a43d6d7..f5ff439bf0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getCollectionActionDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getCollectionActionDetails.md @@ -15,7 +15,3 @@ Gets the ActionDetails for the specified operation if it has previously been mar | :------ | :------ | | `program` | `Program` | | `operation` | `Operation` | - -## Returns - -[`ActionDetails`](Interface.ActionDetails.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getParentResource.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getParentResource.md similarity index 86% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getParentResource.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getParentResource.md index 035bf89e60..3cec874c50 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getParentResource.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getParentResource.md @@ -13,7 +13,3 @@ getParentResource(program, resourceType): Model | undefined | :------ | :------ | | `program` | `Program` | | `resourceType` | `Model` | - -## Returns - -`Model` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceLocationType.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceLocationType.md similarity index 86% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceLocationType.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceLocationType.md index ef5607dd0c..59d4ad5148 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceLocationType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceLocationType.md @@ -13,7 +13,3 @@ getResourceLocationType(program, entity): Model | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Scalar` | - -## Returns - -`Model` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceOperation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceOperation.md similarity index 76% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceOperation.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceOperation.md index dda429a6eb..cd7f24bd49 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceOperation.md @@ -13,7 +13,3 @@ getResourceOperation(program, typespecOperation): ResourceOperation | undefined | :------ | :------ | | `program` | `Program` | | `typespecOperation` | `Operation` | - -## Returns - -[`ResourceOperation`](Interface.ResourceOperation.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeForKeyParam.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeForKeyParam.md similarity index 87% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeForKeyParam.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeForKeyParam.md index 916fa74d2a..2c4ecf6200 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeForKeyParam.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeForKeyParam.md @@ -13,7 +13,3 @@ getResourceTypeForKeyParam(program, param): Model | undefined | :------ | :------ | | `program` | `Program` | | `param` | `ModelProperty` | - -## Returns - -`Model` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeKey.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeKey.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeKey.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeKey.md index 8293311d8c..899bb55b59 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getResourceTypeKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getResourceTypeKey.md @@ -13,7 +13,3 @@ getResourceTypeKey(program, resourceType): ResourceKey | undefined | :------ | :------ | | `program` | `Program` | | `resourceType` | `Model` | - -## Returns - -[`ResourceKey`](Interface.ResourceKey.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getSegment.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getSegment.md similarity index 85% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getSegment.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getSegment.md index 4b391cbea4..53465e3684 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.getSegment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/getSegment.md @@ -13,7 +13,3 @@ getSegment(program, entity): string | undefined | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | - -## Returns - -`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isAutoRoute.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isAutoRoute.md similarity index 90% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isAutoRoute.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isAutoRoute.md index a2e3f25b11..8805220b75 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isAutoRoute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isAutoRoute.md @@ -13,7 +13,3 @@ isAutoRoute(program, entity): boolean | :------ | :------ | | `program` | `Program` | | `entity` | `Interface` \| `Operation` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isListOperation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isListOperation.md similarity index 93% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isListOperation.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isListOperation.md index 0ace542980..5879329c16 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.isListOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/isListOperation.md @@ -15,7 +15,3 @@ Returns `true` if the given operation is marked as a list operation. | :------ | :------ | :------ | | `program` | `Program` | the TypeSpec program | | `target` | `Operation` | the target operation | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceOperation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceOperation.md similarity index 62% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceOperation.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceOperation.md index 1b6f49e80a..35e6b99a80 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceOperation.md @@ -5,10 +5,10 @@ title: "[F] setResourceOperation" --- ```ts setResourceOperation( - context, - entity, - resourceType, - operation): void + context, + entity, + resourceType, + operation): void ``` ## Parameters @@ -18,8 +18,4 @@ setResourceOperation( | `context` | `DecoratorContext` | | `entity` | `Operation` | | `resourceType` | `Model` | -| `operation` | [`ResourceOperations`](Type.ResourceOperations.md) | - -## Returns - -`void` +| `operation` | [`ResourceOperations`](../type-aliases/ResourceOperations.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceTypeKey.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceTypeKey.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceTypeKey.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceTypeKey.md index a11233e6f7..455af87b5e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.setResourceTypeKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/functions/setResourceTypeKey.md @@ -5,9 +5,9 @@ title: "[F] setResourceTypeKey" --- ```ts setResourceTypeKey( - program, - resourceType, - keyProperty): void + program, + resourceType, + keyProperty): void ``` ## Parameters @@ -17,7 +17,3 @@ setResourceTypeKey( | `program` | `Program` | | `resourceType` | `Model` | | `keyProperty` | `ModelProperty` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/index.md index 7fbe7ed41c..63e09fe11a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/index.md @@ -3,59 +3,59 @@ jsApi: true title: "[P] JS Api" --- -## Index +## Exports ### Interfaces -- [ActionDetails](Interface.ActionDetails.md) -- [AutoRouteOptions](Interface.AutoRouteOptions.md) -- [FilteredRouteParam](Interface.FilteredRouteParam.md) -- [ResourceKey](Interface.ResourceKey.md) -- [ResourceOperation](Interface.ResourceOperation.md) +- [ActionDetails](interfaces/ActionDetails.md) +- [AutoRouteOptions](interfaces/AutoRouteOptions.md) +- [FilteredRouteParam](interfaces/FilteredRouteParam.md) +- [ResourceKey](interfaces/ResourceKey.md) +- [ResourceOperation](interfaces/ResourceOperation.md) ### Type Aliases -- [ResourceOperations](Type.ResourceOperations.md) +- [ResourceOperations](type-aliases/ResourceOperations.md) ### Variables -- [namespace](Variable.namespace.md) +- [namespace](variables/namespace.md) ### Functions -- [$action](Function.$action.md) -- [$actionSegment](Function.$actionSegment.md) -- [$actionSeparator](Function.$actionSeparator.md) -- [$autoRoute](Function.$autoRoute.md) -- [$collectionAction](Function.$collectionAction.md) -- [$copyResourceKeyParameters](Function.$copyResourceKeyParameters.md) -- [$createsOrReplacesResource](Function.$createsOrReplacesResource.md) -- [$createsOrUpdatesResource](Function.$createsOrUpdatesResource.md) -- [$createsResource](Function.$createsResource.md) -- [$deletesResource](Function.$deletesResource.md) -- [$listsResource](Function.$listsResource.md) -- [$onValidate](Function.$onValidate.md) -- [$parentResource](Function.$parentResource.md) -- [$readsResource](Function.$readsResource.md) -- [$resource](Function.$resource.md) -- [$resourceLocation](Function.$resourceLocation.md) -- [$resourceTypeForKeyParam](Function.$resourceTypeForKeyParam.md) -- [$segment](Function.$segment.md) -- [$segmentOf](Function.$segmentOf.md) -- [$updatesResource](Function.$updatesResource.md) -- [getAction](Function.getAction.md) -- [getActionDetails](Function.getActionDetails.md) -- [getActionSegment](Function.getActionSegment.md) -- [getActionSeparator](Function.getActionSeparator.md) -- [getCollectionAction](Function.getCollectionAction.md) -- [getCollectionActionDetails](Function.getCollectionActionDetails.md) -- [getParentResource](Function.getParentResource.md) -- [getResourceLocationType](Function.getResourceLocationType.md) -- [getResourceOperation](Function.getResourceOperation.md) -- [getResourceTypeForKeyParam](Function.getResourceTypeForKeyParam.md) -- [getResourceTypeKey](Function.getResourceTypeKey.md) -- [getSegment](Function.getSegment.md) -- [isAutoRoute](Function.isAutoRoute.md) -- [isListOperation](Function.isListOperation.md) -- [setResourceOperation](Function.setResourceOperation.md) -- [setResourceTypeKey](Function.setResourceTypeKey.md) +- [$action](functions/$action.md) +- [$actionSegment](functions/$actionSegment.md) +- [$actionSeparator](functions/$actionSeparator.md) +- [$autoRoute](functions/$autoRoute.md) +- [$collectionAction](functions/$collectionAction.md) +- [$copyResourceKeyParameters](functions/$copyResourceKeyParameters.md) +- [$createsOrReplacesResource](functions/$createsOrReplacesResource.md) +- [$createsOrUpdatesResource](functions/$createsOrUpdatesResource.md) +- [$createsResource](functions/$createsResource.md) +- [$deletesResource](functions/$deletesResource.md) +- [$listsResource](functions/$listsResource.md) +- [$onValidate](functions/$onValidate.md) +- [$parentResource](functions/$parentResource.md) +- [$readsResource](functions/$readsResource.md) +- [$resource](functions/$resource.md) +- [$resourceLocation](functions/$resourceLocation.md) +- [$resourceTypeForKeyParam](functions/$resourceTypeForKeyParam.md) +- [$segment](functions/$segment.md) +- [$segmentOf](functions/$segmentOf.md) +- [$updatesResource](functions/$updatesResource.md) +- [getAction](functions/getAction.md) +- [getActionDetails](functions/getActionDetails.md) +- [getActionSegment](functions/getActionSegment.md) +- [getActionSeparator](functions/getActionSeparator.md) +- [getCollectionAction](functions/getCollectionAction.md) +- [getCollectionActionDetails](functions/getCollectionActionDetails.md) +- [getParentResource](functions/getParentResource.md) +- [getResourceLocationType](functions/getResourceLocationType.md) +- [getResourceOperation](functions/getResourceOperation.md) +- [getResourceTypeForKeyParam](functions/getResourceTypeForKeyParam.md) +- [getResourceTypeKey](functions/getResourceTypeKey.md) +- [getSegment](functions/getSegment.md) +- [isAutoRoute](functions/isAutoRoute.md) +- [isListOperation](functions/isListOperation.md) +- [setResourceOperation](functions/setResourceOperation.md) +- [setResourceTypeKey](functions/setResourceTypeKey.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ActionDetails.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/ActionDetails.md similarity index 100% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Interface.ActionDetails.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/ActionDetails.md diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/AutoRouteOptions.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/AutoRouteOptions.md new file mode 100644 index 0000000000..b7d977cb6b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/AutoRouteOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] AutoRouteOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `routeParamFilter?` | (`op`, `param`) => `undefined` \| [`FilteredRouteParam`](FilteredRouteParam.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/FilteredRouteParam.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/FilteredRouteParam.md new file mode 100644 index 0000000000..5fc5a97d34 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/FilteredRouteParam.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] FilteredRouteParam" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `excludeFromOperationParams?` | `boolean` | - | +| `routeParamString?` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/ResourceKey.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/ResourceKey.md new file mode 100644 index 0000000000..7e1ed93dd0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/ResourceKey.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] ResourceKey" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `keyProperty` | `ModelProperty` | - | +| `resourceType` | `Model` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/ResourceOperation.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/ResourceOperation.md new file mode 100644 index 0000000000..87e7f1cfe7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/interfaces/ResourceOperation.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] ResourceOperation" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `operation` | `string` | - | +| `resourceType` | `Model` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/type-aliases/ResourceOperations.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/type-aliases/ResourceOperations.md new file mode 100644 index 0000000000..e8588cc52a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/type-aliases/ResourceOperations.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[T] ResourceOperations" + +--- +```ts +type ResourceOperations: + | "read" + | "create" + | "createOrReplace" + | "createOrUpdate" + | "update" + | "delete" + | "list"; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/variables/namespace.md similarity index 50% rename from packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.namespace.md rename to packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/variables/namespace.md index f486edc38f..014e97e58f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/http/reference/js-api/Variable.namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/variables/namespace.md @@ -4,5 +4,5 @@ title: "[V] namespace" --- ```ts -const namespace: "TypeSpec.Http" = "TypeSpec.Http" +const namespace: "TypeSpec.Rest" = "TypeSpec.Rest"; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/resource-routing.md b/packages/website/versioned_docs/version-latest/standard-library/rest/resource-routing.md index 006246cbdd..a76d4b6070 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/resource-routing.md +++ b/packages/website/versioned_docs/version-latest/standard-library/rest/resource-routing.md @@ -15,7 +15,7 @@ namespace Pets { } ``` -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. Alternatively, you can name your operation `list`, `create`, `read`, `update`, `delete`, or `deleteAll` and the appropriate verb will be used automatically. Lets add an operation to our `Pets` resource: +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") diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Enumeration.Availability.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Enumeration.Availability.md deleted file mode 100644 index f3ebf5e3b8..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Enumeration.Availability.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[E] Availability" - ---- -## Enumeration Members - -| Member | Value | -| :------ | :------ | -| `Added` | ``"Added"`` | -| `Available` | ``"Available"`` | -| `Removed` | ``"Removed"`` | -| `Unavailable` | ``"Unavailable"`` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMap.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMap.md deleted file mode 100644 index df024297dc..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMap.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getAvailabilityMap" - ---- -```ts -getAvailabilityMap(program, type): Map< string, Availability > | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | `Program` | -| `type` | `Type` | - -## Returns - -`Map`< `string`, [`Availability`](Enumeration.Availability.md) \> \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionDependencies.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionDependencies.md deleted file mode 100644 index 155d631a41..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionDependencies.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getVersionDependencies" - ---- -```ts -getVersionDependencies(program, namespace): Map< Namespace, Map< Version, Version > | Version > | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | `Program` | -| `namespace` | `Namespace` | - -## Returns - -`Map`< `Namespace`, `Map`< [`Version`](Interface.Version.md), [`Version`](Interface.Version.md) \> \| [`Version`](Interface.Version.md) \> \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.indexTimeline.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.indexTimeline.md deleted file mode 100644 index 5c481fbb38..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.indexTimeline.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] indexTimeline" - ---- -```ts -indexTimeline( - program, - timeline, - projectingMoment): ObjectType & TypePrototype & {isFinished: boolean;} -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | `Program` | -| `timeline` | `VersioningTimeline` | -| `projectingMoment` | `TimelineMoment` | - -## Returns - -`ObjectType` & `TypePrototype` & \{`isFinished`: `boolean`;} diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.Version.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.Version.md deleted file mode 100644 index 8f751744cf..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.Version.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[I] Version" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `enumMember` | `EnumMember` | -| `index` | `number` | -| `name` | `string` | -| `namespace` | `Namespace` | -| `value` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.VersionResolution.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.VersionResolution.md deleted file mode 100644 index d0fb320224..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Interface.VersionResolution.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] VersionResolution" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `rootVersion` | `undefined` \| [`Version`](Interface.Version.md) | Version for the root namespace. `undefined` if not versioned. | -| `versions` | `Map`< `Namespace`, [`Version`](Interface.Version.md) \> | Resolved version for all the referenced namespaces. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Variable.namespace.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Variable.namespace.md deleted file mode 100644 index ca36f2a94b..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Variable.namespace.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -jsApi: true -title: "[V] namespace" - ---- -```ts -const namespace: "TypeSpec.Versioning" = "TypeSpec.Versioning" -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Class.VersionMap.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/classes/VersionMap.md similarity index 59% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Class.VersionMap.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/classes/VersionMap.md index 26216f1a74..b026409955 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Class.VersionMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/classes/VersionMap.md @@ -5,7 +5,7 @@ title: "[C] VersionMap" --- ## Constructors -### new VersionMap +### new VersionMap(namespace, enumType) ```ts new VersionMap(namespace, enumType): VersionMap @@ -18,15 +18,11 @@ new VersionMap(namespace, enumType): VersionMap | `namespace` | `Namespace` | | `enumType` | `Enum` | -#### Returns - -[`VersionMap`](Class.VersionMap.md) - ## Properties -| Property | Type | -| :------ | :------ | -| `private` `map` | `Map`< `EnumMember`, [`Version`](Interface.Version.md) \> | +| Modifier | Property | Type | Description | +| :------ | :------ | :------ | :------ | +| `private` | `map` | `Map`<`EnumMember`, [`Version`](../interfaces/Version.md)\> | - | ## Accessors @@ -38,7 +34,7 @@ get size(): number ## Methods -### getVersionForEnumMember +### getVersionForEnumMember() ```ts getVersionForEnumMember(member): undefined | Version @@ -50,18 +46,10 @@ getVersionForEnumMember(member): undefined | Version | :------ | :------ | | `member` | `EnumMember` | -#### Returns - -`undefined` \| [`Version`](Interface.Version.md) - *** -### getVersions +### getVersions() ```ts getVersions(): Version[] ``` - -#### Returns - -[`Version`](Interface.Version.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/enumerations/Availability.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/enumerations/Availability.md new file mode 100644 index 0000000000..464521f3b6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/enumerations/Availability.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[E] Availability" + +--- +## Enumeration Members + +| Member | Value | +| :------ | :------ | +| `Added` | `"Added"` | +| `Available` | `"Available"` | +| `Removed` | `"Removed"` | +| `Unavailable` | `"Unavailable"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$added.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$added.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$added.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$added.md index 427365c86c..1fdad62384 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$added.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$added.md @@ -5,9 +5,9 @@ title: "[F] $added" --- ```ts $added( - context, - t, - v): void + context, + t, + v): void ``` ## Parameters @@ -17,7 +17,3 @@ $added( | `context` | `DecoratorContext` | | `t` | `Type` | | `v` | `EnumMember` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$madeOptional.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$madeOptional.md similarity index 82% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$madeOptional.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$madeOptional.md index b99920915d..7decbe579a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$madeOptional.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$madeOptional.md @@ -5,9 +5,9 @@ title: "[F] $madeOptional" --- ```ts $madeOptional( - context, - t, - v): void + context, + t, + v): void ``` ## Parameters @@ -17,7 +17,3 @@ $madeOptional( | `context` | `DecoratorContext` | | `t` | `ModelProperty` | | `v` | `EnumMember` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$onValidate.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$onValidate.md similarity index 89% rename from packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$onValidate.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$onValidate.md index 212e92eb72..df5dda0051 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/rest/reference/js-api/Function.$onValidate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$onValidate.md @@ -12,7 +12,3 @@ $onValidate(program): void | Parameter | Type | | :------ | :------ | | `program` | `Program` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$removed.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$removed.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$removed.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$removed.md index 5e16f2b389..a7a031f468 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$removed.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$removed.md @@ -5,9 +5,9 @@ title: "[F] $removed" --- ```ts $removed( - context, - t, - v): void + context, + t, + v): void ``` ## Parameters @@ -17,7 +17,3 @@ $removed( | `context` | `DecoratorContext` | | `t` | `Type` | | `v` | `EnumMember` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$renamedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$renamedFrom.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$renamedFrom.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$renamedFrom.md index 2fe3b9d3b8..363443640e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$renamedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$renamedFrom.md @@ -5,10 +5,10 @@ title: "[F] $renamedFrom" --- ```ts $renamedFrom( - context, - t, - v, - oldName): void + context, + t, + v, + oldName): void ``` ## Parameters @@ -19,7 +19,3 @@ $renamedFrom( | `t` | `Type` | | `v` | `EnumMember` | | `oldName` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$returnTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$returnTypeChangedFrom.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$returnTypeChangedFrom.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$returnTypeChangedFrom.md index 3cb63b6ec9..ef23d3f31a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$returnTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$returnTypeChangedFrom.md @@ -5,10 +5,10 @@ title: "[F] $returnTypeChangedFrom" --- ```ts $returnTypeChangedFrom( - context, - op, - v, - oldReturnType): void + context, + op, + v, + oldReturnType): void ``` ## Parameters @@ -19,7 +19,3 @@ $returnTypeChangedFrom( | `op` | `Operation` | | `v` | `EnumMember` | | `oldReturnType` | `any` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$typeChangedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$typeChangedFrom.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$typeChangedFrom.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$typeChangedFrom.md index 299d21dd7b..24b4e25952 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$typeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$typeChangedFrom.md @@ -5,10 +5,10 @@ title: "[F] $typeChangedFrom" --- ```ts $typeChangedFrom( - context, - prop, - v, - oldType): void + context, + prop, + v, + oldType): void ``` ## Parameters @@ -19,7 +19,3 @@ $typeChangedFrom( | `prop` | `ModelProperty` | | `v` | `EnumMember` | | `oldType` | `any` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$useDependency.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$useDependency.md similarity index 78% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$useDependency.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$useDependency.md index 4db99dd2cc..fc0546cc72 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$useDependency.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$useDependency.md @@ -5,9 +5,9 @@ title: "[F] $useDependency" --- ```ts $useDependency( - context, - target, - ...versionRecords): void + context, + target, ... + versionRecords): void ``` ## Parameters @@ -17,7 +17,3 @@ $useDependency( | `context` | `DecoratorContext` | | `target` | `EnumMember` \| `Namespace` | | ...`versionRecords` | `EnumMember`[] | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$versioned.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$versioned.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$versioned.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$versioned.md index 5cf3e83131..1a260ccab4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.$versioned.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/$versioned.md @@ -5,9 +5,9 @@ title: "[F] $versioned" --- ```ts $versioned( - context, - t, - versions): void + context, + t, + versions): void ``` ## Parameters @@ -17,7 +17,3 @@ $versioned( | `context` | `DecoratorContext` | | `t` | `Namespace` | | `versions` | `Enum` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.buildVersionProjections.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/buildVersionProjections.md similarity index 87% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.buildVersionProjections.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/buildVersionProjections.md index a9d48aba13..cd8a640c27 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.buildVersionProjections.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/buildVersionProjections.md @@ -13,7 +13,3 @@ buildVersionProjections(program, rootNs): VersionProjections[] | :------ | :------ | | `program` | `Program` | | `rootNs` | `Namespace` | - -## Returns - -`VersionProjections`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.existsAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/existsAtVersion.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.existsAtVersion.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/existsAtVersion.md index 6ed50afbdf..0e98a7e3a3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.existsAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/existsAtVersion.md @@ -5,9 +5,9 @@ title: "[F] existsAtVersion" --- ```ts existsAtVersion( - p, - type, - versionKey): boolean + p, + type, + versionKey): boolean ``` ## Parameters @@ -17,7 +17,3 @@ existsAtVersion( | `p` | `Program` | | `type` | `Type` | | `versionKey` | `ObjectType` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.findVersionedNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/findVersionedNamespace.md similarity index 86% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.findVersionedNamespace.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/findVersionedNamespace.md index 5e282acbda..fdf0acd7c1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.findVersionedNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/findVersionedNamespace.md @@ -13,7 +13,3 @@ findVersionedNamespace(program, namespace): Namespace | undefined | :------ | :------ | | `program` | `Program` | | `namespace` | `Namespace` | - -## Returns - -`Namespace` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAddedOnVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAddedOnVersions.md similarity index 76% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAddedOnVersions.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAddedOnVersions.md index 6ac4df5d6e..9655c1964b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAddedOnVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAddedOnVersions.md @@ -13,7 +13,3 @@ getAddedOnVersions(p, t): Version[] | undefined | :------ | :------ | | `p` | `Program` | | `t` | `Type` | - -## Returns - -[`Version`](Interface.Version.md)[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMap.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMap.md new file mode 100644 index 0000000000..7f972bc15f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMap.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] getAvailabilityMap" + +--- +```ts +getAvailabilityMap(program, type): Map | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `type` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMapInTimeline.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md similarity index 57% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMapInTimeline.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md index 473853b3a3..9802f6339c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getAvailabilityMapInTimeline.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md @@ -5,9 +5,9 @@ title: "[F] getAvailabilityMapInTimeline" --- ```ts getAvailabilityMapInTimeline( - program, - type, - timeline): Map< TimelineMoment, Availability > | undefined + program, + type, + timeline): Map | undefined ``` ## Parameters @@ -17,7 +17,3 @@ getAvailabilityMapInTimeline( | `program` | `Program` | | `type` | `Type` | | `timeline` | `VersioningTimeline` | - -## Returns - -`Map`< `TimelineMoment`, [`Availability`](Enumeration.Availability.md) \> \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getMadeOptionalOn.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getMadeOptionalOn.md similarity index 84% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getMadeOptionalOn.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getMadeOptionalOn.md index 9a365a49a6..24d90d946c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getMadeOptionalOn.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getMadeOptionalOn.md @@ -16,6 +16,4 @@ getMadeOptionalOn(p, t): Version | undefined ## Returns -[`Version`](Interface.Version.md) \| `undefined` - version when the given type was made optional if applicable. diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getNameAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getNameAtVersion.md similarity index 85% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getNameAtVersion.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getNameAtVersion.md index 5f5ed25ad4..d170922f5b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getNameAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getNameAtVersion.md @@ -5,9 +5,9 @@ title: "[F] getNameAtVersion" --- ```ts getNameAtVersion( - p, - t, - versionKey): string + p, + t, + versionKey): string ``` ## Parameters @@ -20,6 +20,4 @@ getNameAtVersion( ## Returns -`string` - get old name if applicable. diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRemovedOnVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRemovedOnVersions.md similarity index 76% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRemovedOnVersions.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRemovedOnVersions.md index d057792880..12ed5476db 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRemovedOnVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRemovedOnVersions.md @@ -13,7 +13,3 @@ getRemovedOnVersions(p, t): Version[] | undefined | :------ | :------ | | `p` | `Program` | | `t` | `Type` | - -## Returns - -[`Version`](Interface.Version.md)[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFrom.md new file mode 100644 index 0000000000..3d53fc7ce9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFrom.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getRenamedFrom" + +--- +```ts +getRenamedFrom(p, t): RenamedFrom[] | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `p` | `Program` | +| `t` | `Type` | + +## Returns + +the array of RenamedFrom metadata if applicable. diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRenamedFromVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFromVersions.md similarity index 84% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRenamedFromVersions.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFromVersions.md index c45c592089..1da63f3937 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getRenamedFromVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getRenamedFromVersions.md @@ -16,6 +16,4 @@ getRenamedFromVersions(p, t): Version[] | undefined ## Returns -[`Version`](Interface.Version.md)[] \| `undefined` - the list of versions for which this decorator has been applied diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeBeforeVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeBeforeVersion.md similarity index 88% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeBeforeVersion.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeBeforeVersion.md index b3410dbd57..abfe677663 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeBeforeVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeBeforeVersion.md @@ -5,9 +5,9 @@ title: "[F] getReturnTypeBeforeVersion" --- ```ts getReturnTypeBeforeVersion( - p, - t, - versionKey): any + p, + t, + versionKey): any ``` ## Parameters @@ -20,6 +20,4 @@ getReturnTypeBeforeVersion( ## Returns -`any` - get old type if applicable. diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md similarity index 72% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeChangedFrom.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md index c245dabd7a..aca2124e35 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getReturnTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md @@ -4,7 +4,7 @@ title: "[F] getReturnTypeChangedFrom" --- ```ts -getReturnTypeChangedFrom(p, t): Map< Version, Type > | undefined +getReturnTypeChangedFrom(p, t): Map | undefined ``` Returns the mapping of versions to old return type values, if applicable @@ -18,6 +18,4 @@ Returns the mapping of versions to old return type values, if applicable ## Returns -`Map`< [`Version`](Interface.Version.md), `Type` \> \| `undefined` - Map of versions to old types, if any diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeBeforeVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeBeforeVersion.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeBeforeVersion.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeBeforeVersion.md index b23d9a3738..2be8a03bba 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeBeforeVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeBeforeVersion.md @@ -5,9 +5,9 @@ title: "[F] getTypeBeforeVersion" --- ```ts getTypeBeforeVersion( - p, - t, - versionKey): Type | undefined + p, + t, + versionKey): Type | undefined ``` ## Parameters @@ -20,6 +20,4 @@ getTypeBeforeVersion( ## Returns -`Type` \| `undefined` - get old type if applicable. diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeChangedFrom.md similarity index 72% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeChangedFrom.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeChangedFrom.md index 93758cfd09..7039315ede 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getTypeChangedFrom.md @@ -4,7 +4,7 @@ title: "[F] getTypeChangedFrom" --- ```ts -getTypeChangedFrom(p, t): Map< Version, Type > | undefined +getTypeChangedFrom(p, t): Map | undefined ``` Returns the mapping of versions to old type values, if applicable @@ -18,6 +18,4 @@ Returns the mapping of versions to old type values, if applicable ## Returns -`Map`< [`Version`](Interface.Version.md), `Type` \> \| `undefined` - Map of versions to old types, if any diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getUseDependencies.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getUseDependencies.md similarity index 52% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getUseDependencies.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getUseDependencies.md index c1172e32f6..6fc9813ab1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getUseDependencies.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getUseDependencies.md @@ -5,9 +5,9 @@ title: "[F] getUseDependencies" --- ```ts getUseDependencies( - program, - target, - searchEnum = true): Map< Namespace, Map< Version, Version > | Version > | undefined + program, + target, + searchEnum): Map | Version> | undefined ``` ## Parameters @@ -17,7 +17,3 @@ getUseDependencies( | `program` | `Program` | `undefined` | | `target` | `Enum` \| `Namespace` | `undefined` | | `searchEnum` | `boolean` | `true` | - -## Returns - -`Map`< `Namespace`, `Map`< [`Version`](Interface.Version.md), [`Version`](Interface.Version.md) \> \| [`Version`](Interface.Version.md) \> \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersion.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersion.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersion.md index e294003881..7ba5549b34 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersion.md @@ -15,7 +15,3 @@ Get the version map of the namespace. | :------ | :------ | | `program` | `Program` | | `namespace` | `Namespace` | - -## Returns - -[`VersionMap`](Class.VersionMap.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionDependencies.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionDependencies.md new file mode 100644 index 0000000000..60f81f8d17 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionDependencies.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[F] getVersionDependencies" + +--- +```ts +getVersionDependencies(program, namespace): Map | Version> | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `namespace` | `Namespace` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionForEnumMember.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionForEnumMember.md similarity index 79% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionForEnumMember.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionForEnumMember.md index 4c6a4a36de..124598d405 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionForEnumMember.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionForEnumMember.md @@ -13,7 +13,3 @@ getVersionForEnumMember(program, member): Version | undefined | :------ | :------ | | `program` | `Program` | | `member` | `EnumMember` | - -## Returns - -[`Version`](Interface.Version.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersions.md similarity index 74% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersions.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersions.md index 93bf1f312c..c728ea66a4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersions.md @@ -13,7 +13,3 @@ getVersions(p, t): [Namespace, VersionMap] | [] | :------ | :------ | | `p` | `Program` | | `t` | `Type` | - -## Returns - -[`Namespace`, [`VersionMap`](Class.VersionMap.md)] \| [] diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionsForEnum.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionsForEnum.md similarity index 76% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionsForEnum.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionsForEnum.md index 3e6278433d..f1d43817dd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.getVersionsForEnum.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/getVersionsForEnum.md @@ -13,7 +13,3 @@ getVersionsForEnum(program, en): [Namespace, VersionMap] | [] | :------ | :------ | | `program` | `Program` | | `en` | `Enum` | - -## Returns - -[`Namespace`, [`VersionMap`](Class.VersionMap.md)] \| [] diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentNameAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentNameAtVersion.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentNameAtVersion.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentNameAtVersion.md index fe25913984..8c00bdee96 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentNameAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentNameAtVersion.md @@ -5,9 +5,9 @@ title: "[F] hasDifferentNameAtVersion" --- ```ts hasDifferentNameAtVersion( - p, - type, - version): boolean + p, + type, + version): boolean ``` ## Parameters @@ -17,7 +17,3 @@ hasDifferentNameAtVersion( | `p` | `Program` | | `type` | `Type` | | `version` | `ObjectType` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentReturnTypeAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentReturnTypeAtVersion.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentReturnTypeAtVersion.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentReturnTypeAtVersion.md index bb51bbe47d..5621b96796 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentReturnTypeAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentReturnTypeAtVersion.md @@ -5,9 +5,9 @@ title: "[F] hasDifferentReturnTypeAtVersion" --- ```ts hasDifferentReturnTypeAtVersion( - p, - type, - version): boolean + p, + type, + version): boolean ``` ## Parameters @@ -17,7 +17,3 @@ hasDifferentReturnTypeAtVersion( | `p` | `Program` | | `type` | `Type` | | `version` | `ObjectType` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentTypeAtVersion.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentTypeAtVersion.md similarity index 80% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentTypeAtVersion.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentTypeAtVersion.md index c40d0ab224..18fcdb6065 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.hasDifferentTypeAtVersion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/hasDifferentTypeAtVersion.md @@ -5,9 +5,9 @@ title: "[F] hasDifferentTypeAtVersion" --- ```ts hasDifferentTypeAtVersion( - p, - type, - version): boolean + p, + type, + version): boolean ``` ## Parameters @@ -17,7 +17,3 @@ hasDifferentTypeAtVersion( | `p` | `Program` | | `type` | `Type` | | `version` | `ObjectType` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.madeOptionalAfter.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/madeOptionalAfter.md similarity index 77% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.madeOptionalAfter.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/madeOptionalAfter.md index 2caebd7479..6d79ee513c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.madeOptionalAfter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/madeOptionalAfter.md @@ -5,9 +5,9 @@ title: "[F] madeOptionalAfter" --- ```ts madeOptionalAfter( - program, - type, - versionKey): boolean + program, + type, + versionKey): boolean ``` ## Parameters @@ -17,7 +17,3 @@ madeOptionalAfter( | `program` | `Program` | | `type` | `Type` | | `versionKey` | `ObjectType` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.resolveVersions.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/resolveVersions.md similarity index 83% rename from packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.resolveVersions.md rename to packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/resolveVersions.md index ddb1823ba7..20172beec1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/Function.resolveVersions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/functions/resolveVersions.md @@ -15,7 +15,3 @@ Resolve the version to use for all namespace for each of the root namespace vers | :------ | :------ | :------ | | `program` | `Program` | | | `rootNs` | `Namespace` | Root namespace. | - -## Returns - -[`VersionResolution`](Interface.VersionResolution.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/index.md index c62ca865f9..4897908191 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/index.md @@ -3,59 +3,59 @@ jsApi: true title: "[P] JS Api" --- -## Index +## Exports ### Enumerations -- [Availability](Enumeration.Availability.md) +- [Availability](enumerations/Availability.md) ### Classes -- [VersionMap](Class.VersionMap.md) +- [VersionMap](classes/VersionMap.md) ### Interfaces -- [Version](Interface.Version.md) -- [VersionResolution](Interface.VersionResolution.md) +- [Version](interfaces/Version.md) +- [VersionResolution](interfaces/VersionResolution.md) ### Variables -- [namespace](Variable.namespace.md) +- [namespace](variables/namespace.md) ### Functions -- [$added](Function.$added.md) -- [$madeOptional](Function.$madeOptional.md) -- [$onValidate](Function.$onValidate.md) -- [$removed](Function.$removed.md) -- [$renamedFrom](Function.$renamedFrom.md) -- [$returnTypeChangedFrom](Function.$returnTypeChangedFrom.md) -- [$typeChangedFrom](Function.$typeChangedFrom.md) -- [$useDependency](Function.$useDependency.md) -- [$versioned](Function.$versioned.md) -- [buildVersionProjections](Function.buildVersionProjections.md) -- [existsAtVersion](Function.existsAtVersion.md) -- [findVersionedNamespace](Function.findVersionedNamespace.md) -- [getAddedOnVersions](Function.getAddedOnVersions.md) -- [getAvailabilityMap](Function.getAvailabilityMap.md) -- [getAvailabilityMapInTimeline](Function.getAvailabilityMapInTimeline.md) -- [getMadeOptionalOn](Function.getMadeOptionalOn.md) -- [getNameAtVersion](Function.getNameAtVersion.md) -- [getRemovedOnVersions](Function.getRemovedOnVersions.md) -- [getRenamedFromVersions](Function.getRenamedFromVersions.md) -- [getReturnTypeBeforeVersion](Function.getReturnTypeBeforeVersion.md) -- [getReturnTypeChangedFrom](Function.getReturnTypeChangedFrom.md) -- [getTypeBeforeVersion](Function.getTypeBeforeVersion.md) -- [getTypeChangedFrom](Function.getTypeChangedFrom.md) -- [getUseDependencies](Function.getUseDependencies.md) -- [getVersion](Function.getVersion.md) -- [getVersionDependencies](Function.getVersionDependencies.md) -- [getVersionForEnumMember](Function.getVersionForEnumMember.md) -- [getVersions](Function.getVersions.md) -- [getVersionsForEnum](Function.getVersionsForEnum.md) -- [hasDifferentNameAtVersion](Function.hasDifferentNameAtVersion.md) -- [hasDifferentReturnTypeAtVersion](Function.hasDifferentReturnTypeAtVersion.md) -- [hasDifferentTypeAtVersion](Function.hasDifferentTypeAtVersion.md) -- [indexTimeline](Function.indexTimeline.md) -- [madeOptionalAfter](Function.madeOptionalAfter.md) -- [resolveVersions](Function.resolveVersions.md) +- [$added](functions/$added.md) +- [$madeOptional](functions/$madeOptional.md) +- [$onValidate](functions/$onValidate.md) +- [$removed](functions/$removed.md) +- [$renamedFrom](functions/$renamedFrom.md) +- [$returnTypeChangedFrom](functions/$returnTypeChangedFrom.md) +- [$typeChangedFrom](functions/$typeChangedFrom.md) +- [$useDependency](functions/$useDependency.md) +- [$versioned](functions/$versioned.md) +- [buildVersionProjections](functions/buildVersionProjections.md) +- [existsAtVersion](functions/existsAtVersion.md) +- [findVersionedNamespace](functions/findVersionedNamespace.md) +- [getAddedOnVersions](functions/getAddedOnVersions.md) +- [getAvailabilityMap](functions/getAvailabilityMap.md) +- [getAvailabilityMapInTimeline](functions/getAvailabilityMapInTimeline.md) +- [getMadeOptionalOn](functions/getMadeOptionalOn.md) +- [getNameAtVersion](functions/getNameAtVersion.md) +- [getRemovedOnVersions](functions/getRemovedOnVersions.md) +- [getRenamedFrom](functions/getRenamedFrom.md) +- [getRenamedFromVersions](functions/getRenamedFromVersions.md) +- [getReturnTypeBeforeVersion](functions/getReturnTypeBeforeVersion.md) +- [getReturnTypeChangedFrom](functions/getReturnTypeChangedFrom.md) +- [getTypeBeforeVersion](functions/getTypeBeforeVersion.md) +- [getTypeChangedFrom](functions/getTypeChangedFrom.md) +- [getUseDependencies](functions/getUseDependencies.md) +- [getVersion](functions/getVersion.md) +- [getVersionDependencies](functions/getVersionDependencies.md) +- [getVersionForEnumMember](functions/getVersionForEnumMember.md) +- [getVersions](functions/getVersions.md) +- [getVersionsForEnum](functions/getVersionsForEnum.md) +- [hasDifferentNameAtVersion](functions/hasDifferentNameAtVersion.md) +- [hasDifferentReturnTypeAtVersion](functions/hasDifferentReturnTypeAtVersion.md) +- [hasDifferentTypeAtVersion](functions/hasDifferentTypeAtVersion.md) +- [madeOptionalAfter](functions/madeOptionalAfter.md) +- [resolveVersions](functions/resolveVersions.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/interfaces/Version.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/interfaces/Version.md new file mode 100644 index 0000000000..1832bccbeb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/interfaces/Version.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[I] Version" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `enumMember` | `EnumMember` | - | +| `index` | `number` | - | +| `name` | `string` | - | +| `namespace` | `Namespace` | - | +| `value` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/interfaces/VersionResolution.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/interfaces/VersionResolution.md new file mode 100644 index 0000000000..384e3f346a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/interfaces/VersionResolution.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] VersionResolution" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `rootVersion` | `undefined` \| [`Version`](Version.md) | Version for the root namespace. `undefined` if not versioned. | +| `versions` | `Map`<`Namespace`, [`Version`](Version.md)\> | Resolved version for all the referenced namespaces. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/variables/namespace.md b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/variables/namespace.md new file mode 100644 index 0000000000..9c54508ab3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/versioning/reference/js-api/variables/namespace.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] namespace" + +--- +```ts +const namespace: "TypeSpec.Versioning" = "TypeSpec.Versioning"; +``` diff --git a/packages/website/versioned_sidebars/version-latest-sidebars.json b/packages/website/versioned_sidebars/version-latest-sidebars.json index 75637305ef..b813616538 100644 --- a/packages/website/versioned_sidebars/version-latest-sidebars.json +++ b/packages/website/versioned_sidebars/version-latest-sidebars.json @@ -35,6 +35,7 @@ "label": "Getting Started", "items": [ "getting-started/getting-started", + "getting-started/getting-started-http", "getting-started/typespec-for-openapi-dev" ] },