From 1d6b3fb4ae156fea2491a8d6558dae7333428a26 Mon Sep 17 00:00:00 2001 From: Allen Zhang Date: Thu, 13 Jun 2024 12:28:18 -0700 Subject: [PATCH 1/3] Prepare typespec publish --- ...-decorator-model-arg-2024-4-17-11-50-34.md | 21 - ...r-decorator-model-arg-2024-4-6-16-27-17.md | 21 - .../add_madeRequired-2024-4-9-21-13-8.md | 8 - ...haracters-in-docblock-2024-4-23-16-0-21.md | 8 - ...custom-output-viewer-2024-4-28-16-25-31.md | 7 - ...tion-in-doc-comments-2024-4-20-14-31-22.md | 12 - ...tion-in-doc-comments-2024-4-20-14-54-41.md | 8 - ...n-variant-decorators-2024-4-20-14-27-15.md | 7 - ...on-variant-decorators-2024-4-20-14-48-3.md | 8 - ...feature-multipart-v2-2024-4-14-16-27-48.md | 6 - ...feature-multipart-v2-2024-4-14-22-58-52.md | 15 - .../feature-multipart-v2-2024-4-14-23-5-59.md | 8 - ...ure-object-literals-2024-2-15-18-36-3-1.md | 17 - ...ure-object-literals-2024-2-15-18-36-3-2.md | 17 - ...ature-object-literals-2024-2-15-18-36-3.md | 30 - ...ture-object-literals-2024-2-18-22-23-26.md | 10 - ...ature-object-literals-2024-3-16-10-38-3.md | 23 - ...ture-object-literals-2024-3-16-11-58-32.md | 7 - ...ature-object-literals-2024-3-16-12-0-15.md | 7 - ...ture-object-literals-2024-3-16-17-54-23.md | 8 - ...ture-object-literals-32024-2-15-18-36-3.md | 9 - .../feature-prop-doc-2024-5-5-21-1-58.md | 8 - ...s-indeterminate-entity-2024-4-16-19-9-9.md | 7 - ...ot-finish-unfinished-2024-5-11-21-54-41.md | 8 - ...ompiler-circular-refs-2024-4-9-14-57-38.md | 8 - ...example-of-statusCode-2024-5-3-20-58-17.md | 8 - ...fix-http-file-handling-2024-5-6-17-38-0.md | 8 - .../fix-install-shell-2024-5-5-16-51-0.md | 8 - .../fix-missing-export-2024-4-10-8-11-11.md | 6 - .../fix-no-all-no-rules-2024-5-5-16-21-56.md | 8 - ...ndling-trailing-zeros-2024-4-16-2-43-25.md | 8 - ...playground-regression-2024-5-5-16-53-46.md | 6 - ...round-styles-overflow-2024-5-6-19-45-49.md | 8 - ...r-keyword-parameters-2024-5-11-21-33-25.md | 8 - ...ar-constructor-clone-2024-5-12-20-39-42.md | 8 - ...ix-swagger-ui-missing-2024-5-10-15-15-0.md | 8 - .../changes/fix-vitest-2024-4-17-21-35-16.md | 8 - ...er-multiline-strings-2024-4-22-14-32-55.md | 8 - .../highlight-suppress-2024-4-28-16-43-58.md | 7 - ...letion-for-extends-is-2024-4-24-11-15-1.md | 27 - .../json-schema-fixes-2024-4-25-0-58-10.md | 7 - .../json-schema-fixes-2024-4-25-0-58-28.md | 6 - .../json-schema-oneof-2024-5-11-8-56-5.md | 7 - ...n-schema-reftype-fix-2024-4-23-16-41-33.md | 7 - ...ter-auto-all-ruleset-2024-4-28-16-18-46.md | 8 - ...ter-auto-all-ruleset-2024-4-28-16-18-47.md | 8 - .chronus/changes/main-2024-5-13-14-52-31.md | 8 - .../more-logging-vscode-2024-5-6-16-57-48.md | 10 - .../more-logging-vscode-2024-5-7-12-41-0.md | 7 - ...param-override-spread-2024-5-4-20-52-44.md | 8 - .../pick-properties-2024-5-3-17-55-34.md | 8 - .../playground-log-2024-5-12-13-33-41.md | 7 - .../playground-storybook-2024-4-22-18-10-6.md | 8 - .../playground-vite-2024-4-20-21-21-23.md | 8 - ...otobuf-package-names-2024-5-11-16-35-54.md | 7 - ...pgrade-deps-may-2024-2024-4-20-15-37-30.md | 25 - ...oning-FixVersionBug1-2024-4-21-16-34-18.md | 8 - ...ng-FixVersioningBugs-2024-4-22-20-42-27.md | 8 - .../versioning-fixBug-2024-5-5-20-59-9.md | 8 - ...oning-library-cleanup-2024-4-9-22-35-15.md | 8 - .../vs-extension-arm-2024-4-27-15-58-16.md | 7 - .../vscode-output-cmd-2024-4-17-16-6-25.md | 7 - packages/bundler/CHANGELOG.md | 7 + packages/bundler/package.json | 2 +- packages/compiler/CHANGELOG.md | 137 ++++ packages/compiler/package.json | 2 +- packages/eslint-plugin-typespec/CHANGELOG.md | 7 + packages/eslint-plugin-typespec/package.json | 2 +- packages/html-program-viewer/CHANGELOG.md | 11 + packages/html-program-viewer/package.json | 2 +- packages/http/CHANGELOG.md | 23 + packages/http/package.json | 2 +- packages/internal-build-utils/CHANGELOG.md | 7 + packages/internal-build-utils/package.json | 2 +- packages/json-schema/CHANGELOG.md | 17 + packages/json-schema/package.json | 2 +- packages/library-linter/CHANGELOG.md | 7 + packages/library-linter/package.json | 2 +- packages/openapi/CHANGELOG.md | 7 + packages/openapi/package.json | 2 +- packages/openapi3/CHANGELOG.md | 16 + packages/openapi3/package.json | 2 +- packages/playground/CHANGELOG.md | 16 + packages/playground/package.json | 2 +- .../prettier-plugin-typespec/CHANGELOG.md | 7 + .../prettier-plugin-typespec/package.json | 2 +- packages/protobuf/CHANGELOG.md | 12 + packages/protobuf/package.json | 2 +- packages/rest/CHANGELOG.md | 11 + packages/rest/package.json | 2 +- packages/tmlanguage-generator/CHANGELOG.md | 7 + packages/tmlanguage-generator/package.json | 2 +- packages/typespec-vs/CHANGELOG.md | 7 + packages/typespec-vs/package.json | 2 +- packages/typespec-vscode/CHANGELOG.md | 15 + packages/typespec-vscode/package.json | 2 +- packages/versioning/CHANGELOG.md | 14 + packages/versioning/package.json | 2 +- packages/website/playground-versions.json | 1 + .../emitters/json-schema/guide.md | 37 + .../json-schema/reference/decorators.md | 16 + .../emitters/json-schema/reference/index.mdx | 1 + .../js-api/classes/JsonSchemaEmitter.md | 147 +++- .../reference/js-api/functions/$baseUri.md | 2 +- .../reference/js-api/functions/$contains.md | 2 +- .../js-api/functions/$contentEncoding.md | 4 +- .../js-api/functions/$contentMediaType.md | 4 +- .../js-api/functions/$contentSchema.md | 4 +- .../reference/js-api/functions/$extension.md | 2 +- .../reference/js-api/functions/$id.md | 2 +- .../reference/js-api/functions/$jsonSchema.md | 2 +- .../js-api/functions/$maxContains.md | 2 +- .../js-api/functions/$maxProperties.md | 2 +- .../js-api/functions/$minContains.md | 2 +- .../js-api/functions/$minProperties.md | 2 +- .../reference/js-api/functions/$multipleOf.md | 6 +- .../reference/js-api/functions/$onEmit.md | 2 +- .../reference/js-api/functions/$oneOf.md} | 6 +- .../js-api/functions/$prefixItems.md | 2 +- .../js-api/functions/$uniqueItems.md | 2 +- .../js-api/functions/$validatesRawJson.md | 2 +- .../reference/js-api/functions/findBaseUri.md | 2 +- .../reference/js-api/functions/getBaseUri.md | 2 +- .../reference/js-api/functions/getContains.md | 2 +- .../js-api/functions/getContentEncoding.md | 2 +- .../js-api/functions/getContentMediaType.md | 2 +- .../js-api/functions/getContentSchema.md | 2 +- .../js-api/functions/getExtensions.md | 2 +- .../reference/js-api/functions/getId.md | 2 +- .../js-api/functions/getJsonSchema.md | 2 +- .../js-api/functions/getJsonSchemaTypes.md | 2 +- .../js-api/functions/getMaxContains.md | 2 +- .../js-api/functions/getMaxProperties.md | 2 +- .../js-api/functions/getMinContains.md | 2 +- .../js-api/functions/getMinProperties.md | 2 +- .../js-api/functions/getMultipleOf.md | 4 +- .../functions/getMultipleOfAsNumeric.md | 19 + .../js-api/functions/getPrefixItems.md | 2 +- .../js-api/functions/getUniqueItems.md | 2 +- .../functions/isJsonSchemaDeclaration.md | 2 +- .../reference/js-api/functions/isOneOf.md} | 9 +- .../json-schema/reference/js-api/index.md | 4 + .../interfaces/JSONSchemaEmitterOptions.md | 10 +- .../reference/js-api/variables/$flags.md | 8 + .../reference/js-api/variables/$lib.md | 14 +- .../reference/js-api/functions/$onEmit.md | 2 +- .../reference/js-api/functions/$oneOf.md | 2 +- .../reference/js-api/functions/$useRef.md | 4 +- .../reference/js-api/functions/getOneOf.md | 2 +- .../reference/js-api/functions/getOpenAPI3.md | 2 +- .../reference/js-api/functions/getRef.md | 2 +- .../js-api/functions/resolveOptions.md | 2 +- .../reference/js-api/variables/$lib.md | 54 +- .../reference/js-api/functions/$externRef.md | 25 - .../reference/js-api/functions/$field.md | 25 - .../reference/js-api/functions/$onEmit.md | 20 - .../reference/js-api/functions/$package.md | 25 - .../reference/js-api/functions/$reserve.md | 23 - .../reference/js-api/functions/$service.md | 21 - .../reference/js-api/functions/isMap.md | 23 - .../js-api/type-aliases/Reservation.md | 2 +- .../reference/js-api/variables/$lib.md | 66 +- .../js-api/variables/PROTO_FULL_IDENT.md | 4 +- .../extending-typespec/basics.md | 20 +- .../extending-typespec/create-decorators.md | 70 +- .../version-latest/introduction/editor/vs.md | 2 +- .../language-basics/decorators.md | 2 +- .../version-latest/language-basics/scalars.md | 16 +- .../language-basics/templates.md | 40 ++ .../version-latest/language-basics/values.md | 187 +++++ .../libraries/http/reference/data-types.md | 43 ++ .../libraries/http/reference/decorators.md | 41 +- .../libraries/http/reference/index.mdx | 4 + .../js-api/enumerations/Visibility.md | 4 +- .../http/reference/js-api/functions/$body.md | 2 +- .../reference/js-api/functions/$bodyIgnore.md | 2 +- .../reference/js-api/functions/$bodyRoot.md | 2 +- .../reference/js-api/functions/$delete.md | 2 +- .../http/reference/js-api/functions/$get.md | 2 +- .../http/reference/js-api/functions/$head.md | 2 +- .../reference/js-api/functions/$header.md | 2 +- .../$includeInapplicableMetadataInPayload.md | 6 +- .../{$plainData.md => $multipartBody.md} | 6 +- .../reference/js-api/functions/$onValidate.md | 2 +- .../http/reference/js-api/functions/$patch.md | 2 +- .../http/reference/js-api/functions/$path.md | 2 +- .../http/reference/js-api/functions/$post.md | 2 +- .../http/reference/js-api/functions/$put.md | 2 +- .../http/reference/js-api/functions/$query.md | 2 +- .../http/reference/js-api/functions/$route.md | 4 +- .../reference/js-api/functions/$server.md | 2 +- .../js-api/functions/$sharedRoute.md | 2 +- .../reference/js-api/functions/$statusCode.md | 2 +- .../reference/js-api/functions/$useAuth.md | 4 +- .../js-api/functions/DefaultRouteProducer.md | 2 +- .../js-api/functions/createMetadataInfo.md | 2 +- .../js-api/functions/gatherMetadata.md | 32 - .../js-api/functions/getAllHttpServices.md | 2 +- .../js-api/functions/getAllRoutes.md | 2 +- .../js-api/functions/getAuthentication.md | 4 +- .../getAuthenticationForOperation.md | 2 +- .../js-api/functions/getContentTypes.md | 2 +- .../js-api/functions/getHeaderFieldName.md | 2 +- .../js-api/functions/getHeaderFieldOptions.md | 2 +- .../js-api/functions/getHttpFileModel.md | 19 + .../js-api/functions/getHttpOperation.md | 2 +- .../js-api/functions/getHttpService.md | 2 +- .../functions/getOperationParameters.md | 2 +- .../js-api/functions/getOperationVerb.md | 2 +- .../js-api/functions/getPathParamName.md | 2 +- .../js-api/functions/getPathParamOptions.md | 2 +- .../js-api/functions/getQueryParamName.md | 2 +- .../js-api/functions/getQueryParamOptions.md | 2 +- .../js-api/functions/getRequestVisibility.md | 2 +- .../functions/getResponsesForOperation.md | 2 +- .../functions/getRouteOptionsForNamespace.md | 2 +- .../js-api/functions/getRoutePath.md | 4 +- .../js-api/functions/getRouteProducer.md | 2 +- .../reference/js-api/functions/getServers.md | 2 +- .../functions/getStatusCodeDescription.md | 2 +- .../js-api/functions/getStatusCodes.md | 2 +- .../getStatusCodesWithDiagnostics.md | 2 +- .../js-api/functions/getVisibilitySuffix.md | 2 +- .../includeInapplicableMetadataInPayload.md | 2 +- .../includeInterfaceRoutesInNamespace.md | 2 +- .../js-api/functions/isApplicableMetadata.md | 2 +- .../functions/isApplicableMetadataOrBody.md | 2 +- .../http/reference/js-api/functions/isBody.md | 2 +- .../js-api/functions/isBodyIgnore.md | 2 +- .../reference/js-api/functions/isBodyRoot.md | 2 +- .../js-api/functions/isContentTypeHeader.md | 9 +- .../reference/js-api/functions/isHeader.md | 2 +- .../reference/js-api/functions/isHttpFile.md} | 10 +- .../reference/js-api/functions/isMetadata.md | 2 +- .../functions/isMultipartBodyProperty.md | 19 + .../js-api/functions/isOrExtendsHttpFile.md | 19 + .../functions/isOverloadSameEndpoint.md | 4 +- .../reference/js-api/functions/isPathParam.md | 2 +- .../js-api/functions/isQueryParam.md | 2 +- .../js-api/functions/isSharedRoute.md | 2 +- .../js-api/functions/isStatusCode.md | 2 +- .../reference/js-api/functions/isVisible.md | 2 +- .../js-api/functions/listHttpOperationsIn.md | 2 +- .../js-api/functions/reportIfNoRoutes.md | 2 +- .../js-api/functions/resolveAuthentication.md | 2 +- .../functions/resolvePathAndParameters.md | 17 +- .../functions/resolveRequestVisibility.md | 2 +- .../js-api/functions/setAuthentication.md | 4 +- .../reference/js-api/functions/setRoute.md | 2 +- .../functions/setRouteOptionsForNamespace.md | 2 +- .../js-api/functions/setRouteProducer.md | 2 +- .../js-api/functions/setSharedRoute.md | 2 +- .../js-api/functions/setStatusCode.md | 4 +- .../js-api/functions/validateRouteUnique.md | 2 +- .../libraries/http/reference/js-api/index.md | 15 +- .../reference/js-api/interfaces/ApiKeyAuth.md | 4 +- .../reference/js-api/interfaces/BasicAuth.md | 2 +- .../js-api/interfaces/HeaderFieldOptions.md | 2 +- .../reference/js-api/interfaces/HttpBody.md | 18 + .../js-api/interfaces/HttpOperationBody.md | 21 +- .../interfaces/HttpOperationBodyBase.md | 16 + .../interfaces/HttpOperationMultipartBody.md | 21 + .../interfaces/HttpOperationParameters.md | 6 +- .../js-api/interfaces/HttpOperationPart.md | 17 + .../interfaces/HttpOperationRequestBody.md | 24 - .../interfaces/HttpOperationResponse.md | 2 +- .../interfaces/HttpOperationResponseBody.md | 18 - .../HttpOperationResponseContent.md | 2 +- .../interfaces/HttpServiceAuthentication.md | 2 +- .../js-api/interfaces/MetadataInfoOptions.md | 2 +- .../reference/js-api/interfaces/Oauth2Auth.md | 2 +- .../interfaces/QueryParameterOptions.md | 2 +- .../type-aliases/HttpOperationParameter.md | 2 +- .../type-aliases/HttpOperationRequestBody.md | 12 + .../type-aliases/HttpOperationResponseBody.md | 12 + .../js-api/type-aliases/StatusCode.md | 2 +- .../http/reference/js-api/variables/$lib.md | 87 ++- .../js-api/functions/$defaultResponse.md | 2 +- .../reference/js-api/functions/$extension.md | 2 +- .../js-api/functions/$externalDocs.md | 2 +- .../reference/js-api/functions/$info.md | 2 +- .../js-api/functions/$operationId.md | 2 +- .../functions/checkDuplicateTypeName.md | 2 +- .../js-api/functions/getExtensions.md | 2 +- .../js-api/functions/getExternalDocs.md | 2 +- .../reference/js-api/functions/getInfo.md | 2 +- .../js-api/functions/getOpenAPITypeName.md | 2 +- .../js-api/functions/getOperationId.md | 2 +- .../js-api/functions/getParameterKey.md | 2 +- .../js-api/functions/isDefaultResponse.md | 2 +- .../js-api/functions/isReadonlyProperty.md | 2 +- .../reference/js-api/functions/resolveInfo.md | 2 +- .../js-api/functions/resolveOperationId.md | 2 +- .../js-api/functions/setExtension.md | 4 +- .../js-api/functions/shouldInline.md | 2 +- .../js-api/type-aliases/ExtensionKey.md | 2 +- .../reference/js-api/functions/$action.md | 2 +- .../js-api/functions/$actionSegment.md | 2 +- .../js-api/functions/$actionSeparator.md | 4 +- .../reference/js-api/functions/$autoRoute.md | 2 +- .../js-api/functions/$collectionAction.md | 2 +- .../functions/$copyResourceKeyParameters.md | 2 +- .../functions/$createsOrReplacesResource.md | 2 +- .../functions/$createsOrUpdatesResource.md | 2 +- .../js-api/functions/$createsResource.md | 2 +- .../js-api/functions/$deletesResource.md | 2 +- .../js-api/functions/$listsResource.md | 2 +- .../reference/js-api/functions/$onValidate.md | 2 +- .../js-api/functions/$parentResource.md | 2 +- .../js-api/functions/$readsResource.md | 2 +- .../reference/js-api/functions/$resource.md | 2 +- .../js-api/functions/$resourceLocation.md | 2 +- .../functions/$resourceTypeForKeyParam.md | 2 +- .../reference/js-api/functions/$segment.md | 4 +- .../reference/js-api/functions/$segmentOf.md | 2 +- .../js-api/functions/$updatesResource.md | 2 +- .../reference/js-api/functions/getAction.md | 2 +- .../js-api/functions/getActionDetails.md | 2 +- .../js-api/functions/getActionSegment.md | 2 +- .../js-api/functions/getActionSeparator.md | 2 +- .../js-api/functions/getCollectionAction.md | 2 +- .../functions/getCollectionActionDetails.md | 2 +- .../js-api/functions/getParentResource.md | 2 +- .../functions/getResourceLocationType.md | 2 +- .../js-api/functions/getResourceOperation.md | 2 +- .../functions/getResourceTypeForKeyParam.md | 2 +- .../js-api/functions/getResourceTypeKey.md | 2 +- .../reference/js-api/functions/getSegment.md | 2 +- .../reference/js-api/functions/isAutoRoute.md | 2 +- .../js-api/functions/isListOperation.md | 2 +- .../js-api/functions/setResourceOperation.md | 2 +- .../js-api/functions/setResourceTypeKey.md | 2 +- .../js-api/interfaces/ActionDetails.md | 2 +- .../versioning/reference/decorators.md | 29 + .../libraries/versioning/reference/index.mdx | 1 + .../reference/js-api/classes/VersionMap.md | 8 +- .../reference/js-api/functions/$added.md | 4 +- .../js-api/functions/$madeOptional.md | 2 +- .../js-api/functions/$madeRequired.md} | 10 +- .../reference/js-api/functions/$onValidate.md | 2 +- .../reference/js-api/functions/$removed.md | 4 +- .../js-api/functions/$renamedFrom.md | 4 +- .../functions/$returnTypeChangedFrom.md | 2 +- .../js-api/functions/$typeChangedFrom.md | 2 +- .../js-api/functions/$useDependency.md | 4 +- .../reference/js-api/functions/$versioned.md | 2 +- .../functions/buildVersionProjections.md | 2 +- .../js-api/functions/existsAtVersion.md | 23 - .../functions/findVersionedNamespace.md | 2 +- .../js-api/functions/getAddedOnVersions.md | 2 +- .../js-api/functions/getAvailabilityMap.md | 2 +- .../functions/getAvailabilityMapInTimeline.md | 2 +- .../js-api/functions/getMadeOptionalOn.md | 2 +- .../js-api/functions/getNameAtVersion.md | 25 - .../js-api/functions/getRemovedOnVersions.md | 2 +- .../js-api/functions/getRenamedFrom.md | 2 +- .../functions/getRenamedFromVersions.md | 2 +- .../functions/getReturnTypeBeforeVersion.md | 25 - .../functions/getReturnTypeChangedFrom.md | 2 +- .../js-api/functions/getTypeBeforeVersion.md | 25 - .../js-api/functions/getTypeChangedFrom.md | 2 +- .../js-api/functions/getUseDependencies.md | 4 +- .../reference/js-api/functions/getVersion.md | 2 +- .../functions/getVersionDependencies.md | 2 +- .../functions/getVersionForEnumMember.md | 2 +- .../reference/js-api/functions/getVersions.md | 2 +- .../js-api/functions/getVersionsForEnum.md | 2 +- .../functions/hasDifferentNameAtVersion.md | 23 - .../hasDifferentReturnTypeAtVersion.md | 23 - .../functions/hasDifferentTypeAtVersion.md | 23 - .../js-api/functions/resolveVersions.md | 2 +- .../versioning/reference/js-api/index.md | 13 +- .../reference/js-api/variables/namespace.md | 8 - .../libraries/xml/reference/decorators.md | 32 +- .../reference/js-api/functions/$attribute.md | 2 +- .../xml/reference/js-api/functions/$name.md | 2 +- .../xml/reference/js-api/functions/$ns.md | 2 +- .../js-api/functions/$nsDeclarations.md | 2 +- .../reference/js-api/functions/$unwrapped.md | 2 +- .../xml/reference/js-api/functions/getNs.md | 2 +- .../js-api/functions/getXmlEncoding.md | 4 +- .../reference/js-api/functions/isAttribute.md | 2 +- .../reference/js-api/functions/isUnwrapped.md | 2 +- .../release-notes/release-2024-02-06.md | 2 +- .../release-notes/release-2024-06-10.md | 259 +++++++ .../standard-library/built-in-data-types.md | 17 + .../standard-library/built-in-decorators.md | 120 ++-- .../js-api/classes/DuplicateTracker.md | 66 -- .../reference/js-api/classes/EventEmitter.md | 78 --- .../js-api/classes/ProjectionError.md | 68 -- .../reference/js-api/classes/Queue.md | 77 -- .../js-api/classes/ResolveModuleError.md | 68 -- .../js-api/enumerations/IdentifierKind.md | 16 - .../js-api/enumerations/ListenerFlow.md | 10 - .../js-api/enumerations/ModifierFlags.md | 11 - .../js-api/enumerations/NodeFlags.md | 14 - .../js-api/enumerations/SemanticTokenKind.md | 31 - .../js-api/enumerations/SymbolFlags.md | 37 - .../js-api/enumerations/SyntaxKind.md | 104 --- .../reference/js-api/enumerations/Token.md | 84 --- .../js-api/enumerations/TokenFlags.md | 16 - .../js-api/enumerations/UsageFlags.md | 12 - .../reference/js-api/functions/$deprecated.md | 31 - .../js-api/functions/$discriminator.md | 23 - .../reference/js-api/functions/$doc.md | 40 -- .../reference/js-api/functions/$encode.md | 25 - .../js-api/functions/$encodedName.md | 25 - .../reference/js-api/functions/$error.md | 22 - .../reference/js-api/functions/$errorsDoc.md | 23 - .../reference/js-api/functions/$format.md | 35 - .../js-api/functions/$friendlyName.md | 25 - .../js-api/functions/$inspectType.md | 23 - .../js-api/functions/$inspectTypeName.md | 23 - .../reference/js-api/functions/$key.md | 30 - .../js-api/functions/$knownValues.md | 30 - .../reference/js-api/functions/$list.md | 27 - .../reference/js-api/functions/$maxItems.md | 23 - .../reference/js-api/functions/$maxLength.md | 23 - .../reference/js-api/functions/$maxValue.md | 23 - .../js-api/functions/$maxValueExclusive.md | 23 - .../reference/js-api/functions/$minItems.md | 23 - .../reference/js-api/functions/$minLength.md | 23 - .../reference/js-api/functions/$minValue.md | 23 - .../js-api/functions/$minValueExclusive.md | 23 - .../reference/js-api/functions/$overload.md | 25 - .../js-api/functions/$parameterVisibility.md | 23 - .../reference/js-api/functions/$pattern.md | 25 - .../js-api/functions/$projectedName.md | 27 - .../js-api/functions/$returnTypeVisibility.md | 23 - .../reference/js-api/functions/$returnsDoc.md | 23 - .../reference/js-api/functions/$secret.md | 21 - .../reference/js-api/functions/$service.md | 23 - .../reference/js-api/functions/$summary.md | 39 -- .../reference/js-api/functions/$tag.md | 23 - .../reference/js-api/functions/$visibility.md | 23 - .../functions/$withDefaultKeyVisibility.md | 23 - .../functions/$withOptionalProperties.md | 19 - .../functions/$withUpdateableProperties.md | 19 - .../js-api/functions/$withVisibility.md | 23 - .../js-api/functions/$withoutDefaultValues.md | 19 - .../functions/$withoutOmittedProperties.md | 23 - .../reference/js-api/functions/addService.md | 25 - .../reference/js-api/functions/assertType.md | 54 -- .../js-api/functions/cadlTypeToJson.md | 29 - .../js-api/functions/checkFormatCadl.md | 23 - .../js-api/functions/checkFormatTypeSpec.md | 23 - .../reference/js-api/functions/compile.md | 25 - .../js-api/functions/compilerAssert.md | 26 - .../js-api/functions/createCadlLibrary.md | 30 - .../js-api/functions/createChecker.md | 18 - .../functions/createDecoratorDefinition.md | 30 - .../functions/createDiagnosticCollector.md | 18 - .../functions/createProjectedNameProgram.md | 23 - .../js-api/functions/createRekeyableMap.md | 25 - .../reference/js-api/functions/createRule.md | 27 - .../js-api/functions/createScanner.md | 19 - .../js-api/functions/createServer.md | 18 - .../js-api/functions/createSourceFile.md | 19 - .../js-api/functions/createStateAccessors.md | 28 - .../js-api/functions/createTypeSpecLibrary.md | 47 -- .../js-api/functions/defineCodeFix.md | 18 - .../js-api/functions/defineLinter.md | 18 - .../reference/js-api/functions/emitFile.md | 21 - .../ensureTrailingDirectorySeparator.md | 18 - .../js-api/functions/exprIsBareIdentifier.md | 18 - .../js-api/functions/filterModelProperties.md | 27 - .../js-api/functions/finishTypeForProgram.md | 25 - .../js-api/functions/formatDiagnostic.md | 18 - .../js-api/functions/formatIdentifier.md | 18 - .../js-api/functions/formatTypeSpec.md | 19 - .../reference/js-api/functions/getAllTags.md | 19 - .../functions/getAnyExtensionFromPath.md | 28 - .../js-api/functions/getBaseFileName.md | 46 -- .../js-api/functions/getDeprecated.md | 21 - .../js-api/functions/getDeprecationDetails.md | 21 - .../js-api/functions/getDirectoryPath.md | 18 - .../js-api/functions/getDiscriminatedTypes.md | 18 - .../js-api/functions/getDiscriminatedUnion.md | 19 - .../js-api/functions/getDiscriminator.md | 19 - .../reference/js-api/functions/getDoc.md | 23 - .../reference/js-api/functions/getDocData.md | 23 - .../js-api/functions/getDocDataInternal.md | 27 - .../js-api/functions/getEffectiveModelType.md | 34 - .../reference/js-api/functions/getEncode.md | 19 - .../js-api/functions/getErrorsDoc.md | 23 - .../js-api/functions/getErrorsDocData.md | 23 - .../js-api/functions/getFirstAncestor.md | 19 - .../reference/js-api/functions/getFormat.md | 19 - .../js-api/functions/getFriendlyName.md | 19 - .../functions/getFullyQualifiedSymbolName.md | 20 - .../js-api/functions/getIdentifierContext.md | 18 - .../reference/js-api/functions/getKeyName.md | 19 - .../js-api/functions/getKnownValues.md | 19 - .../js-api/functions/getListOperationType.md | 23 - .../js-api/functions/getLocationContext.md | 19 - .../reference/js-api/functions/getMaxItems.md | 19 - .../js-api/functions/getMaxLength.md | 19 - .../reference/js-api/functions/getMaxValue.md | 19 - .../js-api/functions/getMaxValueExclusive.md | 19 - .../reference/js-api/functions/getMinItems.md | 19 - .../js-api/functions/getMinLength.md | 19 - .../reference/js-api/functions/getMinValue.md | 19 - .../js-api/functions/getMinValueExclusive.md | 19 - .../js-api/functions/getNamespaceFullName.md | 21 - .../js-api/functions/getNodeAtPosition.md | 54 -- .../functions/getNormalizedAbsolutePath.md | 19 - .../getNormalizedAbsolutePathWithoutRoot.md | 19 - .../functions/getNormalizedPathComponents.md | 28 - .../functions/getOverloadedOperation.md | 23 - .../js-api/functions/getOverloads.md | 23 - .../js-api/functions/getOverriddenProperty.md | 21 - .../functions/getParameterVisibility.md | 25 - .../js-api/functions/getParentTemplateNode.md | 22 - .../js-api/functions/getPathComponents.md | 49 -- .../functions/getPathFromPathComponents.md | 25 - .../reference/js-api/functions/getPattern.md | 27 - .../js-api/functions/getPatternData.md | 24 - .../functions/getPositionBeforeTrivia.md | 21 - .../js-api/functions/getProjectedName.md | 27 - .../js-api/functions/getProjectedNames.md | 21 - .../reference/js-api/functions/getProperty.md | 19 - .../js-api/functions/getPropertyType.md | 20 - .../functions/getRelativePathFromDirectory.md | 50 -- .../functions/getReturnTypeVisibility.md | 25 - .../js-api/functions/getReturnsDoc.md | 23 - .../js-api/functions/getReturnsDocData.md | 23 - .../js-api/functions/getRootLength.md | 42 -- .../reference/js-api/functions/getService.md | 23 - .../functions/getSourceFileKindFromExt.md | 18 - .../js-api/functions/getSourceLocation.md | 55 -- .../reference/js-api/functions/getSummary.md | 19 - .../reference/js-api/functions/getTags.md | 19 - .../reference/js-api/functions/getTypeName.md | 19 - .../js-api/functions/getVisibility.md | 19 - .../js-api/functions/hasParseError.md | 18 - .../js-api/functions/hasProjectedName.md | 27 - .../hasTrailingDirectorySeparator.md | 20 - .../js-api/functions/ignoreDiagnostics.md | 28 - .../js-api/functions/interpolatePath.md | 21 - .../functions/isAnyDirectorySeparator.md | 20 - .../js-api/functions/isArrayModelType.md | 19 - .../js-api/functions/isCadlValueTypeOf.md | 29 - .../reference/js-api/functions/isComment.md | 18 - .../js-api/functions/isDeclaredInNamespace.md | 26 - .../js-api/functions/isDeclaredType.md | 22 - .../js-api/functions/isDeprecated.md | 21 - .../js-api/functions/isErrorModel.md | 21 - .../reference/js-api/functions/isErrorType.md | 18 - .../js-api/functions/isGlobalNamespace.md | 21 - .../js-api/functions/isImportStatement.md | 18 - .../js-api/functions/isIntrinsicType.md | 23 - .../reference/js-api/functions/isKey.md | 19 - .../reference/js-api/functions/isKeyword.md | 18 - .../js-api/functions/isListOperation.md | 23 - .../reference/js-api/functions/isModifier.md | 18 - .../reference/js-api/functions/isNeverType.md | 18 - .../reference/js-api/functions/isNullType.md | 18 - .../js-api/functions/isNumericType.md | 19 - .../js-api/functions/isPathAbsolute.md | 18 - .../js-api/functions/isProjectedProgram.md | 18 - .../js-api/functions/isPunctuation.md | 18 - .../js-api/functions/isRecordModelType.md | 21 - .../reference/js-api/functions/isSecret.md | 19 - .../reference/js-api/functions/isService.md | 23 - .../js-api/functions/isStatementKeyword.md | 18 - .../js-api/functions/isStdNamespace.md | 18 - .../js-api/functions/isStringType.md | 19 - .../js-api/functions/isTemplateDeclaration.md | 20 - .../isTemplateDeclarationOrInstance.md | 20 - .../js-api/functions/isTemplateInstance.md | 20 - .../reference/js-api/functions/isTrivia.md | 18 - .../js-api/functions/isTypeSpecValueTypeOf.md | 29 - .../js-api/functions/isUnknownType.md | 18 - .../reference/js-api/functions/isUrl.md | 20 - .../reference/js-api/functions/isVisible.md | 23 - .../reference/js-api/functions/isVoidType.md | 18 - .../reference/js-api/functions/joinPaths.md | 36 - .../js-api/functions/listOperationsIn.md | 21 - .../js-api/functions/listServices.md | 22 - .../js-api/functions/logDiagnostics.md | 19 - .../js-api/functions/logVerboseTestOutput.md | 26 - .../mapEventEmitterToNodeListener.md | 22 - .../js-api/functions/markDeprecated.md | 25 - .../js-api/functions/navigateProgram.md | 25 - .../js-api/functions/navigateType.md | 25 - .../functions/navigateTypesInNamespace.md | 23 - .../js-api/functions/normalizePath.md | 18 - .../js-api/functions/normalizeSlashes.md | 20 - .../js-api/functions/paramMessage.md | 25 - .../reference/js-api/functions/parse.md | 19 - .../functions/parseStandaloneTypeReference.md | 18 - .../js-api/functions/projectProgram.md | 23 - .../js-api/functions/reducePathComponents.md | 21 - .../removeTrailingDirectorySeparator.md | 25 - .../js-api/functions/reportDeprecated.md | 25 - .../functions/resolveCompilerOptions.md | 21 - .../js-api/functions/resolveEncodedName.md | 45 -- .../js-api/functions/resolveModule.md | 25 - .../reference/js-api/functions/resolvePath.md | 28 - .../js-api/functions/resolveUsages.md | 23 - .../functions/scopeNavigationToNamespace.md | 33 - .../js-api/functions/setCadlNamespace.md | 23 - .../js-api/functions/setTypeSpecNamespace.md | 21 - .../reference/js-api/functions/skipTrivia.md | 23 - .../js-api/functions/skipWhiteSpace.md | 23 - .../functions/stringTemplateToString.md | 22 - .../js-api/functions/typespecTypeToJson.md | 28 - .../functions/validateDecoratorNotOnType.md | 30 - .../functions/validateDecoratorParamCount.md | 25 - .../functions/validateDecoratorParamType.md | 66 -- .../functions/validateDecoratorTarget.md | 33 - .../validateDecoratorTargetIntrinsic.md | 29 - .../validateDecoratorUniqueOnNode.md | 23 - .../js-api/functions/visitChildren.md | 25 - .../functions/walkPropertiesInherited.md | 25 - .../reference/js-api/index.md | 565 --------------- .../js-api/interfaces/AliasStatementNode.md | 25 - .../js-api/interfaces/AnyKeywordNode.md | 21 - .../js-api/interfaces/ArrayExpressionNode.md | 22 - .../js-api/interfaces/ArrayModelType.md | 68 -- .../AugmentDecoratorStatementNode.md | 24 - .../reference/js-api/interfaces/BaseNode.md | 21 - .../reference/js-api/interfaces/BaseType.md | 73 -- .../js-api/interfaces/BlockComment.md | 17 - .../js-api/interfaces/BooleanLiteral.md | 55 -- .../js-api/interfaces/BooleanLiteralNode.md | 22 - .../js-api/interfaces/CallableMessage.md | 30 - .../reference/js-api/interfaces/Checker.md | 655 ------------------ .../reference/js-api/interfaces/CodeFix.md | 12 - .../js-api/interfaces/CodeFixContext.md | 12 - .../js-api/interfaces/CompileResult.md | 12 - .../js-api/interfaces/CompilerHost.md | 273 -------- .../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 | 59 -- .../js-api/interfaces/DecoratorApplication.md | 13 - .../js-api/interfaces/DecoratorArgument.md | 12 - .../js-api/interfaces/DecoratorContext.md | 72 -- .../DecoratorDeclarationStatementNode.md | 34 - .../js-api/interfaces/DecoratorDefinition.md | 21 - .../interfaces/DecoratorExpressionNode.md | 23 - .../js-api/interfaces/DecoratorFunction.md | 29 - .../interfaces/DecoratorParamDefinition.md | 17 - .../js-api/interfaces/DecoratorValidator.md | 35 - .../js-api/interfaces/DeprecatedDirective.md | 16 - .../js-api/interfaces/DeprecationDetails.md | 12 - .../reference/js-api/interfaces/Diagnostic.md | 14 - .../js-api/interfaces/DiagnosticCollector.md | 90 --- .../js-api/interfaces/DiagnosticCreator.md | 68 -- .../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 | 34 - .../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 - .../js-api/interfaces/EmitContext.md | 44 -- .../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 | 58 -- .../reference/js-api/interfaces/EnumMember.md | 59 -- .../js-api/interfaces/EnumMemberNode.md | 24 - .../js-api/interfaces/EnumSpreadMemberNode.md | 22 - .../js-api/interfaces/EnumStatementNode.md | 24 - .../reference/js-api/interfaces/ErrorType.md | 55 -- .../js-api/interfaces/ExternKeywordNode.md | 21 - .../js-api/interfaces/FileLibraryMetadata.md | 19 - .../reference/js-api/interfaces/FilePos.md | 11 - .../FunctionDeclarationStatementNode.md | 34 - .../js-api/interfaces/FunctionParameter.md | 58 -- .../interfaces/FunctionParameterNode.md | 25 - .../js-api/interfaces/FunctionType.md | 59 -- .../js-api/interfaces/IdentifierContext.md | 11 - .../js-api/interfaces/IdentifierNode.md | 22 - .../js-api/interfaces/ImportStatementNode.md | 22 - .../interfaces/InsertTextCodeFixEdit.md | 13 - .../reference/js-api/interfaces/Interface.md | 62 -- .../interfaces/InterfaceStatementNode.md | 27 - .../interfaces/IntersectionExpressionNode.md | 22 - .../js-api/interfaces/IntrinsicType.md | 55 -- .../js-api/interfaces/InvalidStatementNode.md | 22 - .../interfaces/JsNamespaceDeclarationNode.md | 22 - .../js-api/interfaces/JsSourceFileNode.md | 25 - .../js-api/interfaces/LibraryInstance.md | 14 - .../interfaces/LibraryLocationContext.md | 13 - .../js-api/interfaces/LineAndCharacter.md | 14 - .../js-api/interfaces/LineComment.md | 16 - .../js-api/interfaces/LinterDefinition.md | 11 - .../reference/js-api/interfaces/LinterRule.md | 52 -- .../js-api/interfaces/LinterRuleContext.md | 40 -- .../js-api/interfaces/LinterRuleDefinition.md | 45 -- .../js-api/interfaces/LinterRuleSet.md | 12 - .../js-api/interfaces/ListOperationOptions.md | 10 - .../reference/js-api/interfaces/LogInfo.md | 13 - .../reference/js-api/interfaces/LogSink.md | 22 - .../reference/js-api/interfaces/Logger.md | 76 -- .../js-api/interfaces/MemberExpressionNode.md | 24 - .../reference/js-api/interfaces/Model.md | 66 -- .../js-api/interfaces/ModelExpressionNode.md | 22 - .../js-api/interfaces/ModelProperty.md | 61 -- .../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 | 66 -- .../interfaces/NamespaceNavigationOptions.md | 10 - .../interfaces/NamespaceStatementNode.md | 25 - .../js-api/interfaces/NavigationOptions.md | 10 - .../js-api/interfaces/NeverKeywordNode.md | 21 - .../reference/js-api/interfaces/NeverType.md | 55 -- .../js-api/interfaces/NodePackage.md | 25 - .../reference/js-api/interfaces/NullType.md | 55 -- .../js-api/interfaces/NumericLiteral.md | 56 -- .../js-api/interfaces/NumericLiteralNode.md | 23 - .../reference/js-api/interfaces/ObjectType.md | 55 -- .../reference/js-api/interfaces/Operation.md | 64 -- .../OperationSignatureDeclarationNode.md | 23 - .../OperationSignatureReferenceNode.md | 22 - .../interfaces/OperationStatementNode.md | 26 - .../js-api/interfaces/ParseOptions.md | 11 - .../js-api/interfaces/PatternData.md | 11 - .../js-api/interfaces/ProcessedLog.md | 13 - .../reference/js-api/interfaces/Program.md | 252 ------- .../interfaces/ProjectLocationContext.md | 12 - .../js-api/interfaces/ProjectedNameView.md | 31 - .../js-api/interfaces/ProjectedProgram.md | 305 -------- .../reference/js-api/interfaces/Projection.md | 56 -- .../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 - .../ProjectionScalarSelectorNode.md | 21 - .../interfaces/ProjectionStatementNode.md | 28 - .../ProjectionTupleExpressionNode.md | 22 - .../ProjectionUnaryExpressionNode.md | 23 - .../interfaces/ProjectionUnionSelectorNode.md | 21 - .../ProjectionUnionVariantSelectorNode.md | 21 - .../reference/js-api/interfaces/Projector.md | 32 - .../js-api/interfaces/RecordModelType.md | 68 -- .../interfaces/ReplaceTextCodeFixEdit.md | 18 - .../ResolveCompilerOptionsOptions.md | 19 - .../js-api/interfaces/ResolveModuleHost.md | 70 -- .../js-api/interfaces/ResolveModuleOptions.md | 12 - .../js-api/interfaces/ResolvedFile.md | 11 - .../js-api/interfaces/ResolvedModule.md | 13 - .../js-api/interfaces/ReturnExpressionNode.md | 22 - .../js-api/interfaces/ReturnRecord.md | 11 - .../reference/js-api/interfaces/RmOptions.md | 10 - .../reference/js-api/interfaces/Scalar.md | 62 -- .../js-api/interfaces/ScalarStatementNode.md | 26 - .../reference/js-api/interfaces/Scanner.md | 187 ----- .../js-api/interfaces/SemanticToken.md | 12 - .../reference/js-api/interfaces/Server.md | 426 ------------ .../reference/js-api/interfaces/ServerHost.md | 15 - .../js-api/interfaces/ServerSourceFile.md | 61 -- .../interfaces/ServerWorkspaceFolder.md | 16 - .../reference/js-api/interfaces/Service.md | 16 - .../js-api/interfaces/ServiceDetails.md | 15 - .../reference/js-api/interfaces/SourceFile.md | 52 -- .../js-api/interfaces/SourceLocation.md | 17 - .../interfaces/SourceLocationOptions.md | 10 - .../js-api/interfaces/SourceModel.md | 11 - .../reference/js-api/interfaces/StateDef.md | 10 - .../js-api/interfaces/StringLiteral.md | 55 -- .../js-api/interfaces/StringLiteralNode.md | 22 - .../js-api/interfaces/StringTemplate.md | 55 -- .../StringTemplateExpressionNode.md | 23 - .../interfaces/StringTemplateHeadNode.md | 22 - .../StringTemplateLiteralLikeNode.md | 22 - .../interfaces/StringTemplateMiddleNode.md | 22 - .../interfaces/StringTemplateSpanLiteral.md | 56 -- .../interfaces/StringTemplateSpanNode.md | 23 - .../interfaces/StringTemplateSpanValue.md | 56 -- .../interfaces/StringTemplateTailNode.md | 22 - .../js-api/interfaces/SuppressDirective.md | 17 - .../reference/js-api/interfaces/Sym.md | 20 - .../js-api/interfaces/SymbolLinks.md | 12 - .../interfaces/SyntheticLocationContext.md | 12 - .../js-api/interfaces/TemplateArgumentNode.md | 23 - .../interfaces/TemplateDeclarationNode.md | 20 - .../js-api/interfaces/TemplateParameter.md | 56 -- .../TemplateParameterDeclarationNode.md | 24 - .../js-api/interfaces/TemplatedTypeBase.md | 20 - .../reference/js-api/interfaces/TextRange.md | 19 - .../reference/js-api/interfaces/Tracer.md | 47 -- .../js-api/interfaces/TracerOptions.md | 10 - .../reference/js-api/interfaces/Tuple.md | 55 -- .../js-api/interfaces/TupleExpressionNode.md | 22 - .../js-api/interfaces/TypeInstantiationMap.md | 43 -- .../reference/js-api/interfaces/TypeMapper.md | 29 - .../js-api/interfaces/TypeNameOptions.md | 11 - .../js-api/interfaces/TypeReferenceNode.md | 23 - .../interfaces/TypeSpecCompletionItem.md | 12 - .../js-api/interfaces/TypeSpecLibrary.md | 121 ---- .../js-api/interfaces/TypeSpecLibraryDef.md | 28 - .../js-api/interfaces/TypeSpecManifest.md | 12 - .../js-api/interfaces/TypeSpecScriptNode.md | 32 - .../reference/js-api/interfaces/Union.md | 63 -- .../js-api/interfaces/UnionExpressionNode.md | 22 - .../js-api/interfaces/UnionStatementNode.md | 26 - .../js-api/interfaces/UnionVariant.md | 58 -- .../js-api/interfaces/UnionVariantNode.md | 24 - .../js-api/interfaces/UnknownType.md | 55 -- .../js-api/interfaces/UsageTracker.md | 29 - .../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 | 55 -- .../js-api/type-aliases/CadlLibrary.md | 4 +- .../js-api/type-aliases/CadlLibraryDef.md | 4 +- .../js-api/type-aliases/CreateTypeProps.md | 2 +- .../js-api/type-aliases/Declaration.md | 1 + .../js-api/type-aliases/DiagnosticFormat.md | 8 +- .../js-api/type-aliases/DiagnosticMap.md | 2 +- .../js-api/type-aliases/DiagnosticReport.md | 8 +- .../DiagnosticReportWithoutTarget.md | 8 +- .../reference/js-api/type-aliases/DocTag.md | 1 + .../reference/js-api/type-aliases/Entity.md | 13 + .../js-api/type-aliases/Expression.md | 4 + .../js-api/type-aliases/FunctionParameter.md | 8 + .../js-api/type-aliases/InferredCadlValue.md | 2 +- .../type-aliases/InferredTypeSpecValue.md | 4 +- .../LinterRuleDiagnosticFormat.md | 6 +- .../LinterRuleDiagnosticReport.md | 6 +- ...LinterRuleDiagnosticReportWithoutTarget.md | 6 +- .../js-api/type-aliases/MarshalledValue.md | 4 +- .../type-aliases/MemberContainerType.md | 7 +- .../js-api/type-aliases/MemberNode.md | 7 +- .../js-api/type-aliases/ModelIndexer.md | 2 +- .../js-api/type-aliases/NeverIndexer.md | 2 +- .../reference/js-api/type-aliases/Node.md | 7 +- .../reference/js-api/type-aliases/RuleRef.md | 2 +- .../type-aliases/SemanticNodeListener.md | 2 +- .../js-api/type-aliases/ServerLogLevel.md | 13 + .../js-api/type-aliases/Statement.md | 2 + .../reference/js-api/type-aliases/StdTypes.md | 2 +- .../reference/js-api/type-aliases/Type.md | 29 +- .../js-api/type-aliases/TypeOfDiagnostics.md | 2 +- .../type-aliases/TypeSpecDiagnosticTarget.md | 2 +- .../reference/js-api/type-aliases/Value.md | 16 + .../js-api/variables/altDirectorySeparator.md | 2 +- .../version-latest-sidebars.json | 1 + packages/xml/CHANGELOG.md | 7 + packages/xml/package.json | 2 +- 878 files changed, 2059 insertions(+), 16310 deletions(-) delete mode 100644 .chronus/changes/add-completion-for-decorator-model-arg-2024-4-17-11-50-34.md delete mode 100644 .chronus/changes/add-completion-for-decorator-model-arg-2024-4-6-16-27-17.md delete mode 100644 .chronus/changes/add_madeRequired-2024-4-9-21-13-8.md delete mode 100644 .chronus/changes/bug-escape-characters-in-docblock-2024-4-23-16-0-21.md delete mode 100644 .chronus/changes/custom-output-viewer-2024-4-28-16-25-31.md delete mode 100644 .chronus/changes/feat-fix-indentation-in-doc-comments-2024-4-20-14-31-22.md delete mode 100644 .chronus/changes/feat-fix-indentation-in-doc-comments-2024-4-20-14-54-41.md delete mode 100644 .chronus/changes/feat-fix-union-variant-decorators-2024-4-20-14-27-15.md delete mode 100644 .chronus/changes/feat-fix-union-variant-decorators-2024-4-20-14-48-3.md delete mode 100644 .chronus/changes/feature-multipart-v2-2024-4-14-16-27-48.md delete mode 100644 .chronus/changes/feature-multipart-v2-2024-4-14-22-58-52.md delete mode 100644 .chronus/changes/feature-multipart-v2-2024-4-14-23-5-59.md delete mode 100644 .chronus/changes/feature-object-literals-2024-2-15-18-36-3-1.md delete mode 100644 .chronus/changes/feature-object-literals-2024-2-15-18-36-3-2.md delete mode 100644 .chronus/changes/feature-object-literals-2024-2-15-18-36-3.md delete mode 100644 .chronus/changes/feature-object-literals-2024-2-18-22-23-26.md delete mode 100644 .chronus/changes/feature-object-literals-2024-3-16-10-38-3.md delete mode 100644 .chronus/changes/feature-object-literals-2024-3-16-11-58-32.md delete mode 100644 .chronus/changes/feature-object-literals-2024-3-16-12-0-15.md delete mode 100644 .chronus/changes/feature-object-literals-2024-3-16-17-54-23.md delete mode 100644 .chronus/changes/feature-object-literals-32024-2-15-18-36-3.md delete mode 100644 .chronus/changes/feature-prop-doc-2024-5-5-21-1-58.md delete mode 100644 .chronus/changes/fix-alias-indeterminate-entity-2024-4-16-19-9-9.md delete mode 100644 .chronus/changes/fix-clone-type-donot-finish-unfinished-2024-5-11-21-54-41.md delete mode 100644 .chronus/changes/fix-compiler-circular-refs-2024-4-9-14-57-38.md delete mode 100644 .chronus/changes/fix-example-of-statusCode-2024-5-3-20-58-17.md delete mode 100644 .chronus/changes/fix-http-file-handling-2024-5-6-17-38-0.md delete mode 100644 .chronus/changes/fix-install-shell-2024-5-5-16-51-0.md delete mode 100644 .chronus/changes/fix-missing-export-2024-4-10-8-11-11.md delete mode 100644 .chronus/changes/fix-no-all-no-rules-2024-5-5-16-21-56.md delete mode 100644 .chronus/changes/fix-numeric-not-handling-trailing-zeros-2024-4-16-2-43-25.md delete mode 100644 .chronus/changes/fix-playground-regression-2024-5-5-16-53-46.md delete mode 100644 .chronus/changes/fix-playground-styles-overflow-2024-5-6-19-45-49.md delete mode 100644 .chronus/changes/fix-reserver-keyword-parameters-2024-5-11-21-33-25.md delete mode 100644 .chronus/changes/fix-scalar-constructor-clone-2024-5-12-20-39-42.md delete mode 100644 .chronus/changes/fix-swagger-ui-missing-2024-5-10-15-15-0.md delete mode 100644 .chronus/changes/fix-vitest-2024-4-17-21-35-16.md delete mode 100644 .chronus/changes/formatter-multiline-strings-2024-4-22-14-32-55.md delete mode 100644 .chronus/changes/highlight-suppress-2024-4-28-16-43-58.md delete mode 100644 .chronus/changes/ide-support-completion-for-extends-is-2024-4-24-11-15-1.md delete mode 100644 .chronus/changes/json-schema-fixes-2024-4-25-0-58-10.md delete mode 100644 .chronus/changes/json-schema-fixes-2024-4-25-0-58-28.md delete mode 100644 .chronus/changes/json-schema-oneof-2024-5-11-8-56-5.md delete mode 100644 .chronus/changes/json-schema-reftype-fix-2024-4-23-16-41-33.md delete mode 100644 .chronus/changes/linter-auto-all-ruleset-2024-4-28-16-18-46.md delete mode 100644 .chronus/changes/linter-auto-all-ruleset-2024-4-28-16-18-47.md delete mode 100644 .chronus/changes/main-2024-5-13-14-52-31.md delete mode 100644 .chronus/changes/more-logging-vscode-2024-5-6-16-57-48.md delete mode 100644 .chronus/changes/more-logging-vscode-2024-5-7-12-41-0.md delete mode 100644 .chronus/changes/param-override-spread-2024-5-4-20-52-44.md delete mode 100644 .chronus/changes/pick-properties-2024-5-3-17-55-34.md delete mode 100644 .chronus/changes/playground-log-2024-5-12-13-33-41.md delete mode 100644 .chronus/changes/playground-storybook-2024-4-22-18-10-6.md delete mode 100644 .chronus/changes/playground-vite-2024-4-20-21-21-23.md delete mode 100644 .chronus/changes/protobuf-package-names-2024-5-11-16-35-54.md delete mode 100644 .chronus/changes/upgrade-deps-may-2024-2024-4-20-15-37-30.md delete mode 100644 .chronus/changes/versioning-FixVersionBug1-2024-4-21-16-34-18.md delete mode 100644 .chronus/changes/versioning-FixVersioningBugs-2024-4-22-20-42-27.md delete mode 100644 .chronus/changes/versioning-fixBug-2024-5-5-20-59-9.md delete mode 100644 .chronus/changes/versioning-library-cleanup-2024-4-9-22-35-15.md delete mode 100644 .chronus/changes/vs-extension-arm-2024-4-27-15-58-16.md delete mode 100644 .chronus/changes/vscode-output-cmd-2024-4-17-16-6-25.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/json-schema/guide.md rename packages/website/versioned_docs/version-latest/emitters/{protobuf/reference/js-api/functions/$message.md => json-schema/reference/js-api/functions/$oneOf.md} (58%) create mode 100644 packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOfAsNumeric.md rename packages/website/versioned_docs/version-latest/emitters/{protobuf/reference/js-api/functions/$onValidate.md => json-schema/reference/js-api/functions/isOneOf.md} (56%) create mode 100644 packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/variables/$flags.md delete mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md delete mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md delete mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md delete mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md delete mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md delete mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md delete mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md create mode 100644 packages/website/versioned_docs/version-latest/language-basics/values.md rename packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/{$plainData.md => $multipartBody.md} (57%) delete mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/gatherMetadata.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpFileModel.md rename packages/website/versioned_docs/version-latest/libraries/{versioning/reference/js-api/functions/madeOptionalAfter.md => http/reference/js-api/functions/isHttpFile.md} (55%) create mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMultipartBodyProperty.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOrExtendsHttpFile.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpBody.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBodyBase.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationMultipartBody.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationPart.md delete mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationRequestBody.md delete mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponseBody.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationRequestBody.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationResponseBody.md rename packages/website/versioned_docs/version-latest/{emitters/protobuf/reference/js-api/functions/$stream.md => libraries/versioning/reference/js-api/functions/$madeRequired.md} (56%) delete mode 100644 packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/existsAtVersion.md delete mode 100644 packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getNameAtVersion.md delete mode 100644 packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getReturnTypeBeforeVersion.md delete mode 100644 packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getTypeBeforeVersion.md delete mode 100644 packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/hasDifferentNameAtVersion.md delete mode 100644 packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/hasDifferentReturnTypeAtVersion.md delete mode 100644 packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/hasDifferentTypeAtVersion.md delete mode 100644 packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/variables/namespace.md create mode 100644 packages/website/versioned_docs/version-latest/release-notes/release-2024-06-10.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SemanticTokenKind.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SymbolFlags.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/TokenFlags.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFix.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFixContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompileResult.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratedType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecatedDirective.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticMessages.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveBase.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiscriminatedUnion.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Discriminator.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocData.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EncodeData.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FilePos.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameter.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InsertTextCodeFixEdit.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModuleLibraryMetadata.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PatternData.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedFile.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SemanticToken.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StateDef.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SuppressDirective.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueType.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Entity.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/FunctionParameter.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ServerLogLevel.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Value.md diff --git a/.chronus/changes/add-completion-for-decorator-model-arg-2024-4-17-11-50-34.md b/.chronus/changes/add-completion-for-decorator-model-arg-2024-4-17-11-50-34.md deleted file mode 100644 index 993f7548285..00000000000 --- a/.chronus/changes/add-completion-for-decorator-model-arg-2024-4-17-11-50-34.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Support completion for Model with extended properties - - Example - ```tsp - model Device { - name: string; - description: string; - } - - model Phone extends Device { - ┆ - } | [name] - | [description] - ``` - diff --git a/.chronus/changes/add-completion-for-decorator-model-arg-2024-4-6-16-27-17.md b/.chronus/changes/add-completion-for-decorator-model-arg-2024-4-6-16-27-17.md deleted file mode 100644 index 6318a4f9848..00000000000 --- a/.chronus/changes/add-completion-for-decorator-model-arg-2024-4-6-16-27-17.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Support completion for object values and model expression properties. - - Example - ```tsp - model User { - name: string; - age: int32; - address: string; - } - - const user: User = #{name: "Bob", ┆} - | [age] - | [address] - ``` - diff --git a/.chronus/changes/add_madeRequired-2024-4-9-21-13-8.md b/.chronus/changes/add_madeRequired-2024-4-9-21-13-8.md deleted file mode 100644 index 3202e2fa009..00000000000 --- a/.chronus/changes/add_madeRequired-2024-4-9-21-13-8.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/versioning" ---- - -Add `@madeRequired` decorator diff --git a/.chronus/changes/bug-escape-characters-in-docblock-2024-4-23-16-0-21.md b/.chronus/changes/bug-escape-characters-in-docblock-2024-4-23-16-0-21.md deleted file mode 100644 index adf6fea5564..00000000000 --- a/.chronus/changes/bug-escape-characters-in-docblock-2024-4-23-16-0-21.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Allow `@` to be escaped in doc comment with `\` diff --git a/.chronus/changes/custom-output-viewer-2024-4-28-16-25-31.md b/.chronus/changes/custom-output-viewer-2024-4-28-16-25-31.md deleted file mode 100644 index f61b9d697a7..00000000000 --- a/.chronus/changes/custom-output-viewer-2024-4-28-16-25-31.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/playground" ---- - -Provide ability to add custom program viewers \ No newline at end of file diff --git a/.chronus/changes/feat-fix-indentation-in-doc-comments-2024-4-20-14-31-22.md b/.chronus/changes/feat-fix-indentation-in-doc-comments-2024-4-20-14-31-22.md deleted file mode 100644 index f6d9cd81b09..00000000000 --- a/.chronus/changes/feat-fix-indentation-in-doc-comments-2024-4-20-14-31-22.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/http" - - "@typespec/protobuf" - - "@typespec/rest" - - "@typespec/versioning" - - "@typespec/xml" ---- - -Regen docs diff --git a/.chronus/changes/feat-fix-indentation-in-doc-comments-2024-4-20-14-54-41.md b/.chronus/changes/feat-fix-indentation-in-doc-comments-2024-4-20-14-54-41.md deleted file mode 100644 index 28b7152d033..00000000000 --- a/.chronus/changes/feat-fix-indentation-in-doc-comments-2024-4-20-14-54-41.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Preserve leading whitespace in fenced blocks in doc comments diff --git a/.chronus/changes/feat-fix-union-variant-decorators-2024-4-20-14-27-15.md b/.chronus/changes/feat-fix-union-variant-decorators-2024-4-20-14-27-15.md deleted file mode 100644 index a5d6e21a81c..00000000000 --- a/.chronus/changes/feat-fix-union-variant-decorators-2024-4-20-14-27-15.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" ---- -Doc diff --git a/.chronus/changes/feat-fix-union-variant-decorators-2024-4-20-14-48-3.md b/.chronus/changes/feat-fix-union-variant-decorators-2024-4-20-14-48-3.md deleted file mode 100644 index 836c4235ecd..00000000000 --- a/.chronus/changes/feat-fix-union-variant-decorators-2024-4-20-14-48-3.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/json-schema" ---- - -Fix decorators application for union variants diff --git a/.chronus/changes/feature-multipart-v2-2024-4-14-16-27-48.md b/.chronus/changes/feature-multipart-v2-2024-4-14-16-27-48.md deleted file mode 100644 index cfd31b34e2d..00000000000 --- a/.chronus/changes/feature-multipart-v2-2024-4-14-16-27-48.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/rest" ---- - diff --git a/.chronus/changes/feature-multipart-v2-2024-4-14-22-58-52.md b/.chronus/changes/feature-multipart-v2-2024-4-14-22-58-52.md deleted file mode 100644 index 0ef637f7dbd..00000000000 --- a/.chronus/changes/feature-multipart-v2-2024-4-14-22-58-52.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/http" ---- - -Add new multipart handling. Using `@multipartBody` with `HttpPart`. See [multipart docs](https://typespec.io/docs/next/libraries/http/multipart) for more information. - - ```tsp - op upload(@header contentType: "multipart/mixed", @multipartBody body: { - name: HttpPart; - avatar: HttpPart[]; - }): void; - ``` diff --git a/.chronus/changes/feature-multipart-v2-2024-4-14-23-5-59.md b/.chronus/changes/feature-multipart-v2-2024-4-14-23-5-59.md deleted file mode 100644 index e84b41362f8..00000000000 --- a/.chronus/changes/feature-multipart-v2-2024-4-14-23-5-59.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/openapi3" ---- - -Add support for new multipart constructs in http library diff --git a/.chronus/changes/feature-object-literals-2024-2-15-18-36-3-1.md b/.chronus/changes/feature-object-literals-2024-2-15-18-36-3-1.md deleted file mode 100644 index cc0ab5bb76b..00000000000 --- a/.chronus/changes/feature-object-literals-2024-2-15-18-36-3-1.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: deprecation -packages: - - "@typespec/compiler" ---- - -Using a tuple type as a value is deprecated. Tuple types in contexts where values are expected must be updated to be array values instead. A codefix is provided to automatically convert tuple types into array values. - -```tsp -model Test { - // Deprecated - values: string[] = ["a", "b", "c"]; - - // Correct - values: string[] = #["a", "b", "c"]; -``` diff --git a/.chronus/changes/feature-object-literals-2024-2-15-18-36-3-2.md b/.chronus/changes/feature-object-literals-2024-2-15-18-36-3-2.md deleted file mode 100644 index de3f507c16e..00000000000 --- a/.chronus/changes/feature-object-literals-2024-2-15-18-36-3-2.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: deprecation -packages: - - "@typespec/compiler" ---- - -Using a model type as a value is deprecated. Model types in contexts where values are expected must be updated to be object values instead. A codefix is provided to automatically convert model types into object values. - -```tsp -model Test { - // Deprecated - user: {name: string} = {name: "System"}; - - // Correct - user: {name: string} = #{name: "System"}; -``` diff --git a/.chronus/changes/feature-object-literals-2024-2-15-18-36-3.md b/.chronus/changes/feature-object-literals-2024-2-15-18-36-3.md deleted file mode 100644 index 46b8e211dda..00000000000 --- a/.chronus/changes/feature-object-literals-2024-2-15-18-36-3.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Add syntax for declaring values. [See docs](https://typespec.io/docs/language-basics/values). - -Object and array values -```tsp -@dummy(#{ - name: "John", - age: 48, - address: #{ city: "London" } - aliases: #["Bob", "Frank"] -}) -``` - -Scalar constructors - -```tsp -scalar utcDateTime { - init fromISO(value: string); -} - -model DateRange { - minDate: utcDateTime = utcDateTime.fromISO("2024-02-15T18:36:03Z"); -} -``` diff --git a/.chronus/changes/feature-object-literals-2024-2-18-22-23-26.md b/.chronus/changes/feature-object-literals-2024-2-18-22-23-26.md deleted file mode 100644 index 966b10a2b47..00000000000 --- a/.chronus/changes/feature-object-literals-2024-2-18-22-23-26.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/json-schema" - - "@typespec/protobuf" - - "@typespec/versioning" ---- - -Update to support new value types diff --git a/.chronus/changes/feature-object-literals-2024-3-16-10-38-3.md b/.chronus/changes/feature-object-literals-2024-3-16-10-38-3.md deleted file mode 100644 index 60dd5fe793d..00000000000 --- a/.chronus/changes/feature-object-literals-2024-3-16-10-38-3.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -changeKind: deprecation -packages: - - "@typespec/compiler" ---- - -Decorator API: Legacy marshalling logic - -With the introduction of values, the decorator marshalling behavior has changed in some cases. This behavior is opt-in by setting the `valueMarshalling` package flag to `"new"`, but will be the default behavior in future versions. It is strongly recommended to adopt this new behavior as soon as possible. - - - Example: - ```tsp - extern dec multipleOf(target: numeric | Reflection.ModelProperty, value: valueof numeric); - ``` - Will now emit a deprecated warning because `value` is of type `valueof string` which would marshall to `Numeric` under the new logic but as `number` previously. - - To opt-in you can add the following to your library js/ts files. - ```ts - export const $flags = definePackageFlags({ - decoratorArgMarshalling: "new", - }); - ``` diff --git a/.chronus/changes/feature-object-literals-2024-3-16-11-58-32.md b/.chronus/changes/feature-object-literals-2024-3-16-11-58-32.md deleted file mode 100644 index 3a6f6da2098..00000000000 --- a/.chronus/changes/feature-object-literals-2024-3-16-11-58-32.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/openapi3" ---- - -Add support for new object and array values as default values (e.g. `decimals: decimal[] = #[123, 456.7];`) diff --git a/.chronus/changes/feature-object-literals-2024-3-16-12-0-15.md b/.chronus/changes/feature-object-literals-2024-3-16-12-0-15.md deleted file mode 100644 index 83844db17a6..00000000000 --- a/.chronus/changes/feature-object-literals-2024-3-16-12-0-15.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/rest" ---- - -Update types to support new values in TypeSpec \ No newline at end of file diff --git a/.chronus/changes/feature-object-literals-2024-3-16-17-54-23.md b/.chronus/changes/feature-object-literals-2024-3-16-17-54-23.md deleted file mode 100644 index 9855fea9fef..00000000000 --- a/.chronus/changes/feature-object-literals-2024-3-16-17-54-23.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/html-program-viewer" ---- - -Add support for values diff --git a/.chronus/changes/feature-object-literals-32024-2-15-18-36-3.md b/.chronus/changes/feature-object-literals-32024-2-15-18-36-3.md deleted file mode 100644 index 25e98493276..00000000000 --- a/.chronus/changes/feature-object-literals-32024-2-15-18-36-3.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/http" ---- - -Update Flow Template to make use of the new array values - diff --git a/.chronus/changes/feature-prop-doc-2024-5-5-21-1-58.md b/.chronus/changes/feature-prop-doc-2024-5-5-21-1-58.md deleted file mode 100644 index 7bf3571b2f6..00000000000 --- a/.chronus/changes/feature-prop-doc-2024-5-5-21-1-58.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Add support for `@prop` doc comment tag to describe model properties diff --git a/.chronus/changes/fix-alias-indeterminate-entity-2024-4-16-19-9-9.md b/.chronus/changes/fix-alias-indeterminate-entity-2024-4-16-19-9-9.md deleted file mode 100644 index ebd01a696e2..00000000000 --- a/.chronus/changes/fix-alias-indeterminate-entity-2024-4-16-19-9-9.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" ---- -Fixing change from this release diff --git a/.chronus/changes/fix-clone-type-donot-finish-unfinished-2024-5-11-21-54-41.md b/.chronus/changes/fix-clone-type-donot-finish-unfinished-2024-5-11-21-54-41.md deleted file mode 100644 index 947d8feafef..00000000000 --- a/.chronus/changes/fix-clone-type-donot-finish-unfinished-2024-5-11-21-54-41.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -[API] Do not run decorators on cloned type if the original type wasn't finished diff --git a/.chronus/changes/fix-compiler-circular-refs-2024-4-9-14-57-38.md b/.chronus/changes/fix-compiler-circular-refs-2024-4-9-14-57-38.md deleted file mode 100644 index fadfbea1df7..00000000000 --- a/.chronus/changes/fix-compiler-circular-refs-2024-4-9-14-57-38.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" - - "@typespec/http" - - "@typespec/playground" ---- diff --git a/.chronus/changes/fix-example-of-statusCode-2024-5-3-20-58-17.md b/.chronus/changes/fix-example-of-statusCode-2024-5-3-20-58-17.md deleted file mode 100644 index d09e88744cd..00000000000 --- a/.chronus/changes/fix-example-of-statusCode-2024-5-3-20-58-17.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/http" ---- - -doc: fix incorrect example of `@statusCode` diff --git a/.chronus/changes/fix-http-file-handling-2024-5-6-17-38-0.md b/.chronus/changes/fix-http-file-handling-2024-5-6-17-38-0.md deleted file mode 100644 index 079e0b9a3ec..00000000000 --- a/.chronus/changes/fix-http-file-handling-2024-5-6-17-38-0.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/http" ---- - -Fix handling of filename for http file diff --git a/.chronus/changes/fix-install-shell-2024-5-5-16-51-0.md b/.chronus/changes/fix-install-shell-2024-5-5-16-51-0.md deleted file mode 100644 index c4463be4fc2..00000000000 --- a/.chronus/changes/fix-install-shell-2024-5-5-16-51-0.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Fix EINVAL error when running `tsp code install` diff --git a/.chronus/changes/fix-missing-export-2024-4-10-8-11-11.md b/.chronus/changes/fix-missing-export-2024-4-10-8-11-11.md deleted file mode 100644 index f441bba5f08..00000000000 --- a/.chronus/changes/fix-missing-export-2024-4-10-8-11-11.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/compiler" ---- - diff --git a/.chronus/changes/fix-no-all-no-rules-2024-5-5-16-21-56.md b/.chronus/changes/fix-no-all-no-rules-2024-5-5-16-21-56.md deleted file mode 100644 index ae822a0e92e..00000000000 --- a/.chronus/changes/fix-no-all-no-rules-2024-5-5-16-21-56.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" ---- - -Do not create all rulesets if there are no rules in linter config diff --git a/.chronus/changes/fix-numeric-not-handling-trailing-zeros-2024-4-16-2-43-25.md b/.chronus/changes/fix-numeric-not-handling-trailing-zeros-2024-4-16-2-43-25.md deleted file mode 100644 index a821497cbde..00000000000 --- a/.chronus/changes/fix-numeric-not-handling-trailing-zeros-2024-4-16-2-43-25.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Numeric not handling trailing zeros and causing freeze(e.g. `const a = 100.0`) diff --git a/.chronus/changes/fix-playground-regression-2024-5-5-16-53-46.md b/.chronus/changes/fix-playground-regression-2024-5-5-16-53-46.md deleted file mode 100644 index f1073d0f71f..00000000000 --- a/.chronus/changes/fix-playground-regression-2024-5-5-16-53-46.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/playground" ---- - diff --git a/.chronus/changes/fix-playground-styles-overflow-2024-5-6-19-45-49.md b/.chronus/changes/fix-playground-styles-overflow-2024-5-6-19-45-49.md deleted file mode 100644 index 0fb6b397037..00000000000 --- a/.chronus/changes/fix-playground-styles-overflow-2024-5-6-19-45-49.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/playground" ---- - -Fix issue where hover tooltip would be cropped or not visible diff --git a/.chronus/changes/fix-reserver-keyword-parameters-2024-5-11-21-33-25.md b/.chronus/changes/fix-reserver-keyword-parameters-2024-5-11-21-33-25.md deleted file mode 100644 index 4dbc7ded849..00000000000 --- a/.chronus/changes/fix-reserver-keyword-parameters-2024-5-11-21-33-25.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" ---- - -Fix using js special words as parameters names diff --git a/.chronus/changes/fix-scalar-constructor-clone-2024-5-12-20-39-42.md b/.chronus/changes/fix-scalar-constructor-clone-2024-5-12-20-39-42.md deleted file mode 100644 index 1a0bbbba55b..00000000000 --- a/.chronus/changes/fix-scalar-constructor-clone-2024-5-12-20-39-42.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" ---- - -Fix: Using a scalar constructor defined in a parent scalar doesn't reference the right scalar diff --git a/.chronus/changes/fix-swagger-ui-missing-2024-5-10-15-15-0.md b/.chronus/changes/fix-swagger-ui-missing-2024-5-10-15-15-0.md deleted file mode 100644 index 0eca1a03ff4..00000000000 --- a/.chronus/changes/fix-swagger-ui-missing-2024-5-10-15-15-0.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/playground" ---- - -Fix swagger UI missing diff --git a/.chronus/changes/fix-vitest-2024-4-17-21-35-16.md b/.chronus/changes/fix-vitest-2024-4-17-21-35-16.md deleted file mode 100644 index b762765d84a..00000000000 --- a/.chronus/changes/fix-vitest-2024-4-17-21-35-16.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/openapi3" ---- - -Fix vitest not reloading JS files diff --git a/.chronus/changes/formatter-multiline-strings-2024-4-22-14-32-55.md b/.chronus/changes/formatter-multiline-strings-2024-4-22-14-32-55.md deleted file mode 100644 index 91eaf6abf36..00000000000 --- a/.chronus/changes/formatter-multiline-strings-2024-4-22-14-32-55.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Formatter: Indent or dedent multiline strings to the current indentation diff --git a/.chronus/changes/highlight-suppress-2024-4-28-16-43-58.md b/.chronus/changes/highlight-suppress-2024-4-28-16-43-58.md deleted file mode 100644 index 6b38355bc08..00000000000 --- a/.chronus/changes/highlight-suppress-2024-4-28-16-43-58.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Hide deprecated items from completion list \ No newline at end of file diff --git a/.chronus/changes/ide-support-completion-for-extends-is-2024-4-24-11-15-1.md b/.chronus/changes/ide-support-completion-for-extends-is-2024-4-24-11-15-1.md deleted file mode 100644 index e3c10d89678..00000000000 --- a/.chronus/changes/ide-support-completion-for-extends-is-2024-4-24-11-15-1.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Support completion for keyword 'extends' and 'is' - - Example - ```tsp - model Dog ┆ {} - | [extends] - | [is] - - scalar Addresss ┆ - | [extends] - - op jump ┆ - | [is] - - interface ResourceA ┆ {} - | [extends] - - model Cat {} - | [extends] - ``` - diff --git a/.chronus/changes/json-schema-fixes-2024-4-25-0-58-10.md b/.chronus/changes/json-schema-fixes-2024-4-25-0-58-10.md deleted file mode 100644 index 878d132894b..00000000000 --- a/.chronus/changes/json-schema-fixes-2024-4-25-0-58-10.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Emitter framework: fix losing context when referencing circular types \ No newline at end of file diff --git a/.chronus/changes/json-schema-fixes-2024-4-25-0-58-28.md b/.chronus/changes/json-schema-fixes-2024-4-25-0-58-28.md deleted file mode 100644 index d9fcbef1623..00000000000 --- a/.chronus/changes/json-schema-fixes-2024-4-25-0-58-28.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/json-schema" ---- - diff --git a/.chronus/changes/json-schema-oneof-2024-5-11-8-56-5.md b/.chronus/changes/json-schema-oneof-2024-5-11-8-56-5.md deleted file mode 100644 index ef96db35aea..00000000000 --- a/.chronus/changes/json-schema-oneof-2024-5-11-8-56-5.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/json-schema" ---- - -Add support for @oneOf decorator. \ No newline at end of file diff --git a/.chronus/changes/json-schema-reftype-fix-2024-4-23-16-41-33.md b/.chronus/changes/json-schema-reftype-fix-2024-4-23-16-41-33.md deleted file mode 100644 index caeaa4c2d70..00000000000 --- a/.chronus/changes/json-schema-reftype-fix-2024-4-23-16-41-33.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/json-schema" ---- - -The emitted JSON Schema now doesn't make root schemas for TypeSpec types which do not have the @jsonSchema decorator or are contained in a namespace with that decorator. Instead, such schemas are put into the $defs of any root schema which references them, and are referenced using JSON Pointers. diff --git a/.chronus/changes/linter-auto-all-ruleset-2024-4-28-16-18-46.md b/.chronus/changes/linter-auto-all-ruleset-2024-4-28-16-18-46.md deleted file mode 100644 index 5448e32ca53..00000000000 --- a/.chronus/changes/linter-auto-all-ruleset-2024-4-28-16-18-46.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Linter `all` rulesets is automatically created if not explicitly provided diff --git a/.chronus/changes/linter-auto-all-ruleset-2024-4-28-16-18-47.md b/.chronus/changes/linter-auto-all-ruleset-2024-4-28-16-18-47.md deleted file mode 100644 index ceea70622e0..00000000000 --- a/.chronus/changes/linter-auto-all-ruleset-2024-4-28-16-18-47.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/http" ---- - -Use new compiler automatic `all` ruleset instead of explicitly provided one diff --git a/.chronus/changes/main-2024-5-13-14-52-31.md b/.chronus/changes/main-2024-5-13-14-52-31.md deleted file mode 100644 index e5fa0ec174f..00000000000 --- a/.chronus/changes/main-2024-5-13-14-52-31.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/openapi3" ---- - -Emit diagnostic when an invalid type is used as a property instead of crashing. diff --git a/.chronus/changes/more-logging-vscode-2024-5-6-16-57-48.md b/.chronus/changes/more-logging-vscode-2024-5-6-16-57-48.md deleted file mode 100644 index 4098e34757d..00000000000 --- a/.chronus/changes/more-logging-vscode-2024-5-6-16-57-48.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -changeKind: feature -packages: - - typespec-vscode ---- - -Enhance logging and trace - 1. Support "Developer: Set Log Level..." command to filter logs in TypeSpec output channel - 2. Add "typespecLanguageServer.trace.server" config for whether and how to send the traces from TypeSpec language server to client. (It still depends on client to decide whether to show these traces based on the configured Log Level.) - 3. More logs and traces are added for diagnostic and troubleshooting diff --git a/.chronus/changes/more-logging-vscode-2024-5-7-12-41-0.md b/.chronus/changes/more-logging-vscode-2024-5-7-12-41-0.md deleted file mode 100644 index 35f044cca05..00000000000 --- a/.chronus/changes/more-logging-vscode-2024-5-7-12-41-0.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/compiler" ---- - -More logs and traces are added for diagnostic and troubleshooting in TypeSpec language server diff --git a/.chronus/changes/param-override-spread-2024-5-4-20-52-44.md b/.chronus/changes/param-override-spread-2024-5-4-20-52-44.md deleted file mode 100644 index a98460705db..00000000000 --- a/.chronus/changes/param-override-spread-2024-5-4-20-52-44.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Fix application of `@param` doc tag on operation create with `op is` to override upstream doc diff --git a/.chronus/changes/pick-properties-2024-5-3-17-55-34.md b/.chronus/changes/pick-properties-2024-5-3-17-55-34.md deleted file mode 100644 index ee722d7e951..00000000000 --- a/.chronus/changes/pick-properties-2024-5-3-17-55-34.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Add `PickProperties` type to dynamically select a subset of a model diff --git a/.chronus/changes/playground-log-2024-5-12-13-33-41.md b/.chronus/changes/playground-log-2024-5-12-13-33-41.md deleted file mode 100644 index 31f06a636a5..00000000000 --- a/.chronus/changes/playground-log-2024-5-12-13-33-41.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/playground" ---- - -Support loglevel in playground's logging \ No newline at end of file diff --git a/.chronus/changes/playground-storybook-2024-4-22-18-10-6.md b/.chronus/changes/playground-storybook-2024-4-22-18-10-6.md deleted file mode 100644 index f03da4dbccd..00000000000 --- a/.chronus/changes/playground-storybook-2024-4-22-18-10-6.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/playground" ---- - -Add storybook for playground library diff --git a/.chronus/changes/playground-vite-2024-4-20-21-21-23.md b/.chronus/changes/playground-vite-2024-4-20-21-21-23.md deleted file mode 100644 index 9db9dd493e3..00000000000 --- a/.chronus/changes/playground-vite-2024-4-20-21-21-23.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/playground" ---- - -Simplify to use vite for building playground library diff --git a/.chronus/changes/protobuf-package-names-2024-5-11-16-35-54.md b/.chronus/changes/protobuf-package-names-2024-5-11-16-35-54.md deleted file mode 100644 index 9677616fb05..00000000000 --- a/.chronus/changes/protobuf-package-names-2024-5-11-16-35-54.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/protobuf" ---- - -Corrected cross-package reference behavior in some buggy cases. \ No newline at end of file diff --git a/.chronus/changes/upgrade-deps-may-2024-2024-4-20-15-37-30.md b/.chronus/changes/upgrade-deps-may-2024-2024-4-20-15-37-30.md deleted file mode 100644 index 0d90d57b86f..00000000000 --- a/.chronus/changes/upgrade-deps-may-2024-2024-4-20-15-37-30.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: dependencies -packages: - - "@typespec/bundler" - - "@typespec/compiler" - - "@typespec/eslint-plugin" - - "@typespec/html-program-viewer" - - "@typespec/http" - - "@typespec/internal-build-utils" - - "@typespec/json-schema" - - "@typespec/library-linter" - - "@typespec/openapi" - - "@typespec/openapi3" - - "@typespec/playground" - - "@typespec/prettier-plugin-typespec" - - "@typespec/protobuf" - - "@typespec/rest" - - tmlanguage-generator - - typespec-vscode - - "@typespec/versioning" - - "@typespec/xml" ---- - -Update dependencies - May 2024 diff --git a/.chronus/changes/versioning-FixVersionBug1-2024-4-21-16-34-18.md b/.chronus/changes/versioning-FixVersionBug1-2024-4-21-16-34-18.md deleted file mode 100644 index 1b66d63ed6f..00000000000 --- a/.chronus/changes/versioning-FixVersionBug1-2024-4-21-16-34-18.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/versioning" ---- - -Using `@removed` on member types and `@added` on containing type could result in errors diff --git a/.chronus/changes/versioning-FixVersioningBugs-2024-4-22-20-42-27.md b/.chronus/changes/versioning-FixVersioningBugs-2024-4-22-20-42-27.md deleted file mode 100644 index bad367a8f93..00000000000 --- a/.chronus/changes/versioning-FixVersioningBugs-2024-4-22-20-42-27.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/versioning" ---- - -If a property were marked with @added on a later version, the logic that said it was originally added on the first version was erroneously removed, resulting in incorrect projections. diff --git a/.chronus/changes/versioning-fixBug-2024-5-5-20-59-9.md b/.chronus/changes/versioning-fixBug-2024-5-5-20-59-9.md deleted file mode 100644 index 447dd7970a8..00000000000 --- a/.chronus/changes/versioning-fixBug-2024-5-5-20-59-9.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/versioning" ---- - -Fix regression in last Versioning PR. diff --git a/.chronus/changes/versioning-library-cleanup-2024-4-9-22-35-15.md b/.chronus/changes/versioning-library-cleanup-2024-4-9-22-35-15.md deleted file mode 100644 index bd60b190891..00000000000 --- a/.chronus/changes/versioning-library-cleanup-2024-4-9-22-35-15.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/versioning" ---- - -Organize versioning library diff --git a/.chronus/changes/vs-extension-arm-2024-4-27-15-58-16.md b/.chronus/changes/vs-extension-arm-2024-4-27-15-58-16.md deleted file mode 100644 index 1ada4809f33..00000000000 --- a/.chronus/changes/vs-extension-arm-2024-4-27-15-58-16.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - typespec-vs ---- - -Support Arm64 \ No newline at end of file diff --git a/.chronus/changes/vscode-output-cmd-2024-4-17-16-6-25.md b/.chronus/changes/vscode-output-cmd-2024-4-17-16-6-25.md deleted file mode 100644 index a5d7a26cec6..00000000000 --- a/.chronus/changes/vscode-output-cmd-2024-4-17-16-6-25.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - typespec-vscode ---- - -Add 'TypeSpec: Show Output Channel' command in VSCode extension \ No newline at end of file diff --git a/packages/bundler/CHANGELOG.md b/packages/bundler/CHANGELOG.md index 224a3e54990..d98cc3df621 100644 --- a/packages/bundler/CHANGELOG.md +++ b/packages/bundler/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/bundler +## 0.1.4 + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + + ## 0.1.3 ### Bump dependencies diff --git a/packages/bundler/package.json b/packages/bundler/package.json index 585feaa9322..2882199a117 100644 --- a/packages/bundler/package.json +++ b/packages/bundler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/bundler", - "version": "0.1.3", + "version": "0.1.4", "author": "Microsoft Corporation", "description": "Package to bundle a TypeSpec library.", "homepage": "https://typespec.io", diff --git a/packages/compiler/CHANGELOG.md b/packages/compiler/CHANGELOG.md index 4c6cd01c3a2..ae3b417513e 100644 --- a/packages/compiler/CHANGELOG.md +++ b/packages/compiler/CHANGELOG.md @@ -1,5 +1,142 @@ # Change Log - @typespec/compiler +## 0.57.0 + +### Bug Fixes + +- [#3399](https://github.com/microsoft/typespec/pull/3399) Preserve leading whitespace in fenced blocks in doc comments +- [#3566](https://github.com/microsoft/typespec/pull/3566) [API] Do not run decorators on cloned type if the original type wasn't finished +- [#3522](https://github.com/microsoft/typespec/pull/3522) Fix EINVAL error when running `tsp code install` +- [#3371](https://github.com/microsoft/typespec/pull/3371) Numeric not handling trailing zeros and causing freeze(e.g. `const a = 100.0`) +- [#3451](https://github.com/microsoft/typespec/pull/3451) Emitter framework: fix losing context when referencing circular types +- [#3517](https://github.com/microsoft/typespec/pull/3517) Fix application of `@param` doc tag on operation create with `op is` to override upstream doc +- [#3488](https://github.com/microsoft/typespec/pull/3488) Add `PickProperties` type to dynamically select a subset of a model + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + +### Features + +- [#3280](https://github.com/microsoft/typespec/pull/3280) Support completion for Model with extended properties + + Example + ```tsp + model Device { + name: string; + description: string; + } + + model Phone extends Device { + ┆ + } | [name] + | [description] + ``` +- [#3280](https://github.com/microsoft/typespec/pull/3280) Support completion for object values and model expression properties. + + Example + ```tsp + model User { + name: string; + age: int32; + address: string; + } + + const user: User = #{name: "Bob", ┆} + | [age] + | [address] + ``` +- [#3375](https://github.com/microsoft/typespec/pull/3375) Allow `@` to be escaped in doc comment with `\` +- [#3022](https://github.com/microsoft/typespec/pull/3022) Add syntax for declaring values. [See docs](https://typespec.io/docs/language-basics/values). + +Object and array values +```tsp +@dummy(#{ + name: "John", + age: 48, + address: #{ city: "London" } + aliases: #["Bob", "Frank"] +}) +``` + +Scalar constructors + +```tsp +scalar utcDateTime { + init fromISO(value: string); +} + +model DateRange { + minDate: utcDateTime = utcDateTime.fromISO("2024-02-15T18:36:03Z"); +} +``` +- [#3527](https://github.com/microsoft/typespec/pull/3527) Add support for `@prop` doc comment tag to describe model properties +- [#3422](https://github.com/microsoft/typespec/pull/3422) Formatter: Indent or dedent multiline strings to the current indentation +- [#3460](https://github.com/microsoft/typespec/pull/3460) Hide deprecated items from completion list +- [#3443](https://github.com/microsoft/typespec/pull/3443) Support completion for keyword 'extends' and 'is' + + Example + ```tsp + model Dog ┆ {} + | [extends] + | [is] + + scalar Addresss ┆ + | [extends] + + op jump ┆ + | [is] + + interface ResourceA ┆ {} + | [extends] + + model Cat {} + | [extends] + ``` +- [#3462](https://github.com/microsoft/typespec/pull/3462) Linter `all` rulesets is automatically created if not explicitly provided +- [#3533](https://github.com/microsoft/typespec/pull/3533) More logs and traces are added for diagnostic and troubleshooting in TypeSpec language server + +### Deprecations + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Using a tuple type as a value is deprecated. Tuple types in contexts where values are expected must be updated to be array values instead. A codefix is provided to automatically convert tuple types into array values. + +```tsp +model Test { + // Deprecated + values: string[] = ["a", "b", "c"]; + + // Correct + values: string[] = #["a", "b", "c"]; +``` +- [#3022](https://github.com/microsoft/typespec/pull/3022) Using a model type as a value is deprecated. Model types in contexts where values are expected must be updated to be object values instead. A codefix is provided to automatically convert model types into object values. + +```tsp +model Test { + // Deprecated + user: {name: string} = {name: "System"}; + + // Correct + user: {name: string} = #{name: "System"}; +``` +- [#3022](https://github.com/microsoft/typespec/pull/3022) Decorator API: Legacy marshalling logic + +With the introduction of values, the decorator marshalling behavior has changed in some cases. This behavior is opt-in by setting the `valueMarshalling` package flag to `"new"`, but will be the default behavior in future versions. It is strongly recommended to adopt this new behavior as soon as possible. + + + Example: + ```tsp + extern dec multipleOf(target: numeric | Reflection.ModelProperty, value: valueof numeric); + ``` + Will now emit a deprecated warning because `value` is of type `valueof string` which would marshall to `Numeric` under the new logic but as `number` previously. + + To opt-in you can add the following to your library js/ts files. + ```ts + export const $flags = definePackageFlags({ + decoratorArgMarshalling: "new", + }); + ``` + + ## 0.56.0 ### Bug Fixes diff --git a/packages/compiler/package.json b/packages/compiler/package.json index 4435723f603..06d7bf203a6 100644 --- a/packages/compiler/package.json +++ b/packages/compiler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/compiler", - "version": "0.56.0", + "version": "0.57.0", "description": "TypeSpec Compiler Preview", "author": "Microsoft Corporation", "license": "MIT", diff --git a/packages/eslint-plugin-typespec/CHANGELOG.md b/packages/eslint-plugin-typespec/CHANGELOG.md index 0724012f372..4a10be0b269 100644 --- a/packages/eslint-plugin-typespec/CHANGELOG.md +++ b/packages/eslint-plugin-typespec/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/eslint-plugin +## 0.57.0 + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + + ## 0.56.0 ### Bump dependencies diff --git a/packages/eslint-plugin-typespec/package.json b/packages/eslint-plugin-typespec/package.json index a8a50edc32d..9c7b55a964c 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.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "Eslint plugin providing set of rules to be used in the JS/TS code of TypeSpec libraries", "homepage": "https://typespec.io", diff --git a/packages/html-program-viewer/CHANGELOG.md b/packages/html-program-viewer/CHANGELOG.md index 2c4209915be..a5aca219d97 100644 --- a/packages/html-program-viewer/CHANGELOG.md +++ b/packages/html-program-viewer/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log - @typespec/html-program-viewer +## 0.57.0 + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + +### Features + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Add support for values + + ## 0.56.0 ### Bump dependencies diff --git a/packages/html-program-viewer/package.json b/packages/html-program-viewer/package.json index 1919de69780..6d17c449203 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.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting an html view of the program.", "homepage": "https://typespec.io", diff --git a/packages/http/CHANGELOG.md b/packages/http/CHANGELOG.md index 960139e7f01..0aacae8bb85 100644 --- a/packages/http/CHANGELOG.md +++ b/packages/http/CHANGELOG.md @@ -1,5 +1,28 @@ # Change Log - @typespec/http +## 0.57.0 + +### Bug Fixes + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Update Flow Template to make use of the new array values + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + +### Features + +- [#3342](https://github.com/microsoft/typespec/pull/3342) Add new multipart handling. Using `@multipartBody` with `HttpPart`. See [multipart docs](https://typespec.io/docs/next/libraries/http/multipart) for more information. + + ```tsp + op upload(@header contentType: "multipart/mixed", @multipartBody body: { + name: HttpPart; + avatar: HttpPart[]; + }): void; + ``` +- [#3462](https://github.com/microsoft/typespec/pull/3462) Use new compiler automatic `all` ruleset instead of explicitly provided one + + ## 0.56.0 ### Bug Fixes diff --git a/packages/http/package.json b/packages/http/package.json index 18a1138d12a..088fcefcbe1 100644 --- a/packages/http/package.json +++ b/packages/http/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/http", - "version": "0.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "TypeSpec HTTP protocol binding", "homepage": "https://github.com/microsoft/typespec", diff --git a/packages/internal-build-utils/CHANGELOG.md b/packages/internal-build-utils/CHANGELOG.md index 61f39a556b7..dc426171af7 100644 --- a/packages/internal-build-utils/CHANGELOG.md +++ b/packages/internal-build-utils/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/internal-build-utils +## 0.57.0 + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + + ## 0.56.0 ### Bump dependencies diff --git a/packages/internal-build-utils/package.json b/packages/internal-build-utils/package.json index 24e211921b9..21b942d33f2 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.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "Internal library to TypeSpec providing helpers to build.", "homepage": "https://typespec.io", diff --git a/packages/json-schema/CHANGELOG.md b/packages/json-schema/CHANGELOG.md index 4257dc4cbdb..25c57cf69e4 100644 --- a/packages/json-schema/CHANGELOG.md +++ b/packages/json-schema/CHANGELOG.md @@ -1,5 +1,22 @@ # Change Log - @typespec/json-schema +## 0.57.0 + +### Bug Fixes + +- [#3398](https://github.com/microsoft/typespec/pull/3398) Fix decorators application for union variants +- [#3022](https://github.com/microsoft/typespec/pull/3022) Update to support new value types +- [#3430](https://github.com/microsoft/typespec/pull/3430) The emitted JSON Schema now doesn't make root schemas for TypeSpec types which do not have the @jsonSchema decorator or are contained in a namespace with that decorator. Instead, such schemas are put into the $defs of any root schema which references them, and are referenced using JSON Pointers. + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + +### Features + +- [#3557](https://github.com/microsoft/typespec/pull/3557) Add support for @oneOf decorator. + + ## 0.56.0 ### Bump dependencies diff --git a/packages/json-schema/package.json b/packages/json-schema/package.json index 688bd2e94e3..85b96e40fa7 100644 --- a/packages/json-schema/package.json +++ b/packages/json-schema/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/json-schema", - "version": "0.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting TypeSpec to JSON Schema and converting JSON Schema to TypeSpec", "homepage": "https://github.com/microsoft/typespec", diff --git a/packages/library-linter/CHANGELOG.md b/packages/library-linter/CHANGELOG.md index b7b9aa3c380..f7cd7fa796d 100644 --- a/packages/library-linter/CHANGELOG.md +++ b/packages/library-linter/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/library-linter +## 0.57.0 + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + + ## 0.56.0 ### Bump dependencies diff --git a/packages/library-linter/package.json b/packages/library-linter/package.json index c7647c34eb0..32471e0fecc 100644 --- a/packages/library-linter/package.json +++ b/packages/library-linter/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/library-linter", - "version": "0.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "TypeSpec library for linting another library.", "homepage": "https://typespec.io", diff --git a/packages/openapi/CHANGELOG.md b/packages/openapi/CHANGELOG.md index 4f571b03c8b..be8d63cbd9d 100644 --- a/packages/openapi/CHANGELOG.md +++ b/packages/openapi/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/openapi +## 0.57.0 + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + + ## 0.56.0 ### Bump dependencies diff --git a/packages/openapi/package.json b/packages/openapi/package.json index 05bc0035fcd..1cea77790b5 100644 --- a/packages/openapi/package.json +++ b/packages/openapi/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi", - "version": "0.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "TypeSpec library providing OpenAPI concepts", "homepage": "https://typespec.io", diff --git a/packages/openapi3/CHANGELOG.md b/packages/openapi3/CHANGELOG.md index 7f11a5d0732..3766d08fe7e 100644 --- a/packages/openapi3/CHANGELOG.md +++ b/packages/openapi3/CHANGELOG.md @@ -1,5 +1,21 @@ # Change Log - @typespec/openapi3 +## 0.57.0 + +### Bug Fixes + +- [#3342](https://github.com/microsoft/typespec/pull/3342) Add support for new multipart constructs in http library +- [#3574](https://github.com/microsoft/typespec/pull/3574) Emit diagnostic when an invalid type is used as a property instead of crashing. + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + +### Features + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Add support for new object and array values as default values (e.g. `decimals: decimal[] = #[123, 456.7];`) + + ## 0.56.0 ### Bug Fixes diff --git a/packages/openapi3/package.json b/packages/openapi3/package.json index 993f709cbb2..9b30c996a4d 100644 --- a/packages/openapi3/package.json +++ b/packages/openapi3/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi3", - "version": "0.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding", "homepage": "https://typespec.io", diff --git a/packages/playground/CHANGELOG.md b/packages/playground/CHANGELOG.md index 954079fd492..486437fba4a 100644 --- a/packages/playground/CHANGELOG.md +++ b/packages/playground/CHANGELOG.md @@ -1,5 +1,21 @@ # Change Log - @typespec/playground +## 0.3.0 + +### Bug Fixes + +- [#3542](https://github.com/microsoft/typespec/pull/3542) Fix issue where hover tooltip would be cropped or not visible + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + +### Features + +- [#3465](https://github.com/microsoft/typespec/pull/3465) Provide ability to add custom program viewers +- [#3569](https://github.com/microsoft/typespec/pull/3569) Support loglevel in playground's logging + + ## 0.2.2 ### Bug Fixes diff --git a/packages/playground/package.json b/packages/playground/package.json index 1e983f5b91a..889942f6317 100644 --- a/packages/playground/package.json +++ b/packages/playground/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/playground", - "version": "0.2.2", + "version": "0.3.0", "author": "Microsoft Corporation", "description": "TypeSpec playground UI components.", "homepage": "https://typespec.io", diff --git a/packages/prettier-plugin-typespec/CHANGELOG.md b/packages/prettier-plugin-typespec/CHANGELOG.md index f79328c4521..0df35dd7e4d 100644 --- a/packages/prettier-plugin-typespec/CHANGELOG.md +++ b/packages/prettier-plugin-typespec/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/prettier-plugin-typespec +## 0.57.0 + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + + ## 0.56.0 ### Bump dependencies diff --git a/packages/prettier-plugin-typespec/package.json b/packages/prettier-plugin-typespec/package.json index 21592fd84e7..3838f808f70 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.56.0", + "version": "0.57.0", "description": "", "main": "dist/index.js", "scripts": { diff --git a/packages/protobuf/CHANGELOG.md b/packages/protobuf/CHANGELOG.md index 000dd63c336..9f9254fb762 100644 --- a/packages/protobuf/CHANGELOG.md +++ b/packages/protobuf/CHANGELOG.md @@ -1,5 +1,17 @@ # Change Log - @typespec/protobuf +## 0.57.0 + +### Bug Fixes + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Update to support new value types +- [#3561](https://github.com/microsoft/typespec/pull/3561) Corrected cross-package reference behavior in some buggy cases. + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + + ## 0.56.0 ### Bump dependencies diff --git a/packages/protobuf/package.json b/packages/protobuf/package.json index bd697a683f4..2fba9d6d596 100644 --- a/packages/protobuf/package.json +++ b/packages/protobuf/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/protobuf", - "version": "0.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "TypeSpec library and emitter for Protobuf (gRPC)", "homepage": "https://github.com/microsoft/typespec", diff --git a/packages/rest/CHANGELOG.md b/packages/rest/CHANGELOG.md index 875ee27ce78..5b16c1a9702 100644 --- a/packages/rest/CHANGELOG.md +++ b/packages/rest/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log - @typespec/rest +## 0.57.0 + +### Bug Fixes + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Update types to support new values in TypeSpec + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + + ## 0.56.0 ### Bump dependencies diff --git a/packages/rest/package.json b/packages/rest/package.json index 67eb918ee99..4e0e1cebfc3 100644 --- a/packages/rest/package.json +++ b/packages/rest/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/rest", - "version": "0.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "TypeSpec REST protocol binding", "homepage": "https://typespec.io", diff --git a/packages/tmlanguage-generator/CHANGELOG.md b/packages/tmlanguage-generator/CHANGELOG.md index e7315a67361..54a484f0be3 100644 --- a/packages/tmlanguage-generator/CHANGELOG.md +++ b/packages/tmlanguage-generator/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - tmlanguage-generator +## 0.5.6 + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + + ## 0.5.5 ### Bump dependencies diff --git a/packages/tmlanguage-generator/package.json b/packages/tmlanguage-generator/package.json index a72b2c31563..fa6f06dce7d 100644 --- a/packages/tmlanguage-generator/package.json +++ b/packages/tmlanguage-generator/package.json @@ -1,6 +1,6 @@ { "name": "tmlanguage-generator", - "version": "0.5.5", + "version": "0.5.6", "author": "Microsoft Corporation", "description": "Helper library to generate TextMate syntax highlighting tmLanguage files.", "homepage": "https://github.com/microsoft/typespec/tree/main/packages/tmlanguage-generator", diff --git a/packages/typespec-vs/CHANGELOG.md b/packages/typespec-vs/CHANGELOG.md index f86f34e477f..6b9c0020ad3 100644 --- a/packages/typespec-vs/CHANGELOG.md +++ b/packages/typespec-vs/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - typespec-vs +## 0.57.0 + +### Features + +- [#3461](https://github.com/microsoft/typespec/pull/3461) Support Arm64 + + ## 0.56.0 No changes, version bump only. diff --git a/packages/typespec-vs/package.json b/packages/typespec-vs/package.json index dad8d1449b1..6a9aee00189 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.56.0", + "version": "0.57.0", "description": "TypeSpec Language Support for Visual Studio", "homepage": "https://typespec.io", "readme": "https://github.com/microsoft/typespec/blob/main/README.md", diff --git a/packages/typespec-vscode/CHANGELOG.md b/packages/typespec-vscode/CHANGELOG.md index a83e84ea3b6..0bc3d1ebecb 100644 --- a/packages/typespec-vscode/CHANGELOG.md +++ b/packages/typespec-vscode/CHANGELOG.md @@ -1,5 +1,20 @@ # Change Log - typespec-vscode +## 0.57.0 + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + +### Features + +- [#3533](https://github.com/microsoft/typespec/pull/3533) Enhance logging and trace + 1. Support "Developer: Set Log Level..." command to filter logs in TypeSpec output channel + 2. Add "typespecLanguageServer.trace.server" config for whether and how to send the traces from TypeSpec language server to client. (It still depends on client to decide whether to show these traces based on the configured Log Level.) + 3. More logs and traces are added for diagnostic and troubleshooting +- [#3385](https://github.com/microsoft/typespec/pull/3385) Add 'TypeSpec: Show Output Channel' command in VSCode extension + + ## 0.56.0 ### Bump dependencies diff --git a/packages/typespec-vscode/package.json b/packages/typespec-vscode/package.json index a41267c3700..3a8239ebbb2 100644 --- a/packages/typespec-vscode/package.json +++ b/packages/typespec-vscode/package.json @@ -1,6 +1,6 @@ { "name": "typespec-vscode", - "version": "0.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "TypeSpec language support for VS Code", "homepage": "https://typespec.io", diff --git a/packages/versioning/CHANGELOG.md b/packages/versioning/CHANGELOG.md index 7474646caf3..c65654fb78e 100644 --- a/packages/versioning/CHANGELOG.md +++ b/packages/versioning/CHANGELOG.md @@ -1,5 +1,19 @@ # Change Log - @typespec/versioning +## 0.57.0 + +### Bug Fixes + +- [#3292](https://github.com/microsoft/typespec/pull/3292) Add `@madeRequired` decorator +- [#3022](https://github.com/microsoft/typespec/pull/3022) Update to support new value types +- [#3409](https://github.com/microsoft/typespec/pull/3409) Using `@removed` on member types and `@added` on containing type could result in errors +- [#3255](https://github.com/microsoft/typespec/pull/3255) If a property were marked with @added on a later version, the logic that said it was originally added on the first version was erroneously removed, resulting in incorrect projections. + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + + ## 0.56.0 ### Bug Fixes diff --git a/packages/versioning/package.json b/packages/versioning/package.json index 9592c5e1c70..383b15f48ba 100644 --- a/packages/versioning/package.json +++ b/packages/versioning/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/versioning", - "version": "0.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "TypeSpec library for declaring and emitting versioned APIs", "homepage": "https://typespec.io", diff --git a/packages/website/playground-versions.json b/packages/website/playground-versions.json index 2c0d89df865..82e9bb79856 100644 --- a/packages/website/playground-versions.json +++ b/packages/website/playground-versions.json @@ -1,4 +1,5 @@ [ + "0.57.x", "0.56.x", "0.55.x", "0.54.x", diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/guide.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/guide.md new file mode 100644 index 00000000000..6636c477a50 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/guide.md @@ -0,0 +1,37 @@ +--- +title: Guide +--- + +# JSON Schema files and references + +When a TypeSpec data type has the `@jsonSchema` decorator or is declared inside a namespace with that decorator, it is considered a _JSON Schema type_. + +By default, this emitter will produce one JSON Schema file per JSON Schema type. The file defines an `$id` metadata keyword based on the TypeSpec type name and the file format of the schema (for example, `Widget.yaml`). The `$id` can be overridden by using the `@id` decorator. + +:::note +The base URI of a schema is the reference point for resolving relative URIs within the schema, such as those inside `$ref`s. When the `$id` metadata keyword of a schema is an absolute URI, the `$id` is the base URI. When the `$id` is a relative reference, then the base URI is determined by resolving the relative reference against the URI used to retrieve the schema. + +The default behavior of this emitter for a model named `Widget` is to produce a schema with a `$id` of `Widget.yaml`, which allows the actual base URI of the document to differ depending on where it is retrieved from, and therefore should allow resolving relative references to other schemas whether loaded from disk or retrieved over HTTP. +::: + +When JSON Schema types reference other JSON Schema types, those references are created using a `$ref` with a relative reference (see the note above for how this works in JSON Schema). + +How this emitter handles data types which aren't JSON Schema types can be controlled using the `emitAllModels` and `emitAllRefs` options. + +By default, this emitter does not define schemas for such data types. Instead, the schemas for them are placed in the `$defs` of any JSON Schema types that reference them. The schemas do not define either `$id` or `$schema` metadata keywords. The `$defs` are referenced using a `$ref` with URI fragment containing a JSON Pointer, which uses the syntax of the following form: + +```json +{ "$ref": "#/$defs/{TypeNameHere}" } +``` + +If you want to treat all TypeSpec types as JSON Schema types (even if they don't have the `@jsonSchema` decorator), you can set the `emitAllModels` option to true. With this set, every data type in your TypeSpec program will get its own schema file, and all references will be relative URIs. + +If you want to treat all TypeSpec types referenced from JSON Schema types as JSON Schema types (even if they don't have the `@jsonSchema` decorator), you can set the `emitAllRefs` option to true. With this set, data types which are referenced from JSON Schema types will get their own schema file, and all references to them will be relative URIs. + +## Bundling behavior + +By default, this emitter will produce separate schema files for each JSON Schema type in your program. However, if you prefer to bundle all of your schemas into a single file, you can set the `bundleId` option to the id you want to use for your bundle. You will now get a single file containing all of your schemas. + +Note that bundling does not affect any references within the bundled schemas. In particular, references between JSON Schema types still use relative URIs. As such, correctly resolving these references to the local file requires JSON Schema implementations to support bundling as defined in the JSON Schema 2020-12 specification. + +Note also that this does not affect the behavior of non-JSON Schema data types. In particular, by default, non-JSON Schema data types are inlined into each referencing schema's `$defs` object. The `emitAllModels` and `emitAllRefs` options can be used to turn these inlined `$defs` into `$defs` in the bundle. diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/decorators.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/decorators.md index a61dd90562f..e8445e5ad45 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/decorators.md @@ -258,6 +258,22 @@ Specify that the numeric type must be a multiple of some numeric value. | ----- | ----------------- | -------------------------------------------------- | | value | `valueof numeric` | The numeric type must be a multiple of this value. | +### `@oneOf` {#@TypeSpec.JsonSchema.oneOf} + +Specify that `oneOf` should be used instead of `anyOf` for that union. + +```typespec +@TypeSpec.JsonSchema.oneOf +``` + +#### Target + +`Union | ModelProperty` + +#### Parameters + +None + ### `@prefixItems` {#@TypeSpec.JsonSchema.prefixItems} Specify that the target array must begin with the provided types. diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/index.mdx b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/index.mdx index bbc10f06d42..ce0f343fb01 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/index.mdx +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/index.mdx @@ -52,6 +52,7 @@ npm install --save-peer @typespec/json-schema - [`@minContains`](./decorators.md#@TypeSpec.JsonSchema.minContains) - [`@minProperties`](./decorators.md#@TypeSpec.JsonSchema.minProperties) - [`@multipleOf`](./decorators.md#@TypeSpec.JsonSchema.multipleOf) +- [`@oneOf`](./decorators.md#@TypeSpec.JsonSchema.oneOf) - [`@prefixItems`](./decorators.md#@TypeSpec.JsonSchema.prefixItems) - [`@uniqueItems`](./decorators.md#@TypeSpec.JsonSchema.uniqueItems) diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/classes/JsonSchemaEmitter.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/classes/JsonSchemaEmitter.md index 9dd44e51bf2..31162e03e68 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/classes/JsonSchemaEmitter.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/classes/JsonSchemaEmitter.md @@ -9,7 +9,7 @@ title: "[C] JsonSchemaEmitter" ## Constructors -### new JsonSchemaEmitter(emitter) +### new JsonSchemaEmitter() ```ts new JsonSchemaEmitter(emitter): JsonSchemaEmitter @@ -34,12 +34,12 @@ call `createAssetEmitter` on the emitter context object. ## Properties -| Property | Modifier | Type | Inherited from | -| :------ | :------ | :------ | :------ | -| `#idDuplicateTracker` | `private` | `DuplicateTracker`<`string`, `DiagnosticTarget`\> | - | -| `#refToDecl` | `private` | `Map`<`string`, `Declaration`<`Record`<`string`, `unknown`\>\>\> | - | -| `#typeForSourceFile` | `private` | `Map`<`SourceFile`<`any`\>, [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md)\> | - | -| `emitter` | `protected` | `AssetEmitter`<`Record`<`string`, `any`\>, [`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> | `TypeEmitter.emitter` | +| Property | Modifier | Type | Default value | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `#idDuplicateTracker` | `private` | `DuplicateTracker`<`string`, `DiagnosticTarget`\> | `...` | - | +| `#refToDecl` | `private` | `Map`<`string`, `Declaration`<`Record`<`string`, `unknown`\>\>\> | `...` | - | +| `#typeForSourceFile` | `private` | `Map`<`SourceFile`<`any`\>, [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md)\> | `...` | - | +| `emitter` | `protected` | `AssetEmitter`<`Record`<`string`, `any`\>, [`JSONSchemaEmitterOptions`](../interfaces/JSONSchemaEmitterOptions.md)\> | `undefined` | `TypeEmitter.emitter` | ## Methods @@ -53,7 +53,7 @@ private #applyConstraints(type, schema): void | Parameter | Type | | :------ | :------ | -| `type` | \| `Scalar` \| `ModelProperty` \| `Model` \| `Enum` \| `Union` | +| `type` | \| `Enum` \| `Model` \| `ModelProperty` \| `Scalar` \| `Union` \| `UnionVariant` | | `schema` | `ObjectBuilder`<`unknown`\> | #### Returns @@ -97,6 +97,24 @@ private #fileExtension(): "json" | "yaml" *** +### #finalizeSourceFileContent() + +```ts +private #finalizeSourceFileContent(sourceFile): Record +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `sourceFile` | `SourceFile`<`object`\> | + +#### Returns + +`Record`<`string`, `any`\> + +*** + ### #getCurrentSourceFile() ```ts @@ -147,10 +165,34 @@ private #getDefaultValue(type, defaultType): any *** +### #getRootSchemaProps() + +```ts +private #getRootSchemaProps(type, name): object +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | +| `name` | `string` | + +#### Returns + +`object` + +| Member | Type | Value | +| :------ | :------ | :------ | +| `$id` | `string` | ... | +| `$schema` | `string` | "https://json-schema.org/draft/2020-12/schema" | + +*** + ### #getSchemaForScalar() ```ts -private #getSchemaForScalar(scalar): Object +private #getSchemaForScalar(scalar): object ``` #### Parameters @@ -161,14 +203,14 @@ private #getSchemaForScalar(scalar): Object #### Returns -`Object` +`object` *** ### #getSchemaForStdScalars() ```ts -private #getSchemaForStdScalars(baseBuiltIn): Object | Object | Object | Object +private #getSchemaForStdScalars(baseBuiltIn): object | object | object | object ``` #### Parameters @@ -179,7 +221,30 @@ private #getSchemaForStdScalars(baseBuiltIn): Object | Object | Object | Object #### Returns -`Object` \| `Object` \| `Object` \| `Object` +`object` \| `object` \| `object` \| `object` + +*** + +### #initializeSchema() + +```ts +private #initializeSchema( + type, + name, +props): ObjectBuilder +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | +| `name` | `string` | +| `props` | `Record`<`string`, `unknown`\> | + +#### Returns + +`ObjectBuilder`<`unknown`\> *** @@ -204,7 +269,7 @@ private #isStdType(type): boolean ### #newFileScope() ```ts -private #newFileScope(type): Object +private #newFileScope(type): object ``` #### Parameters @@ -215,7 +280,7 @@ private #newFileScope(type): Object #### Returns -`Object` +`object` | Member | Type | Value | | :------ | :------ | :------ | @@ -253,6 +318,42 @@ private #requiredModelProperties(model): undefined | string[] *** +### #serializeSourceFileContent() + +```ts +private #serializeSourceFileContent(content): string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `content` | `Record`<`string`, `any`\> | + +#### Returns + +`string` + +*** + +### #shouldEmitRootSchema() + +```ts +private #shouldEmitRootSchema(type): boolean +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | + +#### Returns + +`boolean` + +*** + ### #trackId() ```ts @@ -608,7 +709,7 @@ enumMember(member): EmitterOutput> ### enumMemberContext() ```ts -enumMemberContext(member): Object +enumMemberContext(member): object ``` #### Parameters @@ -619,7 +720,7 @@ enumMemberContext(member): Object #### Returns -`Object` +`object` #### Inherited from @@ -1644,17 +1745,23 @@ operationReturnTypeReferenceContext(operation, returnType): Context programContext(program): Context ``` +Context shared by the entire program. In cases where you are emitting to a +single file, use this method to establish your main source file and set the +`scope` property to that source file's `globalScope`. + #### Parameters -| Parameter | Type | -| :------ | :------ | -| `program` | `Program` | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | `Program` | | #### Returns `Context` -#### Overrides +Context + +#### Inherited from `TypeEmitter.programContext` diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$baseUri.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$baseUri.md index 119e6ad7008..8f234ca4916 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$baseUri.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$baseUri.md @@ -4,7 +4,7 @@ title: "[F] $baseUri" --- ```ts -$baseUri( +function $baseUri( context, target, baseUri): void diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contains.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contains.md index d006f08daca..d5484c18607 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contains.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contains.md @@ -4,7 +4,7 @@ title: "[F] $contains" --- ```ts -$contains( +function $contains( context, target, value): void diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentEncoding.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentEncoding.md index 899fe9e0164..4d0b4ec5587 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentEncoding.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentEncoding.md @@ -4,7 +4,7 @@ title: "[F] $contentEncoding" --- ```ts -$contentEncoding( +function $contentEncoding( context, target, value): void @@ -15,7 +15,7 @@ $contentEncoding( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Scalar` \| `ModelProperty` | +| `target` | `ModelProperty` \| `Scalar` | | `value` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentMediaType.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentMediaType.md index 8b0e86d5c11..75398e2f1bc 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentMediaType.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentMediaType.md @@ -4,7 +4,7 @@ title: "[F] $contentMediaType" --- ```ts -$contentMediaType( +function $contentMediaType( context, target, value): void @@ -15,7 +15,7 @@ $contentMediaType( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Scalar` \| `ModelProperty` | +| `target` | `ModelProperty` \| `Scalar` | | `value` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentSchema.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentSchema.md index d22ee477e1a..0eda2dfb77b 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentSchema.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$contentSchema.md @@ -4,7 +4,7 @@ title: "[F] $contentSchema" --- ```ts -$contentSchema( +function $contentSchema( context, target, value): void @@ -15,7 +15,7 @@ $contentSchema( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Scalar` \| `ModelProperty` | +| `target` | `ModelProperty` \| `Scalar` | | `value` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$extension.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$extension.md index b281f98f46e..81a4882c384 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$extension.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$extension.md @@ -4,7 +4,7 @@ title: "[F] $extension" --- ```ts -$extension( +function $extension( context, target, key, diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$id.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$id.md index c649d211720..7703e347bac 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$id.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$id.md @@ -4,7 +4,7 @@ title: "[F] $id" --- ```ts -$id( +function $id( context, target, id): void diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$jsonSchema.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$jsonSchema.md index 7f06cffe04c..a5ae169a388 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$jsonSchema.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$jsonSchema.md @@ -4,7 +4,7 @@ title: "[F] $jsonSchema" --- ```ts -$jsonSchema( +function $jsonSchema( context, target, baseUri?): void diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxContains.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxContains.md index 112a0a5ac5d..9a4708a79ef 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxContains.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxContains.md @@ -4,7 +4,7 @@ title: "[F] $maxContains" --- ```ts -$maxContains( +function $maxContains( context, target, value): void diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxProperties.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxProperties.md index ad327097279..6c56d5a7142 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxProperties.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$maxProperties.md @@ -4,7 +4,7 @@ title: "[F] $maxProperties" --- ```ts -$maxProperties( +function $maxProperties( context, target, value): void diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minContains.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minContains.md index 44074e3dce1..169a7b9f652 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minContains.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minContains.md @@ -4,7 +4,7 @@ title: "[F] $minContains" --- ```ts -$minContains( +function $minContains( context, target, value): void diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minProperties.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minProperties.md index 43447639346..9be6c745af2 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minProperties.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$minProperties.md @@ -4,7 +4,7 @@ title: "[F] $minProperties" --- ```ts -$minProperties( +function $minProperties( context, target, value): void diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$multipleOf.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$multipleOf.md index 11fad245a70..4270c0306e4 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$multipleOf.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$multipleOf.md @@ -4,7 +4,7 @@ title: "[F] $multipleOf" --- ```ts -$multipleOf( +function $multipleOf( context, target, value): void @@ -15,8 +15,8 @@ $multipleOf( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Scalar` \| `ModelProperty` | -| `value` | `number` | +| `target` | `ModelProperty` \| `Scalar` | +| `value` | `Numeric` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$onEmit.md index 34fd56356c6..c46bfb3a8b7 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$onEmit.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$onEmit.md @@ -4,7 +4,7 @@ title: "[F] $onEmit" --- ```ts -$onEmit(context): Promise +function $onEmit(context): Promise ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$oneOf.md similarity index 58% rename from packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md rename to packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$oneOf.md index bdd2d0b1300..832826d15b2 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$oneOf.md @@ -1,10 +1,10 @@ --- jsApi: true -title: "[F] $message" +title: "[F] $oneOf" --- ```ts -$message(context, target): void +function $oneOf(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $message(context, target): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Type` | +| `target` | `ModelProperty` \| `Union` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$prefixItems.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$prefixItems.md index 5242fd4c677..515d72544c7 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$prefixItems.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$prefixItems.md @@ -4,7 +4,7 @@ title: "[F] $prefixItems" --- ```ts -$prefixItems( +function $prefixItems( context, target, value): void diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$uniqueItems.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$uniqueItems.md index 20481689b12..5ab84ce2aa4 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$uniqueItems.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$uniqueItems.md @@ -4,7 +4,7 @@ title: "[F] $uniqueItems" --- ```ts -$uniqueItems(context, target): void +function $uniqueItems(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$validatesRawJson.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$validatesRawJson.md index 3ab8854606a..5fc01f02377 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$validatesRawJson.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$validatesRawJson.md @@ -4,7 +4,7 @@ title: "[F] $validatesRawJson" --- ```ts -$validatesRawJson( +function $validatesRawJson( context, target, value): void diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/findBaseUri.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/findBaseUri.md index 2874a653ddf..28feb6c1351 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/findBaseUri.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/findBaseUri.md @@ -4,7 +4,7 @@ title: "[F] findBaseUri" --- ```ts -findBaseUri(program, target): string | undefined +function findBaseUri(program, target): string | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getBaseUri.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getBaseUri.md index c94f6620057..f074f6cd825 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getBaseUri.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getBaseUri.md @@ -4,7 +4,7 @@ title: "[F] getBaseUri" --- ```ts -getBaseUri(program, target): any +function getBaseUri(program, target): any ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContains.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContains.md index b0da5ad87f0..181cc360570 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContains.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContains.md @@ -4,7 +4,7 @@ title: "[F] getContains" --- ```ts -getContains(program, target): any +function getContains(program, target): any ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentEncoding.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentEncoding.md index daaac1ade3e..28386f05ae4 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentEncoding.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentEncoding.md @@ -4,7 +4,7 @@ title: "[F] getContentEncoding" --- ```ts -getContentEncoding(program, target): string +function getContentEncoding(program, target): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentMediaType.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentMediaType.md index a3e3c8a6c04..eb09e51319c 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentMediaType.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentMediaType.md @@ -4,7 +4,7 @@ title: "[F] getContentMediaType" --- ```ts -getContentMediaType(program, target): string +function getContentMediaType(program, target): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentSchema.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentSchema.md index 52c63e3751c..dc5caf3438e 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentSchema.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getContentSchema.md @@ -4,7 +4,7 @@ title: "[F] getContentSchema" --- ```ts -getContentSchema(program, target): any +function getContentSchema(program, target): any ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getExtensions.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getExtensions.md index 36a2585205d..b3839c561a8 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getExtensions.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getExtensions.md @@ -4,7 +4,7 @@ title: "[F] getExtensions" --- ```ts -getExtensions(program, target): ExtensionRecord[] +function getExtensions(program, target): ExtensionRecord[] ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getId.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getId.md index c1a7a41f977..96eb2ddd191 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getId.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getId.md @@ -4,7 +4,7 @@ title: "[F] getId" --- ```ts -getId(program, target): any +function getId(program, target): any ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchema.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchema.md index d08e1edf471..c55fd50a1f8 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchema.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchema.md @@ -4,7 +4,7 @@ title: "[F] getJsonSchema" --- ```ts -getJsonSchema(program, target): boolean +function getJsonSchema(program, target): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchemaTypes.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchemaTypes.md index 1d0453f6163..f0e50e58eff 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchemaTypes.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getJsonSchemaTypes.md @@ -4,7 +4,7 @@ title: "[F] getJsonSchemaTypes" --- ```ts -getJsonSchemaTypes(program): (Namespace | Model)[] +function getJsonSchemaTypes(program): (Namespace | Model)[] ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxContains.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxContains.md index 1444d483123..ebdaf963822 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxContains.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxContains.md @@ -4,7 +4,7 @@ title: "[F] getMaxContains" --- ```ts -getMaxContains(program, target): any +function getMaxContains(program, target): any ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxProperties.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxProperties.md index d00b87352ec..ffe2b13e0ed 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxProperties.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMaxProperties.md @@ -4,7 +4,7 @@ title: "[F] getMaxProperties" --- ```ts -getMaxProperties(program, target): any +function getMaxProperties(program, target): any ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinContains.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinContains.md index 84ee972bfde..655d1719312 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinContains.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinContains.md @@ -4,7 +4,7 @@ title: "[F] getMinContains" --- ```ts -getMinContains(program, target): any +function getMinContains(program, target): any ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinProperties.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinProperties.md index 6c748548e22..d1503e2cd10 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinProperties.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMinProperties.md @@ -4,7 +4,7 @@ title: "[F] getMinProperties" --- ```ts -getMinProperties(program, target): any +function getMinProperties(program, target): any ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOf.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOf.md index 1c0a704b15c..d71713148bc 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOf.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOf.md @@ -4,7 +4,7 @@ title: "[F] getMultipleOf" --- ```ts -getMultipleOf(program, target): any +function getMultipleOf(program, target): number | undefined ``` ## Parameters @@ -16,4 +16,4 @@ getMultipleOf(program, target): any ## Returns -`any` +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOfAsNumeric.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOfAsNumeric.md new file mode 100644 index 00000000000..5858be8acc3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getMultipleOfAsNumeric.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMultipleOfAsNumeric" + +--- +```ts +function getMultipleOfAsNumeric(program, target): Numeric | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Type` | + +## Returns + +`Numeric` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getPrefixItems.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getPrefixItems.md index 0e6407ad2f7..2255917a927 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getPrefixItems.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getPrefixItems.md @@ -4,7 +4,7 @@ title: "[F] getPrefixItems" --- ```ts -getPrefixItems(program, target): Tuple | undefined +function getPrefixItems(program, target): Tuple | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getUniqueItems.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getUniqueItems.md index 1de081729cc..7e635d44b3c 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getUniqueItems.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/getUniqueItems.md @@ -4,7 +4,7 @@ title: "[F] getUniqueItems" --- ```ts -getUniqueItems(program, target): any +function getUniqueItems(program, target): any ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md index 2b0058ce04c..18fdb24b319 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isJsonSchemaDeclaration.md @@ -4,7 +4,7 @@ title: "[F] isJsonSchemaDeclaration" --- ```ts -isJsonSchemaDeclaration(program, target): boolean +function isJsonSchemaDeclaration(program, target): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isOneOf.md similarity index 56% rename from packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md rename to packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isOneOf.md index 54dfb225020..5ddb0ed4186 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isOneOf.md @@ -1,20 +1,19 @@ --- jsApi: true -title: "[F] $onValidate" +title: "[F] isOneOf" --- ```ts -$onValidate(program): Promise +function isOneOf(program, target): boolean ``` -Validation function - ## Parameters | Parameter | Type | | :------ | :------ | | `program` | `Program` | +| `target` | `Type` | ## Returns -`Promise`<`void`\> +`boolean` diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/index.md index d08bd3368b6..bbaab5b47d3 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/index.md @@ -18,6 +18,7 @@ title: "[P] JS API" ## Variables +- [$flags](variables/$flags.md) - [$lib](variables/$lib.md) - [EmitterOptionsSchema](variables/EmitterOptionsSchema.md) - [namespace](variables/namespace.md) @@ -38,6 +39,7 @@ title: "[P] JS API" - [$minProperties](functions/$minProperties.md) - [$multipleOf](functions/$multipleOf.md) - [$onEmit](functions/$onEmit.md) +- [$oneOf](functions/$oneOf.md) - [$prefixItems](functions/$prefixItems.md) - [$uniqueItems](functions/$uniqueItems.md) - [$validatesRawJson](functions/$validatesRawJson.md) @@ -56,6 +58,8 @@ title: "[P] JS API" - [getMinContains](functions/getMinContains.md) - [getMinProperties](functions/getMinProperties.md) - [getMultipleOf](functions/getMultipleOf.md) +- [getMultipleOfAsNumeric](functions/getMultipleOfAsNumeric.md) - [getPrefixItems](functions/getPrefixItems.md) - [getUniqueItems](functions/getUniqueItems.md) - [isJsonSchemaDeclaration](functions/isJsonSchemaDeclaration.md) +- [isOneOf](functions/isOneOf.md) diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md index ebe07c899cc..394f0e2a63c 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/interfaces/JSONSchemaEmitterOptions.md @@ -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/emitters/json-schema/reference/js-api/variables/$flags.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/variables/$flags.md new file mode 100644 index 00000000000..a26ed5d9953 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/variables/$flags.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] $flags" + +--- +```ts +const $flags: PackageFlags; +``` diff --git a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/variables/$lib.md index 9a947919d3e..7e37857aaba 100644 --- a/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/variables/$lib.md @@ -4,16 +4,16 @@ title: "[V] $lib" --- ```ts -const $lib: TypeSpecLibrary; +const $lib: TypeSpecLibrary; ``` ## Type declaration | Member | Type | Value | | :------ | :------ | :------ | -| `duplicate-id` | `Object` | - | -| `duplicate-id.default` | `CallableMessage`<[`"id"`]\> | - | -| `invalid-default` | `Object` | - | -| `invalid-default.default` | `CallableMessage`<[`"type"`]\> | - | -| `unknown-scalar` | `Object` | - | -| `unknown-scalar.default` | `CallableMessage`<[`"name"`]\> | - | +| `duplicate-id` | `object` | ... | +| `duplicate-id.default` | `CallableMessage`<[`string`]\> | ... | +| `invalid-default` | `object` | ... | +| `invalid-default.default` | `CallableMessage`<[`string`]\> | ... | +| `unknown-scalar` | `object` | ... | +| `unknown-scalar.default` | `CallableMessage`<[`string`]\> | ... | diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$onEmit.md index 1ea0af454d4..4a527d7cdfe 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$onEmit.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$onEmit.md @@ -4,7 +4,7 @@ title: "[F] $onEmit" --- ```ts -$onEmit(context): Promise +function $onEmit(context): Promise ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$oneOf.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$oneOf.md index b87337b5f94..832826d15b2 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$oneOf.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$oneOf.md @@ -4,7 +4,7 @@ title: "[F] $oneOf" --- ```ts -$oneOf(context, target): void +function $oneOf(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$useRef.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$useRef.md index c68f4060082..497a2e7f0ec 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$useRef.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/$useRef.md @@ -4,7 +4,7 @@ title: "[F] $useRef" --- ```ts -$useRef( +function $useRef( context, target, ref): void @@ -15,7 +15,7 @@ $useRef( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `ModelProperty` \| `Model` | +| `target` | `Model` \| `ModelProperty` | | `ref` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOneOf.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOneOf.md index 3f4d7270426..09cafaf08a3 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOneOf.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOneOf.md @@ -4,7 +4,7 @@ title: "[F] getOneOf" --- ```ts -getOneOf(program, entity): boolean +function getOneOf(program, entity): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOpenAPI3.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOpenAPI3.md index df558647f88..ce97cdc22bf 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOpenAPI3.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getOpenAPI3.md @@ -4,7 +4,7 @@ title: "[F] getOpenAPI3" --- ```ts -getOpenAPI3(program, options): Promise +function getOpenAPI3(program, options): Promise ``` Get the OpenAPI 3 document records from the given program. The documents are diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getRef.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getRef.md index 20ad7ec6488..a8d8f611d3f 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getRef.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/getRef.md @@ -4,7 +4,7 @@ title: "[F] getRef" --- ```ts -getRef(program, entity): string | undefined +function getRef(program, entity): string | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/resolveOptions.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/resolveOptions.md index c1a2aa96e04..b0c7b783b86 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/resolveOptions.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/functions/resolveOptions.md @@ -4,7 +4,7 @@ title: "[F] resolveOptions" --- ```ts -resolveOptions(context): ResolvedOpenAPI3EmitterOptions +function resolveOptions(context): ResolvedOpenAPI3EmitterOptions ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md index 5b54375a74e..00430970aff 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md @@ -4,44 +4,44 @@ title: "[V] $lib" --- ```ts -const $lib: TypeSpecLibrary; +const $lib: TypeSpecLibrary; ``` ## Type declaration | Member | Type | Value | | :------ | :------ | :------ | -| `duplicate-header` | `Object` | - | -| `duplicate-header.default` | `CallableMessage`<[`"header"`]\> | - | -| `empty-enum` | `Object` | - | +| `duplicate-header` | `object` | ... | +| `duplicate-header.default` | `CallableMessage`<[`"header"`]\> | ... | +| `empty-enum` | `object` | ... | | `empty-enum.default` | `"Empty enums are not supported for OpenAPI v3 - enums must have at least one value."` | "Empty enums are not supported for OpenAPI v3 - enums must have at least one value." | -| `empty-union` | `Object` | - | +| `empty-union` | `object` | ... | | `empty-union.default` | `"Empty unions are not supported for OpenAPI v3 - enums must have at least one value."` | "Empty unions are not supported for OpenAPI v3 - enums must have at least one value." | -| `enum-unique-type` | `Object` | - | +| `enum-unique-type` | `object` | ... | | `enum-unique-type.default` | `"Enums are not supported unless all options are literals of the same type."` | "Enums are not supported unless all options are literals of the same type." | -| `inconsistent-shared-route-request-visibility` | `Object` | - | +| `inconsistent-shared-route-request-visibility` | `object` | ... | | `inconsistent-shared-route-request-visibility.default` | "All operations with \`@sharedRoutes\` must have the same \`@requestVisibility\`." | "All operations with \`@sharedRoutes\` must have the same \`@requestVisibility\`." | -| `inline-cycle` | `Object` | - | -| `inline-cycle.default` | `CallableMessage`<[`"type"`]\> | - | -| `invalid-default` | `Object` | - | -| `invalid-default.default` | `CallableMessage`<[`"type"`]\> | - | -| `invalid-format` | `Object` | - | -| `invalid-format.default` | `CallableMessage`<[`"value"`, `"paramType"`]\> | - | -| `invalid-schema` | `Object` | - | -| `invalid-schema.default` | `CallableMessage`<[`"type"`]\> | - | -| `invalid-server-variable` | `Object` | - | -| `invalid-server-variable.default` | `CallableMessage`<[`"propName"`]\> | - | -| `oneof-union` | `Object` | - | +| `inline-cycle` | `object` | ... | +| `inline-cycle.default` | `CallableMessage`<[`"type"`]\> | ... | +| `invalid-default` | `object` | ... | +| `invalid-default.default` | `CallableMessage`<[`"type"`]\> | ... | +| `invalid-format` | `object` | ... | +| `invalid-format.default` | `CallableMessage`<[`"value"`, `"paramType"`]\> | ... | +| `invalid-schema` | `object` | ... | +| `invalid-schema.default` | `CallableMessage`<[`"type"`]\> | ... | +| `invalid-server-variable` | `object` | ... | +| `invalid-server-variable.default` | `CallableMessage`<[`"propName"`]\> | ... | +| `oneof-union` | `object` | ... | | `oneof-union.default` | `"@oneOf decorator can only be used on a union or a model property which type is a union."` | "@oneOf decorator can only be used on a union or a model property which type is a union." | -| `path-query` | `Object` | - | -| `path-query.default` | `"OpenAPI does not allow paths containing a query string."` | - | -| `resource-namespace` | `Object` | - | +| `path-query` | `object` | ... | +| `path-query.default` | `"OpenAPI does not allow paths containing a query string."` | ... | +| `resource-namespace` | `object` | ... | | `resource-namespace.default` | `"Resource goes on namespace"` | "Resource goes on namespace" | -| `status-code-in-default-response` | `Object` | - | +| `status-code-in-default-response` | `object` | ... | | `status-code-in-default-response.default` | `"a default response should not have an explicit status code"` | "a default response should not have an explicit status code" | -| `union-null` | `Object` | - | +| `union-null` | `object` | ... | | `union-null.default` | `"Cannot have a union containing only null types."` | "Cannot have a union containing only null types." | -| `unsupported-auth` | `Object` | - | -| `unsupported-auth.default` | `CallableMessage`<[`"authType"`]\> | - | -| `unsupported-status-code-range` | `Object` | - | -| `unsupported-status-code-range.default` | `CallableMessage`<[`"start"`, `"end"`]\> | - | +| `unsupported-auth` | `object` | ... | +| `unsupported-auth.default` | `CallableMessage`<[`"authType"`]\> | ... | +| `unsupported-status-code-range` | `object` | ... | +| `unsupported-status-code-range.default` | `CallableMessage`<[`"start"`, `"end"`]\> | ... | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md deleted file mode 100644 index ec81e55e26d..00000000000 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] $externRef" - ---- -```ts -$externRef( - ctx, - target, - path, - name): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `ctx` | `DecoratorContext` | -| `target` | `Model` | -| `path` | `StringLiteral` | -| `name` | `StringLiteral` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md deleted file mode 100644 index c12164c1c31..00000000000 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] $field" - ---- -```ts -$field( - context, - target, - index): void -``` - -Decorate a model property with a field index. Field indices are required for all fields of emitted messages. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `context` | `DecoratorContext` | - | -| `target` | `ModelProperty` | | -| `index` | `number` | - | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md deleted file mode 100644 index e8aecc7c093..00000000000 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[F] $onEmit" - ---- -```ts -$onEmit(ctx): Promise -``` - -Emitter main function. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `ctx` | `EmitContext`<`ProtobufEmitterOptions`\> | - -## Returns - -`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md deleted file mode 100644 index e5106863b53..00000000000 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] $package" - ---- -```ts -$package( - context, - target, - details?): void -``` - -Declare a Protobuf package. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `context` | `DecoratorContext` | - | -| `target` | `Namespace` | target decorator namespace | -| `details`? | `Type` | - | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md deleted file mode 100644 index c16acc6e4c0..00000000000 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $reserve" - ---- -```ts -$reserve( - context, - target, ... - reservations): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | `DecoratorContext` | -| `target` | `Type` | -| ...`reservations` | `unknown`[] | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md deleted file mode 100644 index 3f35f2324f9..00000000000 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] $service" - ---- -```ts -$service(ctx, target): void -``` - -Decorate an interface as a service, indicating that it represents a Protobuf `service` declaration. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `ctx` | `DecoratorContext` | decorator context | -| `target` | `Interface` | the decorated interface | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md deleted file mode 100644 index 6708926d078..00000000000 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] isMap" - ---- -```ts -isMap(program, m): boolean -``` - -Determines whether a type represents a Protobuf map. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | `Program` | the program context | -| `m` | `Type` | the type to test | - -## 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/emitters/protobuf/reference/js-api/type-aliases/Reservation.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/type-aliases/Reservation.md index 6fafc3e0f6f..22298fc322a 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/type-aliases/Reservation.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/type-aliases/Reservation.md @@ -4,5 +4,5 @@ title: "[T] Reservation" --- ```ts -type Reservation: string | number | [number, number] & Object; +type Reservation: string | number | [number, number] & object; ``` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/variables/$lib.md index 5728b943f6b..b94a11578d9 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/variables/$lib.md @@ -4,54 +4,54 @@ title: "[V] $lib" --- ```ts -const $lib: TypeSpecLibrary = TypeSpecProtobufLibrary; +const $lib: TypeSpecLibrary = TypeSpecProtobufLibrary; ``` ## Type declaration | Member | Type | Value | | :------ | :------ | :------ | -| `anonymous-model` | `Object` | - | +| `anonymous-model` | `object` | ... | | `anonymous-model.default` | `string` | "anonymous models cannot be used in Protobuf messages" | -| `field-index` | `Object` | - | -| `field-index.invalid` | `CallableMessage`<[`string`]\> | - | -| `field-index.missing` | `CallableMessage`<[`string`]\> | - | -| `field-index.out-of-bounds` | `CallableMessage`<[`string`, `string`]\> | - | -| `field-index.reserved` | `CallableMessage`<[`string`]\> | - | -| `field-index.user-reserved` | `CallableMessage`<[`string`]\> | - | -| `field-index.user-reserved-range` | `CallableMessage`<[`string`]\> | - | -| `field-name` | `Object` | - | -| `field-name.user-reserved` | `CallableMessage`<[`string`]\> | - | -| `illegal-reservation` | `Object` | - | +| `field-index` | `object` | ... | +| `field-index.invalid` | `CallableMessage`<[`string`]\> | ... | +| `field-index.missing` | `CallableMessage`<[`string`]\> | ... | +| `field-index.out-of-bounds` | `CallableMessage`<[`string`, `string`]\> | ... | +| `field-index.reserved` | `CallableMessage`<[`string`]\> | ... | +| `field-index.user-reserved` | `CallableMessage`<[`string`]\> | ... | +| `field-index.user-reserved-range` | `CallableMessage`<[`string`]\> | ... | +| `field-name` | `object` | ... | +| `field-name.user-reserved` | `CallableMessage`<[`string`]\> | ... | +| `illegal-reservation` | `object` | ... | | `illegal-reservation.default` | `string` | "reservation value must be a string literal, uint32 literal, or a tuple of two uint32 literals denoting a range" | -| `invalid-package-name` | `Object` | - | -| `invalid-package-name.default` | `CallableMessage`<[`string`]\> | - | -| `model-not-in-package` | `Object` | - | -| `model-not-in-package.default` | `CallableMessage`<[`string`]\> | - | -| `namespace-collision` | `Object` | - | -| `namespace-collision.default` | `CallableMessage`<[`string`]\> | - | -| `nested-array` | `Object` | - | +| `invalid-package-name` | `object` | ... | +| `invalid-package-name.default` | `CallableMessage`<[`string`]\> | ... | +| `model-not-in-package` | `object` | ... | +| `model-not-in-package.default` | `CallableMessage`<[`string`]\> | ... | +| `namespace-collision` | `object` | ... | +| `namespace-collision.default` | `CallableMessage`<[`string`]\> | ... | +| `nested-array` | `object` | ... | | `nested-array.default` | `string` | "nested arrays are not supported by the Protobuf emitter" | -| `package` | `Object` | - | -| `package.disallowed-option-type` | `CallableMessage`<[`string`, `string`]\> | - | -| `root-operation` | `Object` | - | +| `package` | `object` | ... | +| `package.disallowed-option-type` | `CallableMessage`<[`string`, `string`]\> | ... | +| `root-operation` | `object` | ... | | `root-operation.default` | `string` | "operations in the root namespace are not supported (no associated Protobuf service)" | -| `unconvertible-enum` | `Object` | - | +| `unconvertible-enum` | `object` | ... | | `unconvertible-enum.default` | `string` | "enums must explicitly assign exactly one integer to each member to be used in a Protobuf message" | | `unconvertible-enum.no-zero-first` | `string` | "the first variant of an enum must be set to zero to be used in a Protobuf message" | -| `unspeakable-template-argument` | `Object` | - | -| `unspeakable-template-argument.default` | `CallableMessage`<[`string`]\> | - | -| `unsupported-field-type` | `Object` | - | +| `unspeakable-template-argument` | `object` | ... | +| `unspeakable-template-argument.default` | `CallableMessage`<[`string`]\> | ... | +| `unsupported-field-type` | `object` | ... | | `unsupported-field-type.recursive-map` | `string` | "a protobuf map's 'value' type may not refer to another map" | -| `unsupported-field-type.unconvertible` | `CallableMessage`<[`string`]\> | - | +| `unsupported-field-type.unconvertible` | `CallableMessage`<[`string`]\> | ... | | `unsupported-field-type.union` | `string` | "a message field's type may not be a union" | -| `unsupported-field-type.unknown-intrinsic` | `CallableMessage`<[`string`]\> | - | -| `unsupported-field-type.unknown-scalar` | `CallableMessage`<[`string`]\> | - | -| `unsupported-input-type` | `Object` | - | +| `unsupported-field-type.unknown-intrinsic` | `CallableMessage`<[`string`]\> | ... | +| `unsupported-field-type.unknown-scalar` | `CallableMessage`<[`string`]\> | ... | +| `unsupported-input-type` | `object` | ... | | `unsupported-input-type.unconvertible` | `string` | "input parameters cannot be converted to a Protobuf message" | | `unsupported-input-type.wrong-number` | `string` | "Protobuf methods must accept exactly one Model input (an empty model will do)" | | `unsupported-input-type.wrong-type` | `string` | "Protobuf methods may only accept a named Model as an input" | -| `unsupported-intrinsic` | `Object` | - | -| `unsupported-intrinsic.default` | `CallableMessage`<[`string`]\> | - | -| `unsupported-return-type` | `Object` | - | +| `unsupported-intrinsic` | `object` | ... | +| `unsupported-intrinsic.default` | `CallableMessage`<[`string`]\> | ... | +| `unsupported-return-type` | `object` | ... | | `unsupported-return-type.default` | `string` | "Protobuf methods must return a named Model" | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/variables/PROTO_FULL_IDENT.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/variables/PROTO_FULL_IDENT.md index 43dd276bb55..99c17b6e908 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/variables/PROTO_FULL_IDENT.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/variables/PROTO_FULL_IDENT.md @@ -9,5 +9,5 @@ const PROTO_FULL_IDENT: RegExp; Defined in the [ProtoBuf Language Spec](https://developers.google.com/protocol-buffers/docs/reference/proto3-spec#identifiers). -ident = letter \{ letter | decimalDigit | "_" \} -fullIdent = ident \{ "." ident \} +ident = letter { letter | decimalDigit | "_" } +fullIdent = ident { "." ident } 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 6928722ab7b..af1c7494882 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/basics.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/basics.md @@ -106,7 +106,7 @@ Open `./src/lib.ts` and create your library definition that registers your libra If `$lib` is not accessible from your library package (for example, `import {$lib} from "my-library";`), some features such as linting and emitter option validation will not be available. ::: -Here's an example: +For example: ```typescript import { createTypeSpecLibrary } from "@typespec/compiler"; @@ -122,7 +122,19 @@ export const { reportDiagnostic, createDiagnostic } = $lib; Diagnostics are used for linters and decorators, which are covered in subsequent topics. -### f. Create `index.ts` +### f. Set package flags + +You can optionally set any package flags by exporting a `$flags` const that is initialized with the `definePackageFlags`. Like `$lib`, this value must be exported from your package. + +It is strongly recommended to set `valueMarshalling` to `"new"` as this will be the default behavior in future TypeSpec versions. + +```typescript +export const $flags = definePackageFlags({ + valueMarshalling: "new", +}); +``` + +### g. Create `index.ts` Open `./src/index.ts` and import your library definition: @@ -131,7 +143,7 @@ Open `./src/index.ts` and import your library definition: export { $lib } from "./lib.js"; ``` -### g. Build TypeScript +### h. Build TypeScript TypeSpec can only import JavaScript files, so any changes made to TypeScript sources need to be compiled before they are visible to TypeSpec. To do this, run `npx tsc -p .` in your library's root directory. If you want to re-run the TypeScript compiler whenever files are changed, you can run `npx tsc -p . --watch`. @@ -148,7 +160,7 @@ Alternatively, you can add these as scripts in your `package.json` to make them You can then run `npm run build` or `npm run watch` to build or watch your library. -### h. Add your main TypeSpec file +### i. Add your main TypeSpec file Open `./lib/main.tsp` and import your JS entrypoint. This ensures that when TypeSpec imports your library, the code to define the library is run. When we add decorators in later topics, this import will ensure those get exposed as well. diff --git a/packages/website/versioned_docs/version-latest/extending-typespec/create-decorators.md b/packages/website/versioned_docs/version-latest/extending-typespec/create-decorators.md index 717c917f1e1..c4d5275e014 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/create-decorators.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/create-decorators.md @@ -35,7 +35,7 @@ using TypeSpec.Reflection; extern dec track(target: Model | Enum); ``` -### Optional parameters +## Optional parameters You can mark a decorator parameter as optional using `?`. @@ -43,7 +43,7 @@ You can mark a decorator parameter as optional using `?`. extern dec track(target: Model | Enum, name?: valueof string); ``` -### Rest parameters +## Rest parameters You can prefix the last parameter of a decorator with `...` to collect all the remaining arguments. The type of this parameter must be an `array expression`. @@ -51,28 +51,25 @@ You can prefix the last parameter of a decorator with `...` to collect all the r extern dec track(target: Model | Enum, ...names: valueof string[]); ``` -## Requesting a value type +## Value parameters -It's common for decorator parameters to expect a value (e.g., a string or a number). However, using `: string` as the type would also allow a user of the decorator to pass `string` itself or a custom scalar extending string, as well as a union of strings. Instead, the decorator can use `valueof ` to specify that it expects a value of that kind. - -| Example | Description | -| ----------------- | ----------------- | -| `valueof string` | Expects a string | -| `valueof float64` | Expects a float | -| `valueof int32` | Expects a number | -| `valueof boolean` | Expects a boolean | +A decorator parameter can receive [values](../language-basics/values.md) by using the `valueof` operator. For example the parameter `valueof string` expects a string value. Values are provided to the decorator implementation according the [decorator parameter marshalling](#decorator-parameter-marshalling) rules. ```tsp extern dec tag(target: unknown, value: valueof string); -// bad +// error: string is not a value @tag(string) -// good -@tag("This is the tag name") +// ok, a string literal can be a value +@tag("widgets") + +// ok, passing a value from a const +const tagName: string = "widgets"; +@tag(tagName) ``` -## Implement the decorator in JavaScript +## JavaScript decorator implementation Decorators can be implemented in JavaScript by prefixing the function name with `$`. A decorator function must have the following parameters: @@ -89,7 +86,7 @@ export function $logType(context: DecoratorContext, target: Type, name: valueof } ``` -Or in pure JavaScript: +Or in JavaScript: ```ts // model.js @@ -113,26 +110,35 @@ model Dog { ### Decorator parameter marshalling -For certain TypeSpec types (Literal types), the decorator does not receive the actual type but a marshalled value if the decorator parameter type is a `valueof`. This simplifies the most common cases. +When decorators are passed types, the type is passed as-is. When a decorator is passed a TypeSpec value, the decorator receives a JavaScript value with a type that is appropriate for representing that value. -| TypeSpec Type | Marshalled value in JS | -| ----------------- | ---------------------- | -| `valueof string` | `string` | -| `valueof numeric` | `number` | -| `valueof boolean` | `boolean` | +:::note +This behavior depends on the value of the `valueMarshalling` [package flag](../extending-typespec/basics.md#f-set-package-flags). This section describes the behavior when `valueMarshalling` is set to `"new"`. In a future release this will become the default value marshalling so it is strongly recommended to set this flag. But for now, the default value marshalling is `"legacy"` which is described in the next section. In a future release the `valueMarshalling` flag will need to be set to `"legacy"` to keep the previous marshalling behavior, but the flag will eventually be removed entirely. +::: -For all other types, they are not transformed. +| TypeSpec value type | Marshalled type in JS | +| ------------------- | --------------------------------- | +| `string` | `string` | +| `boolean` | `boolean` | +| `numeric` | `Numeric` or `number` (see below) | +| `null` | `null` | +| enum member | `EnumMemberValue` | -Example: +When marshalling numeric values, either the `Numeric` wrapper type is used, or a `number` is passed directly, depending on whether the value can be represented as a JavaScript number without precision loss. In particular, the types `numeric`, `integer`, `decimal`, `float`, `int64`, `uint64`, and `decimal128` are marshalled as a `Numeric` type. All other numeric types are marshalled as `number`. -```ts -export function $tag( - context: DecoratorContext, - target: Type, - stringArg: string, // Here instead of receiving a `StringLiteral`, the string value is being sent. - modelArg: Model // Model has no special handling so we receive the Model type -) {} -``` +When marshalling custom scalar subtypes, the marshalling behavior of the known supertype is used. For example, a `scalar customScalar extends numeric` will marshal as a `Numeric`, regardless of any value constraints that might be present. + +#### Legacy value marshalling + +With legacy value marshalling, TypeSpec strings, numbers, and booleans values are always marshalled as JS values. All other values are marshalled as their corresponding type. For example, `null` is marshalled as `NullType`. + +| TypeSpec Value Type | Marshalled value in JS | +| ------------------- | ---------------------- | +| `string` | `string` | +| `numeric` | `number` | +| `boolean` | `boolean` | + +Note that with legacy marshalling, because JavaScript numbers have limited range and precision, it is possible to define values in TypeSpec that cannot be accurately represented in JavaScript. #### String templates and marshalling 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 d5dd81272a4..c546c7933db 100644 --- a/packages/website/versioned_docs/version-latest/introduction/editor/vs.md +++ b/packages/website/versioned_docs/version-latest/introduction/editor/vs.md @@ -4,7 +4,7 @@ title: TypeSpec Visual Studio Extension ## Installation -Install the extension via the Visual Studio extension manager from the [TypeSpec for Visual Studio - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=typespec.typespec-vs). +Install the extension via the Visual Studio extension manager from the [TypeSpec for Visual Studio - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=typespec.typespecvs). ## Configure diff --git a/packages/website/versioned_docs/version-latest/language-basics/decorators.md b/packages/website/versioned_docs/version-latest/language-basics/decorators.md index dc8a64dda44..aa57714ad57 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/decorators.md +++ b/packages/website/versioned_docs/version-latest/language-basics/decorators.md @@ -61,4 +61,4 @@ model Dog { ## Creating decorators -_For more information on creating decorators, see the [Creating Decorators Documentation](../extending-typespec/create-decorators.md)._ +For more information on creating decorators, see [Creating Decorators](../extending-typespec/create-decorators.md). diff --git a/packages/website/versioned_docs/version-latest/language-basics/scalars.md b/packages/website/versioned_docs/version-latest/language-basics/scalars.md index 78a5009c8ea..13b295ece8e 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/scalars.md +++ b/packages/website/versioned_docs/version-latest/language-basics/scalars.md @@ -22,9 +22,23 @@ scalar Password extends string; ## Scalars with template parameters -Scalars can also support template parameters. However, it's important to note that these templates are primarily used for decorators. +Scalars can also support template parameters. These template parameters are primarily used for decorators. ```typespec @doc(Type) scalar Unreal; ``` + +## Scalar initializers + +Scalars can be declared with an initializer for creating specific scalar values based on other values. For example: + +```typespec +scalar ipv4 extends string { + init fromInt(value: uint32); +} + +const homeIp = ipv4.fromInt(2130706433); +``` + +Initializers do not have any runtime code associated with them. Instead, they merely record the scalar initializer invoked along with the arguments passed so that emitters can construct the proper value when needed. diff --git a/packages/website/versioned_docs/version-latest/language-basics/templates.md b/packages/website/versioned_docs/version-latest/language-basics/templates.md index 5868f8b554c..857b93de8d7 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/templates.md +++ b/packages/website/versioned_docs/version-latest/language-basics/templates.md @@ -108,3 +108,43 @@ alias Example3 = Test< Since template arguments can be specified by name, the names of template parameters are part of the template's public API. **Renaming a template parameter may break existing specifications that use the template.** **Note**: Template arguments are evaluated in the order the parameters are defined in the template _definition_, not the order in which they are written in the template _instance_. While this is usually inconsequential, it may be important in some cases where evaluating a template argument may trigger decorators with side effects. + +## Templates with values + +Templates can be declared to accept values using a `valueof` constraint. This is useful for providing default values and parameters for decorators that take values. + +```typespec +alias TakesValue = { + @doc(StringValue) + property: StringType; +}; + +alias M1 = TakesValue<"a", "b">; +``` + +When a passing a literal or an enum or union member reference directly as a template parameter that accepts either a type or a value, we pass the value. In particular, `StringTypeOrValue` is a value with the string literal type `"a"`. + +```typespec +alias TakesTypeOrValue = { + @customDecorator(StringOrValue) + property: string; +}; + +alias M1 = TakesValue<"a">; +``` + +The [`typeof` operator](./values.md#the-typeof-operator) can be used to get the declared type of a value if needed. + +### Template parameter value types + +When a template is instantiated with a value, the type of the value and the result of the `typeof` operator is determined based on the argument rather than the template parameter constraint. This follows the same rules as [const declaration type inference](./values.md#const-declarations). In particular, inside the template `TakesValue`, the type of `StringValue` is the string literal type `"b"`. If we passed a `const` instead, the type of the value would be the const's type. In the following example, the type of `property` in `M1` is `"a" | "b"`. + +```typespec +alias TakesValue = { + @doc(StringValue) + property: typeof StringValue; +}; + +const str: "a" | "b" = "a"; +alias M1 = TakesValue; +``` diff --git a/packages/website/versioned_docs/version-latest/language-basics/values.md b/packages/website/versioned_docs/version-latest/language-basics/values.md new file mode 100644 index 00000000000..4bed4774f02 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/language-basics/values.md @@ -0,0 +1,187 @@ +--- +id: values +title: Values +--- + +# Values + +TypeSpec can define values in addition to types. Values are useful in an API description to define default values for types or provide example values. They are also useful when passing data to decorators, and for template parameters that are ultimately passed to decorators or used as default values. + +Values cannot be used as types, and types cannot be used as values, they are completely separate. However, string, number, boolean, and null literals can be either a type or a value depending on context (see also [scalar literals](#scalar-literals)). Additionally, union and enum member references may produce a type or a value depending on context (see also [enum member & union variant references](#enum-member--union-variant-references)). + +## Value kinds + +There are four kinds of values: objects, arrays, scalars. and null. These values can be created with object values, array values, scalar values and initializers, and the null literal respectively. Additionally, values can result from referencing enum members and union variants. + +### Object values + +Object values use the syntax `#{}` and can define any number of properties. For example: + +```typespec +const point = #{ x: 0, y: 0 }; +``` + +The object value's properties must refer to other values. It is an error to reference a type. + +```typespec +const example = #{ + prop1: #{ nested: true }; // ok + prop2: { nested: true }; // error: values can't reference a type + prop3: string; // error: values can't reference a type +} +``` + +### Array values + +Array values use the syntax `#[]` and can define any number of items. For example: + +```typespec +const points = #[#{ x: 0, y: 0 }, #{ x: 1, y: 1 }]; +``` + +As with object values, array values cannot contain types. + +If an array type defines a minimum and maximum size using the `@minValue` and `@maxValue` decorators, the compiler will validate that the array value has the appropriate number of items. For example: + +```typespec +/** Can have at most 2 tags */ +@maxItems(2) +model Tags is Array; + +const exampleTags1: Tags = #["TypeSpec", "JSON"]; // ok +const exampleTags2: Tags = #["TypeSpec", "JSON", "OpenAPI"]; // error +``` + +### Scalar values + +There are two ways to create scalar values: with a literal syntax like `"string value"`, and with a scalar initializer like `utcDateTime.fromISO("2020-12-01T12:00:00Z")`. + +#### Scalar literals + +The literal syntax for strings, numerics, booleans and null can evaluate to either a type or a value depending on the surrounding context of the literal. When the literal is in _type context_ (a model property type, operation return type, alias definition, etc.) the literal becomes a literal type. When the literal is in _value context_ (a default value, property of an object value, const definition, etc.), the literal becomes a value. When the literal is in an _ambiguous context_ (e.g. an argument to a template or decorator that can accept either a type or a value) the literal becomes a value. The `typeof` operator can be used to convert the literal to a type in such ambiguous contexts. + +```typespec +extern dec setNumberValue(target: unknown, color: valueof numeric); +extern dec setNumberType(target: unknown, color: numeric); +extern dec setNumberTypeOrValue(target: unknown, color: numeric | (valueof numeric)); + +@setNumberValue(123) // Passes the scalar value `numeric(123)`. +@setNumberType(123) // Passes the numeric literal type 123. +@setNumberTypeOrValue(123) // passes the scalar value `numeric(123)`. +model A {} +``` + +#### Scalar initializers + +Scalar initializers create scalar values by calling an initializer with one or more values. Scalar initializers for types extended from `numeric`, `string`, and `boolean` are called by adding parenthesis after the scalar reference: + +```typespec +const n = int8(100); +const s = string("hello"); +``` + +Any scalar can additionally be declared with named initializers that take one or more value parameters. For example, `utcDateTime` provides a `fromISO` initializer that takes an ISO string. Named scalars can be declared like so: + +```typespec +scalar ipv4 extends string { + init fromInt(value: uint32); +} + +const ip = ipv4.fromInt(2341230); +``` + +#### Null values + +Null values are created with the `null` literal. + +```typespec +const value: string | null = null; +``` + +The `null` value, like the `null` type, doesn't have any special behavior in the TypeSpec language. It is just the value `null` like that in JSON. + +## Const declarations + +Const declarations allow storing values in a variable for later reference. Const declarations have an optional type annotation. When the type annotation is absent, the type is inferred from the value by constructing an exact type from the initializer. + +```typespec +const stringValue: string = "hello"; +// ^-- type: string + +const oneValue = 1; +// ^-- type: 1 + +const objectValue = #{ x: 0, y: 0 }; +// ^-- type: { x: 0, y: 0 } +``` + +## The `typeof` operator + +The `typeof` operator returns the declared or inferred type of a value reference. Note that the actual value being stored by the referenced variable may be more specific than the declared type of the value. For example, if a const is declared with a union type, the value will only ever store one specific variant at a time, but typeof will give you the declared union type. + +```typespec +const stringValue: string = "hello"; +// typeof stringValue returns `string`. + +const oneValue = 1; +// typeof stringValue returns `1` + +const stringOrOneValue: string | 1 = 1; +// typeof stringOrOneValue returns `string | 1` +``` + +## Validation + +TypeSpec will validate values against built-in validation decorators like `@minLength` and `@maxValue`. + +```typespec +@maxLength(3) +scalar shortString extends string; + +const s1: shortString = "abc"; // ok +const s2: shortString = "abcd"; // error: + +model Entity { + a: shortString; +} + +const e1: Entity = #{ a: "abcd" }; // error +``` + +## Enum member & union variant references + +References to enum members and union variants can be either types or values and follow the same rules as scalar literals. When an enum member reference is in _type context_, the reference becomes an enum member type. When in _value context_ or _ambiguous context_ the reference becomes the enum member's value. + +```typespec +extern dec setColorValue(target: unknown, color: valueof string); +extern dec setColorMember(target: unknown, color: Reflection.EnumMember); + +enum Color { + red, + green, + blue, +} + +@setColorValue(Color.red) // same as passing the literal "red" +@setColorMember(Color.red) // passes the enum member Color.red +model A {} +``` + +When a union variant reference is in _type context_, the reference becomes the type of the union variant. When in _value context_ or _ambiguous context_ the reference becomes the value of the union variant. It is an error to refer to a union variant whose type is not a literal type. + +```typespec +extern dec setColorValue(target: unknown, color: valueof string); +extern dec setColorType(target: unknown, color: string); + +union Color { + red: "red", + green: "green", + blue: "blue", + other: string, +} + +@setColorValue(Color.red) // passes the scalar value `string("red")` +@setColorValue(Color.other) // error, trying to pass a type as a value. +@setColorType(Color.red) // passes the string literal type `"red"` +model A {} +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/data-types.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/data-types.md index 109a8f83730..dc8106701e9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/data-types.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/data-types.md @@ -205,6 +205,20 @@ model TypeSpec.Http.CreatedResponse | ---------- | ----- | ---------------- | | statusCode | `201` | The status code. | +### `File` {#TypeSpec.Http.File} + +```typespec +model TypeSpec.Http.File +``` + +#### Properties + +| Name | Type | Description | +| ------------ | -------- | ----------- | +| contentType? | `string` | | +| filename? | `string` | | +| contents | `bytes` | | + ### `ForbiddenResponse` {#TypeSpec.Http.ForbiddenResponse} Access is forbidden. @@ -234,6 +248,35 @@ model TypeSpec.Http.HeaderOptions | name? | `string` | Name of the header when sent over HTTP. | | format? | `"csv" \| "multi" \| "tsv" \| "ssv" \| "pipes" \| "simple" \| "form"` | Determines the format of the array if type array is used. | +### `HttpPart` {#TypeSpec.Http.HttpPart} + +```typespec +model TypeSpec.Http.HttpPart +``` + +#### Template Parameters + +| Name | Description | +| ------- | ----------- | +| Type | | +| Options | | + +#### Properties + +None + +### `HttpPartOptions` {#TypeSpec.Http.HttpPartOptions} + +```typespec +model TypeSpec.Http.HttpPartOptions +``` + +#### Properties + +| Name | Type | Description | +| ----- | -------- | ------------------------------------------- | +| name? | `string` | Name of the part when using the array form. | + ### `ImplicitFlow` {#TypeSpec.Http.ImplicitFlow} Implicit flow diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/decorators.md index 2996c91707e..26c688c55b2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/decorators.md @@ -225,6 +225,32 @@ Specify if inapplicable metadata should be included in the payload for the given | ----- | ----------------- | --------------------------------------------------------------- | | value | `valueof boolean` | If true, inapplicable metadata will be included in the payload. | +### `@multipartBody` {#@TypeSpec.Http.multipartBody} + +```typespec +@TypeSpec.Http.multipartBody +``` + +#### Target + +`ModelProperty` + +#### Parameters + +None + +#### Examples + +```tsp +op upload( + @header `content-type`: "multipart/form-data", + @multipartBody body: { + fullName: HttpPart; + headShots: HttpPart[]; + }, +): void; +``` + ### `@patch` {#@TypeSpec.Http.patch} Specify the HTTP verb for the target operation to be `PATCH`. @@ -358,7 +384,7 @@ it will be used as a prefix to the route URI of the operation. `@route` can only be applied to operations, namespaces, and interfaces. ```typespec -@TypeSpec.Http.route(path: valueof string, options?: (anonymous model)) +@TypeSpec.Http.route(path: valueof string, options?: { shared: boolean }) ``` #### Target @@ -411,8 +437,8 @@ namespace PetStore; ```typespec @server("https://{region}.foo.com", "Regional endpoint", { -@doc("Region name") -region?: string = "westus", + @doc("Region name") + region?: string = "westus", }) ``` @@ -462,8 +488,13 @@ None #### Examples ```typespec -op read(): {@statusCode: 200, @body pet: Pet} -op create(): {@statusCode: 201 | 202} +op read(): { + @statusCode _: 200; + @body pet: Pet; +}; +op create(): { + @statusCode _: 201 | 202; +}; ``` ### `@useAuth` {#@TypeSpec.Http.useAuth} diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/index.mdx b/packages/website/versioned_docs/version-latest/libraries/http/reference/index.mdx index ec9a88f52e8..d85da81df69 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/index.mdx +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/index.mdx @@ -43,6 +43,7 @@ npm install --save-peer @typespec/http - [`@head`](./decorators.md#@TypeSpec.Http.head) - [`@header`](./decorators.md#@TypeSpec.Http.header) - [`@includeInapplicableMetadataInPayload`](./decorators.md#@TypeSpec.Http.includeInapplicableMetadataInPayload) +- [`@multipartBody`](./decorators.md#@TypeSpec.Http.multipartBody) - [`@patch`](./decorators.md#@TypeSpec.Http.patch) - [`@path`](./decorators.md#@TypeSpec.Http.path) - [`@post`](./decorators.md#@TypeSpec.Http.post) @@ -66,8 +67,11 @@ npm install --save-peer @typespec/http - [`ClientCredentialsFlow`](./data-types.md#TypeSpec.Http.ClientCredentialsFlow) - [`ConflictResponse`](./data-types.md#TypeSpec.Http.ConflictResponse) - [`CreatedResponse`](./data-types.md#TypeSpec.Http.CreatedResponse) +- [`File`](./data-types.md#TypeSpec.Http.File) - [`ForbiddenResponse`](./data-types.md#TypeSpec.Http.ForbiddenResponse) - [`HeaderOptions`](./data-types.md#TypeSpec.Http.HeaderOptions) +- [`HttpPart`](./data-types.md#TypeSpec.Http.HttpPart) +- [`HttpPartOptions`](./data-types.md#TypeSpec.Http.HttpPartOptions) - [`ImplicitFlow`](./data-types.md#TypeSpec.Http.ImplicitFlow) - [`LocationHeader`](./data-types.md#TypeSpec.Http.LocationHeader) - [`MovedResponse`](./data-types.md#TypeSpec.Http.MovedResponse) diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/enumerations/Visibility.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/enumerations/Visibility.md index 09a0ca42369..e5182c69655 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/enumerations/Visibility.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/enumerations/Visibility.md @@ -13,9 +13,9 @@ REST API. | `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. | +| `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. | +| `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/libraries/http/reference/js-api/functions/$body.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$body.md index 85ed387308a..5cc14bfaf24 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$body.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$body.md @@ -4,7 +4,7 @@ title: "[F] $body" --- ```ts -$body(context, target): void +function $body(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyIgnore.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyIgnore.md index 2260d9400e3..9f293d44393 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyIgnore.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyIgnore.md @@ -4,7 +4,7 @@ title: "[F] $bodyIgnore" --- ```ts -$bodyIgnore(context, target): void +function $bodyIgnore(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyRoot.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyRoot.md index 4910da0e7bd..5529cd6c705 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyRoot.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$bodyRoot.md @@ -4,7 +4,7 @@ title: "[F] $bodyRoot" --- ```ts -$bodyRoot(context, target): void +function $bodyRoot(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$delete.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$delete.md index b498c22bd32..b00afa63ef8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$delete.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$delete.md @@ -4,7 +4,7 @@ title: "[F] $delete" --- ```ts -$delete(context, target): void +function $delete(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$get.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$get.md index 480aa9ffb00..5f3bb183087 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$get.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$get.md @@ -4,7 +4,7 @@ title: "[F] $get" --- ```ts -$get(context, target): void +function $get(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$head.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$head.md index 84b422f9526..5fd1aad5190 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$head.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$head.md @@ -4,7 +4,7 @@ title: "[F] $head" --- ```ts -$head(context, target): void +function $head(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$header.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$header.md index 61cbd7196e6..dffade5123e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$header.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$header.md @@ -4,7 +4,7 @@ title: "[F] $header" --- ```ts -$header( +function $header( context, target, headerNameOrOptions?): void diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md index 312198ac005..b84ebd405da 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$includeInapplicableMetadataInPayload.md @@ -4,7 +4,7 @@ title: "[F] $includeInapplicableMetadataInPayload" --- ```ts -$includeInapplicableMetadataInPayload( +function $includeInapplicableMetadataInPayload( context, entity, value): void @@ -19,8 +19,8 @@ decorator. | Parameter | Type | Description | | :------ | :------ | :------ | | `context` | `DecoratorContext` | - | -| `entity` | `Type` | Target model, namespace, or model property. If applied to a
model or namespace, applies recursively to child models,
namespaces, and model properties unless overridden by
applying this decorator to a child. | -| `value` | `boolean` | `true` to include inapplicable metadata in payload, false to
exclude it. | +| `entity` | `Type` |

Target model, namespace, or model property. If applied to a

model or namespace, applies recursively to child models,

namespaces, and model properties unless overridden by

applying this decorator to a child.

| +| `value` | `boolean` |

`true` to include inapplicable metadata in payload, false to

exclude it.

| ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$plainData.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$multipartBody.md similarity index 57% rename from packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$plainData.md rename to packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$multipartBody.md index d340a798ad6..88463e2fb4a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$plainData.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$multipartBody.md @@ -1,10 +1,10 @@ --- jsApi: true -title: "[F] $plainData" +title: "[F] $multipartBody" --- ```ts -$plainData(context, target): void +function $multipartBody(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $plainData(context, target): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` | +| `target` | `ModelProperty` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$onValidate.md index 212e92eb72e..3b2236c14ab 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$onValidate.md @@ -4,7 +4,7 @@ title: "[F] $onValidate" --- ```ts -$onValidate(program): void +function $onValidate(program): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$patch.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$patch.md index f975792dfcf..ef801972ff0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$patch.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$patch.md @@ -4,7 +4,7 @@ title: "[F] $patch" --- ```ts -$patch(context, target): void +function $patch(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$path.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$path.md index 9574f3a3b8c..49c40f1c844 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$path.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$path.md @@ -4,7 +4,7 @@ title: "[F] $path" --- ```ts -$path( +function $path( context, target, paramName?): void diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$post.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$post.md index b0fc15a8a90..9e697c030e5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$post.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$post.md @@ -4,7 +4,7 @@ title: "[F] $post" --- ```ts -$post(context, target): void +function $post(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$put.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$put.md index 445052ac487..066c404e69c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$put.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$put.md @@ -4,7 +4,7 @@ title: "[F] $put" --- ```ts -$put(context, target): void +function $put(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$query.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$query.md index 89857025ac5..17707f346ae 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$query.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$query.md @@ -4,7 +4,7 @@ title: "[F] $query" --- ```ts -$query( +function $query( context, target, queryNameOrOptions?): void diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$route.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$route.md index 283b04bedb8..b0070ad783f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$route.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$route.md @@ -4,7 +4,7 @@ title: "[F] $route" --- ```ts -$route( +function $route( context, target, path, @@ -24,7 +24,7 @@ it will be used as a prefix to the route URI of the operation. | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Interface` \| `Namespace` \| `Operation` | +| `target` | `Namespace` \| `Interface` \| `Operation` | | `path` | `string` | | `options`? | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$server.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$server.md index d2987164abd..c20e7d244e2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$server.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$server.md @@ -4,7 +4,7 @@ title: "[F] $server" --- ```ts -$server( +function $server( context, target, url, diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$sharedRoute.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$sharedRoute.md index 5543b78ade3..01bdd2f12a1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$sharedRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$sharedRoute.md @@ -4,7 +4,7 @@ title: "[F] $sharedRoute" --- ```ts -$sharedRoute(context, target): void +function $sharedRoute(context, target): void ``` `@sharedRoute` marks the operation as sharing a route path with other operations. diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$statusCode.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$statusCode.md index 3b421164c65..5dd150fc08d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$statusCode.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$statusCode.md @@ -4,7 +4,7 @@ title: "[F] $statusCode" --- ```ts -$statusCode(context, target): void +function $statusCode(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$useAuth.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$useAuth.md index faee9533acd..1a26fa69410 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$useAuth.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$useAuth.md @@ -4,7 +4,7 @@ title: "[F] $useAuth" --- ```ts -$useAuth( +function $useAuth( context, entity, authConfig): void @@ -15,7 +15,7 @@ $useAuth( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Interface` \| `Namespace` \| `Operation` | +| `entity` | `Namespace` \| `Interface` \| `Operation` | | `authConfig` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/DefaultRouteProducer.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/DefaultRouteProducer.md index 32fcf1d6bc5..7a57cd6864d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/DefaultRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/DefaultRouteProducer.md @@ -4,7 +4,7 @@ title: "[F] DefaultRouteProducer" --- ```ts -DefaultRouteProducer( +function DefaultRouteProducer( program, operation, parentSegments, diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/createMetadataInfo.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/createMetadataInfo.md index 1bb3fd03526..f9336794a97 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/createMetadataInfo.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/createMetadataInfo.md @@ -4,7 +4,7 @@ title: "[F] createMetadataInfo" --- ```ts -createMetadataInfo(program, options?): MetadataInfo +function createMetadataInfo(program, options?): MetadataInfo ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/gatherMetadata.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/gatherMetadata.md deleted file mode 100644 index 65c998621c9..00000000000 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/gatherMetadata.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -jsApi: true -title: "[F] gatherMetadata" - ---- -```ts -gatherMetadata( - program, - diagnostics, - type, - visibility, - isMetadataCallback, -rootMapOut?): Set -``` - -Walks the given type and collects all applicable metadata and `@body` -properties recursively. - -## Parameters - -| Parameter | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `program` | `Program` | `undefined` | - | -| `diagnostics` | `DiagnosticCollector` | `undefined` | - | -| `type` | `Type` | `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`\> diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllHttpServices.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllHttpServices.md index 4a76f1e34e1..63be58d9bf9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllHttpServices.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllHttpServices.md @@ -4,7 +4,7 @@ title: "[F] getAllHttpServices" --- ```ts -getAllHttpServices(program, options?): [HttpService[], readonly Diagnostic[]] +function getAllHttpServices(program, options?): [HttpService[], readonly Diagnostic[]] ``` Returns all the services defined. diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllRoutes.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllRoutes.md index e575a001ab5..813c4cf3875 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllRoutes.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAllRoutes.md @@ -4,7 +4,7 @@ title: "[F] getAllRoutes" --- ```ts -getAllRoutes(program, options?): [HttpOperation[], readonly Diagnostic[]] +function getAllRoutes(program, options?): [HttpOperation[], readonly Diagnostic[]] ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthentication.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthentication.md index eea872b4c75..252ed715bc2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthentication.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthentication.md @@ -4,7 +4,7 @@ title: "[F] getAuthentication" --- ```ts -getAuthentication(program, entity): Authentication | undefined +function getAuthentication(program, entity): Authentication | undefined ``` ## Parameters @@ -12,7 +12,7 @@ getAuthentication(program, entity): Authentication | undefined | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `entity` | `Interface` \| `Namespace` \| `Operation` | +| `entity` | `Namespace` \| `Interface` \| `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthenticationForOperation.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthenticationForOperation.md index f6d9df27b25..23a521e01df 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthenticationForOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getAuthenticationForOperation.md @@ -4,7 +4,7 @@ title: "[F] getAuthenticationForOperation" --- ```ts -getAuthenticationForOperation(program, operation): Authentication | undefined +function getAuthenticationForOperation(program, operation): Authentication | undefined ``` Resolve the authentication for a given operation. diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getContentTypes.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getContentTypes.md index 8926f02618c..7899a7315f2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getContentTypes.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getContentTypes.md @@ -4,7 +4,7 @@ title: "[F] getContentTypes" --- ```ts -getContentTypes(property): [string[], readonly Diagnostic[]] +function getContentTypes(property): [string[], readonly Diagnostic[]] ``` Resolve the content types from a model property by looking at the value. diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldName.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldName.md index 5096ca42e67..a6b583974d0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldName.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldName.md @@ -4,7 +4,7 @@ title: "[F] getHeaderFieldName" --- ```ts -getHeaderFieldName(program, entity): string +function getHeaderFieldName(program, entity): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldOptions.md index f9674d89d4d..9e85658f163 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHeaderFieldOptions.md @@ -4,7 +4,7 @@ title: "[F] getHeaderFieldOptions" --- ```ts -getHeaderFieldOptions(program, entity): HeaderFieldOptions +function getHeaderFieldOptions(program, entity): HeaderFieldOptions ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpFileModel.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpFileModel.md new file mode 100644 index 00000000000..7749f794215 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpFileModel.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getHttpFileModel" + +--- +```ts +function getHttpFileModel(program, type): HttpFileModel | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `type` | `Type` | + +## Returns + +`HttpFileModel` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpOperation.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpOperation.md index 952150aa661..d54ac7b3760 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpOperation.md @@ -4,7 +4,7 @@ title: "[F] getHttpOperation" --- ```ts -getHttpOperation( +function getHttpOperation( program, operation, options?): [HttpOperation, readonly Diagnostic[]] diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpService.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpService.md index 30d4dc0bed4..7e4e9d23050 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpService.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getHttpService.md @@ -4,7 +4,7 @@ title: "[F] getHttpService" --- ```ts -getHttpService( +function getHttpService( program, serviceNamespace, options?): [HttpService, readonly Diagnostic[]] diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationParameters.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationParameters.md index 1106400bcba..67dafeed64b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationParameters.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationParameters.md @@ -4,7 +4,7 @@ title: "[F] getOperationParameters" --- ```ts -getOperationParameters( +function getOperationParameters( program, operation, overloadBase?, diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationVerb.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationVerb.md index c1232d91b19..5b85538de61 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationVerb.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getOperationVerb.md @@ -4,7 +4,7 @@ title: "[F] getOperationVerb" --- ```ts -getOperationVerb(program, entity): HttpVerb | undefined +function getOperationVerb(program, entity): HttpVerb | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamName.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamName.md index 947c88dedfa..f39230064ef 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamName.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamName.md @@ -4,7 +4,7 @@ title: "[F] getPathParamName" --- ```ts -getPathParamName(program, entity): string +function getPathParamName(program, entity): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamOptions.md index 4b7fb1bf4ad..872a2f4a5e6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getPathParamOptions.md @@ -4,7 +4,7 @@ title: "[F] getPathParamOptions" --- ```ts -getPathParamOptions(program, entity): PathParameterOptions +function getPathParamOptions(program, entity): PathParameterOptions ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamName.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamName.md index da9c1758b24..4dfd6c0c602 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamName.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamName.md @@ -4,7 +4,7 @@ title: "[F] getQueryParamName" --- ```ts -getQueryParamName(program, entity): string +function getQueryParamName(program, entity): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamOptions.md index ad13ac707b7..4015e2f4e7c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getQueryParamOptions.md @@ -4,7 +4,7 @@ title: "[F] getQueryParamOptions" --- ```ts -getQueryParamOptions(program, entity): QueryParameterOptions +function getQueryParamOptions(program, entity): QueryParameterOptions ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRequestVisibility.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRequestVisibility.md index 2854af31003..6ac69258767 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRequestVisibility.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRequestVisibility.md @@ -4,7 +4,7 @@ title: "[F] getRequestVisibility" --- ```ts -getRequestVisibility(verb): Visibility +function getRequestVisibility(verb): Visibility ``` Determines the visibility to use for a request with the given verb. diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getResponsesForOperation.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getResponsesForOperation.md index a2b10e35ae9..ba6bc612f27 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getResponsesForOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getResponsesForOperation.md @@ -4,7 +4,7 @@ title: "[F] getResponsesForOperation" --- ```ts -getResponsesForOperation(program, operation): [HttpOperationResponse[], readonly Diagnostic[]] +function getResponsesForOperation(program, operation): [HttpOperationResponse[], readonly Diagnostic[]] ``` Get the responses for a given operation. diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteOptionsForNamespace.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteOptionsForNamespace.md index f1beff5fdd5..33550417e51 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteOptionsForNamespace.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteOptionsForNamespace.md @@ -4,7 +4,7 @@ title: "[F] getRouteOptionsForNamespace" --- ```ts -getRouteOptionsForNamespace(program, namespace): RouteOptions | undefined +function getRouteOptionsForNamespace(program, namespace): RouteOptions | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRoutePath.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRoutePath.md index d883ef3f0d2..5f4acf70fb5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRoutePath.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRoutePath.md @@ -4,7 +4,7 @@ title: "[F] getRoutePath" --- ```ts -getRoutePath(program, entity): RoutePath | undefined +function getRoutePath(program, entity): RoutePath | undefined ``` ## Parameters @@ -12,7 +12,7 @@ getRoutePath(program, entity): RoutePath | undefined | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `entity` | `Interface` \| `Namespace` \| `Operation` | +| `entity` | `Namespace` \| `Interface` \| `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteProducer.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteProducer.md index 8c122a8a2be..bddacdbe605 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getRouteProducer.md @@ -4,7 +4,7 @@ title: "[F] getRouteProducer" --- ```ts -getRouteProducer(program, operation): RouteProducer +function getRouteProducer(program, operation): RouteProducer ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getServers.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getServers.md index 4db6a742993..3cf3691556f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getServers.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getServers.md @@ -4,7 +4,7 @@ title: "[F] getServers" --- ```ts -getServers(program, type): HttpServer[] | undefined +function getServers(program, type): HttpServer[] | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodeDescription.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodeDescription.md index 87683cddad8..674d4f91d57 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodeDescription.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodeDescription.md @@ -4,7 +4,7 @@ title: "[F] getStatusCodeDescription" --- ```ts -getStatusCodeDescription(statusCode): +function getStatusCodeDescription(statusCode): | undefined | "Informational" | "Successful" diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodes.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodes.md index 58bcbc0ce33..79d891474be 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodes.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodes.md @@ -4,7 +4,7 @@ title: "[F] getStatusCodes" --- ```ts -getStatusCodes(program, entity): HttpStatusCodes +function getStatusCodes(program, entity): HttpStatusCodes ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md index 945bb11a4fa..0a617dac422 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getStatusCodesWithDiagnostics.md @@ -4,7 +4,7 @@ title: "[F] getStatusCodesWithDiagnostics" --- ```ts -getStatusCodesWithDiagnostics(program, type): [HttpStatusCodes, readonly Diagnostic[]] +function getStatusCodesWithDiagnostics(program, type): [HttpStatusCodes, readonly Diagnostic[]] ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getVisibilitySuffix.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getVisibilitySuffix.md index dd86ca48156..45f9c8f2358 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getVisibilitySuffix.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/getVisibilitySuffix.md @@ -4,7 +4,7 @@ title: "[F] getVisibilitySuffix" --- ```ts -getVisibilitySuffix(visibility, canonicalVisibility): string +function getVisibilitySuffix(visibility, canonicalVisibility): string ``` Provides a naming suffix to create a unique name for a type with this diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md index 293ee6ea1e0..81697379ba5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInapplicableMetadataInPayload.md @@ -4,7 +4,7 @@ title: "[F] includeInapplicableMetadataInPayload" --- ```ts -includeInapplicableMetadataInPayload(program, property): boolean +function includeInapplicableMetadataInPayload(program, property): boolean ``` Determines if the given model property should be included in the payload if it is diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md index a560921e4a1..034fd5c2b9e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/includeInterfaceRoutesInNamespace.md @@ -4,7 +4,7 @@ title: "[F] includeInterfaceRoutesInNamespace" --- ```ts -includeInterfaceRoutesInNamespace( +function includeInterfaceRoutesInNamespace( program, target, sourceInterface): void diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadata.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadata.md index 76e954e79d8..a870973c557 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadata.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadata.md @@ -4,7 +4,7 @@ title: "[F] isApplicableMetadata" --- ```ts -isApplicableMetadata( +function isApplicableMetadata( program, property, visibility, diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadataOrBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadataOrBody.md index 59755082c6c..6f0fe6f87a1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadataOrBody.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isApplicableMetadataOrBody.md @@ -4,7 +4,7 @@ title: "[F] isApplicableMetadataOrBody" --- ```ts -isApplicableMetadataOrBody( +function isApplicableMetadataOrBody( program, property, visibility, diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBody.md index 5507e46ac08..59284ca3135 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBody.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBody.md @@ -4,7 +4,7 @@ title: "[F] isBody" --- ```ts -isBody(program, entity): boolean +function isBody(program, entity): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyIgnore.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyIgnore.md index b0b5551c105..8a9963d8acd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyIgnore.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyIgnore.md @@ -4,7 +4,7 @@ title: "[F] isBodyIgnore" --- ```ts -isBodyIgnore(program, entity): boolean +function isBodyIgnore(program, entity): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyRoot.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyRoot.md index 66394bdd053..5497d28d661 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyRoot.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isBodyRoot.md @@ -4,7 +4,7 @@ title: "[F] isBodyRoot" --- ```ts -isBodyRoot(program, entity): boolean +function isBodyRoot(program, entity): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isContentTypeHeader.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isContentTypeHeader.md index 9eb585e9b34..04f2847e933 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isContentTypeHeader.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isContentTypeHeader.md @@ -4,11 +4,9 @@ title: "[F] isContentTypeHeader" --- ```ts -isContentTypeHeader(program, property): boolean +function isContentTypeHeader(program, property): boolean ``` -Check if the given model property is the content type header. - ## Parameters | Parameter | Type | Description | @@ -21,3 +19,8 @@ Check if the given model property is the content type header. `boolean` True if the model property is marked as a header and has the name `content-type`(case insensitive.) + +## Deprecated + +Use `OperationProperty.kind === 'contentType'` instead. +Check if the given model property is the content type header. diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHeader.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHeader.md index 12866ccacae..6d083e74493 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHeader.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHeader.md @@ -4,7 +4,7 @@ title: "[F] isHeader" --- ```ts -isHeader(program, entity): boolean +function isHeader(program, entity): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/madeOptionalAfter.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHttpFile.md similarity index 55% rename from packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/madeOptionalAfter.md rename to packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHttpFile.md index 180463b2761..5fb912b515c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/madeOptionalAfter.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isHttpFile.md @@ -1,22 +1,20 @@ --- jsApi: true -title: "[F] madeOptionalAfter" +title: "[F] isHttpFile" --- ```ts -madeOptionalAfter( - program, - type, - versionKey): boolean +function isHttpFile(program, type): boolean ``` +Check if the given type is an `HttpFile` + ## Parameters | Parameter | Type | | :------ | :------ | | `program` | `Program` | | `type` | `Type` | -| `versionKey` | `ObjectType` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMetadata.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMetadata.md index ee8b7f79528..81e82a2bc3c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMetadata.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMetadata.md @@ -4,7 +4,7 @@ title: "[F] isMetadata" --- ```ts -isMetadata(program, property): boolean +function isMetadata(program, property): boolean ``` Determines if a property is metadata. A property is defined to be diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMultipartBodyProperty.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMultipartBodyProperty.md new file mode 100644 index 00000000000..f148eda70ff --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isMultipartBodyProperty.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isMultipartBodyProperty" + +--- +```ts +function isMultipartBodyProperty(program, entity): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `entity` | `Type` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOrExtendsHttpFile.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOrExtendsHttpFile.md new file mode 100644 index 00000000000..9151de70f2c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOrExtendsHttpFile.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isOrExtendsHttpFile" + +--- +```ts +function isOrExtendsHttpFile(program, type): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `type` | `Type` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOverloadSameEndpoint.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOverloadSameEndpoint.md index 0381f238e8d..d02d3a19351 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOverloadSameEndpoint.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isOverloadSameEndpoint.md @@ -4,14 +4,14 @@ title: "[F] isOverloadSameEndpoint" --- ```ts -isOverloadSameEndpoint(overload): boolean +function isOverloadSameEndpoint(overload): boolean ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `overload` | [`HttpOperation`](../interfaces/HttpOperation.md) & `Object` | +| `overload` | [`HttpOperation`](../interfaces/HttpOperation.md) & `object` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isPathParam.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isPathParam.md index 234c9d49c17..92a47e6471f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isPathParam.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isPathParam.md @@ -4,7 +4,7 @@ title: "[F] isPathParam" --- ```ts -isPathParam(program, entity): boolean +function isPathParam(program, entity): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isQueryParam.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isQueryParam.md index ce13bfe40f9..5bee8b63397 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isQueryParam.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isQueryParam.md @@ -4,7 +4,7 @@ title: "[F] isQueryParam" --- ```ts -isQueryParam(program, entity): boolean +function isQueryParam(program, entity): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isSharedRoute.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isSharedRoute.md index 20dcc9fea46..1865ac3f833 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isSharedRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isSharedRoute.md @@ -4,7 +4,7 @@ title: "[F] isSharedRoute" --- ```ts -isSharedRoute(program, operation): boolean +function isSharedRoute(program, operation): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isStatusCode.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isStatusCode.md index 82423465113..edb677d4d6e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isStatusCode.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isStatusCode.md @@ -4,7 +4,7 @@ title: "[F] isStatusCode" --- ```ts -isStatusCode(program, entity): boolean +function isStatusCode(program, entity): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isVisible.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isVisible.md index 17710f5cd9d..aa384d141d7 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isVisible.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/isVisible.md @@ -4,7 +4,7 @@ title: "[F] isVisible" --- ```ts -isVisible( +function isVisible( program, property, visibility): boolean diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/listHttpOperationsIn.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/listHttpOperationsIn.md index 39c7e922c4b..63199fd0464 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/listHttpOperationsIn.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/listHttpOperationsIn.md @@ -4,7 +4,7 @@ title: "[F] listHttpOperationsIn" --- ```ts -listHttpOperationsIn( +function listHttpOperationsIn( program, container, options?): [HttpOperation[], readonly Diagnostic[]] diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/reportIfNoRoutes.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/reportIfNoRoutes.md index 701efb6b9d4..eb6cde3d87d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/reportIfNoRoutes.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/reportIfNoRoutes.md @@ -4,7 +4,7 @@ title: "[F] reportIfNoRoutes" --- ```ts -reportIfNoRoutes(program, routes): void +function reportIfNoRoutes(program, routes): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveAuthentication.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveAuthentication.md index e465100e08b..a7954f0b5ec 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveAuthentication.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveAuthentication.md @@ -4,7 +4,7 @@ title: "[F] resolveAuthentication" --- ```ts -resolveAuthentication(service): HttpServiceAuthentication +function resolveAuthentication(service): HttpServiceAuthentication ``` Compute the authentication for a given service. diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolvePathAndParameters.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolvePathAndParameters.md index 03aaccd285d..a7b88a653b4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolvePathAndParameters.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolvePathAndParameters.md @@ -4,11 +4,11 @@ title: "[F] resolvePathAndParameters" --- ```ts -resolvePathAndParameters( +function resolvePathAndParameters( program, operation, overloadBase, -options): DiagnosticResult +options): DiagnosticResult ``` ## Parameters @@ -22,11 +22,10 @@ options): DiagnosticResult ## Returns -`DiagnosticResult`<`Object`\> +`DiagnosticResult`<`object`\> -> | Member | Type | -> | :------ | :------ | -> | `parameters` | [`HttpOperationParameters`](../interfaces/HttpOperationParameters.md) | -> | `path` | `string` | -> | `pathSegments` | `string`[] | -> +| Member | Type | +| :------ | :------ | +| `parameters` | [`HttpOperationParameters`](../interfaces/HttpOperationParameters.md) | +| `path` | `string` | +| `pathSegments` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveRequestVisibility.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveRequestVisibility.md index c563153d8f3..85e91784b8b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveRequestVisibility.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/resolveRequestVisibility.md @@ -4,7 +4,7 @@ title: "[F] resolveRequestVisibility" --- ```ts -resolveRequestVisibility( +function resolveRequestVisibility( program, operation, verb): Visibility diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setAuthentication.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setAuthentication.md index 9dea86ba504..23ee0309da1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setAuthentication.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setAuthentication.md @@ -4,7 +4,7 @@ title: "[F] setAuthentication" --- ```ts -setAuthentication( +function setAuthentication( program, entity, auth): void @@ -15,7 +15,7 @@ setAuthentication( | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `entity` | `Interface` \| `Namespace` \| `Operation` | +| `entity` | `Namespace` \| `Interface` \| `Operation` | | `auth` | [`Authentication`](../interfaces/Authentication.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRoute.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRoute.md index 3575f132203..389bd1023bb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRoute.md @@ -4,7 +4,7 @@ title: "[F] setRoute" --- ```ts -setRoute( +function setRoute( context, entity, details): void diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteOptionsForNamespace.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteOptionsForNamespace.md index ef381fba55e..5bfef1b0376 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteOptionsForNamespace.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteOptionsForNamespace.md @@ -4,7 +4,7 @@ title: "[F] setRouteOptionsForNamespace" --- ```ts -setRouteOptionsForNamespace( +function setRouteOptionsForNamespace( program, namespace, options): void diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteProducer.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteProducer.md index 44395324dbe..7373fc77a00 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteProducer.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setRouteProducer.md @@ -4,7 +4,7 @@ title: "[F] setRouteProducer" --- ```ts -setRouteProducer( +function setRouteProducer( program, operation, routeProducer): void diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setSharedRoute.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setSharedRoute.md index 5a17f9bf5e6..2ac77c5c574 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setSharedRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setSharedRoute.md @@ -4,7 +4,7 @@ title: "[F] setSharedRoute" --- ```ts -setSharedRoute(program, operation): void +function setSharedRoute(program, operation): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setStatusCode.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setStatusCode.md index 47ddd915205..71f2022f019 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setStatusCode.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setStatusCode.md @@ -4,7 +4,7 @@ title: "[F] setStatusCode" --- ```ts -setStatusCode( +function setStatusCode( program, entity, codes): void @@ -15,7 +15,7 @@ setStatusCode( | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `entity` | `ModelProperty` \| `Model` | +| `entity` | `Model` \| `ModelProperty` | | `codes` | `string`[] | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/validateRouteUnique.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/validateRouteUnique.md index 8cd61c1c45f..fb476a57243 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/validateRouteUnique.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/validateRouteUnique.md @@ -4,7 +4,7 @@ title: "[F] validateRouteUnique" --- ```ts -validateRouteUnique( +function validateRouteUnique( program, diagnostics, operations): void diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/index.md index f543db785eb..71a5e1c5ffb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/index.md @@ -21,12 +21,14 @@ title: "[P] JS API" - [ClientCredentialsFlow](interfaces/ClientCredentialsFlow.md) - [HeaderFieldOptions](interfaces/HeaderFieldOptions.md) - [HttpAuthBase](interfaces/HttpAuthBase.md) +- [HttpBody](interfaces/HttpBody.md) - [HttpOperation](interfaces/HttpOperation.md) - [HttpOperationBody](interfaces/HttpOperationBody.md) +- [HttpOperationBodyBase](interfaces/HttpOperationBodyBase.md) +- [HttpOperationMultipartBody](interfaces/HttpOperationMultipartBody.md) - [HttpOperationParameters](interfaces/HttpOperationParameters.md) -- [HttpOperationRequestBody](interfaces/HttpOperationRequestBody.md) +- [HttpOperationPart](interfaces/HttpOperationPart.md) - [HttpOperationResponse](interfaces/HttpOperationResponse.md) -- [HttpOperationResponseBody](interfaces/HttpOperationResponseBody.md) - [HttpOperationResponseContent](interfaces/HttpOperationResponseContent.md) - [HttpServer](interfaces/HttpServer.md) - [HttpService](interfaces/HttpService.md) @@ -55,6 +57,8 @@ title: "[P] JS API" - [HttpAuth](type-aliases/HttpAuth.md) - [HttpAuthRef](type-aliases/HttpAuthRef.md) - [HttpOperationParameter](type-aliases/HttpOperationParameter.md) +- [HttpOperationRequestBody](type-aliases/HttpOperationRequestBody.md) +- [HttpOperationResponseBody](type-aliases/HttpOperationResponseBody.md) - [HttpStatusCodes](type-aliases/HttpStatusCodes.md) - [HttpStatusCodesEntry](type-aliases/HttpStatusCodesEntry.md) - [HttpVerb](type-aliases/HttpVerb.md) @@ -83,10 +87,10 @@ title: "[P] JS API" - [$head](functions/$head.md) - [$header](functions/$header.md) - [$includeInapplicableMetadataInPayload](functions/$includeInapplicableMetadataInPayload.md) +- [$multipartBody](functions/$multipartBody.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) @@ -97,7 +101,6 @@ title: "[P] JS API" - [$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) @@ -105,6 +108,7 @@ title: "[P] JS API" - [getContentTypes](functions/getContentTypes.md) - [getHeaderFieldName](functions/getHeaderFieldName.md) - [getHeaderFieldOptions](functions/getHeaderFieldOptions.md) +- [getHttpFileModel](functions/getHttpFileModel.md) - [getHttpOperation](functions/getHttpOperation.md) - [getHttpService](functions/getHttpService.md) - [getOperationParameters](functions/getOperationParameters.md) @@ -132,7 +136,10 @@ title: "[P] JS API" - [isBodyRoot](functions/isBodyRoot.md) - [isContentTypeHeader](functions/isContentTypeHeader.md) - [isHeader](functions/isHeader.md) +- [isHttpFile](functions/isHttpFile.md) - [isMetadata](functions/isMetadata.md) +- [isMultipartBodyProperty](functions/isMultipartBodyProperty.md) +- [isOrExtendsHttpFile](functions/isOrExtendsHttpFile.md) - [isOverloadSameEndpoint](functions/isOverloadSameEndpoint.md) - [isPathParam](functions/isPathParam.md) - [isQueryParam](functions/isQueryParam.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ApiKeyAuth.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ApiKeyAuth.md index b77cc1e0392..a96c2194b90 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ApiKeyAuth.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/ApiKeyAuth.md @@ -30,8 +30,8 @@ Cookie: X-API-KEY=abcdef12345 | Type parameter | | :------ | -| `TLocation` extends `ApiKeyLocation` | -| `TName` extends `string` | +| `TLocation` *extends* `ApiKeyLocation` | +| `TName` *extends* `string` | ## Properties diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/BasicAuth.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/BasicAuth.md index eeec02b3a3a..a23c30934c5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/BasicAuth.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/BasicAuth.md @@ -7,7 +7,7 @@ Basic authentication is a simple authentication scheme built into the HTTP proto The client sends HTTP requests with the Authorization header that contains the word Basic word followed by a space and a base64-encoded string username:password. For example, to authorize as demo / p@55w0rd the client would send ``` - Authorization: Basic ZGVtbzpwQDU1dzByZA== +Authorization: Basic ZGVtbzpwQDU1dzByZA== ``` ## Extends diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HeaderFieldOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HeaderFieldOptions.md index 91f717d48e4..707dea0e826 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HeaderFieldOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HeaderFieldOptions.md @@ -7,6 +7,6 @@ title: "[I] HeaderFieldOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `format?` | \| `"form"` \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` | The string format of the array. "csv" and "simple" are used interchangeably, as are
"multi" and "form". | +| `format?` | \| `"form"` \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` |

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

"multi" and "form".

| | `name` | `string` | - | | `type` | `"header"` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpBody.md new file mode 100644 index 00000000000..3df97b4d795 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpBody.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] HttpBody" + +--- +## Extended by + +- [`HttpOperationBody`](HttpOperationBody.md) + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `containsMetadataAnnotations` | `readonly` | `boolean` | If the body contains metadata annotations to ignore. For example `@header`. | +| `isExplicit` | `readonly` | `boolean` | If the body was explicitly set with `@body`. | +| ~~`parameter?`~~ | `public` | `ModelProperty` |

**Deprecated**

use [property](HttpBody.md)

| +| `property?` | `readonly` | `ModelProperty` | If the body was explicitly set as a property. Correspond to the property with `@body` or `@bodyRoot` | +| `type` | `readonly` | `Type` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBody.md index 8af6a3298dd..6939ee16fee 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBody.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBody.md @@ -3,16 +3,19 @@ jsApi: true title: "[I] HttpOperationBody" --- -## Extended by +## Extends -- [`HttpOperationRequestBody`](HttpOperationRequestBody.md) -- [`HttpOperationResponseBody`](HttpOperationResponseBody.md) +- [`HttpOperationBodyBase`](HttpOperationBodyBase.md).[`HttpBody`](HttpBody.md) ## Properties -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `containsMetadataAnnotations` | `readonly` | `boolean` | If the body contains metadata annotations to ignore. For example `@header`. | -| `contentTypes` | `public` | `string`[] | Content types. | -| `isExplicit` | `readonly` | `boolean` | If the body was explicitly set with `@body`. | -| `type` | `public` | `Type` | Type of the operation body. | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `bodyKind` | `readonly` | `"single"` | - | - | +| `containsMetadataAnnotations` | `readonly` | `boolean` | If the body contains metadata annotations to ignore. For example `@header`. | [`HttpBody`](HttpBody.md).`containsMetadataAnnotations` | +| `contentTypeProperty?` | `readonly` | `ModelProperty` | Property used to set the content type if exists | [`HttpOperationBodyBase`](HttpOperationBodyBase.md).`contentTypeProperty` | +| `contentTypes` | `readonly` | `string`[] | Content types. | [`HttpOperationBodyBase`](HttpOperationBodyBase.md).`contentTypes` | +| `isExplicit` | `readonly` | `boolean` | If the body was explicitly set with `@body`. | [`HttpBody`](HttpBody.md).`isExplicit` | +| ~~`parameter?`~~ | `public` | `ModelProperty` |

**Deprecated**

use [property](HttpBody.md)

| [`HttpBody`](HttpBody.md).`parameter` | +| `property?` | `readonly` | `ModelProperty` | If the body was explicitly set as a property. Correspond to the property with `@body` or `@bodyRoot` | [`HttpBody`](HttpBody.md).`property` | +| `type` | `readonly` | `Type` | - | [`HttpBody`](HttpBody.md).`type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBodyBase.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBodyBase.md new file mode 100644 index 00000000000..4152b3a2bda --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationBodyBase.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] HttpOperationBodyBase" + +--- +## Extended by + +- [`HttpOperationBody`](HttpOperationBody.md) +- [`HttpOperationMultipartBody`](HttpOperationMultipartBody.md) + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `contentTypeProperty?` | `readonly` | `ModelProperty` | Property used to set the content type if exists | +| `contentTypes` | `readonly` | `string`[] | Content types. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationMultipartBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationMultipartBody.md new file mode 100644 index 00000000000..ff2b285172b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationMultipartBody.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] HttpOperationMultipartBody" + +--- +Body marked with `@multipartBody` + +## Extends + +- [`HttpOperationBodyBase`](HttpOperationBodyBase.md) + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `bodyKind` | `readonly` | `"multipart"` | - | - | +| `contentTypeProperty?` | `readonly` | `ModelProperty` | Property used to set the content type if exists | [`HttpOperationBodyBase`](HttpOperationBodyBase.md).`contentTypeProperty` | +| `contentTypes` | `readonly` | `string`[] | Content types. | [`HttpOperationBodyBase`](HttpOperationBodyBase.md).`contentTypes` | +| `parts` | `readonly` | [`HttpOperationPart`](HttpOperationPart.md)[] | - | - | +| `property` | `readonly` | `ModelProperty` | Property annotated with `@multipartBody` | - | +| `type` | `readonly` | `Model` \| `Tuple` | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationParameters.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationParameters.md index 8c37fd9ae1c..0657abe957d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationParameters.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationParameters.md @@ -7,7 +7,7 @@ title: "[I] HttpOperationParameters" | Property | Type | Description | | :------ | :------ | :------ | -| `body?` | [`HttpOperationRequestBody`](HttpOperationRequestBody.md) | - | -| ~~`bodyParameter?`~~ | `ModelProperty` | **Deprecated**
use body.parameter | -| ~~`bodyType?`~~ | `Type` | **Deprecated**
use body.type | +| `body?` | [`HttpOperationBody`](HttpOperationBody.md) \| [`HttpOperationMultipartBody`](HttpOperationMultipartBody.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/libraries/http/reference/js-api/interfaces/HttpOperationPart.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationPart.md new file mode 100644 index 00000000000..60d123b0887 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationPart.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] HttpOperationPart" + +--- +Represent an part in a multipart body. + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `body` | `readonly` | [`HttpOperationBody`](HttpOperationBody.md) | Part body | +| `filename?` | `readonly` | `ModelProperty` | If the Part is an HttpFile this is the property defining the filename | +| `headers` | `readonly` | `HeaderProperty`[] | Part headers | +| `multi` | `readonly` | `boolean` | If there can be multiple of that part | +| `name?` | `readonly` | `string` | Part name | +| `optional` | `readonly` | `boolean` | If the part is optional | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationRequestBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationRequestBody.md deleted file mode 100644 index 6523a4bafaa..00000000000 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationRequestBody.md +++ /dev/null @@ -1,24 +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`](HttpOperationBody.md) - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `containsMetadataAnnotations` | `readonly` | `boolean` | If the body contains metadata annotations to ignore. For example `@header`. | [`HttpOperationBody`](HttpOperationBody.md).`containsMetadataAnnotations` | -| `contentTypes` | `public` | `string`[] | Content types. | [`HttpOperationBody`](HttpOperationBody.md).`contentTypes` | -| `isExplicit` | `readonly` | `boolean` | If the body was explicitly set with `@body`. | [`HttpOperationBody`](HttpOperationBody.md).`isExplicit` | -| `parameter?` | `public` | `ModelProperty` | If the body was explicitly set as a property. Correspond to the property with `@body` or `@bodyRoot` | - | -| `type` | `public` | `Type` | Type of the operation body. | [`HttpOperationBody`](HttpOperationBody.md).`type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponse.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponse.md index 45424a8bdf2..6faa833617f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponse.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponse.md @@ -9,6 +9,6 @@ title: "[I] HttpOperationResponse" | :------ | :------ | :------ | | `description?` | `string` | Response description. | | `responses` | [`HttpOperationResponseContent`](HttpOperationResponseContent.md)[] | Responses contents. | -| ~~`statusCode`~~ | [`StatusCode`](../type-aliases/StatusCode.md) | **Deprecated**
use [statusCodes](HttpOperationResponse.md) | +| ~~`statusCode`~~ | [`StatusCode`](../type-aliases/StatusCode.md) |

**Deprecated**

use [statusCodes](HttpOperationResponse.md)

| | `statusCodes` | `number` \| `"*"` \| [`HttpStatusCodeRange`](HttpStatusCodeRange.md) | Status code or range of status code for the response. | | `type` | `Type` | Response TypeSpec type. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponseBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponseBody.md deleted file mode 100644 index a72c350b0ce..00000000000 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponseBody.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[I] HttpOperationResponseBody" - ---- -## Extends - -- [`HttpOperationBody`](HttpOperationBody.md) - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `containsMetadataAnnotations` | `readonly` | `boolean` | If the body contains metadata annotations to ignore. For example `@header`. | [`HttpOperationBody`](HttpOperationBody.md).`containsMetadataAnnotations` | -| `contentTypes` | `public` | `string`[] | Content types. | [`HttpOperationBody`](HttpOperationBody.md).`contentTypes` | -| `isExplicit` | `readonly` | `boolean` | If the body was explicitly set with `@body`. | [`HttpOperationBody`](HttpOperationBody.md).`isExplicit` | -| `property?` | `readonly` | `ModelProperty` | If the body was explicitly set as a property. Correspond to the property with `@body` or `@bodyRoot` | - | -| `type` | `public` | `Type` | Type of the operation body. | [`HttpOperationBody`](HttpOperationBody.md).`type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponseContent.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponseContent.md index f995cae603d..6dca384fae9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponseContent.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpOperationResponseContent.md @@ -7,5 +7,5 @@ title: "[I] HttpOperationResponseContent" | Property | Type | | :------ | :------ | -| `body?` | [`HttpOperationResponseBody`](HttpOperationResponseBody.md) | +| `body?` | [`HttpOperationBody`](HttpOperationBody.md) \| [`HttpOperationMultipartBody`](HttpOperationMultipartBody.md) | | `headers?` | `Record`<`string`, `ModelProperty`\> | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpServiceAuthentication.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpServiceAuthentication.md index 8b67cbc04aa..f18e068ff22 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpServiceAuthentication.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/HttpServiceAuthentication.md @@ -9,4 +9,4 @@ title: "[I] HttpServiceAuthentication" | :------ | :------ | :------ | :------ | | `defaultAuth` | `readonly` | [`AuthenticationReference`](AuthenticationReference.md) | Default authentication for operations in this service. | | `operationsAuth` | `readonly` | `Map`<`Operation`, [`AuthenticationReference`](AuthenticationReference.md)\> | Authentication overrides for individual operations. | -| `schemes` | `readonly` | [`HttpAuth`](../type-aliases/HttpAuth.md)[] | All the authentication schemes used in this service.
Some might only be used in certain operations. | +| `schemes` | `readonly` | [`HttpAuth`](../type-aliases/HttpAuth.md)[] | All the authentication schemes used in this service. Some might only be used in certain operations. | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/MetadataInfoOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/MetadataInfoOptions.md index 34112549543..4d1a9ccff5b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/MetadataInfoOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/MetadataInfoOptions.md @@ -7,7 +7,7 @@ title: "[I] MetadataInfoOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `canonicalVisibility?` | [`Visibility`](../enumerations/Visibility.md) | The visibility to be used as the baseline against which
[MetadataInfo.isEmptied](MetadataInfo.md#isemptied) and [MetadataInfo.isTransformed](MetadataInfo.md#istransformed)
are computed. If not specified, [Visibility.None](../enumerations/Visibility.md) is used, which
will consider that any model that has fields that are only visible to
some visibilities as transformed. | +| `canonicalVisibility?` | [`Visibility`](../enumerations/Visibility.md) |

The visibility to be used as the baseline against which

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

| ## Methods diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/Oauth2Auth.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/Oauth2Auth.md index af9e8e18474..e04f59ad4b4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/Oauth2Auth.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/Oauth2Auth.md @@ -16,7 +16,7 @@ For more information about OAuth 2.0, see oauth.net and RFC 6749. | Type parameter | | :------ | -| `TFlows` extends [`OAuth2Flow`](../type-aliases/OAuth2Flow.md)[] | +| `TFlows` *extends* [`OAuth2Flow`](../type-aliases/OAuth2Flow.md)[] | ## Properties diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/QueryParameterOptions.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/QueryParameterOptions.md index 465ee8eaa90..a6ddd6a50bd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/QueryParameterOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/interfaces/QueryParameterOptions.md @@ -7,6 +7,6 @@ title: "[I] QueryParameterOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `format?` | \| `"form"` \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` | The string format of the array. "csv" and "simple" are used interchangeably, as are
"multi" and "form". | +| `format?` | \| `"form"` \| `"csv"` \| `"multi"` \| `"ssv"` \| `"tsv"` \| `"pipes"` \| `"simple"` |

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

"multi" and "form".

| | `name` | `string` | - | | `type` | `"query"` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationParameter.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationParameter.md index 7011486bd82..c930504ce99 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationParameter.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationParameter.md @@ -4,7 +4,7 @@ title: "[T] HttpOperationParameter" --- ```ts -type HttpOperationParameter: HeaderFieldOptions | QueryParameterOptions | PathParameterOptions & Object; +type HttpOperationParameter: HeaderFieldOptions | QueryParameterOptions | PathParameterOptions & object; ``` ## Type declaration diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationRequestBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationRequestBody.md new file mode 100644 index 00000000000..d925600b8d5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationRequestBody.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[T] HttpOperationRequestBody" + +--- +```ts +type HttpOperationRequestBody: HttpOperationBody; +``` + +## Deprecated + +use [HttpOperationBody](../interfaces/HttpOperationBody.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationResponseBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationResponseBody.md new file mode 100644 index 00000000000..1038db998b4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/HttpOperationResponseBody.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[T] HttpOperationResponseBody" + +--- +```ts +type HttpOperationResponseBody: HttpOperationBody; +``` + +## Deprecated + +use [HttpOperationBody](../interfaces/HttpOperationBody.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/StatusCode.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/StatusCode.md index a51f7c07c0a..e0c54e2dd84 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/StatusCode.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/type-aliases/StatusCode.md @@ -4,7 +4,7 @@ title: "[T] StatusCode" --- ```ts -type StatusCode: \${number}\ | "*"; +type StatusCode: `${number}` | "*"; ``` ## Deprecated diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/variables/$lib.md index 58ef9ddd5ae..4df8cc43092 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/variables/$lib.md @@ -4,7 +4,8 @@ title: "[V] $lib" --- ```ts -const $lib: TypeSpecLibrary, +const $lib: TypeSpecLibrary, + | "file" | "statusCode" | "body" | "header" @@ -13,6 +14,7 @@ const $lib: TypeSpecLibrary, | "authentication" | "bodyRoot" | "bodyIgnore" + | "multipartBody" | "verbs" | "servers" | "includeInapplicableMetadataInPayload" @@ -20,55 +22,66 @@ const $lib: TypeSpecLibrary, | "routeProducer" | "routes" | "sharedRoutes" -| "routeOptions">; + | "routeOptions" +| "httpPart">; ``` ## Type declaration | Member | Type | Value | | :------ | :------ | :------ | -| `content-type-ignored` | `Object` | - | +| `content-type-ignored` | `object` | ... | | `content-type-ignored.default` | "\`Content-Type\` header ignored because there is no body." | "\`Content-Type\` header ignored because there is no body." | -| `content-type-string` | `Object` | - | +| `content-type-string` | `object` | ... | | `content-type-string.default` | `"contentType parameter must be a string literal or union of string literals"` | "contentType parameter must be a string literal or union of string literals" | -| `duplicate-body` | `Object` | - | +| `duplicate-body` | `object` | ... | | `duplicate-body.bodyAndUnannotated` | `"Operation has a @body and an unannotated parameter. There can only be one representing the body"` | "Operation has a @body and an unannotated parameter. There can only be one representing the body" | | `duplicate-body.default` | `"Operation has multiple @body parameters declared"` | "Operation has multiple @body parameters declared" | | `duplicate-body.duplicateUnannotated` | `"Operation has multiple unannotated parameters. There can only be one representing the body"` | "Operation has multiple unannotated parameters. There can only be one representing the body" | -| `duplicate-operation` | `Object` | - | -| `duplicate-operation.default` | `CallableMessage`<[`string`, `string`, `string`]\> | - | -| `duplicate-route-decorator` | `Object` | - | +| `duplicate-operation` | `object` | ... | +| `duplicate-operation.default` | `CallableMessage`<[`string`, `string`, `string`]\> | ... | +| `duplicate-route-decorator` | `object` | ... | | `duplicate-route-decorator.namespace` | `"@route was defined twice on this namespace and has different values."` | "@route was defined twice on this namespace and has different values." | -| `header-format-required` | `Object` | - | -| `header-format-required.default` | `"A format must be specified for @header when type is an array. e.g. @header({format: \"csv\"})"` | - | -| `http-verb-duplicate` | `Object` | - | -| `http-verb-duplicate.default` | `CallableMessage`<[`string`]\> | - | -| `http-verb-wrong-type` | `Object` | - | -| `http-verb-wrong-type.default` | `CallableMessage`<[`string`, `string`]\> | - | -| `invalid-type-for-auth` | `Object` | - | -| `invalid-type-for-auth.default` | `CallableMessage`<[`string`]\> | - | -| `metadata-ignored` | `Object` | - | -| `metadata-ignored.default` | `CallableMessage`<[`string`]\> | - | -| `missing-path-param` | `Object` | - | -| `missing-path-param.default` | `CallableMessage`<[`string`]\> | - | -| `missing-server-param` | `Object` | - | -| `missing-server-param.default` | `CallableMessage`<[`string`]\> | - | -| `multipart-model` | `Object` | - | +| `formdata-no-part-name` | `object` | ... | +| `formdata-no-part-name.default` | `"Part used in multipart/form-data must have a name."` | "Part used in multipart/form-data must have a name." | +| `header-format-required` | `object` | ... | +| `header-format-required.default` | "A format must be specified for @header when type is an array. e.g. @header(\{format: \"csv\"\})" | ... | +| `http-file-extra-property` | `object` | ... | +| `http-file-extra-property.default` | `CallableMessage`<[`string`]\> | ... | +| `http-verb-duplicate` | `object` | ... | +| `http-verb-duplicate.default` | `CallableMessage`<[`string`]\> | ... | +| `http-verb-wrong-type` | `object` | ... | +| `http-verb-wrong-type.default` | `CallableMessage`<[`string`, `string`]\> | ... | +| `invalid-type-for-auth` | `object` | ... | +| `invalid-type-for-auth.default` | `CallableMessage`<[`string`]\> | ... | +| `metadata-ignored` | `object` | ... | +| `metadata-ignored.default` | `CallableMessage`<[`string`]\> | ... | +| `missing-path-param` | `object` | ... | +| `missing-path-param.default` | `CallableMessage`<[`string`]\> | ... | +| `missing-server-param` | `object` | ... | +| `missing-server-param.default` | `CallableMessage`<[`string`]\> | ... | +| `multipart-invalid-content-type` | `object` | ... | +| `multipart-invalid-content-type.default` | `CallableMessage`<[`string`, `string`]\> | ... | +| `multipart-model` | `object` | ... | | `multipart-model.default` | `"Multipart request body must be a model."` | "Multipart request body must be a model." | -| `multiple-status-codes` | `Object` | - | +| `multipart-nested` | `object` | ... | +| `multipart-nested.default` | `"Cannot use @multipartBody inside of an HttpPart"` | "Cannot use @multipartBody inside of an HttpPart" | +| `multipart-part` | `object` | ... | +| `multipart-part.default` | `"Expect item to be an HttpPart model."` | "Expect item to be an HttpPart model." | +| `multiple-status-codes` | `object` | ... | | `multiple-status-codes.default` | "Multiple \`@statusCode\` decorators defined for this operation response." | "Multiple \`@statusCode\` decorators defined for this operation response." | -| `no-service-found` | `Object` | - | -| `no-service-found.default` | `CallableMessage`<[`string`]\> | - | -| `operation-param-duplicate-type` | `Object` | - | -| `operation-param-duplicate-type.default` | `CallableMessage`<[`string`, `string`]\> | - | -| `optional-path-param` | `Object` | - | -| `optional-path-param.default` | `CallableMessage`<[`string`]\> | - | -| `query-format-required` | `Object` | - | -| `query-format-required.default` | `"A format must be specified for @query when type is an array. e.g. @query({format: \"multi\"})"` | - | -| `shared-inconsistency` | `Object` | - | -| `shared-inconsistency.default` | `CallableMessage`<[`string`, `string`]\> | - | -| `status-code-invalid` | `Object` | - | +| `no-service-found` | `object` | ... | +| `no-service-found.default` | `CallableMessage`<[`string`]\> | ... | +| `operation-param-duplicate-type` | `object` | ... | +| `operation-param-duplicate-type.default` | `CallableMessage`<[`string`, `string`]\> | ... | +| `optional-path-param` | `object` | ... | +| `optional-path-param.default` | `CallableMessage`<[`string`]\> | ... | +| `query-format-required` | `object` | ... | +| `query-format-required.default` | "A format must be specified for @query when type is an array. e.g. @query(\{format: \"multi\"\})" | ... | +| `shared-inconsistency` | `object` | ... | +| `shared-inconsistency.default` | `CallableMessage`<[`string`, `string`]\> | ... | +| `status-code-invalid` | `object` | ... | | `status-code-invalid.default` | `"statusCode value must be a numeric or string literal or union of numeric or string literals"` | "statusCode value must be a numeric or string literal or union of numeric or string literals" | | `status-code-invalid.value` | `"statusCode value must be a three digit code between 100 and 599"` | "statusCode value must be a three digit code between 100 and 599" | -| `write-visibility-not-supported` | `Object` | - | -| `write-visibility-not-supported.default` | `"@visibility(\"write\") is not supported. Use @visibility(\"update\"), @visibility(\"create\") or @visibility(\"create\", \"update\") as appropriate."` | - | +| `write-visibility-not-supported` | `object` | ... | +| `write-visibility-not-supported.default` | "@visibility(\"write\") is not supported. Use @visibility(\"update\"), @visibility(\"create\") or @visibility(\"create\", \"update\") as appropriate." | ... | diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$defaultResponse.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$defaultResponse.md index 25ab4a45bfc..607f358e231 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$defaultResponse.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$defaultResponse.md @@ -4,7 +4,7 @@ title: "[F] $defaultResponse" --- ```ts -$defaultResponse(context, target): void +function $defaultResponse(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$extension.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$extension.md index b281f98f46e..81a4882c384 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$extension.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$extension.md @@ -4,7 +4,7 @@ title: "[F] $extension" --- ```ts -$extension( +function $extension( context, target, key, diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$externalDocs.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$externalDocs.md index 9a4485710de..18aa614f9c9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$externalDocs.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$externalDocs.md @@ -4,7 +4,7 @@ title: "[F] $externalDocs" --- ```ts -$externalDocs( +function $externalDocs( context, target, url, diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$info.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$info.md index 9dc9803a1a7..277f3a2840b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$info.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$info.md @@ -4,7 +4,7 @@ title: "[F] $info" --- ```ts -$info( +function $info( context, target, additionalInfo): void diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$operationId.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$operationId.md index 9528a9facfe..119a1bad840 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$operationId.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$operationId.md @@ -4,7 +4,7 @@ title: "[F] $operationId" --- ```ts -$operationId( +function $operationId( context, target, operationId): void diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/checkDuplicateTypeName.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/checkDuplicateTypeName.md index 596a03e178e..2561829ddcd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/checkDuplicateTypeName.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/checkDuplicateTypeName.md @@ -4,7 +4,7 @@ title: "[F] checkDuplicateTypeName" --- ```ts -checkDuplicateTypeName( +function checkDuplicateTypeName( program, type, name, diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExtensions.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExtensions.md index dbf5babdaf7..426578b9225 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExtensions.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExtensions.md @@ -4,7 +4,7 @@ title: "[F] getExtensions" --- ```ts -getExtensions(program, entity): ReadonlyMap +function getExtensions(program, entity): ReadonlyMap ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExternalDocs.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExternalDocs.md index 855a1c9e64c..5d139f36410 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExternalDocs.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getExternalDocs.md @@ -4,7 +4,7 @@ title: "[F] getExternalDocs" --- ```ts -getExternalDocs(program, entity): ExternalDocs | undefined +function getExternalDocs(program, entity): ExternalDocs | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getInfo.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getInfo.md index 866f66b07fa..c27c2a6fef4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getInfo.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getInfo.md @@ -4,7 +4,7 @@ title: "[F] getInfo" --- ```ts -getInfo(program, entity): AdditionalInfo | undefined +function getInfo(program, entity): AdditionalInfo | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOpenAPITypeName.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOpenAPITypeName.md index f1b32896d46..b96e2f65667 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOpenAPITypeName.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOpenAPITypeName.md @@ -4,7 +4,7 @@ title: "[F] getOpenAPITypeName" --- ```ts -getOpenAPITypeName( +function getOpenAPITypeName( program, type, options, diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOperationId.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOperationId.md index f6150de6c4b..8bce13c2c11 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOperationId.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getOperationId.md @@ -4,7 +4,7 @@ title: "[F] getOperationId" --- ```ts -getOperationId(program, entity): string | undefined +function getOperationId(program, entity): string | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getParameterKey.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getParameterKey.md index 5faa50ede49..980d31ecbf2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getParameterKey.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/getParameterKey.md @@ -4,7 +4,7 @@ title: "[F] getParameterKey" --- ```ts -getParameterKey( +function getParameterKey( program, property, newParam, diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isDefaultResponse.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isDefaultResponse.md index 0e1a024b769..07b1d1dfd94 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isDefaultResponse.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isDefaultResponse.md @@ -4,7 +4,7 @@ title: "[F] isDefaultResponse" --- ```ts -isDefaultResponse(program, entity): boolean +function isDefaultResponse(program, entity): boolean ``` Check if the given model has been mark as a default response. diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isReadonlyProperty.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isReadonlyProperty.md index 6594fe94901..87c5bb38a94 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isReadonlyProperty.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/isReadonlyProperty.md @@ -4,7 +4,7 @@ title: "[F] isReadonlyProperty" --- ```ts -isReadonlyProperty(program, property): boolean +function isReadonlyProperty(program, property): boolean ``` Determines if a property is read-only, which is defined as being diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveInfo.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveInfo.md index 6157a66c9fb..cbb22b903a4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveInfo.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveInfo.md @@ -4,7 +4,7 @@ title: "[F] resolveInfo" --- ```ts -resolveInfo(program, entity): AdditionalInfo | undefined +function resolveInfo(program, entity): AdditionalInfo | undefined ``` Resolve the info entry by merging data specified with `@service`, `@summary` and `@info`. diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveOperationId.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveOperationId.md index 7c61cc81012..9c5448c7584 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveOperationId.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/resolveOperationId.md @@ -4,7 +4,7 @@ title: "[F] resolveOperationId" --- ```ts -resolveOperationId(program, operation): string +function resolveOperationId(program, operation): string ``` Resolve the OpenAPI operation ID for the given operation using the following logic: diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/setExtension.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/setExtension.md index 09c73e9128c..5f7555006c6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/setExtension.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/setExtension.md @@ -4,7 +4,7 @@ title: "[F] setExtension" --- ```ts -setExtension( +function setExtension( program, entity, extensionName, @@ -17,7 +17,7 @@ setExtension( | :------ | :------ | | `program` | `Program` | | `entity` | `Type` | -| `extensionName` | \`x-${string}\` | +| `extensionName` | \`x-$\{string\}\` | | `data` | `unknown` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/shouldInline.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/shouldInline.md index 539e51977b6..5de3331ed24 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/shouldInline.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/shouldInline.md @@ -4,7 +4,7 @@ title: "[F] shouldInline" --- ```ts -shouldInline(program, type): boolean +function shouldInline(program, type): boolean ``` Determines whether a type will be inlined in OpenAPI rather than defined diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/type-aliases/ExtensionKey.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/type-aliases/ExtensionKey.md index e5249ff81c3..7f133f3b1cd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/type-aliases/ExtensionKey.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/type-aliases/ExtensionKey.md @@ -4,5 +4,5 @@ title: "[T] ExtensionKey" --- ```ts -type ExtensionKey: \x-${string}\; +type ExtensionKey: `x-${string}`; ``` diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$action.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$action.md index 7c45e08a5c3..e48f7940843 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$action.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$action.md @@ -4,7 +4,7 @@ title: "[F] $action" --- ```ts -$action( +function $action( context, target, name?): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSegment.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSegment.md index 7b2a7c302e6..26e065cabc8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSegment.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSegment.md @@ -4,7 +4,7 @@ title: "[F] $actionSegment" --- ```ts -$actionSegment( +function $actionSegment( context, target, value): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSeparator.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSeparator.md index 595b0ae5a74..62f3ac76ceb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSeparator.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSeparator.md @@ -4,7 +4,7 @@ title: "[F] $actionSeparator" --- ```ts -$actionSeparator( +function $actionSeparator( context, entity, separator): void @@ -20,7 +20,7 @@ $actionSeparator( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `ModelProperty` \| `Model` \| `Operation` | +| `entity` | `Model` \| `ModelProperty` \| `Operation` | | `separator` | `"/"` \| `":"` \| `"/:"` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$autoRoute.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$autoRoute.md index 7c97e67eeec..b25c7c9cf38 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$autoRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$autoRoute.md @@ -4,7 +4,7 @@ title: "[F] $autoRoute" --- ```ts -$autoRoute(context, target): void +function $autoRoute(context, target): void ``` `@autoRoute` enables automatic route generation for an operation or interface. diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$collectionAction.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$collectionAction.md index 59d491664f6..6630aed584d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$collectionAction.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$collectionAction.md @@ -4,7 +4,7 @@ title: "[F] $collectionAction" --- ```ts -$collectionAction( +function $collectionAction( context, target, resourceType, diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$copyResourceKeyParameters.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$copyResourceKeyParameters.md index 44fbf81ad74..0261fa666e0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$copyResourceKeyParameters.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$copyResourceKeyParameters.md @@ -4,7 +4,7 @@ title: "[F] $copyResourceKeyParameters" --- ```ts -$copyResourceKeyParameters( +function $copyResourceKeyParameters( context, entity, filter?): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrReplacesResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrReplacesResource.md index fe8d8b459f1..be060b775b2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrReplacesResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrReplacesResource.md @@ -4,7 +4,7 @@ title: "[F] $createsOrReplacesResource" --- ```ts -$createsOrReplacesResource( +function $createsOrReplacesResource( context, entity, resourceType): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrUpdatesResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrUpdatesResource.md index a8403a7f8c1..404cf69e4e0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrUpdatesResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsOrUpdatesResource.md @@ -4,7 +4,7 @@ title: "[F] $createsOrUpdatesResource" --- ```ts -$createsOrUpdatesResource( +function $createsOrUpdatesResource( context, entity, resourceType): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsResource.md index 10f11b10150..00fe8180a28 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$createsResource.md @@ -4,7 +4,7 @@ title: "[F] $createsResource" --- ```ts -$createsResource( +function $createsResource( context, entity, resourceType): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$deletesResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$deletesResource.md index 2fe790c329f..841aecd33cd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$deletesResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$deletesResource.md @@ -4,7 +4,7 @@ title: "[F] $deletesResource" --- ```ts -$deletesResource( +function $deletesResource( context, entity, resourceType): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$listsResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$listsResource.md index ebf860a2853..7500bf938fd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$listsResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$listsResource.md @@ -4,7 +4,7 @@ title: "[F] $listsResource" --- ```ts -$listsResource( +function $listsResource( context, target, resourceType): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$onValidate.md index 212e92eb72e..3b2236c14ab 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$onValidate.md @@ -4,7 +4,7 @@ title: "[F] $onValidate" --- ```ts -$onValidate(program): void +function $onValidate(program): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$parentResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$parentResource.md index b8990d51026..720a8106233 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$parentResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$parentResource.md @@ -4,7 +4,7 @@ title: "[F] $parentResource" --- ```ts -$parentResource( +function $parentResource( context, target, parent): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$readsResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$readsResource.md index 3c1424f9c09..406230d9931 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$readsResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$readsResource.md @@ -4,7 +4,7 @@ title: "[F] $readsResource" --- ```ts -$readsResource( +function $readsResource( context, target, resourceType): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resource.md index 4f2bb0e812f..71d5fe42d4c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resource.md @@ -4,7 +4,7 @@ title: "[F] $resource" --- ```ts -$resource( +function $resource( context, target, collectionName): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceLocation.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceLocation.md index 350044c631f..27357d8c45d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceLocation.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceLocation.md @@ -4,7 +4,7 @@ title: "[F] $resourceLocation" --- ```ts -$resourceLocation( +function $resourceLocation( context, target, resourceType): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceTypeForKeyParam.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceTypeForKeyParam.md index 2c47b2f263c..6d1138c2e4c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceTypeForKeyParam.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceTypeForKeyParam.md @@ -4,7 +4,7 @@ title: "[F] $resourceTypeForKeyParam" --- ```ts -$resourceTypeForKeyParam( +function $resourceTypeForKeyParam( context, entity, resourceType): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segment.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segment.md index 1dcc213df92..3bd75f9820d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segment.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segment.md @@ -4,7 +4,7 @@ title: "[F] $segment" --- ```ts -$segment( +function $segment( context, entity, name): void @@ -22,7 +22,7 @@ path parameter's name field. | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `ModelProperty` \| `Model` \| `Operation` | +| `entity` | `Model` \| `ModelProperty` \| `Operation` | | `name` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segmentOf.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segmentOf.md index b90d9f5803c..734909cfb7a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segmentOf.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segmentOf.md @@ -4,7 +4,7 @@ title: "[F] $segmentOf" --- ```ts -$segmentOf( +function $segmentOf( context, target, type): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$updatesResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$updatesResource.md index 22655150edf..c9fcee81dec 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$updatesResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$updatesResource.md @@ -4,7 +4,7 @@ title: "[F] $updatesResource" --- ```ts -$updatesResource( +function $updatesResource( context, entity, resourceType): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getAction.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getAction.md index ff9533a06f5..cadb42849c1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getAction.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getAction.md @@ -4,7 +4,7 @@ title: "[F] getAction" --- ```ts -getAction(program, operation): string | null | undefined +function getAction(program, operation): string | null | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionDetails.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionDetails.md index 2061cae0066..f721124e4f6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionDetails.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionDetails.md @@ -4,7 +4,7 @@ title: "[F] getActionDetails" --- ```ts -getActionDetails(program, operation): ActionDetails | undefined +function getActionDetails(program, operation): ActionDetails | undefined ``` Gets the ActionDetails for the specified operation if it has previously been marked with @action. diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSegment.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSegment.md index 4a67666f95f..11193928be0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSegment.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSegment.md @@ -4,7 +4,7 @@ title: "[F] getActionSegment" --- ```ts -getActionSegment(program, entity): string | undefined +function getActionSegment(program, entity): string | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSeparator.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSeparator.md index ad10e29315f..c86a7e6eedf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSeparator.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getActionSeparator.md @@ -4,7 +4,7 @@ title: "[F] getActionSeparator" --- ```ts -getActionSeparator(program, entity): string | undefined +function getActionSeparator(program, entity): string | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionAction.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionAction.md index d1641f55e9f..e8187b8be83 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionAction.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionAction.md @@ -4,7 +4,7 @@ title: "[F] getCollectionAction" --- ```ts -getCollectionAction(program, operation): string | null | undefined +function getCollectionAction(program, operation): string | null | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionActionDetails.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionActionDetails.md index d0d4616f7e0..c1e40bbdb9a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionActionDetails.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getCollectionActionDetails.md @@ -4,7 +4,7 @@ title: "[F] getCollectionActionDetails" --- ```ts -getCollectionActionDetails(program, operation): ActionDetails | undefined +function getCollectionActionDetails(program, operation): ActionDetails | undefined ``` Gets the ActionDetails for the specified operation if it has previously been marked with @collectionAction. diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getParentResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getParentResource.md index 035bf89e60e..d930349aa2b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getParentResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getParentResource.md @@ -4,7 +4,7 @@ title: "[F] getParentResource" --- ```ts -getParentResource(program, resourceType): Model | undefined +function getParentResource(program, resourceType): Model | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceLocationType.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceLocationType.md index ef5607dd0c9..0b26ef5e890 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceLocationType.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceLocationType.md @@ -4,7 +4,7 @@ title: "[F] getResourceLocationType" --- ```ts -getResourceLocationType(program, entity): Model | undefined +function getResourceLocationType(program, entity): Model | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceOperation.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceOperation.md index 38e8f197c37..18415e1534d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceOperation.md @@ -4,7 +4,7 @@ title: "[F] getResourceOperation" --- ```ts -getResourceOperation(program, typespecOperation): ResourceOperation | undefined +function getResourceOperation(program, typespecOperation): ResourceOperation | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeForKeyParam.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeForKeyParam.md index 916fa74d2ab..f5cca459f39 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeForKeyParam.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeForKeyParam.md @@ -4,7 +4,7 @@ title: "[F] getResourceTypeForKeyParam" --- ```ts -getResourceTypeForKeyParam(program, param): Model | undefined +function getResourceTypeForKeyParam(program, param): Model | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeKey.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeKey.md index 6b3ac20de6e..be6bf69f798 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeKey.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getResourceTypeKey.md @@ -4,7 +4,7 @@ title: "[F] getResourceTypeKey" --- ```ts -getResourceTypeKey(program, resourceType): ResourceKey | undefined +function getResourceTypeKey(program, resourceType): ResourceKey | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getSegment.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getSegment.md index 4b391cbea41..eef7dc41e93 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getSegment.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/getSegment.md @@ -4,7 +4,7 @@ title: "[F] getSegment" --- ```ts -getSegment(program, entity): string | undefined +function getSegment(program, entity): string | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isAutoRoute.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isAutoRoute.md index a2e3f25b11a..7fbc1ab5f95 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isAutoRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isAutoRoute.md @@ -4,7 +4,7 @@ title: "[F] isAutoRoute" --- ```ts -isAutoRoute(program, entity): boolean +function isAutoRoute(program, entity): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isListOperation.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isListOperation.md index 0ace542980e..c2e263c4958 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isListOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/isListOperation.md @@ -4,7 +4,7 @@ title: "[F] isListOperation" --- ```ts -isListOperation(program, target): boolean +function isListOperation(program, target): boolean ``` Returns `true` if the given operation is marked as a list operation. diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceOperation.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceOperation.md index 74831209bcd..1f46905c31c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceOperation.md @@ -4,7 +4,7 @@ title: "[F] setResourceOperation" --- ```ts -setResourceOperation( +function setResourceOperation( context, entity, resourceType, diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceTypeKey.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceTypeKey.md index 511fa16af90..ef9ae9dc671 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceTypeKey.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/setResourceTypeKey.md @@ -4,7 +4,7 @@ title: "[F] setResourceTypeKey" --- ```ts -setResourceTypeKey( +function setResourceTypeKey( program, resourceType, keyProperty): void diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ActionDetails.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ActionDetails.md index 449ba33cf4c..906b7fb4442 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ActionDetails.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/interfaces/ActionDetails.md @@ -9,5 +9,5 @@ Provides details about an action or collection action. | Property | Type | Description | | :------ | :------ | :------ | -| `kind` | `"automatic"` \| `"specified"` | Identifies whether the action's name was generated from the original
operation name or if it was explicitly specified. | +| `kind` | `"automatic"` \| `"specified"` | Identifies whether the action's name was generated from the original operation name or if it was explicitly specified. | | `name` | `string` | The name of the action | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/decorators.md index 08da695b585..42a25fac7c3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/decorators.md @@ -72,6 +72,35 @@ model Foo { } ``` +### `@madeRequired` {#@TypeSpec.Versioning.madeRequired} + +Identifies when a target was made required. + +```typespec +@TypeSpec.Versioning.madeRequired(version: EnumMember) +``` + +#### Target + +`ModelProperty` + +#### Parameters + +| Name | Type | Description | +| ------- | ------------ | ------------------------------------------------- | +| version | `EnumMember` | The version that the target was made required in. | + +#### Examples + +```tsp +model Foo { + name: string; + + @madeRequired(Versions.v2) + nickname: string; +} +``` + ### `@removed` {#@TypeSpec.Versioning.removed} Identifies when the target was removed. diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/index.mdx b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/index.mdx index c5bc25693d4..1a9826b0347 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/index.mdx +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/index.mdx @@ -37,6 +37,7 @@ npm install --save-peer @typespec/versioning - [`@added`](./decorators.md#@TypeSpec.Versioning.added) - [`@madeOptional`](./decorators.md#@TypeSpec.Versioning.madeOptional) +- [`@madeRequired`](./decorators.md#@TypeSpec.Versioning.madeRequired) - [`@removed`](./decorators.md#@TypeSpec.Versioning.removed) - [`@renamedFrom`](./decorators.md#@TypeSpec.Versioning.renamedFrom) - [`@returnTypeChangedFrom`](./decorators.md#@TypeSpec.Versioning.returnTypeChangedFrom) diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/classes/VersionMap.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/classes/VersionMap.md index 9285f4264ab..bcc25aab450 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/classes/VersionMap.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/classes/VersionMap.md @@ -5,7 +5,7 @@ title: "[C] VersionMap" --- ## Constructors -### new VersionMap(namespace, enumType) +### new VersionMap() ```ts new VersionMap(namespace, enumType): VersionMap @@ -24,9 +24,9 @@ new VersionMap(namespace, enumType): VersionMap ## Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `map` | `private` | `Map`<`EnumMember`, [`Version`](../interfaces/Version.md)\> | +| Property | Modifier | Type | Default value | +| :------ | :------ | :------ | :------ | +| `map` | `private` | `Map`<`EnumMember`, [`Version`](../interfaces/Version.md)\> | `...` | ## Accessors diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$added.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$added.md index 07fd15966fd..bcd6aaa86b8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$added.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$added.md @@ -4,7 +4,7 @@ title: "[F] $added" --- ```ts -$added( +function $added( context, target, version): void @@ -15,7 +15,7 @@ $added( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | \| `Scalar` \| `ModelProperty` \| `Model` \| `Interface` \| `Enum` \| `EnumMember` \| `Operation` \| `Union` \| `UnionVariant` | +| `target` | \| `Enum` \| `EnumMember` \| `Interface` \| `Model` \| `ModelProperty` \| `Operation` \| `Scalar` \| `Union` \| `UnionVariant` | | `version` | `EnumMember` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeOptional.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeOptional.md index 2513a9314e5..52adced9d82 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeOptional.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeOptional.md @@ -4,7 +4,7 @@ title: "[F] $madeOptional" --- ```ts -$madeOptional( +function $madeOptional( context, target, version): void diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeRequired.md similarity index 56% rename from packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md rename to packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeRequired.md index 4f82a6343b0..5e8a23f0569 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeRequired.md @@ -1,13 +1,13 @@ --- jsApi: true -title: "[F] $stream" +title: "[F] $madeRequired" --- ```ts -$stream( +function $madeRequired( context, target, - mode): void + version): void ``` ## Parameters @@ -15,8 +15,8 @@ $stream( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Operation` | -| `mode` | `Type` | +| `target` | `ModelProperty` | +| `version` | `EnumMember` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$onValidate.md index 212e92eb72e..3b2236c14ab 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$onValidate.md @@ -4,7 +4,7 @@ title: "[F] $onValidate" --- ```ts -$onValidate(program): void +function $onValidate(program): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$removed.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$removed.md index 29716f7d5c3..eb79ad607a8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$removed.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$removed.md @@ -4,7 +4,7 @@ title: "[F] $removed" --- ```ts -$removed( +function $removed( context, t, v): void @@ -15,7 +15,7 @@ $removed( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `t` | \| `Scalar` \| `ModelProperty` \| `Model` \| `Interface` \| `Enum` \| `EnumMember` \| `Operation` \| `Union` \| `UnionVariant` | +| `t` | \| `Enum` \| `EnumMember` \| `Interface` \| `Model` \| `ModelProperty` \| `Operation` \| `Scalar` \| `Union` \| `UnionVariant` | | `v` | `EnumMember` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$renamedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$renamedFrom.md index b5f13c50526..2556f27490f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$renamedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$renamedFrom.md @@ -4,7 +4,7 @@ title: "[F] $renamedFrom" --- ```ts -$renamedFrom( +function $renamedFrom( context, target, version, @@ -16,7 +16,7 @@ $renamedFrom( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | \| `Scalar` \| `ModelProperty` \| `Model` \| `Interface` \| `Enum` \| `EnumMember` \| `Operation` \| `Union` \| `UnionVariant` | +| `target` | \| `Enum` \| `EnumMember` \| `Interface` \| `Model` \| `ModelProperty` \| `Operation` \| `Scalar` \| `Union` \| `UnionVariant` | | `version` | `EnumMember` | | `oldName` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$returnTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$returnTypeChangedFrom.md index 4be50ea782e..714fd6f1920 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$returnTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$returnTypeChangedFrom.md @@ -4,7 +4,7 @@ title: "[F] $returnTypeChangedFrom" --- ```ts -$returnTypeChangedFrom( +function $returnTypeChangedFrom( context, target, version, diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$typeChangedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$typeChangedFrom.md index 961a253b18c..6683edc9914 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$typeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$typeChangedFrom.md @@ -4,7 +4,7 @@ title: "[F] $typeChangedFrom" --- ```ts -$typeChangedFrom( +function $typeChangedFrom( context, target, version, diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$useDependency.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$useDependency.md index b49fdc61e59..be43d9ae5bf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$useDependency.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$useDependency.md @@ -4,7 +4,7 @@ title: "[F] $useDependency" --- ```ts -$useDependency( +function $useDependency( context, target, ... versionRecords): void @@ -15,7 +15,7 @@ $useDependency( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `EnumMember` \| `Namespace` | +| `target` | `Namespace` \| `EnumMember` | | ...`versionRecords` | `EnumMember`[] | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$versioned.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$versioned.md index e3bab32690b..5d20fc5c545 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$versioned.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$versioned.md @@ -4,7 +4,7 @@ title: "[F] $versioned" --- ```ts -$versioned( +function $versioned( context, target, versions): void diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/buildVersionProjections.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/buildVersionProjections.md index 0cebfc653cb..5e9f8ca7d32 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/buildVersionProjections.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/buildVersionProjections.md @@ -4,7 +4,7 @@ title: "[F] buildVersionProjections" --- ```ts -buildVersionProjections(program, rootNs): VersionProjections[] +function buildVersionProjections(program, rootNs): VersionProjections[] ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/existsAtVersion.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/existsAtVersion.md deleted file mode 100644 index 0859befce57..00000000000 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/existsAtVersion.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] existsAtVersion" - ---- -```ts -existsAtVersion( - p, - type, - versionKey): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `p` | `Program` | -| `type` | `Type` | -| `versionKey` | `ObjectType` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/findVersionedNamespace.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/findVersionedNamespace.md index 5e282acbda9..d59bc47cb7a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/findVersionedNamespace.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/findVersionedNamespace.md @@ -4,7 +4,7 @@ title: "[F] findVersionedNamespace" --- ```ts -findVersionedNamespace(program, namespace): Namespace | undefined +function findVersionedNamespace(program, namespace): Namespace | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAddedOnVersions.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAddedOnVersions.md index 1850c0e9b18..c22f7e763cf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAddedOnVersions.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAddedOnVersions.md @@ -4,7 +4,7 @@ title: "[F] getAddedOnVersions" --- ```ts -getAddedOnVersions(p, t): Version[] | undefined +function getAddedOnVersions(p, t): Version[] | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMap.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMap.md index f39c2e9e39f..9152ffc3467 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMap.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMap.md @@ -4,7 +4,7 @@ title: "[F] getAvailabilityMap" --- ```ts -getAvailabilityMap(program, type): Map | undefined +function getAvailabilityMap(program, type): Map | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md index dfd9932bccb..21b09221790 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getAvailabilityMapInTimeline.md @@ -4,7 +4,7 @@ title: "[F] getAvailabilityMapInTimeline" --- ```ts -getAvailabilityMapInTimeline( +function getAvailabilityMapInTimeline( program, type, timeline): Map | undefined diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getMadeOptionalOn.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getMadeOptionalOn.md index f2f1758a104..4155da45d7c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getMadeOptionalOn.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getMadeOptionalOn.md @@ -4,7 +4,7 @@ title: "[F] getMadeOptionalOn" --- ```ts -getMadeOptionalOn(p, t): Version | undefined +function getMadeOptionalOn(p, t): Version | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getNameAtVersion.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getNameAtVersion.md deleted file mode 100644 index 7152651a3c2..00000000000 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getNameAtVersion.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] getNameAtVersion" - ---- -```ts -getNameAtVersion( - p, - t, - versionKey): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `p` | `Program` | -| `t` | `Type` | -| `versionKey` | `ObjectType` | - -## Returns - -`string` - -get old name if applicable. diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRemovedOnVersions.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRemovedOnVersions.md index 2710d05daff..48b0d50564b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRemovedOnVersions.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRemovedOnVersions.md @@ -4,7 +4,7 @@ title: "[F] getRemovedOnVersions" --- ```ts -getRemovedOnVersions(p, t): Version[] | undefined +function getRemovedOnVersions(p, t): Version[] | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFrom.md index 281d453204c..35c1f947ace 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFrom.md @@ -4,7 +4,7 @@ title: "[F] getRenamedFrom" --- ```ts -getRenamedFrom(p, t): RenamedFrom[] | undefined +function getRenamedFrom(p, t): RenamedFrom[] | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFromVersions.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFromVersions.md index 7271627b657..648245770e8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFromVersions.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getRenamedFromVersions.md @@ -4,7 +4,7 @@ title: "[F] getRenamedFromVersions" --- ```ts -getRenamedFromVersions(p, t): Version[] | undefined +function getRenamedFromVersions(p, t): Version[] | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getReturnTypeBeforeVersion.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getReturnTypeBeforeVersion.md deleted file mode 100644 index 4dd8f4ac806..00000000000 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getReturnTypeBeforeVersion.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] getReturnTypeBeforeVersion" - ---- -```ts -getReturnTypeBeforeVersion( - p, - t, - versionKey): any -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `p` | `Program` | -| `t` | `Type` | -| `versionKey` | `ObjectType` | - -## Returns - -`any` - -get old type if applicable. diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md index fcfe8651a23..0b61ca1cf11 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getReturnTypeChangedFrom.md @@ -4,7 +4,7 @@ title: "[F] getReturnTypeChangedFrom" --- ```ts -getReturnTypeChangedFrom(p, t): Map | undefined +function getReturnTypeChangedFrom(p, t): Map | undefined ``` Returns the mapping of versions to old return type values, if applicable diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getTypeBeforeVersion.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getTypeBeforeVersion.md deleted file mode 100644 index 9577e38be66..00000000000 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getTypeBeforeVersion.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] getTypeBeforeVersion" - ---- -```ts -getTypeBeforeVersion( - p, - t, - versionKey): Type | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `p` | `Program` | -| `t` | `Type` | -| `versionKey` | `ObjectType` | - -## Returns - -`Type` \| `undefined` - -get old type if applicable. diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getTypeChangedFrom.md index cfc7770ff34..fd20cc21aff 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getTypeChangedFrom.md @@ -4,7 +4,7 @@ title: "[F] getTypeChangedFrom" --- ```ts -getTypeChangedFrom(p, t): Map | undefined +function getTypeChangedFrom(p, t): Map | undefined ``` Returns the mapping of versions to old type values, if applicable diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getUseDependencies.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getUseDependencies.md index 91e38014def..6a7748063cf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getUseDependencies.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getUseDependencies.md @@ -4,7 +4,7 @@ title: "[F] getUseDependencies" --- ```ts -getUseDependencies( +function getUseDependencies( program, target, searchEnum): Map | Version> | undefined @@ -15,7 +15,7 @@ getUseDependencies( | Parameter | Type | Default value | | :------ | :------ | :------ | | `program` | `Program` | `undefined` | -| `target` | `Enum` \| `Namespace` | `undefined` | +| `target` | `Namespace` \| `Enum` | `undefined` | | `searchEnum` | `boolean` | `true` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersion.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersion.md index 5e41facaf2c..19c4115fe83 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersion.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersion.md @@ -4,7 +4,7 @@ title: "[F] getVersion" --- ```ts -getVersion(program, namespace): VersionMap | undefined +function getVersion(program, namespace): VersionMap | undefined ``` Get the version map of the namespace. diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionDependencies.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionDependencies.md index d634787c134..13c387f598a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionDependencies.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionDependencies.md @@ -4,7 +4,7 @@ title: "[F] getVersionDependencies" --- ```ts -getVersionDependencies(program, namespace): Map | Version> | undefined +function getVersionDependencies(program, namespace): Map | Version> | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionForEnumMember.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionForEnumMember.md index 5766333d94c..34759d0beda 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionForEnumMember.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionForEnumMember.md @@ -4,7 +4,7 @@ title: "[F] getVersionForEnumMember" --- ```ts -getVersionForEnumMember(program, member): Version | undefined +function getVersionForEnumMember(program, member): Version | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersions.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersions.md index 16ff101189b..ab2ccab6caa 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersions.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersions.md @@ -4,7 +4,7 @@ title: "[F] getVersions" --- ```ts -getVersions(p, t): [Namespace, VersionMap] | [] +function getVersions(p, t): [Namespace, VersionMap] | [] ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionsForEnum.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionsForEnum.md index 75d0c4198a3..159ee0442cf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionsForEnum.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/getVersionsForEnum.md @@ -4,7 +4,7 @@ title: "[F] getVersionsForEnum" --- ```ts -getVersionsForEnum(program, en): [Namespace, VersionMap] | [] +function getVersionsForEnum(program, en): [Namespace, VersionMap] | [] ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/hasDifferentNameAtVersion.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/hasDifferentNameAtVersion.md deleted file mode 100644 index f10a2a59403..00000000000 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/hasDifferentNameAtVersion.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] hasDifferentNameAtVersion" - ---- -```ts -hasDifferentNameAtVersion( - p, - type, - version): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `p` | `Program` | -| `type` | `Type` | -| `version` | `ObjectType` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/hasDifferentReturnTypeAtVersion.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/hasDifferentReturnTypeAtVersion.md deleted file mode 100644 index 9f3c307f8b7..00000000000 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/hasDifferentReturnTypeAtVersion.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] hasDifferentReturnTypeAtVersion" - ---- -```ts -hasDifferentReturnTypeAtVersion( - p, - type, - version): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `p` | `Program` | -| `type` | `Type` | -| `version` | `ObjectType` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/hasDifferentTypeAtVersion.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/hasDifferentTypeAtVersion.md deleted file mode 100644 index 56b9d0e896c..00000000000 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/hasDifferentTypeAtVersion.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] hasDifferentTypeAtVersion" - ---- -```ts -hasDifferentTypeAtVersion( - p, - type, - version): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `p` | `Program` | -| `type` | `Type` | -| `version` | `ObjectType` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/resolveVersions.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/resolveVersions.md index 517dd64bf3c..1f3d2eafb1a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/resolveVersions.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/resolveVersions.md @@ -4,7 +4,7 @@ title: "[F] resolveVersions" --- ```ts -resolveVersions(program, namespace): VersionResolution[] +function resolveVersions(program, namespace): VersionResolution[] ``` Resolve the version to use for all namespace for each of the root namespace versions. diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/index.md index 411294a3cb4..df1952959ec 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/index.md @@ -17,14 +17,11 @@ title: "[P] JS API" - [VersionProjections](interfaces/VersionProjections.md) - [VersionResolution](interfaces/VersionResolution.md) -## Variables - -- [namespace](variables/namespace.md) - ## Functions - [$added](functions/$added.md) - [$madeOptional](functions/$madeOptional.md) +- [$madeRequired](functions/$madeRequired.md) - [$onValidate](functions/$onValidate.md) - [$removed](functions/$removed.md) - [$renamedFrom](functions/$renamedFrom.md) @@ -33,19 +30,15 @@ title: "[P] JS API" - [$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) @@ -53,8 +46,4 @@ title: "[P] JS API" - [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/libraries/versioning/reference/js-api/variables/namespace.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/variables/namespace.md deleted file mode 100644 index 9c54508ab3b..00000000000 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/variables/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/libraries/xml/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/decorators.md index 0f384c07cba..d1917fce4dd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/decorators.md @@ -36,7 +36,7 @@ model Blob { ```xml -abcdef + abcdef ``` @@ -85,9 +85,9 @@ model Book { ```xml -string -string -string + string + string + string ``` @@ -192,11 +192,11 @@ model Pet { ```xml - - -string - - + + + string + + ``` @@ -210,9 +210,9 @@ model Pet { ```xml - -string - + + string + ``` @@ -226,9 +226,9 @@ model BlobName { ```xml - -abcdef - + + abcdef + ``` @@ -242,6 +242,6 @@ model BlobName { ```xml -abcdef + abcdef ``` diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$attribute.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$attribute.md index eec07dbbbf8..af08cdeb19c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$attribute.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$attribute.md @@ -4,7 +4,7 @@ title: "[F] $attribute" --- ```ts -$attribute(context, target): void +function $attribute(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$name.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$name.md index 1004aa3aec7..43b53c8907f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$name.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$name.md @@ -4,7 +4,7 @@ title: "[F] $name" --- ```ts -$name( +function $name( context, target, name): void diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$ns.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$ns.md index 8fdcdd8e77d..bc571ef2a11 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$ns.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$ns.md @@ -4,7 +4,7 @@ title: "[F] $ns" --- ```ts -$ns( +function $ns( context, target, ns, diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$nsDeclarations.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$nsDeclarations.md index cfae36e7ce7..cf1811e6fdf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$nsDeclarations.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$nsDeclarations.md @@ -4,7 +4,7 @@ title: "[F] $nsDeclarations" --- ```ts -$nsDeclarations(context, target): void +function $nsDeclarations(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$unwrapped.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$unwrapped.md index f905329db29..5fcbb72e682 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$unwrapped.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/$unwrapped.md @@ -4,7 +4,7 @@ title: "[F] $unwrapped" --- ```ts -$unwrapped(context, target): void +function $unwrapped(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getNs.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getNs.md index a06ac7f7457..2c9a6fc088e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getNs.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getNs.md @@ -4,7 +4,7 @@ title: "[F] getNs" --- ```ts -getNs(program, target): XmlNamespace | undefined +function getNs(program, target): XmlNamespace | undefined ``` Get the namespace and prefix for the given type. diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getXmlEncoding.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getXmlEncoding.md index bdc160dc16c..8a3917b0f0d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getXmlEncoding.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/getXmlEncoding.md @@ -4,7 +4,7 @@ title: "[F] getXmlEncoding" --- ```ts -getXmlEncoding(program, type): XmlEncodeData | undefined +function getXmlEncoding(program, type): XmlEncodeData | undefined ``` Resolve how the given type should be encoded in XML. @@ -15,7 +15,7 @@ This will return the default encoding for each types.(e.g. TypeSpec.Xml.Encoding | Parameter | Type | Description | | :------ | :------ | :------ | | `program` | `Program` | | -| `type` | `Scalar` \| `ModelProperty` | | +| `type` | `ModelProperty` \| `Scalar` | | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isAttribute.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isAttribute.md index 8bd7968a00a..38f4bf62db4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isAttribute.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isAttribute.md @@ -4,7 +4,7 @@ title: "[F] isAttribute" --- ```ts -isAttribute(program, target): boolean +function isAttribute(program, target): boolean ``` Check if the given property should be serialized as an attribute instead of a node. diff --git a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isUnwrapped.md b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isUnwrapped.md index 38981cfabda..068043f60b2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isUnwrapped.md +++ b/packages/website/versioned_docs/version-latest/libraries/xml/reference/js-api/functions/isUnwrapped.md @@ -4,7 +4,7 @@ title: "[F] isUnwrapped" --- ```ts -isUnwrapped(program, target): boolean +function isUnwrapped(program, target): boolean ``` Check if the given property should be unwrapped in the XML containing node. diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2024-02-06.md b/packages/website/versioned_docs/version-latest/release-notes/release-2024-02-06.md index 6e1d98b877e..0ff2d186160 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2024-02-06.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2024-02-06.md @@ -6,7 +6,7 @@ title: February 2024 ## Release of VSCode and Visual Studio extensions -- [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=typespec.vscode-extension) +- [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=typespec.typespec-vscode) - [Visual Studio Extension](https://marketplace.visualstudio.com/items?itemName=typespec.typespecvs) ## New Features diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2024-06-10.md b/packages/website/versioned_docs/version-latest/release-notes/release-2024-06-10.md new file mode 100644 index 00000000000..5e37300aee7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2024-06-10.md @@ -0,0 +1,259 @@ +--- +title: 0.57 - June 2024 +--- + +:::warning +This release contains deprecations +::: + +## Values In TypeSpec + +Decorators often expect some sort of configuration to be passed as an argument. In version `0.51.0` we introduced the `valueof` keyword to constrain a decorator or template parameter to be a value, however this was limited to string, numeric and boolean values. +When dealing with more complex decorators or free form data, one had to use a model type to represent the data. Unfortunately, this approach was difficult for decorator authors to handle reliably and required somewhat sophisticated validation to avoid some common pitfalls that couldn't be prevented through type system constraints. + +In this release we introduce a new concept to TypeSpec: values. This includes new syntax for declaring object and array values, scalar constructors, and `const` declarations. + +### Object values + +Object values can be declared with the `#{}` syntax. + +```tsp +const user = #{ name: "Bob", age: 48, address: #{ city: "London" } }; +``` + +### Array values + +Array values can be declared with the `#[]` syntax. + +```tsp +const users = #["Bob", "Frank"]; +``` + +### `const` + +Const declares a variable that holds a value, and can optionally specify a type. + +```tsp +const name = "Bob"; +const name: string = "Bob"; +``` + +### Scalar constructors + +Scalars can define custom values with scalar value constructors. Scalars which don't extend a base type like `string`, `number` or `boolean` can define a constructor. + +```tsp +scalar ipV4 { + init fromInt(value: int32); +} +const ip: ipV4 = ipV4.fromInt(3232235776); +``` + +[See values doc for more info](https://typespec.io/docs/language-basics/values) + +## Deprecations + +### @typespec/compiler + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Using a tuple type as a value is deprecated. Tuple types in contexts where values are expected must be updated to be array values instead. A codefix is provided to automatically convert tuple types into array values. + +```tsp +model Test { + // Deprecated + values: string[] = ["a", "b", "c"]; + + // Correct + values: string[] = #["a", "b", "c"]; +} +``` + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Using a model type as a value is deprecated. Model types in contexts where values are expected must be updated to be object values instead. A codefix is provided to automatically convert model types into object values. + +```tsp +model Test { + // Deprecated + user: { + name: string; + } = { + name: "System"; + }; + + // Correct + user: { + name: string; + } = #{ name: "System" }; +} +``` + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Decorator API: Legacy marshalling logic + +With the introduction of values, the decorator marshalling behavior has changed in some cases. This behavior is opt-in by setting the `valueMarshalling` package flag to `"new"`, but will be the default behavior in future versions. It is strongly recommended to adopt this new behavior as soon as possible. + +Example: + +```tsp +extern dec multipleOf(target: numeric | Reflection.ModelProperty, value: valueof numeric); +``` + +Will now emit a deprecated warning because `value` is of type `valueof string` which would marshall to `Numeric` under the new logic but as `number` previously. + +To opt-in you can add the following to your library js/ts files. + +```ts +export const $flags = definePackageFlags({ + decoratorArgMarshalling: "new", +}); +``` + +## Features + +### @typespec/compiler + +- [#3280](https://github.com/microsoft/typespec/pull/3280) Support completion for Model with extended properties + + Example + + ```tsp + model Device { + name: string; + description: string; + } + + model Phone extends Device { + ┆ + } | [name] + | [description] + ``` + +- [#3280](https://github.com/microsoft/typespec/pull/3280) Support completion for object values and model expression properties. + + Example + + ```tsp + model User { + name: string; + age: int32; + address: string; + } + + const user: User = #{name: "Bob", ┆} + | [age] + | [address] + ``` + +- [#3375](https://github.com/microsoft/typespec/pull/3375) Allow `@` to be escaped in doc comment with `\` +- [#3022](https://github.com/microsoft/typespec/pull/3022) Add syntax for declaring values. [See docs](https://typespec.io/docs/language-basics/values). + +Object and array values + +```tsp +@dummy(#{ + name: "John", + age: 48, + address: #{ city: "London" } + aliases: #["Bob", "Frank"] +}) +``` + +Scalar constructors + +```tsp +scalar utcDateTime { + init fromISO(value: string); +} + +model DateRange { + minDate: utcDateTime = utcDateTime.fromISO("2024-02-15T18:36:03Z"); +} +``` + +- [#3527](https://github.com/microsoft/typespec/pull/3527) Add support for `@prop` doc comment tag to describe model properties +- [#3460](https://github.com/microsoft/typespec/pull/3460) Hide deprecated items from completion list +- [#3462](https://github.com/microsoft/typespec/pull/3462) Linter `all` rulesets is automatically created if not explicitly provided +- [#3533](https://github.com/microsoft/typespec/pull/3533) More logs and traces are added for diagnostic and troubleshooting in TypeSpec language server +- [#3422](https://github.com/microsoft/typespec/pull/3422) Formatter: Indent or dedent multiline strings to the current indentation + +### @typespec/http + +- [#3342](https://github.com/microsoft/typespec/pull/3342) Add new multipart handling. Using `@multipartBody` with `HttpPart`. See [multipart docs](https://typespec.io/docs/next/libraries/http/multipart) for more information. + + ```tsp + op upload( + @header contentType: "multipart/mixed", + @multipartBody body: { + name: HttpPart; + avatar: HttpPart[]; + }, + ): void; + ``` + +- [#3462](https://github.com/microsoft/typespec/pull/3462) Use new compiler automatic `all` ruleset instead of explicitly provided one + +### @typespec/openapi3 + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Add support for new object and array values as default values (e.g. `decimals: decimal[] = #[123, 456.7];`) + +### @typespec/html-program-viewer + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Add support for values + +### @typespec/json-schema + +- [#3557](https://github.com/microsoft/typespec/pull/3557) Add support for @oneOf decorator. + +### typespec-vs + +- [#3461](https://github.com/microsoft/typespec/pull/3461) Support Arm64 + +### typespec-vscode + +- [#3533](https://github.com/microsoft/typespec/pull/3533) Enhance logging and trace + +1. Support "Developer: Set Log Level..." command to filter logs in TypeSpec output channel +2. Add "typespecLanguageServer.trace.server" config for whether and how to send the traces from TypeSpec language server to client. (It still depends on client to decide whether to show these traces based on the configured Log Level.) +3. More logs and traces are added for diagnostic and troubleshooting + +- [#3385](https://github.com/microsoft/typespec/pull/3385) Add 'TypeSpec: Show Output Channel' command in VSCode extension + +## Bug Fixes + +### @typespec/compiler + +- [#3399](https://github.com/microsoft/typespec/pull/3399) Preserve leading whitespace in fenced blocks in doc comments +- [#3522](https://github.com/microsoft/typespec/pull/3522) Fix EINVAL error when running `tsp code install` +- [#3371](https://github.com/microsoft/typespec/pull/3371) Numeric not handling trailing zeros and causing freeze(e.g. `const a = 100.0`) +- [#3451](https://github.com/microsoft/typespec/pull/3451) Emitter framework: fix losing context when referencing circular types +- [#3517](https://github.com/microsoft/typespec/pull/3517) Fix application of `@param` doc tag on operation create with `op is` to override upstream doc +- [#3488](https://github.com/microsoft/typespec/pull/3488) Add `PickProperties` type to dynamically select a subset of a model + +### @typespec/http + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Update Flow Template to make use of the new array values + +### @typespec/versioning + +- [#3292](https://github.com/microsoft/typespec/pull/3292) Add `@madeRequired` decorator +- [#3022](https://github.com/microsoft/typespec/pull/3022) Update to support new value types +- [#3409](https://github.com/microsoft/typespec/pull/3409) Using `@removed` on member types and `@added` on containing type could result in errors +- [#3255](https://github.com/microsoft/typespec/pull/3255) If a property were marked with @added on a later version, the logic that said it was originally added on the first version was erroneously removed, resulting in incorrect projections. + +### @typespec/rest + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Update types to support new values in TypeSpec + +### @typespec/openapi3 + +- [#3342](https://github.com/microsoft/typespec/pull/3342) Add support for new multipart constructs in http library +- [#3574](https://github.com/microsoft/typespec/pull/3574) Emit diagnostic when an invalid type is used as a property instead of crashing. + +### @typespec/protobuf + +- [#3022](https://github.com/microsoft/typespec/pull/3022) Update to support new value types +- [#3561](https://github.com/microsoft/typespec/pull/3561) Corrected cross-package reference behavior in some buggy cases. +- + +### @typespec/json-schema + +- [#3398](https://github.com/microsoft/typespec/pull/3398) Fix decorators application for union variants +- [#3022](https://github.com/microsoft/typespec/pull/3022) Update to support new value types +- [#3430](https://github.com/microsoft/typespec/pull/3430) The emitted JSON Schema now doesn't make root schemas for TypeSpec types which do not have the @jsonSchema decorator or are contained in a namespace with that decorator. Instead, such schemas are put into the $defs of any root schema which references them, and are referenced using JSON Pointers. 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 719158cd911..d058b9dbe9d 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 @@ -96,6 +96,23 @@ model OptionalProperties | Source | An object whose spread properties are all optional. | +#### Properties +None + +### `PickProperties` {#PickProperties} + +Represents a collection of properties with only the specified keys included. +```typespec +model PickProperties +``` + +#### Template Parameters +| Name | Description | +|------|-------------| +| Source | An object whose properties are spread. | +| Keys | The property keys to include. | + + #### Properties None 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 fe3cf11a220..86336bf0c31 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 @@ -21,7 +21,7 @@ NOTE: This decorator **should not** be used, use the `#deprecated` directive ins #### Parameters | Name | Type | Description | |------|------|-------------| -| message | `valueof string` | Deprecation message. | +| message | [valueof `string`](#string) | Deprecation message. | #### Examples @@ -47,7 +47,7 @@ Specify the property to be used to discriminate this type. #### Parameters | Name | Type | Description | |------|------|-------------| -| propertyName | `valueof string` | The property name to use for discrimination | +| propertyName | [valueof `string`](#string) | The property name to use for discrimination | #### Examples @@ -82,7 +82,7 @@ Attach a documentation string. #### Parameters | Name | Type | Description | |------|------|-------------| -| doc | `valueof string` | Documentation string | +| doc | [valueof `string`](#string) | Documentation string | | formatArgs | `{}` | Record with key value pair that can be interpolated in the doc. | #### Examples @@ -142,16 +142,16 @@ Provide an alternative name for this type when serialized to the given mime type #### Parameters | Name | Type | Description | |------|------|-------------| -| mimeType | `valueof string` | Mime type this should apply to. The mime type should be a known mime type as described here https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types without any suffix (e.g. `+json`) | -| name | `valueof string` | Alternative name | +| mimeType | [valueof `string`](#string) | Mime type this should apply to. The mime type should be a known mime type as described here https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types without any suffix (e.g. `+json`) | +| name | [valueof `string`](#string) | Alternative name | #### Examples ```typespec model Certificate { -@encodedName("application/json", "exp") -@encodedName("application/xml", "expiry") -expireAt: int32; + @encodedName("application/json", "exp") + @encodedName("application/xml", "expiry") + expireAt: int32; } ``` @@ -160,7 +160,7 @@ expireAt: int32; ```typespec @encodedName("application/merge-patch+json", "exp") -^ error cannot use subtype + ^ error cannot use subtype ``` @@ -183,8 +183,8 @@ None ```typespec @error model PetStoreError { -code: string; -message: string; + code: string; + message: string; } ``` @@ -204,7 +204,7 @@ If an operation returns a union of success and errors it only describe the error #### Parameters | Name | Type | Description | |------|------|-------------| -| doc | `valueof string` | Documentation string | +| doc | [valueof `string`](#string) | Documentation string | #### Examples @@ -230,7 +230,7 @@ The format names are open ended and are left to emitter to interpret. #### Parameters | Name | Type | Description | |------|------|-------------| -| format | `valueof string` | format name. | +| format | [valueof `string`](#string) | format name. | #### Examples @@ -254,7 +254,7 @@ Specifies how a templated type should name their instances. #### Parameters | Name | Type | Description | |------|------|-------------| -| name | `valueof string` | name the template instance should take | +| name | [valueof `string`](#string) | name the template instance should take | | formatArgs | `unknown` | Model with key value used to interpolate the name | #### Examples @@ -262,8 +262,8 @@ Specifies how a templated type should name their instances. ```typespec @friendlyName("{name}List", T) model List { -value: Item[]; -nextLink: string; + value: Item[]; + nextLink: string; } ``` @@ -282,7 +282,7 @@ A debugging decorator used to inspect a type. #### Parameters | Name | Type | Description | |------|------|-------------| -| text | `valueof string` | Custom text to log | +| text | [valueof `string`](#string) | Custom text to log | @@ -300,7 +300,7 @@ A debugging decorator used to inspect a type name. #### Parameters | Name | Type | Description | |------|------|-------------| -| text | `valueof string` | Custom text to log | +| text | [valueof `string`](#string) | Custom text to log | @@ -318,13 +318,13 @@ Mark a model property as the key to identify instances of that type #### Parameters | Name | Type | Description | |------|------|-------------| -| altName | `valueof string` | Name of the property. If not specified, the decorated property name is used. | +| altName | [valueof `string`](#string) | Name of the property. If not specified, the decorated property name is used. | #### Examples ```typespec model Pet { -@key id: string; + @key id: string; } ``` @@ -352,8 +352,8 @@ Provide a set of known values to a string type. scalar ErrorCode extends string; enum KnownErrorCode { -NotFound, -Invalid, + NotFound, + Invalid, } ``` @@ -390,7 +390,7 @@ Specify the maximum number of items this array should have. #### Parameters | Name | Type | Description | |------|------|-------------| -| value | `valueof integer` | Maximum number | +| value | [valueof `integer`](#integer) | Maximum number | #### Examples @@ -414,7 +414,7 @@ Specify the maximum length this string type should be. #### Parameters | Name | Type | Description | |------|------|-------------| -| value | `valueof integer` | Maximum length | +| value | [valueof `integer`](#integer) | Maximum length | #### Examples @@ -438,7 +438,7 @@ Specify the maximum value this numeric type should be. #### Parameters | Name | Type | Description | |------|------|-------------| -| value | `valueof numeric` | Maximum value | +| value | [valueof `numeric`](#numeric) | Maximum value | #### Examples @@ -463,7 +463,7 @@ value. #### Parameters | Name | Type | Description | |------|------|-------------| -| value | `valueof numeric` | Maximum value | +| value | [valueof `numeric`](#numeric) | Maximum value | #### Examples @@ -487,7 +487,7 @@ Specify the minimum number of items this array should have. #### Parameters | Name | Type | Description | |------|------|-------------| -| value | `valueof integer` | Minimum number | +| value | [valueof `integer`](#integer) | Minimum number | #### Examples @@ -511,7 +511,7 @@ Specify the minimum length this string type should be. #### Parameters | Name | Type | Description | |------|------|-------------| -| value | `valueof integer` | Minimum length | +| value | [valueof `integer`](#integer) | Minimum length | #### Examples @@ -535,7 +535,7 @@ Specify the minimum value this numeric type should be. #### Parameters | Name | Type | Description | |------|------|-------------| -| value | `valueof numeric` | Minimum value | +| value | [valueof `numeric`](#numeric) | Minimum value | #### Examples @@ -560,7 +560,7 @@ value. #### Parameters | Name | Type | Description | |------|------|-------------| -| value | `valueof numeric` | Minimum value | +| value | [valueof `numeric`](#numeric) | Minimum value | #### Examples @@ -636,8 +636,8 @@ validates a GUID string might have a message like "Must be a valid GUID." #### Parameters | Name | Type | Description | |------|------|-------------| -| pattern | `valueof string` | Regular expression. | -| validationMessage | `valueof string` | Optional validation message that may provide context when validation fails. | +| pattern | [valueof `string`](#string) | Regular expression. | +| validationMessage | [valueof `string`](#string) | Optional validation message that may provide context when validation fails. | #### Examples @@ -663,15 +663,15 @@ Provide an alternative name for this type. #### Parameters | Name | Type | Description | |------|------|-------------| -| targetName | `valueof string` | Projection target | -| projectedName | `valueof string` | Alternative name | +| targetName | [valueof `string`](#string) | Projection target | +| projectedName | [valueof `string`](#string) | Alternative name | #### Examples ```typespec model Certificate { -@projectedName("json", "exp") -expireAt: int32; + @projectedName("json", "exp") + expireAt: int32; } ``` @@ -691,7 +691,7 @@ If an operation returns a union of success and errors it only describe the succe #### Parameters | Name | Type | Description | |------|------|-------------| -| doc | `valueof string` | Documentation string | +| doc | [valueof `string`](#string) | Documentation string | #### Examples @@ -793,7 +793,7 @@ Typically a short, single-line description. #### Parameters | Name | Type | Description | |------|------|-------------| -| summary | `valueof string` | Summary string. | +| summary | [valueof `string`](#string) | Summary string. | #### Examples @@ -817,7 +817,7 @@ Attaches a tag to an operation, interface, or namespace. Multiple `@tag` decorat #### Parameters | Name | Type | Description | |------|------|-------------| -| tag | `valueof string` | Tag value | +| tag | [valueof `string`](#string) | Tag value | @@ -855,12 +855,12 @@ See also: [Automatic visibility](https://typespec.io/docs/libraries/http/operati ```typespec model Dog { -// the service will generate an ID, so you don't need to send it. -@visibility("read") id: int32; -// the service will store this secret name, but won't ever return it -@visibility("create", "update") secretName: string; -// the regular name is always present -name: string; + // the service will generate an ID, so you don't need to send it. + @visibility("read") id: int32; + // the service will store this secret name, but won't ever return it + @visibility("create", "update") secretName: string; + // the regular name is always present + name: string; } ``` @@ -879,7 +879,7 @@ Set the visibility of key properties in a model if not already set. #### Parameters | Name | Type | Description | |------|------|-------------| -| visibility | `valueof string` | The desired default visibility value. If a key property already has a `visibility` decorator then the default visibility is not applied. | +| visibility | [valueof `string`](#string) | The desired default visibility value. If a key property already has a `visibility` decorator then the default visibility is not applied. | @@ -933,6 +933,24 @@ Returns the model with the given properties omitted. +### `@withPickedProperties` {#@withPickedProperties} + +Returns the model with only the given properties included. +```typespec +@withPickedProperties(pick: string | Union) +``` + +#### Target + +`Model` + +#### Parameters +| Name | Type | Description | +|------|------|-------------| +| pick | `string \| Union` | List of properties to include | + + + ### `@withUpdateableProperties` {#@withUpdateableProperties} Returns the model with non-updateable properties removed. @@ -977,9 +995,9 @@ not necessary to use this decorator. ```typespec model Dog { -@visibility("read") id: int32; -@visibility("create", "update") secretName: string; -name: string; + @visibility("read") id: int32; + @visibility("create", "update") secretName: string; + name: string; } // The spread operator will copy all the properties of Dog into DogRead, @@ -990,14 +1008,14 @@ name: string; // properties are kept. @withVisibility("create", "update") model DogCreateOrUpdate { -...Dog; + ...Dog; } // In this case the id and name properties are kept and the secretName property // is removed. @withVisibility("read") model DogRead { -...Dog; + ...Dog; } ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md deleted file mode 100644 index 6ab8c2f50e1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -jsApi: true -title: "[C] DuplicateTracker" - ---- -Helper class to track duplicate instance - -## Type parameters - -| Type parameter | -| :------ | -| `K` | -| `V` | - -## Constructors - -### new DuplicateTracker() - -```ts -new DuplicateTracker(): DuplicateTracker -``` - -#### Returns - -[`DuplicateTracker`](DuplicateTracker.md)<`K`, `V`\> - -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `#entries` | `private` | `Map`<`K`, `V`[]\> | - -## Methods - -### entries() - -```ts -entries(): Iterable<[K, V[]]> -``` - -Return iterator of all the duplicate entries. - -#### Returns - -`Iterable`<[`K`, `V`[]]\> - -*** - -### track() - -```ts -track(k, v): void -``` - -Track usage of K. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `k` | `K` | key that is being checked for duplicate. | -| `v` | `V` | value that map to the key | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md deleted file mode 100644 index b98d920c449..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -jsApi: true -title: "[C] EventEmitter" - ---- -## Type parameters - -| Type parameter | -| :------ | -| `T` extends `Object` | - -## Constructors - -### new EventEmitter() - -```ts -new EventEmitter(): EventEmitter -``` - -#### Returns - -[`EventEmitter`](EventEmitter.md)<`T`\> - -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `listeners` | `private` | `Map` `any`[]\> | - -## Methods - -### emit() - -```ts -emit(name, ...args): void -``` - -#### Type parameters - -| Type parameter | -| :------ | -| `K` extends `string` \| `number` \| `symbol` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `K` | -| ...`args` | `Parameters`<`T`\[`K`\]\> | - -#### Returns - -`void` - -*** - -### on() - -```ts -on(name, listener): void -``` - -#### Type parameters - -| Type parameter | -| :------ | -| `K` extends `string` \| `number` \| `symbol` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `K` | -| `listener` | (...`args`) => `any` | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md deleted file mode 100644 index d4ff2cb67df..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -jsApi: true -title: "[C] ProjectionError" - ---- -Represents a failure while interpreting a projection. - -## Extends - -- `Error` - -## Constructors - -### new ProjectionError(message) - -```ts -new ProjectionError(message): ProjectionError -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `message` | `string` | - -#### Returns - -[`ProjectionError`](ProjectionError.md) - -#### Overrides - -`Error.constructor` - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `cause?` | `public` | `unknown` | - | `Error.cause` | -| `message` | `public` | `string` | - | `Error.message` | -| `name` | `public` | `string` | - | `Error.name` | -| `stack?` | `public` | `string` | - | `Error.stack` | -| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces

**See**
https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | -| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | - -## Methods - -### captureStackTrace() - -```ts -static captureStackTrace(targetObject, constructorOpt?): void -``` - -Create .stack property on a target object - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt`? | `Function` | - -#### Returns - -`void` - -#### Inherited from - -`Error.captureStackTrace` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md deleted file mode 100644 index f308902603d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -jsApi: true -title: "[C] Queue" - ---- -## Type parameters - -| Type parameter | -| :------ | -| `T` | - -## Constructors - -### new Queue(elements) - -```ts -new Queue(elements?): Queue -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `elements`? | `T`[] | - -#### Returns - -[`Queue`](Queue.md)<`T`\> - -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `#elements` | `private` | `T`[] | -| `#headIndex` | `private` | `number` | - -## Methods - -### dequeue() - -```ts -dequeue(): T -``` - -#### Returns - -`T` - -*** - -### enqueue() - -```ts -enqueue(...items): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| ...`items` | `T`[] | - -#### Returns - -`void` - -*** - -### isEmpty() - -```ts -isEmpty(): boolean -``` - -#### Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md deleted file mode 100644 index 8e4583342dc..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -jsApi: true -title: "[C] ResolveModuleError" - ---- -## Extends - -- `Error` - -## Constructors - -### new ResolveModuleError(code, message) - -```ts -new ResolveModuleError(code, message): ResolveModuleError -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `code` | `ResolveModuleErrorCode` | -| `message` | `string` | - -#### Returns - -[`ResolveModuleError`](ResolveModuleError.md) - -#### Overrides - -`Error.constructor` - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `cause?` | `public` | `unknown` | - | `Error.cause` | -| `code` | `public` | `ResolveModuleErrorCode` | - | - | -| `message` | `public` | `string` | - | `Error.message` | -| `name` | `public` | `string` | - | `Error.name` | -| `stack?` | `public` | `string` | - | `Error.stack` | -| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces

**See**
https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | -| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | - -## Methods - -### captureStackTrace() - -```ts -static captureStackTrace(targetObject, constructorOpt?): void -``` - -Create .stack property on a target object - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt`? | `Function` | - -#### Returns - -`void` - -#### Inherited from - -`Error.captureStackTrace` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md deleted file mode 100644 index 535514e33c4..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[E] IdentifierKind" - ---- -## Enumeration Members - -| Enumeration Member | Value | -| :------ | :------ | -| `Declaration` | `5` | -| `Decorator` | `2` | -| `Function` | `3` | -| `Other` | `6` | -| `TemplateArgument` | `1` | -| `TypeReference` | `0` | -| `Using` | `4` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md deleted file mode 100644 index 428237836b4..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[E] ListenerFlow" - ---- -## Enumeration Members - -| Enumeration Member | Value | Description | -| :------ | :------ | :------ | -| `NoRecursion` | `1` | Do not navigate any containing or referenced type. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md deleted file mode 100644 index cf0eb278a60..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[E] ModifierFlags" - ---- -## Enumeration Members - -| Enumeration Member | Value | -| :------ | :------ | -| `Extern` | `2` | -| `None` | `0` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md deleted file mode 100644 index 5200f7e5191..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[E] NodeFlags" - ---- -## Enumeration Members - -| Enumeration Member | Value | Description | -| :------ | :------ | :------ | -| `DescendantErrorsExamined` | `1` | If this is set, the DescendantHasError bit can be trusted. If this not set,
children need to be visited still to see if DescendantHasError should be
set.

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

Use the parser's `hasParseError` API instead of using this flag directly. | -| `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 deleted file mode 100644 index a75f252552f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SemanticTokenKind.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -jsApi: true -title: "[E] SemanticTokenKind" - ---- -## Enumeration Members - -| Enumeration 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 deleted file mode 100644 index a1213782291..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SymbolFlags.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -jsApi: true -title: "[E] SymbolFlags" - ---- -## Enumeration Members - -| Enumeration 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 deleted file mode 100644 index 5c660c344f5..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -jsApi: true -title: "[E] SyntaxKind" - ---- -AST types - -## Enumeration Members - -| Enumeration Member | Value | Description | -| :------ | :------ | :------ | -| `AliasStatement` | `24` | - | -| `ArrayExpression` | `31` | - | -| `AugmentDecoratorStatement` | `4` | - | -| `BlockComment` | `51` | - | -| `BooleanLiteral` | `34` | - | -| `CadlScript` | `0` | **Deprecated**
Use TypeSpecScript | -| `DecoratorDeclarationStatement` | `25` | - | -| `DecoratorExpression` | `5` | - | -| `DirectiveExpression` | `6` | - | -| `Doc` | `52` | - | -| `DocErrorsTag` | `56` | - | -| `DocParamTag` | `54` | - | -| `DocReturnsTag` | `55` | - | -| `DocTemplateTag` | `57` | - | -| `DocText` | `53` | - | -| `DocUnknownTag` | `58` | - | -| `EmptyStatement` | `48` | - | -| `EnumMember` | `22` | - | -| `EnumSpreadMember` | `23` | - | -| `EnumStatement` | `21` | - | -| `ExternKeyword` | `40` | - | -| `FunctionDeclarationStatement` | `26` | - | -| `FunctionParameter` | `27` | - | -| `Identifier` | `3` | - | -| `ImportStatement` | `2` | - | -| `InterfaceStatement` | `18` | - | -| `IntersectionExpression` | `29` | - | -| `InvalidStatement` | `49` | - | -| `JsNamespaceDeclaration` | `90` | - | -| `JsSourceFile` | `1` | - | -| `LineComment` | `50` | - | -| `MemberExpression` | `7` | - | -| `ModelExpression` | `14` | - | -| `ModelProperty` | `15` | - | -| `ModelSpreadProperty` | `16` | - | -| `ModelStatement` | `13` | - | -| `NamespaceStatement` | `8` | - | -| `NeverKeyword` | `42` | - | -| `NumericLiteral` | `33` | - | -| `OperationSignatureDeclaration` | `11` | - | -| `OperationSignatureReference` | `12` | - | -| `OperationStatement` | `10` | - | -| `Projection` | `59` | - | -| `ProjectionArithmeticExpression` | `78` | - | -| `ProjectionBlockExpression` | `72` | - | -| `ProjectionCallExpression` | `79` | - | -| `ProjectionDecoratorReferenceExpression` | `88` | - | -| `ProjectionEnumMemberSelector` | `69` | - | -| `ProjectionEnumSelector` | `68` | - | -| `ProjectionEqualityExpression` | `75` | - | -| `ProjectionExpressionStatement` | `70` | - | -| `ProjectionIfExpression` | `71` | - | -| `ProjectionInterfaceSelector` | `67` | - | -| `ProjectionLambdaExpression` | `80` | - | -| `ProjectionLambdaParameterDeclaration` | `81` | - | -| `ProjectionLogicalExpression` | `74` | - | -| `ProjectionMemberExpression` | `73` | - | -| `ProjectionModelExpression` | `82` | - | -| `ProjectionModelProperty` | `83` | - | -| `ProjectionModelPropertySelector` | `62` | - | -| `ProjectionModelSelector` | `61` | - | -| `ProjectionModelSpreadProperty` | `84` | - | -| `ProjectionOperationSelector` | `64` | - | -| `ProjectionParameterDeclaration` | `60` | - | -| `ProjectionReference` | `46` | - | -| `ProjectionRelationalExpression` | `77` | - | -| `ProjectionScalarSelector` | `63` | - | -| `ProjectionSpreadProperty` | `85` | - | -| `ProjectionStatement` | `87` | - | -| `ProjectionTupleExpression` | `86` | - | -| `ProjectionUnaryExpression` | `76` | - | -| `ProjectionUnionSelector` | `65` | - | -| `ProjectionUnionVariantSelector` | `66` | - | -| `Return` | `89` | - | -| `ScalarStatement` | `17` | - | -| `StringLiteral` | `32` | - | -| `StringTemplateExpression` | `35` | - | -| `StringTemplateHead` | `36` | - | -| `StringTemplateMiddle` | `37` | - | -| `StringTemplateSpan` | `39` | - | -| `StringTemplateTail` | `38` | - | -| `TemplateArgument` | `91` | - | -| `TemplateParameterDeclaration` | `47` | - | -| `TupleExpression` | `30` | - | -| `TypeReference` | `45` | - | -| `TypeSpecScript` | `0` | - | -| `UnionExpression` | `28` | - | -| `UnionStatement` | `19` | - | -| `UnionVariant` | `20` | - | -| `UnknownKeyword` | `43` | - | -| `UsingStatement` | `9` | - | -| `ValueOfExpression` | `44` | - | -| `VoidKeyword` | `41` | - | 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 deleted file mode 100644 index 3aac1992925..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -jsApi: true -title: "[E] Token" - ---- -## Enumeration Members - -| Enumeration Member | Value | -| :------ | :------ | -| `AliasKeyword` | `57` | -| `Ampersand` | `30` | -| `AmpsersandAmpersand` | `45` | -| `At` | `35` | -| `AtAt` | `36` | -| `Bar` | `31` | -| `BarBar` | `46` | -| `CloseBrace` | `18` | -| `CloseBracket` | `22` | -| `CloseParen` | `20` | -| `Colon` | `33` | -| `ColonColon` | `34` | -| `Comma` | `26` | -| `ConflictMarker` | `13` | -| `DecKeyword` | `64` | -| `DocCodeFenceDelimiter` | `16` | -| `DocCodeSpan` | `15` | -| `DocText` | `14` | -| `Dot` | `23` | -| `Ellipsis` | `24` | -| `ElseKeyword` | `62` | -| `EndOfFile` | `2` | -| `EnumKeyword` | `56` | -| `Equals` | `29` | -| `EqualsEquals` | `47` | -| `EqualsGreaterThan` | `49` | -| `Exclamation` | `42` | -| `ExclamationEquals` | `48` | -| `ExtendsKeyword` | `68` | -| `ExternKeyword` | `67` | -| `FalseKeyword` | `70` | -| `FnKeyword` | `65` | -| `ForwardSlash` | `39` | -| `GreaterThan` | `28` | -| `GreaterThanEquals` | `44` | -| `Hash` | `37` | -| `Hyphen` | `41` | -| `Identifier` | `3` | -| `IfKeyword` | `63` | -| `ImportKeyword` | `50` | -| `InterfaceKeyword` | `59` | -| `Invalid` | `1` | -| `IsKeyword` | `58` | -| `LessThan` | `27` | -| `LessThanEquals` | `43` | -| `ModelKeyword` | `51` | -| `MultiLineComment` | `10` | -| `NamespaceKeyword` | `53` | -| `NeverKeyword` | `73` | -| `NewLine` | `11` | -| `None` | `0` | -| `NumericLiteral` | `4` | -| `OpKeyword` | `55` | -| `OpenBrace` | `17` | -| `OpenBracket` | `21` | -| `OpenParen` | `19` | -| `Plus` | `40` | -| `ProjectionKeyword` | `61` | -| `Question` | `32` | -| `ReturnKeyword` | `71` | -| `ScalarKeyword` | `52` | -| `Semicolon` | `25` | -| `SingleLineComment` | `9` | -| `Star` | `38` | -| `StringLiteral` | `5` | -| `StringTemplateHead` | `6` | -| `StringTemplateMiddle` | `7` | -| `StringTemplateTail` | `8` | -| `TrueKeyword` | `69` | -| `UnionKeyword` | `60` | -| `UnknownKeyword` | `74` | -| `UsingKeyword` | `54` | -| `ValueOfKeyword` | `66` | -| `VoidKeyword` | `72` | -| `Whitespace` | `12` | 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 deleted file mode 100644 index 6efba971af2..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/TokenFlags.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[E] TokenFlags" - ---- -## Enumeration Members - -| Enumeration 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/enumerations/UsageFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md deleted file mode 100644 index 4e8a9584229..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[E] UsageFlags" - ---- -## Enumeration Members - -| Enumeration Member | Value | -| :------ | :------ | -| `Input` | `2` | -| `None` | `0` | -| `Output` | `4` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md deleted file mode 100644 index 142a19dead8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -jsApi: true -title: "[F] $deprecated" - ---- -```ts -$deprecated( - context, - target, - message): void -``` - -Mark a type as deprecated - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | -| `target` | [`Type`](../type-aliases/Type.md) | Decorator target | -| `message` | `string` | Deprecation target. | - -## Returns - -`void` - -## Example - -``` @deprecated("Foo is deprecated, use Bar instead.") - model Foo {} -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md deleted file mode 100644 index 730a4d20769..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $discriminator" - ---- -```ts -$discriminator( - context, - target, - propertyName): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md) | -| `propertyName` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md deleted file mode 100644 index 874967f9e07..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -jsApi: true -title: "[F] $doc" - ---- -```ts -$doc( - context, - target, - doc, - formatArgs?): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Type`](../type-aliases/Type.md) | -| `doc` | `string` | -| `formatArgs`? | [`Type`](../type-aliases/Type.md) | - -## Returns - -`void` - -## Doc - -attaches a documentation string. Works great with multi-line string literals. - -The first argument to - -## Doc - -is a string, which may contain template parameters, enclosed in braces, -which are replaced with an attribute for the type (commonly "name") passed as the second (optional) argument. - -## Doc - -can be specified on any language element -- a model, an operation, a namespace, etc. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md deleted file mode 100644 index 733e8d82b03..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] $encode" - ---- -```ts -$encode( - context, - target, - encoding, - encodedAs?): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `encoding` | [`Type`](../type-aliases/Type.md) | -| `encodedAs`? | [`Scalar`](../interfaces/Scalar.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md deleted file mode 100644 index bb851bfdf3d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] $encodedName" - ---- -```ts -$encodedName( - context, - target, - mimeType, - name): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Type`](../type-aliases/Type.md) | -| `mimeType` | `string` | -| `name` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md deleted file mode 100644 index 8a19de42996..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[F] $error" - ---- -```ts -$error(context, target): void -``` - -`@error` decorator marks a model as an error type. - Any derived models (using extends) will also be seen as error types. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Model`](../interfaces/Model.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md deleted file mode 100644 index 20301ec58da..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $errorsDoc" - ---- -```ts -$errorsDoc( - context, - target, - doc): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Operation`](../interfaces/Operation.md) | -| `doc` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md deleted file mode 100644 index a8af2e67513..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -jsApi: true -title: "[F] $format" - ---- -```ts -$format( - context, - target, - format): void -``` - -`@format` - specify the data format hint for a string type - -The first argument is a string that identifies the format that the string type expects. Any string -can be entered here, but a TypeSpec emitter must know how to interpret - -For TypeSpec specs that will be used with an OpenAPI emitter, the OpenAPI specification describes possible -valid values for a string type's format: - -https://github.com/OAI/OpenAPI-Specification/blob/3.0.3/versions/3.0.3.md#dataTypes - -`@format` can be specified on a type that extends from `string` or a `string`-typed model property. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.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 deleted file mode 100644 index 3b8bf8bbb35..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] $friendlyName" - ---- -```ts -$friendlyName( - context, - target, - name, - formatArgs?): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Type`](../type-aliases/Type.md) | -| `name` | `string` | -| `formatArgs`? | [`Type`](../type-aliases/Type.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md deleted file mode 100644 index 170d63cccd7..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $inspectType" - ---- -```ts -$inspectType( - context, - target, - text): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Type`](../type-aliases/Type.md) | -| `text` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md deleted file mode 100644 index 693ab993e37..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $inspectTypeName" - ---- -```ts -$inspectTypeName( - context, - target, - text): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Type`](../type-aliases/Type.md) | -| `text` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md deleted file mode 100644 index 0b1d41e0a65..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -jsApi: true -title: "[F] $key" - ---- -```ts -$key( - context, - target, - altName?): void -``` - -`@key` - mark a model property as the key to identify instances of that type - -The optional first argument accepts an alternate key name which may be used by emitters. -Otherwise, the name of the target property will be used. - -`@key` can only be applied to model properties. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) | -| `altName`? | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md deleted file mode 100644 index 0e0b47ddaa2..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -jsApi: true -title: "[F] $knownValues" - ---- -```ts -$knownValues( - context, - target, - knownValues): void -``` - -`@knownValues` marks a string type with an enum that contains all known values - -The first parameter is a reference to an enum type that describes all possible values that the -type accepts. - -`@knownValues` can only be applied to model types that extend `string`. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | - | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | Decorator target. Must be a string. (model Foo extends string) | -| `knownValues` | [`Enum`](../interfaces/Enum.md) | Must be an enum. | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md deleted file mode 100644 index 54543b658ba..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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`? | [`Model`](../interfaces/Model.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/functions/$maxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md deleted file mode 100644 index 72526d81709..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $maxItems" - ---- -```ts -$maxItems( - context, - target, - value): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Type`](../type-aliases/Type.md) | -| `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md deleted file mode 100644 index 470d7b8d6c7..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $maxLength" - ---- -```ts -$maxLength( - context, - target, - value): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md deleted file mode 100644 index a7302098973..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $maxValue" - ---- -```ts -$maxValue( - context, - target, - value): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md deleted file mode 100644 index c5c6c084991..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $maxValueExclusive" - ---- -```ts -$maxValueExclusive( - context, - target, - value): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md deleted file mode 100644 index 44a0f2e999d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $minItems" - ---- -```ts -$minItems( - context, - target, - value): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Type`](../type-aliases/Type.md) | -| `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md deleted file mode 100644 index 3f2c0e8e95b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $minLength" - ---- -```ts -$minLength( - context, - target, - value): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md deleted file mode 100644 index a02f3cf0cf0..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $minValue" - ---- -```ts -$minValue( - context, - target, - value): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md deleted file mode 100644 index 92b95141caa..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $minValueExclusive" - ---- -```ts -$minValueExclusive( - context, - target, - value): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `value` | `number` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md deleted file mode 100644 index 3f936ba8ea4..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$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`](../interfaces/DecoratorContext.md) | DecoratorContext | -| `target` | [`Operation`](../interfaces/Operation.md) | The specializing operation declaration | -| `overloadbase` | [`Operation`](../interfaces/Operation.md) | - | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md deleted file mode 100644 index d5e50e80be5..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $parameterVisibility" - ---- -```ts -$parameterVisibility( - context, - target, ... - visibilities): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Operation`](../interfaces/Operation.md) | -| ...`visibilities` | `string`[] | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md deleted file mode 100644 index b80b5ac720a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] $pattern" - ---- -```ts -$pattern( - context, - target, - pattern, - validationMessage?): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `pattern` | `string` | -| `validationMessage`? | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md deleted file mode 100644 index d24686d40ec..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[F] $projectedName" - ---- -```ts -$projectedName( - context, - target, - targetName, - projectedName): void -``` - -`@projectedName` - Indicate that this entity should be renamed according to the given projection. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | -| `target` | [`Type`](../type-aliases/Type.md) | The that should have a different name. | -| `targetName` | `string` | - | -| `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 deleted file mode 100644 index 87ceeaa964f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $returnTypeVisibility" - ---- -```ts -$returnTypeVisibility( - context, - target, ... - visibilities): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Operation`](../interfaces/Operation.md) | -| ...`visibilities` | `string`[] | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md deleted file mode 100644 index d1300a9a845..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $returnsDoc" - ---- -```ts -$returnsDoc( - context, - target, - doc): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Operation`](../interfaces/Operation.md) | -| `doc` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md deleted file mode 100644 index 5e78d478b8f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$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`](../interfaces/DecoratorContext.md) | Decorator context | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | Decorator target, either a string model or a property with type string. | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md deleted file mode 100644 index f3fcadb8330..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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`? | [`Type`](../type-aliases/Type.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md deleted file mode 100644 index 7df5e124514..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -jsApi: true -title: "[F] $summary" - ---- -```ts -$summary( - context, - target, - summary): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Type`](../type-aliases/Type.md) | -| `summary` | `string` | - -## Returns - -`void` - -## Summary - -attaches a documentation string. It is typically used to give a short, single-line -description, and can be used in combination with or instead of @doc. - -The first argument to - -## Summary - -is a string, which may contain template parameters, enclosed in braces, -which are replaced with an attribute for the type (commonly "name") passed as the second (optional) argument. - -## Summary - -can be specified on any language element -- a model, an operation, a namespace, etc. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md deleted file mode 100644 index 16988bc2d4b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md deleted file mode 100644 index 6a04edc5595..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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`[] | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md deleted file mode 100644 index b9ce0e80fe1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $withDefaultKeyVisibility" - ---- -```ts -$withDefaultKeyVisibility( - context, - target, - visibility): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Model`](../interfaces/Model.md) | -| `visibility` | `string` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md deleted file mode 100644 index 9182ad39ab7..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] $withOptionalProperties" - ---- -```ts -$withOptionalProperties(context, target): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Model`](../interfaces/Model.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md deleted file mode 100644 index bad13c7465b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] $withUpdateableProperties" - ---- -```ts -$withUpdateableProperties(context, target): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Model`](../interfaces/Model.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md deleted file mode 100644 index 03960bef8d5..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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`[] | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md deleted file mode 100644 index 7a3db2917c3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] $withoutDefaultValues" - ---- -```ts -$withoutDefaultValues(context, target): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Model`](../interfaces/Model.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md deleted file mode 100644 index 5a5c1316e62..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] $withoutOmittedProperties" - ---- -```ts -$withoutOmittedProperties( - context, - target, - omit): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Model`](../interfaces/Model.md) | -| `omit` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md deleted file mode 100644 index 2b5ba67bd52..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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`](../interfaces/Program.md) | Program | -| `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | -| `details` | [`ServiceDetails`](../interfaces/ServiceDetails.md) | Service details | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md deleted file mode 100644 index e38d3a60d93..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -jsApi: true -title: "[F] assertType" - ---- -```ts -assertType( - typeDescription, - t, ... - kinds): asserts t is Type & Object -``` - -Assert that the input type has one of the kinds provided - -## Type parameters - -| Type parameter | -| :------ | -| `TKind` extends ( - \| `"Scalar"` - \| `"ModelProperty"` - \| `"Model"` - \| `"Interface"` - \| `"Enum"` - \| `"EnumMember"` - \| `"TemplateParameter"` - \| `"Namespace"` - \| `"Operation"` - \| `"String"` - \| `"Number"` - \| `"Boolean"` - \| `"StringTemplate"` - \| `"StringTemplateSpan"` - \| `"Tuple"` - \| `"Union"` - \| `"UnionVariant"` - \| `"Intrinsic"` - \| `"Function"` - \| `"Decorator"` - \| `"FunctionParameter"` - \| `"Object"` - \| `"Projection"`)[] | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `typeDescription` | `string` | -| `t` | [`Type`](../type-aliases/Type.md) | -| ...`kinds` | `TKind` | - -## Returns - -`asserts t is Type & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md deleted file mode 100644 index 4a2a01cab42..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -jsApi: true -title: "[F] cadlTypeToJson" - ---- -```ts -cadlTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] -``` - -## Type parameters - -| Type parameter | -| :------ | -| `T` | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `typespecType` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | -| `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | - -## Returns - -[`T` \| `undefined`, [`Diagnostic`](../interfaces/Diagnostic.md)[]] - -## Deprecated - -use typespecTypeToJson diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md deleted file mode 100644 index fb948326d1a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] checkFormatCadl" - ---- -```ts -checkFormatCadl(code, prettierConfig?): Promise -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `code` | `string` | -| `prettierConfig`? | `Options` | - -## Returns - -`Promise`<`boolean`\> - -## Deprecated - -use checkFormatTypeSpec diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md deleted file mode 100644 index 3b0a69b84b8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] checkFormatTypeSpec" - ---- -```ts -checkFormatTypeSpec(code, prettierConfig?): Promise -``` - -Check the given is correctly formatted. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `code` | `string` | -| `prettierConfig`? | `Options` | - -## Returns - -`Promise`<`boolean`\> - -true if code is formatted correctly. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md deleted file mode 100644 index bb7aff09c8d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -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) | - -## Returns - -`Promise`<[`Program`](../interfaces/Program.md)\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md deleted file mode 100644 index 397746cf85d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[F] compilerAssert" - ---- -```ts -compilerAssert( - condition, - message, - target?): asserts condition -``` - -Use this to report bugs in the compiler, and not errors in the source code -being compiled. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `condition` | `any` | Throw if this is not true. | -| `message` | `string` | Error message. | -| `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | Optional location in source code that might give a clue about
what got the compiler off track. | - -## Returns - -`asserts condition` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md deleted file mode 100644 index a0f630643ea..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -jsApi: true -title: "[F] createCadlLibrary" - ---- -```ts -createCadlLibrary(lib): TypeSpecLibrary -``` - -## Type parameters - -| Type parameter | Value | -| :------ | :------ | -| `T` extends `Object` | - | -| `E` extends `Record`<`string`, `any`\> | - | -| `State` extends `string` | `never` | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `lib` | `Readonly`<[`TypeSpecLibraryDef`](../interfaces/TypeSpecLibraryDef.md)<`T`, `E`, `State`\>\> | - -## Returns - -[`TypeSpecLibrary`](../interfaces/TypeSpecLibrary.md)<`T`, `E`, `State`\> - -## Deprecated - -use createTypeSpecLibrary diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md deleted file mode 100644 index de80530f72d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] createChecker" - ---- -```ts -createChecker(program): Checker -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | - -## Returns - -[`Checker`](../interfaces/Checker.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md deleted file mode 100644 index df1f1ebf3ed..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -jsApi: true -title: "[F] createDecoratorDefinition" - ---- -```ts -createDecoratorDefinition(definition): DecoratorValidator -``` - -## Type parameters - -| Type parameter | -| :------ | -| `T` extends [`TypeKind`](../type-aliases/TypeKind.md) | -| `P` extends readonly [`DecoratorParamDefinition`](../interfaces/DecoratorParamDefinition.md)<[`TypeKind`](../type-aliases/TypeKind.md)\>[] | -| `S` extends `undefined` \| [`DecoratorParamDefinition`](../interfaces/DecoratorParamDefinition.md)<[`TypeKind`](../type-aliases/TypeKind.md)\> | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `definition` | [`DecoratorDefinition`](../interfaces/DecoratorDefinition.md)<`T`, `P`, `S`\> | - -## Returns - -[`DecoratorValidator`](../interfaces/DecoratorValidator.md)<`T`, `P`, `S`\> - -## Deprecated - -use extern dec definition in TypeSpec instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md deleted file mode 100644 index fd912a73d07..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] createDiagnosticCollector" - ---- -```ts -createDiagnosticCollector(): DiagnosticCollector -``` - -Create a new instance of the - -## Returns - -[`DiagnosticCollector`](../interfaces/DiagnosticCollector.md) - -## See - -DiagnosticCollector. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md deleted file mode 100644 index 0f5b83f52cc..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] createProjectedNameProgram" - ---- -```ts -createProjectedNameProgram(program, target): ProjectedNameView -``` - -Create an helper to manager project names. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | Program | -| `target` | `string` | Name of the projected name target(e.g. json, csharp, etc.) | - -## Returns - -[`ProjectedNameView`](../interfaces/ProjectedNameView.md) - -ProjectedNameView diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md deleted file mode 100644 index 3b6c23ac32c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] createRekeyableMap" - ---- -```ts -createRekeyableMap(entries?): RekeyableMap -``` - -## Type parameters - -| Type parameter | -| :------ | -| `K` | -| `V` | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `entries`? | [`K`, `V`][] | - -## Returns - -`RekeyableMap`<`K`, `V`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md deleted file mode 100644 index 153cf8b90d0..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[F] createRule" - ---- -```ts -createRule(definition): LinterRuleDefinition -``` - -Create a new linter rule. - -## Type parameters - -| Type parameter | -| :------ | -| `N` extends `string` | -| `T` extends [`DiagnosticMessages`](../interfaces/DiagnosticMessages.md) | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `definition` | [`LinterRuleDefinition`](../interfaces/LinterRuleDefinition.md)<`N`, `T`\> | - -## Returns - -[`LinterRuleDefinition`](../interfaces/LinterRuleDefinition.md)<`N`, `T`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md deleted file mode 100644 index 2f97135c1c4..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -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) | - -## Returns - -[`Scanner`](../interfaces/Scanner.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md deleted file mode 100644 index da2a6edfc01..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] createServer" - ---- -```ts -createServer(host): Server -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `host` | [`ServerHost`](../interfaces/ServerHost.md) | - -## Returns - -[`Server`](../interfaces/Server.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md deleted file mode 100644 index ba61bbf7733..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] createSourceFile" - ---- -```ts -createSourceFile(text, path): SourceFile -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `text` | `string` | -| `path` | `string` | - -## Returns - -[`SourceFile`](../interfaces/SourceFile.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.md deleted file mode 100644 index 3580062c7c0..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.md +++ /dev/null @@ -1,28 +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`](../interfaces/Projector.md) | - -## Returns - -`Object` - -| Member | Type | -| :------ | :------ | -| `stateMap` | <`T`\>(`key`) => `StateMapView`<`T`\> | -| `stateSet` | (`key`) => `StateSetView` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md deleted file mode 100644 index b245ca6de16..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -jsApi: true -title: "[F] createTypeSpecLibrary" - ---- -```ts -createTypeSpecLibrary(lib): TypeSpecLibrary -``` - -Create a new TypeSpec library definition. - -## Type parameters - -| Type parameter | Value | -| :------ | :------ | -| `T` extends `Object` | - | -| `E` extends `Record`<`string`, `any`\> | - | -| `State` extends `string` | `never` | - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `lib` | `Readonly`<[`TypeSpecLibraryDef`](../interfaces/TypeSpecLibraryDef.md)<`T`, `E`, `State`\>\> | Library definition. | - -## Returns - -[`TypeSpecLibrary`](../interfaces/TypeSpecLibrary.md)<`T`, `E`, `State`\> - -Library with utility functions. - -## Tutorial - -Create the lib object with `as const` to get the full typing. - -## Example - -```ts -const libDef = { - name: "myLib", - diagnostics: { - "my-code": {serverity: "error", messages: {default: "Foo bar"}} - }, -} as const; - -const lib = createTypeSpecLibrary(libDef); -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md deleted file mode 100644 index 802753dbe38..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] defineCodeFix" - ---- -```ts -defineCodeFix(fix): CodeFix -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `fix` | [`CodeFix`](../interfaces/CodeFix.md) | - -## Returns - -[`CodeFix`](../interfaces/CodeFix.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md deleted file mode 100644 index ec398eb87b3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] defineLinter" - ---- -```ts -defineLinter(def): LinterDefinition -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `def` | [`LinterDefinition`](../interfaces/LinterDefinition.md) | - -## Returns - -[`LinterDefinition`](../interfaces/LinterDefinition.md) 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 deleted file mode 100644 index c0e94345a83..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -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 | - -## Returns - -`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md deleted file mode 100644 index 12e9afcd7cd..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] ensureTrailingDirectorySeparator" - ---- -```ts -ensureTrailingDirectorySeparator(path): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md deleted file mode 100644 index e40bafddc80..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] exprIsBareIdentifier" - ---- -```ts -exprIsBareIdentifier(expr): expr is TypeReferenceNode & Object -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `expr` | [`Expression`](../type-aliases/Expression.md) | - -## Returns - -`expr is TypeReferenceNode & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md deleted file mode 100644 index 849ef168288..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[F] filterModelProperties" - ---- -```ts -filterModelProperties( - program, - model, - filter): Model -``` - -Applies a filter to the properties of a given type. If no properties -are filtered out, then return the input unchanged. Otherwise, return -a new anonymous model with only the filtered properties. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | - | -| `model` | [`Model`](../interfaces/Model.md) | The input model to filter. | -| `filter` | (`property`) => `boolean` | The filter to apply. Properties are kept when this returns true. | - -## Returns - -[`Model`](../interfaces/Model.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md deleted file mode 100644 index 3c50c8e1f42..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] finishTypeForProgram" - ---- -```ts -finishTypeForProgram(program, typeDef): T -``` - -## Type parameters - -| Type parameter | -| :------ | -| `T` extends [`Type`](../type-aliases/Type.md) | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `typeDef` | `T` | - -## Returns - -`T` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md deleted file mode 100644 index 3b9605deef8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] formatDiagnostic" - ---- -```ts -formatDiagnostic(diagnostic): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `diagnostic` | [`Diagnostic`](../interfaces/Diagnostic.md) | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md deleted file mode 100644 index 484f24d9bef..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] formatIdentifier" - ---- -```ts -formatIdentifier(sv): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `sv` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md deleted file mode 100644 index 753468c7b3f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] formatTypeSpec" - ---- -```ts -formatTypeSpec(code, prettierConfig?): Promise -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `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 deleted file mode 100644 index 3d95451fee7..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -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) | - -## Returns - -`string`[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md deleted file mode 100644 index 47d49049a08..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -jsApi: true -title: "[F] getAnyExtensionFromPath" - ---- -```ts -getAnyExtensionFromPath(path): string -``` - -Gets the file extension for a path. -Normalizes it to lower case. - -```ts -getAnyExtensionFromPath("/path/to/file.ext") === ".ext" -getAnyExtensionFromPath("/path/to/file.ext/") === ".ext" -getAnyExtensionFromPath("/path/to/file") === "" -getAnyExtensionFromPath("/path/to.ext/file") === "" -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md deleted file mode 100644 index aa73d5729ec..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -jsApi: true -title: "[F] getBaseFileName" - ---- -```ts -getBaseFileName(path): string -``` - -Returns the path except for its containing directory name. -Semantics align with NodeJS's `path.basename` except that we support URL's as well. - -```ts -// POSIX -getBaseFileName("/path/to/file.ext") === "file.ext" -getBaseFileName("/path/to/") === "to" -getBaseFileName("/") === "" -// DOS -getBaseFileName("c:/path/to/file.ext") === "file.ext" -getBaseFileName("c:/path/to/") === "to" -getBaseFileName("c:/") === "" -getBaseFileName("c:") === "" -// URL -getBaseFileName("http://typescriptlang.org/path/to/file.ext") === "file.ext" -getBaseFileName("http://typescriptlang.org/path/to/") === "to" -getBaseFileName("http://typescriptlang.org/") === "" -getBaseFileName("http://typescriptlang.org") === "" -getBaseFileName("file://server/path/to/file.ext") === "file.ext" -getBaseFileName("file://server/path/to/") === "to" -getBaseFileName("file://server/") === "" -getBaseFileName("file://server") === "" -getBaseFileName("file:///path/to/file.ext") === "file.ext" -getBaseFileName("file:///path/to/") === "to" -getBaseFileName("file:///") === "" -getBaseFileName("file://") === "" -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md deleted file mode 100644 index 95200328e14..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] getDeprecated" - ---- -```ts -getDeprecated(program, type): string | undefined -``` - -Return the deprecated message or undefined if not deprecated - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | Program | -| `type` | [`Type`](../type-aliases/Type.md) | Type | - -## Returns - -`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md deleted file mode 100644 index f6542775557..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] getDeprecationDetails" - ---- -```ts -getDeprecationDetails(program, typeOrNode): DeprecationDetails | undefined -``` - -Returns complete deprecation details for the given type or node - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | Program | -| `typeOrNode` | [`Type`](../type-aliases/Type.md) \| [`Node`](../type-aliases/Node.md) | A Type or Node to check for deprecation | - -## Returns - -[`DeprecationDetails`](../interfaces/DeprecationDetails.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md deleted file mode 100644 index 07d5e1a5a98..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] getDirectoryPath" - ---- -```ts -getDirectoryPath(path): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md deleted file mode 100644 index 803e1a402c2..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] getDiscriminatedTypes" - ---- -```ts -getDiscriminatedTypes(program): [Model | Union, Discriminator][] -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | - -## Returns - -[[`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md), [`Discriminator`](../interfaces/Discriminator.md)][] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md deleted file mode 100644 index 07f3096e559..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md) | -| `discriminator` | [`Discriminator`](../interfaces/Discriminator.md) | - -## Returns - -[[`DiscriminatedUnion`](../interfaces/DiscriminatedUnion.md), readonly [`Diagnostic`](../interfaces/Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md deleted file mode 100644 index 645c49827b8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -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) | - -## Returns - -[`Discriminator`](../interfaces/Discriminator.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md deleted file mode 100644 index 7aff9c47e62..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] getDoc" - ---- -```ts -getDoc(program, target): string | undefined -``` - -Get the documentation string for the given type. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../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/functions/getDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md deleted file mode 100644 index 9fb51757b1b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] getDocData" - ---- -```ts -getDocData(program, target): DocData | undefined -``` - -Get the documentation information for the given type. In most cases you probably just want to use [getDoc](getDoc.md) - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | Program | -| `target` | [`Type`](../type-aliases/Type.md) | Type | - -## Returns - -[`DocData`](../interfaces/DocData.md) \| `undefined` - -Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.md deleted file mode 100644 index af7fc9576ec..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 - -[`DocData`](../interfaces/DocData.md) \| `undefined` - -Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md deleted file mode 100644 index 4315c21417a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -jsApi: true -title: "[F] getEffectiveModelType" - ---- -```ts -getEffectiveModelType( - program, - model, - filter?): Model -``` - -If the input is anonymous (or the provided filter removes properties) -and there exists a named model with the same set of properties -(ignoring filtered properties), then return that named model. -Otherwise, return the input unchanged. - -This can be used by emitters to find a better name for a set of -properties after filtering. For example, given `{ @metadata prop: -string} & SomeName`, and an emitter that wishes to discard properties -marked with `@metadata`, the emitter can use this to recover that the -best name for the remaining properties is `SomeName`. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | - | -| `model` | [`Model`](../interfaces/Model.md) | The input model | -| `filter`? | (`property`) => `boolean` | An optional filter to apply to the input model's
properties. | - -## Returns - -[`Model`](../interfaces/Model.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md deleted file mode 100644 index 984c786f8cb..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getEncode" - ---- -```ts -getEncode(program, target): EncodeData | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | - -## Returns - -[`EncodeData`](../interfaces/EncodeData.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md deleted file mode 100644 index 7b7d94b08e1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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 - -`string` \| `undefined` - -Documentation value diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md deleted file mode 100644 index 437425e1084..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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 - -[`DocData`](../interfaces/DocData.md) \| `undefined` - -Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md deleted file mode 100644 index 41898c72a0f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getFirstAncestor" - ---- -```ts -getFirstAncestor(node, test): Node | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`Node`](../type-aliases/Node.md) | -| `test` | [`NodeCallback`](../type-aliases/NodeCallback.md)<`boolean`\> | - -## Returns - -[`Node`](../type-aliases/Node.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md deleted file mode 100644 index edc2b182769..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getFormat" - ---- -```ts -getFormat(program, target): string | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md deleted file mode 100644 index 1f8e4c78f8a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getFriendlyName" - ---- -```ts -getFriendlyName(program, target): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md deleted file mode 100644 index ba12d4d11ee..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[F] getFullyQualifiedSymbolName" - ---- -```ts -getFullyQualifiedSymbolName(sym, options?): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `sym` | `undefined` \| [`Sym`](../interfaces/Sym.md) | -| `options`? | `Object` | -| `options.useGlobalPrefixAtTopLevel`? | `boolean` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md deleted file mode 100644 index 237920b3b83..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] getIdentifierContext" - ---- -```ts -getIdentifierContext(id): IdentifierContext -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `id` | [`IdentifierNode`](../interfaces/IdentifierNode.md) | - -## Returns - -[`IdentifierContext`](../interfaces/IdentifierContext.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md deleted file mode 100644 index ad759b41109..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getKeyName" - ---- -```ts -getKeyName(program, property): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md deleted file mode 100644 index 4580f1e7d54..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getKnownValues" - ---- -```ts -getKnownValues(program, target): Enum | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | - -## Returns - -[`Enum`](../interfaces/Enum.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md deleted file mode 100644 index d77ea57cad5..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] getListOperationType" - ---- -```ts -getListOperationType(program, target): Model | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -[`Model`](../interfaces/Model.md) \| `undefined` - -## Deprecated - -This function is unused and will be removed in a future release. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md deleted file mode 100644 index 7c4b713a460..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getLocationContext" - ---- -```ts -getLocationContext(program, type): LocationContext -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `type` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | - -## Returns - -[`LocationContext`](../type-aliases/LocationContext.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md deleted file mode 100644 index bef35c87af1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getMaxItems" - ---- -```ts -getMaxItems(program, target): number | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md deleted file mode 100644 index a10e2bcc68d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getMaxLength" - ---- -```ts -getMaxLength(program, target): number | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md deleted file mode 100644 index d3e75be269b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getMaxValue" - ---- -```ts -getMaxValue(program, target): number | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md deleted file mode 100644 index cc245fdb02e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getMaxValueExclusive" - ---- -```ts -getMaxValueExclusive(program, target): number | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md deleted file mode 100644 index 53e57a38c0d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getMinItems" - ---- -```ts -getMinItems(program, target): number | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md deleted file mode 100644 index d47c83e38f8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getMinLength" - ---- -```ts -getMinLength(program, target): number | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md deleted file mode 100644 index e9571d102e9..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getMinValue" - ---- -```ts -getMinValue(program, target): number | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md deleted file mode 100644 index d4ea937bffd..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getMinValueExclusive" - ---- -```ts -getMinValueExclusive(program, target): number | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md deleted file mode 100644 index 74dbc56f63d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] getNamespaceFullName" - ---- -```ts -getNamespaceFullName(type, options?): string -``` - -Return the full name of the namespace(e.g. "Foo.Bar") - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `type` | [`Namespace`](../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/functions/getNodeAtPosition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md deleted file mode 100644 index 736a81a4a8c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -jsApi: true -title: "[F] getNodeAtPosition" - ---- -## getNodeAtPosition(script, position, filter) - -```ts -getNodeAtPosition( - script, - position, - filter?): Node | undefined -``` - -Resolve the node in the syntax tree that that is at the given position. - -### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `script` | [`TypeSpecScriptNode`](../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-aliases/Node.md) \| `undefined` - -## getNodeAtPosition(script, position, filter) - -```ts -getNodeAtPosition( - script, - position, - filter): T | undefined -``` - -### Type parameters - -| Type parameter | -| :------ | -| `T` extends [`Node`](../type-aliases/Node.md) | - -### Parameters - -| Parameter | Type | -| :------ | :------ | -| `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | -| `position` | `number` | -| `filter` | (`node`) => `node is T` | - -### Returns - -`T` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md deleted file mode 100644 index d3bc953a888..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getNormalizedAbsolutePath" - ---- -```ts -getNormalizedAbsolutePath(fileName, currentDirectory): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `fileName` | `string` | -| `currentDirectory` | `undefined` \| `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md deleted file mode 100644 index 7c149fe73e1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getNormalizedAbsolutePathWithoutRoot" - ---- -```ts -getNormalizedAbsolutePathWithoutRoot(fileName, currentDirectory): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `fileName` | `string` | -| `currentDirectory` | `undefined` \| `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md deleted file mode 100644 index 24d43d93f9d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -jsApi: true -title: "[F] getNormalizedPathComponents" - ---- -```ts -getNormalizedPathComponents(path, currentDirectory): string[] -``` - -Parse a path into an array containing a root component (at index 0) and zero or more path -components (at indices > 0). The result is normalized. -If the path is relative, the root component is `""`. -If the path is absolute, the root component includes the first path separator (`/`). - -```ts -getNormalizedPathComponents("to/dir/../file.ext", "/path/") === ["/", "path", "to", "file.ext"] -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | -| `currentDirectory` | `undefined` \| `string` | - -## Returns - -`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md deleted file mode 100644 index 72e5c14d991..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] getOverloadedOperation" - ---- -```ts -getOverloadedOperation(program, operation): Operation | undefined -``` - -If the given operation overloads another operation, return that operation. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | Program | -| `operation` | [`Operation`](../interfaces/Operation.md) | The operation to check for an overload target. | - -## Returns - -[`Operation`](../interfaces/Operation.md) \| `undefined` - -The operation this operation overloads, if any. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md deleted file mode 100644 index ab8f3d98707..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] getOverloads" - ---- -```ts -getOverloads(program, operation): Operation[] | undefined -``` - -Get all operations that are marked as overloads of the given operation - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | Program | -| `operation` | [`Operation`](../interfaces/Operation.md) | Operation | - -## Returns - -[`Operation`](../interfaces/Operation.md)[] \| `undefined` - -An array of operations that overload the given operation. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md deleted file mode 100644 index 0ab77e503a4..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] getOverriddenProperty" - ---- -```ts -getOverriddenProperty(property): ModelProperty | undefined -``` - -Gets the property from the nearest base type that is overridden by the -given property, if any. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | - -## Returns - -[`ModelProperty`](../interfaces/ModelProperty.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md deleted file mode 100644 index e4f504e6552..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] getParameterVisibility" - ---- -```ts -getParameterVisibility(program, entity): string[] | undefined -``` - -Returns the visibilities of the parameters of the given operation, if provided with `@parameterVisibility`. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `entity` | [`Operation`](../interfaces/Operation.md) | - -## Returns - -`string`[] \| `undefined` - -## See - -[$parameterVisibility]($parameterVisibility.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md deleted file mode 100644 index cd9695af51b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[F] getParentTemplateNode" - ---- -```ts -getParentTemplateNode(node): Node & TemplateDeclarationNode | undefined -``` - -Lookup and find the node - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `node` | [`Node`](../type-aliases/Node.md) | Node | - -## Returns - -[`Node`](../type-aliases/Node.md) & [`TemplateDeclarationNode`](../interfaces/TemplateDeclarationNode.md) \| `undefined` - -Template Parent node if applicable diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md deleted file mode 100644 index 0abf6ab72d4..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -jsApi: true -title: "[F] getPathComponents" - ---- -```ts -getPathComponents(path, currentDirectory): string[] -``` - -Parse a path into an array containing a root component (at index 0) and zero or more path -components (at indices > 0). The result is not normalized. -If the path is relative, the root component is `""`. -If the path is absolute, the root component includes the first path separator (`/`). - -```ts -// POSIX -getPathComponents("/path/to/file.ext") === ["/", "path", "to", "file.ext"] -getPathComponents("/path/to/") === ["/", "path", "to"] -getPathComponents("/") === ["/"] -// DOS -getPathComponents("c:/path/to/file.ext") === ["c:/", "path", "to", "file.ext"] -getPathComponents("c:/path/to/") === ["c:/", "path", "to"] -getPathComponents("c:/") === ["c:/"] -getPathComponents("c:") === ["c:"] -// URL -getPathComponents("http://typescriptlang.org/path/to/file.ext") === ["http://typescriptlang.org/", "path", "to", "file.ext"] -getPathComponents("http://typescriptlang.org/path/to/") === ["http://typescriptlang.org/", "path", "to"] -getPathComponents("http://typescriptlang.org/") === ["http://typescriptlang.org/"] -getPathComponents("http://typescriptlang.org") === ["http://typescriptlang.org"] -getPathComponents("file://server/path/to/file.ext") === ["file://server/", "path", "to", "file.ext"] -getPathComponents("file://server/path/to/") === ["file://server/", "path", "to"] -getPathComponents("file://server/") === ["file://server/"] -getPathComponents("file://server") === ["file://server"] -getPathComponents("file:///path/to/file.ext") === ["file:///", "path", "to", "file.ext"] -getPathComponents("file:///path/to/") === ["file:///", "path", "to"] -getPathComponents("file:///") === ["file:///"] -getPathComponents("file://") === ["file://"] -``` - -## Parameters - -| Parameter | Type | Default value | -| :------ | :------ | :------ | -| `path` | `string` | `undefined` | -| `currentDirectory` | `string` | `""` | - -## Returns - -`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md deleted file mode 100644 index 9f5ec22613a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] getPathFromPathComponents" - ---- -```ts -getPathFromPathComponents(pathComponents): string -``` - -Formats a parsed path consisting of a root component (at index 0) and zero or more path -segments (at indices > 0). - -```ts -getPathFromPathComponents(["/", "path", "to", "file.ext"]) === "/path/to/file.ext" -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `pathComponents` | readonly `string`[] | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md deleted file mode 100644 index 43893733004..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[F] getPattern" - ---- -```ts -getPattern(program, target): string | undefined -``` - -Gets the pattern regular expression associated with a given type, if one has been set. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | the Program containing the target Type | -| `target` | [`Type`](../type-aliases/Type.md) | the type to get the pattern for | - -## Returns - -`string` \| `undefined` - -the pattern string, if one was set - -## See - -getPatternData diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md deleted file mode 100644 index 577ffe621d4..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[F] getPatternData" - ---- -```ts -getPatternData(program, target): PatternData | undefined -``` - -Gets the associated pattern data, including the pattern regular expression and optional validation message, if any -has been set. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | the Program containing the target Type | -| `target` | [`Type`](../type-aliases/Type.md) | the type to get the pattern data for | - -## Returns - -[`PatternData`](../interfaces/PatternData.md) \| `undefined` - -the pattern data, if any was set diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md deleted file mode 100644 index 09ac2efec13..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] getPositionBeforeTrivia" - ---- -```ts -getPositionBeforeTrivia(script, pos): number -``` - -Adjust the given postion backwards before any trivia. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | -| `pos` | `number` | - -## Returns - -`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md deleted file mode 100644 index 6895accf1e6..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[F] getProjectedName" - ---- -```ts -getProjectedName( - program, - target, - projectionName): string | undefined -``` - -Get the projected name of the given entity for the given projection. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../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 deleted file mode 100644 index b8c3f85a20e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -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 - -`ReadonlyMap`<`string`, `string`\> \| `undefined` - -Map of the projected names for the given entity. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md deleted file mode 100644 index e374afa6c22..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getProperty" - ---- -```ts -getProperty(type, propertyName): ModelProperty | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Model`](../interfaces/Model.md) | -| `propertyName` | `string` | - -## Returns - -[`ModelProperty`](../interfaces/ModelProperty.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md deleted file mode 100644 index 87fdd3f58e2..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[F] getPropertyType" - ---- -```ts -getPropertyType(target): Type -``` - -Return the type of the property or the model itself. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | - -## Returns - -[`Type`](../type-aliases/Type.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md deleted file mode 100644 index eb43f017d8e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -jsApi: true -title: "[F] getRelativePathFromDirectory" - ---- -## getRelativePathFromDirectory(from, to, ignoreCase) - -```ts -getRelativePathFromDirectory( - from, - to, - ignoreCase): string -``` - -Gets a relative path that can be used to traverse between `from` and `to`. - -### Parameters - -| Parameter | Type | -| :------ | :------ | -| `from` | `string` | -| `to` | `string` | -| `ignoreCase` | `boolean` | - -### Returns - -`string` - -## getRelativePathFromDirectory(fromDirectory, to, getCanonicalFileName) - -```ts -getRelativePathFromDirectory( - fromDirectory, - to, - getCanonicalFileName): string -``` - -Gets a relative path that can be used to traverse between `from` and `to`. - -### Parameters - -| Parameter | Type | -| :------ | :------ | -| `fromDirectory` | `string` | -| `to` | `string` | -| `getCanonicalFileName` | `GetCanonicalFileName` | - -### Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md deleted file mode 100644 index 05210db4d2a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] getReturnTypeVisibility" - ---- -```ts -getReturnTypeVisibility(program, entity): string[] | undefined -``` - -Returns the visibilities of the return type of the given operation, if provided with `@returnTypeVisibility`. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `entity` | [`Operation`](../interfaces/Operation.md) | - -## Returns - -`string`[] \| `undefined` - -## See - -[$returnTypeVisibility]($returnTypeVisibility.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md deleted file mode 100644 index a28ad129ab6..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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 - -`string` \| `undefined` - -Documentation value diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md deleted file mode 100644 index 225e0faaba0..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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 - -[`DocData`](../interfaces/DocData.md) \| `undefined` - -Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md deleted file mode 100644 index de62b4b5abb..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -jsApi: true -title: "[F] getRootLength" - ---- -```ts -getRootLength(path): number -``` - -Returns length of the root part of a path or URL (i.e. length of "/", "x:/", "//server/share/, file:///user/files"). - -For example: -```ts -getRootLength("a") === 0 // "" -getRootLength("/") === 1 // "/" -getRootLength("c:") === 2 // "c:" -getRootLength("c:d") === 0 // "" -getRootLength("c:/") === 3 // "c:/" -getRootLength("c:\\") === 3 // "c:\\" -getRootLength("//server") === 7 // "//server" -getRootLength("//server/share") === 8 // "//server/" -getRootLength("\\\\server") === 7 // "\\\\server" -getRootLength("\\\\server\\share") === 8 // "\\\\server\\" -getRootLength("file:///path") === 8 // "file:///" -getRootLength("file:///c:") === 10 // "file:///c:" -getRootLength("file:///c:d") === 8 // "file:///" -getRootLength("file:///c:/path") === 11 // "file:///c:/" -getRootLength("file://server") === 13 // "file://server" -getRootLength("file://server/path") === 14 // "file://server/" -getRootLength("http://server") === 13 // "http://server" -getRootLength("http://server/path") === 14 // "http://server/" -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md deleted file mode 100644 index d66035656c6..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] getService" - ---- -```ts -getService(program, namespace): Service | undefined -``` - -Get the service information for the given namespace. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | Program | -| `namespace` | [`Namespace`](../interfaces/Namespace.md) | Service namespace | - -## Returns - -[`Service`](../interfaces/Service.md) \| `undefined` - -Service information or undefined if namespace is not a service namespace. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md deleted file mode 100644 index f2b2e15e727..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] getSourceFileKindFromExt" - ---- -```ts -getSourceFileKindFromExt(path): SourceFileKind | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -[`SourceFileKind`](../type-aliases/SourceFileKind.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md deleted file mode 100644 index c77c0cc5759..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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) | - -### Returns - -[`SourceLocation`](../interfaces/SourceLocation.md) - -## getSourceLocation(target, options) - -```ts -getSourceLocation(target, options?): undefined -``` - -### Parameters - -| Parameter | Type | -| :------ | :------ | -| `target` | `undefined` \| *typeof* [`NoTarget`](../variables/NoTarget.md) | -| `options`? | [`SourceLocationOptions`](../interfaces/SourceLocationOptions.md) | - -### Returns - -`undefined` - -## 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) | - -### Returns - -[`SourceLocation`](../interfaces/SourceLocation.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md deleted file mode 100644 index 8effbe4d009..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getSummary" - ---- -```ts -getSummary(program, type): string | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `type` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md deleted file mode 100644 index 5f0bbfc5c75..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getTags" - ---- -```ts -getTags(program, target): string[] -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md deleted file mode 100644 index c511f31f97d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -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) | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md deleted file mode 100644 index 82318009844..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getVisibility" - ---- -```ts -getVisibility(program, target): string[] | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`string`[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md deleted file mode 100644 index 8d726b22638..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] hasParseError" - ---- -```ts -hasParseError(node): number | true -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`Node`](../type-aliases/Node.md) | - -## Returns - -`number` \| `true` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md deleted file mode 100644 index ab7251c8a78..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[F] hasProjectedName" - ---- -```ts -hasProjectedName( - program, - target, - projectionName): boolean -``` - -Get the projected name of the given entity for the given projection. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../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/functions/hasTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md deleted file mode 100644 index 58c9568e47b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[F] hasTrailingDirectorySeparator" - ---- -```ts -hasTrailingDirectorySeparator(path): boolean -``` - -Determines whether a path has a trailing separator (`/` or `\\`). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md deleted file mode 100644 index 81fdef065d7..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -jsApi: true -title: "[F] ignoreDiagnostics" - ---- -```ts -ignoreDiagnostics(result): T -``` - -Ignore the diagnostics emitted by the diagnostic accessor pattern and just return the actual result. - -## Type parameters - -| Type parameter | -| :------ | -| `T` | - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `result` | [`DiagnosticResult`](../type-aliases/DiagnosticResult.md)<`T`\> | Accessor pattern tuple result including the actual result and the list of diagnostics. | - -## Returns - -`T` - -Actual result. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md deleted file mode 100644 index 17c40de8e7a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] interpolatePath" - ---- -```ts -interpolatePath(pathTemplate, predefinedVariables): string -``` - -Interpolate a path template - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `pathTemplate` | `string` | Path template | -| `predefinedVariables` | `Record`<`string`, `undefined` \| `string`\> | Variables that can be used in the path template. | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md deleted file mode 100644 index abee4537ebb..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[F] isAnyDirectorySeparator" - ---- -```ts -isAnyDirectorySeparator(charCode): boolean -``` - -Determines whether a charCode corresponds to `/` or ``. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `charCode` | `number` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md deleted file mode 100644 index 41d0e12807c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] isArrayModelType" - ---- -```ts -isArrayModelType(program, type): type is ArrayModelType -``` - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | - | -| `type` | [`Model`](../interfaces/Model.md) | Model type | - -## Returns - -`type is ArrayModelType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md deleted file mode 100644 index 5f27dd12aa8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -jsApi: true -title: "[F] isCadlValueTypeOf" - ---- -```ts -isCadlValueTypeOf(target, expectedType): target is InferredTypeSpecValue -``` - -## Type parameters - -| Type parameter | -| :------ | -| `K` extends [`TypeKind`](../type-aliases/TypeKind.md) | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `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/functions/isComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md deleted file mode 100644 index b30083bb6e6..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isComment" - ---- -```ts -isComment(token): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `token` | [`Token`](../enumerations/Token.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md deleted file mode 100644 index b75b5969d54..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[F] isDeclaredInNamespace" - ---- -```ts -isDeclaredInNamespace( - type, - namespace, - options): boolean -``` - -Check if the given type is declared in the specified namespace or, optionally, its child namespaces. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `type` | \| [`Model`](../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/functions/isDeclaredType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md deleted file mode 100644 index 8916b6e7b8d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[F] isDeclaredType" - ---- -```ts -isDeclaredType(type): boolean -``` - -Check if the type is a declared type. This include: -- non templated type -- template declaration - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md deleted file mode 100644 index f52fe8b53fb..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] isDeprecated" - ---- -```ts -isDeprecated(program, type): boolean -``` - -Check if the given type is deprecated - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | Program | -| `type` | [`Type`](../type-aliases/Type.md) | Type | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md deleted file mode 100644 index 743b7f23c12..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] isErrorModel" - ---- -```ts -isErrorModel(program, target): boolean -``` - -Check if the type is an error model or a descendant of an error model. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md deleted file mode 100644 index 27f4941c22e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isErrorType" - ---- -```ts -isErrorType(type): type is ErrorType -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`type is ErrorType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md deleted file mode 100644 index bf482ade011..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] isGlobalNamespace" - ---- -```ts -isGlobalNamespace(program, namespace): namespace is Namespace & Object -``` - -Check if the given namespace is the global namespace - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../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/functions/isImportStatement.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md deleted file mode 100644 index b92767ae14a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isImportStatement" - ---- -```ts -isImportStatement(node): node is ImportStatementNode -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`Node`](../type-aliases/Node.md) | - -## Returns - -`node is ImportStatementNode` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md deleted file mode 100644 index 22175e71ab1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md deleted file mode 100644 index de827d3e63f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] isKey" - ---- -```ts -isKey(program, property): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md deleted file mode 100644 index 44e74a76825..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isKeyword" - ---- -```ts -isKeyword(token): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `token` | [`Token`](../enumerations/Token.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md deleted file mode 100644 index 2a766fa5931..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] isListOperation" - ---- -```ts -isListOperation(program, target): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `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/functions/isModifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md deleted file mode 100644 index 4d0548170c4..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isModifier" - ---- -```ts -isModifier(token): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `token` | [`Token`](../enumerations/Token.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md deleted file mode 100644 index f054d8aebff..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isNeverType" - ---- -```ts -isNeverType(type): type is NeverType -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`type is NeverType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md deleted file mode 100644 index 41e1ce2ce3f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isNullType" - ---- -```ts -isNullType(type): type is NullType -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`type is NullType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md deleted file mode 100644 index 5c8fa2ab12a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`target is Scalar` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md deleted file mode 100644 index 21e4b9b286f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isPathAbsolute" - ---- -```ts -isPathAbsolute(path): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md deleted file mode 100644 index 61e16dc5bcc..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isProjectedProgram" - ---- -```ts -isProjectedProgram(program): program is ProjectedProgram -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | - -## Returns - -`program is ProjectedProgram` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md deleted file mode 100644 index 2219b798296..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isPunctuation" - ---- -```ts -isPunctuation(token): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `token` | [`Token`](../enumerations/Token.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md deleted file mode 100644 index 70514fcac7f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] isRecordModelType" - ---- -```ts -isRecordModelType(program, type): type is ArrayModelType -``` - -Check if a model is an array type. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | - | -| `type` | [`Model`](../interfaces/Model.md) | Model type | - -## Returns - -`type is ArrayModelType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md deleted file mode 100644 index 54b813cccb5..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] isSecret" - ---- -```ts -isSecret(program, target): boolean | undefined -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`boolean` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md deleted file mode 100644 index 2a278b6e622..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] isService" - ---- -```ts -isService(program, namespace): boolean -``` - -Check if the namespace is defined as a service. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../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/functions/isStatementKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md deleted file mode 100644 index da379ee03ea..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isStatementKeyword" - ---- -```ts -isStatementKeyword(token): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `token` | [`Token`](../enumerations/Token.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md deleted file mode 100644 index fc21666a880..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isStdNamespace" - ---- -```ts -isStdNamespace(namespace): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `namespace` | [`Namespace`](../interfaces/Namespace.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md deleted file mode 100644 index 5b71a07254b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | -| `target` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`target is Scalar` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md deleted file mode 100644 index 1d3ab132c9c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[F] isTemplateDeclaration" - ---- -```ts -isTemplateDeclaration(type): type is TemplatedType & Object -``` - -Resolve if the type is a template type declaration(Non initialized template type). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`TemplatedType`](../type-aliases/TemplatedType.md) | - -## Returns - -`type is TemplatedType & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md deleted file mode 100644 index 1f5ffe2aca9..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[F] isTemplateDeclarationOrInstance" - ---- -```ts -isTemplateDeclarationOrInstance(type): boolean -``` - -Resolve if the type was created from a template type or is a template type declaration. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`TemplatedType`](../type-aliases/TemplatedType.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md deleted file mode 100644 index 55add5ec1af..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[F] isTemplateInstance" - ---- -```ts -isTemplateInstance(type): type is TemplatedType & Object -``` - -Check the given type is a finished template instance. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`type is TemplatedType & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md deleted file mode 100644 index 4a7db7572a9..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isTrivia" - ---- -```ts -isTrivia(token): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `token` | [`Token`](../enumerations/Token.md) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md deleted file mode 100644 index bfb89ac31e6..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -jsApi: true -title: "[F] isTypeSpecValueTypeOf" - ---- -```ts -isTypeSpecValueTypeOf(target, expectedType): target is InferredTypeSpecValue -``` - -Check if the given target is of any of the TypeSpec types. - -## Type parameters - -| Type parameter | -| :------ | -| `K` extends [`TypeKind`](../type-aliases/TypeKind.md) | - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `target` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | Target to validate. | -| `expectedType` | `K` \| readonly `K`[] | One or multiple allowed TypeSpec types. | - -## Returns - -`target is InferredTypeSpecValue` - -boolean if the target is of one of the allowed types. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md deleted file mode 100644 index d96a20b145d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isUnknownType" - ---- -```ts -isUnknownType(type): type is UnknownType -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`type is UnknownType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md deleted file mode 100644 index fac8b27849d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[F] isUrl" - ---- -```ts -isUrl(path): boolean -``` - -Determines whether a path starts with a URL scheme (e.g. starts with `http://`, `ftp://`, `file://`, etc.). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md deleted file mode 100644 index 5b89aa6098b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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`[] | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md deleted file mode 100644 index 0556ff90e5b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] isVoidType" - ---- -```ts -isVoidType(type): type is VoidType -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | - -## Returns - -`type is VoidType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md deleted file mode 100644 index e78d9eea750..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -jsApi: true -title: "[F] joinPaths" - ---- -```ts -joinPaths(path, ...paths): string -``` - -Combines paths. If a path is absolute, it replaces any previous path. Relative paths are not simplified. - -```ts -// Non-rooted -joinPaths("path", "to", "file.ext") === "path/to/file.ext" -joinPaths("path", "dir", "..", "to", "file.ext") === "path/dir/../to/file.ext" -// POSIX -joinPaths("/path", "to", "file.ext") === "/path/to/file.ext" -joinPaths("/path", "/to", "file.ext") === "/to/file.ext" -// DOS -joinPaths("c:/path", "to", "file.ext") === "c:/path/to/file.ext" -joinPaths("c:/path", "c:/to", "file.ext") === "c:/to/file.ext" -// URL -joinPaths("file:///path", "to", "file.ext") === "file:///path/to/file.ext" -joinPaths("file:///path", "file:///to", "file.ext") === "file:///to/file.ext" -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | -| ...`paths` | (`undefined` \| `string`)[] | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md deleted file mode 100644 index ac93da4059e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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`](../interfaces/Interface.md) \| [`Namespace`](../interfaces/Namespace.md) | Container. | -| `options` | [`ListOperationOptions`](../interfaces/ListOperationOptions.md) | Options. | - -## Returns - -[`Operation`](../interfaces/Operation.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md deleted file mode 100644 index 0d54482b409..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[F] listServices" - ---- -```ts -listServices(program): Service[] -``` - -List all the services defined in the TypeSpec program - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | Program | - -## Returns - -[`Service`](../interfaces/Service.md)[] - -List of service. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md deleted file mode 100644 index 9cb0323501f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] logDiagnostics" - ---- -```ts -logDiagnostics(diagnostics, logger): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `diagnostics` | readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] | -| `logger` | [`LogSink`](../interfaces/LogSink.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md deleted file mode 100644 index cd6d715306a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[F] logVerboseTestOutput" - ---- -```ts -logVerboseTestOutput(messageOrCallback): void -``` - -Verbose output is enabled by default for runs in mocha explorer in VS Code, -where the output is nicely associated with the individual test, and disabled -by default for command line runs where we don't want to spam the console. - -If the steps taken to produce the message are expensive, pass a callback -instead of producing the message then passing it here only to be dropped -when verbose output is disabled. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `messageOrCallback` | `string` \| (`log`) => `void` | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md deleted file mode 100644 index faeb12b857e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[F] mapEventEmitterToNodeListener" - ---- -```ts -mapEventEmitterToNodeListener(eventEmitter): SemanticNodeListener -``` - -Create a Semantic node listener from an event emitter. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `eventEmitter` | [`EventEmitter`](../classes/EventEmitter.md)<[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md)\> | Event emitter. | - -## Returns - -[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) - -Semantic node listener. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md deleted file mode 100644 index 32cca70f554..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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`](../interfaces/Program.md) | Program | -| `type` | [`Type`](../type-aliases/Type.md) | Type | -| `details` | [`DeprecationDetails`](../interfaces/DeprecationDetails.md) | Details of the deprecation | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md deleted file mode 100644 index 820142d61b9..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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`](../interfaces/Program.md) | Program to navigate. | -| `listeners` | [`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) | Listener called when visiting types. | -| `options` | [`NavigationOptions`](../interfaces/NavigationOptions.md) | Navigation options. | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md deleted file mode 100644 index bc2bd515fd3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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-aliases/Type.md) | Type to navigate. | -| `listeners` | [`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) | Listener for the types found. | -| `options` | [`NavigationOptions`](../interfaces/NavigationOptions.md) | Navigation options | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md deleted file mode 100644 index 5f5a9abac5b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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` & `Object` & `Object` & `Object` | -| `options` | [`NamespaceNavigationOptions`](../interfaces/NamespaceNavigationOptions.md) & [`NavigationOptions`](../interfaces/NavigationOptions.md) | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md deleted file mode 100644 index 5f3c85b47a0..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] normalizePath" - ---- -```ts -normalizePath(path): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md deleted file mode 100644 index f57cabe09d3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[F] normalizeSlashes" - ---- -```ts -normalizeSlashes(path): string -``` - -Normalize path separators, converting `\` into `/`. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md deleted file mode 100644 index 96b7bcd0ab1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] paramMessage" - ---- -```ts -paramMessage(strings, ...keys): CallableMessage -``` - -## Type parameters - -| Type parameter | -| :------ | -| `T` extends `string`[] | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `strings` | readonly `string`[] | -| ...`keys` | `T` | - -## Returns - -[`CallableMessage`](../interfaces/CallableMessage.md)<`T`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md deleted file mode 100644 index 19635813f6e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] parse" - ---- -```ts -parse(code, options): TypeSpecScriptNode -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `code` | `string` \| [`SourceFile`](../interfaces/SourceFile.md) | -| `options` | [`ParseOptions`](../interfaces/ParseOptions.md) | - -## Returns - -[`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md deleted file mode 100644 index 11aeb6b5b72..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[F] parseStandaloneTypeReference" - ---- -```ts -parseStandaloneTypeReference(code): [TypeReferenceNode, readonly Diagnostic[]] -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `code` | `string` \| [`SourceFile`](../interfaces/SourceFile.md) | - -## Returns - -[[`TypeReferenceNode`](../interfaces/TypeReferenceNode.md), readonly [`Diagnostic`](../interfaces/Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md deleted file mode 100644 index 370563d6786..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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) | - -## Returns - -[`ProjectedProgram`](../interfaces/ProjectedProgram.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md deleted file mode 100644 index d98770badbe..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] reducePathComponents" - ---- -```ts -reducePathComponents(components): string[] -``` - -Reduce an array of path components to a more simplified path by navigating any -`"."` or `".."` entries in the path. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `components` | readonly `string`[] | - -## Returns - -`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md deleted file mode 100644 index 277ef723b72..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] removeTrailingDirectorySeparator" - ---- -```ts -removeTrailingDirectorySeparator(path): string -``` - -Removes a trailing directory separator from a path, if it does not already have one. - -```ts -removeTrailingDirectorySeparator("/path/to/file.ext") === "/path/to/file.ext" -removeTrailingDirectorySeparator("/path/to/file.ext/") === "/path/to/file.ext" -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md deleted file mode 100644 index f5f7ef69ba3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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`](../interfaces/Program.md) | TypeSpec Program. | -| `message` | `string` | Message describing the deprecation. | -| `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | Target of the deprecation. | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md deleted file mode 100644 index 6389f91e09b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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`](../interfaces/CompilerHost.md) | Compiler host | -| `options` | [`ResolveCompilerOptionsOptions`](../interfaces/ResolveCompilerOptionsOptions.md) | | - -## Returns - -`Promise`<[[`CompilerOptions`](../interfaces/CompilerOptions.md), readonly [`Diagnostic`](../interfaces/Diagnostic.md)[]]\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md deleted file mode 100644 index 91639e59b80..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -jsApi: true -title: "[F] resolveEncodedName" - ---- -```ts -resolveEncodedName( - program, - target, - mimeType): string -``` - -Resolve the encoded name for the given type when serialized to the given mime type. -If a specific value was provided by `@encodedName` decorator for that mime type it will return that otherwise it will return the name of the type. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) & `Object` | -| `mimeType` | `string` | - -## Returns - -`string` - -## Example - -For the given -```tsp -model Certificate { - @encodedName("application/json", "exp") - @encodedName("application/xml", "expiry") - expireAt: utcDateTime; - -} -``` - -```ts -resolveEncodedName(program, type, "application/json") // exp -resolveEncodedName(program, type, "application/merge-patch+json") // exp -resolveEncodedName(program, type, "application/xml") // expireAt -resolveEncodedName(program, type, "application/yaml") // expiry -``` 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 deleted file mode 100644 index aa009c703f2..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -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 - -`Promise`<[`ModuleResolutionResult`](../type-aliases/ModuleResolutionResult.md)\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md deleted file mode 100644 index cb260f4ffdd..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -jsApi: true -title: "[F] resolvePath" - ---- -```ts -resolvePath(path, ...paths): string -``` - -Combines and resolves paths. If a path is absolute, it replaces any previous path. Any -`.` and `..` path components are resolved. Trailing directory separators are preserved. - -```ts -resolvePath("/path", "to", "file.ext") === "path/to/file.ext" -resolvePath("/path", "to", "file.ext/") === "path/to/file.ext/" -resolvePath("/path", "dir", "..", "to", "file.ext") === "path/to/file.ext" -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | -| ...`paths` | (`undefined` \| `string`)[] | - -## Returns - -`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md deleted file mode 100644 index ea6924d66d3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] resolveUsages" - ---- -```ts -resolveUsages(types): UsageTracker -``` - -Resolve usage(input, output or both) of various types in the given namespace. -Will recursively scan all namespace, interfaces and operations contained inside the namespace. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `types` | [`OperationContainer`](../type-aliases/OperationContainer.md) \| [`OperationContainer`](../type-aliases/OperationContainer.md)[] | Entrypoint(s) namespace, interface or operations to get usage from. | - -## Returns - -[`UsageTracker`](../interfaces/UsageTracker.md) - -Map of types to usage. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md deleted file mode 100644 index bdd2cd32b58..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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 - -| Type parameter | -| :------ | -| `T` extends `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` & `Object` | - -## 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 - -`T` - -wrapped listeners that that can be used with `navigateType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md deleted file mode 100644 index db6837821f3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] setCadlNamespace" - ---- -```ts -setCadlNamespace(namespace, ...functions): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `namespace` | `string` | -| ...`functions` | (...`args`) => `any`[] | - -## Returns - -`void` - -## Deprecated - -use setTypeSpecNamespace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md deleted file mode 100644 index 2d54e87e462..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[F] setTypeSpecNamespace" - ---- -```ts -setTypeSpecNamespace(namespace, ...functions): void -``` - -Set the TypeSpec namespace for that function. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `namespace` | `string` | Namespace string (e.g. "Foo.Bar") | -| ...`functions` | (...`args`) => `any`[] | Functions | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md deleted file mode 100644 index 4a26a6f1ff5..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] skipTrivia" - ---- -```ts -skipTrivia( - input, - position, - endPosition): number -``` - -## Parameters - -| Parameter | Type | Default value | -| :------ | :------ | :------ | -| `input` | `string` | `undefined` | -| `position` | `number` | `undefined` | -| `endPosition` | `number` | `input.length` | - -## Returns - -`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md deleted file mode 100644 index 4f80fb1b191..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[F] skipWhiteSpace" - ---- -```ts -skipWhiteSpace( - input, - position, - endPosition): number -``` - -## Parameters - -| Parameter | Type | Default value | -| :------ | :------ | :------ | -| `input` | `string` | `undefined` | -| `position` | `number` | `undefined` | -| `endPosition` | `number` | `input.length` | - -## Returns - -`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md deleted file mode 100644 index 02474140f6b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[F] stringTemplateToString" - ---- -```ts -stringTemplateToString(stringTemplate): [string, readonly Diagnostic[]] -``` - -Convert a string template to a string value. -Only literal interpolated can be converted to string. -Otherwise diagnostics will be reported. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `stringTemplate` | [`StringTemplate`](../interfaces/StringTemplate.md) | String template to convert. | - -## Returns - -[`string`, readonly [`Diagnostic`](../interfaces/Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md deleted file mode 100644 index eaa62def3ba..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -jsApi: true -title: "[F] typespecTypeToJson" - ---- -```ts -typespecTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] -``` - -Convert a TypeSpec type to a serializable Json object. -Emits diagnostics if the given type is invalid - -## Type parameters - -| Type parameter | -| :------ | -| `T` | - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `typespecType` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | The type to convert to Json data | -| `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | The diagnostic target in case of errors. | - -## Returns - -[`T` \| `undefined`, [`Diagnostic`](../interfaces/Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md deleted file mode 100644 index 45e8845ee26..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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`](../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 - -`boolean` - -Whether the decorator application is valid diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md deleted file mode 100644 index 7b3b87dcae7..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] validateDecoratorParamCount" - ---- -```ts -validateDecoratorParamCount( - context, - min, - max, - parameters): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `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 deleted file mode 100644 index 6bd5f1b10dd..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md +++ /dev/null @@ -1,66 +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 - -| Type parameter | -| :------ | -| `K` extends - \| `"Scalar"` - \| `"ModelProperty"` - \| `"Model"` - \| `"Interface"` - \| `"Enum"` - \| `"EnumMember"` - \| `"TemplateParameter"` - \| `"Namespace"` - \| `"Operation"` - \| `"String"` - \| `"Number"` - \| `"Boolean"` - \| `"StringTemplate"` - \| `"StringTemplateSpan"` - \| `"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 - -`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/functions/validateDecoratorTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md deleted file mode 100644 index dad723bf229..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/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 : Type & Object -``` - -Validate the decorator target is matching the expected value. - -## Type parameters - -| Type parameter | -| :------ | -| `K` extends [`TypeKind`](../type-aliases/TypeKind.md) | - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | -| `target` | [`Type`](../type-aliases/Type.md) | | -| `decoratorName` | `string` | | -| `expectedType` | `K` \| readonly `K`[] | | - -## Returns - -`target is K extends "Any" ? Type : Type & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md deleted file mode 100644 index cabe8dd6448..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -jsApi: true -title: "[F] validateDecoratorTargetIntrinsic" - ---- -```ts -validateDecoratorTargetIntrinsic( - context, - target, - decoratorName, - expectedType): boolean -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `decoratorName` | `string` | -| `expectedType` | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md)[] | - -## Returns - -`boolean` - -## Deprecated - -this function is deprecated use decorator definition in TypeSpec instead or check assignability directly. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md deleted file mode 100644 index 89c5bae0232..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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) | - -## Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md deleted file mode 100644 index d7aa8b8f9fc..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] visitChildren" - ---- -```ts -visitChildren(node, cb): T | undefined -``` - -## Type parameters - -| Type parameter | -| :------ | -| `T` | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`Node`](../type-aliases/Node.md) | -| `cb` | [`NodeCallback`](../type-aliases/NodeCallback.md)<`T`\> | - -## Returns - -`T` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md deleted file mode 100644 index f4a03243481..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[F] walkPropertiesInherited" - ---- -```ts -walkPropertiesInherited(model): Generator -``` - -Enumerates the properties declared by model or inherited from its base. - -Properties declared by more derived types are enumerated before properties -of less derived types. - -Properties that are overridden are not enumerated. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `model` | [`Model`](../interfaces/Model.md) | - -## Returns - -`Generator`<[`ModelProperty`](../interfaces/ModelProperty.md), `void`, `unknown`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md deleted file mode 100644 index 30f9e05fdb2..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md +++ /dev/null @@ -1,565 +0,0 @@ ---- -jsApi: true -title: "[P] JS API" - ---- -## Enumerations - -- [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](classes/DuplicateTracker.md) -- [EventEmitter](classes/EventEmitter.md) -- [ProjectionError](classes/ProjectionError.md) -- [Queue](classes/Queue.md) -- [ResolveModuleError](classes/ResolveModuleError.md) - -## Interfaces - -- [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) -- [CodeFix](interfaces/CodeFix.md) -- [CodeFixContext](interfaces/CodeFixContext.md) -- [CompileResult](interfaces/CompileResult.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) -- [FilePos](interfaces/FilePos.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) -- [InsertTextCodeFixEdit](interfaces/InsertTextCodeFixEdit.md) -- [Interface](interfaces/Interface.md) -- [InterfaceStatementNode](interfaces/InterfaceStatementNode.md) -- [IntersectionExpressionNode](interfaces/IntersectionExpressionNode.md) -- [IntrinsicType](interfaces/IntrinsicType.md) -- [InvalidStatementNode](interfaces/InvalidStatementNode.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) -- [PatternData](interfaces/PatternData.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) -- [ProjectionScalarSelectorNode](interfaces/ProjectionScalarSelectorNode.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) -- [ReplaceTextCodeFixEdit](interfaces/ReplaceTextCodeFixEdit.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) -- [SourceModel](interfaces/SourceModel.md) -- [StateDef](interfaces/StateDef.md) -- [StringLiteral](interfaces/StringLiteral.md) -- [StringLiteralNode](interfaces/StringLiteralNode.md) -- [StringTemplate](interfaces/StringTemplate.md) -- [StringTemplateExpressionNode](interfaces/StringTemplateExpressionNode.md) -- [StringTemplateHeadNode](interfaces/StringTemplateHeadNode.md) -- [StringTemplateLiteralLikeNode](interfaces/StringTemplateLiteralLikeNode.md) -- [StringTemplateMiddleNode](interfaces/StringTemplateMiddleNode.md) -- [StringTemplateSpanLiteral](interfaces/StringTemplateSpanLiteral.md) -- [StringTemplateSpanNode](interfaces/StringTemplateSpanNode.md) -- [StringTemplateSpanValue](interfaces/StringTemplateSpanValue.md) -- [StringTemplateTailNode](interfaces/StringTemplateTailNode.md) -- [SuppressDirective](interfaces/SuppressDirective.md) -- [Sym](interfaces/Sym.md) -- [SymbolLinks](interfaces/SymbolLinks.md) -- [SyntheticLocationContext](interfaces/SyntheticLocationContext.md) -- [TemplateArgumentNode](interfaces/TemplateArgumentNode.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 - -- [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) -- [CodeFixEdit](type-aliases/CodeFixEdit.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) -- [StringTemplateSpan](type-aliases/StringTemplateSpan.md) -- [StringTemplateToken](type-aliases/StringTemplateToken.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](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 - -- [$deprecated](functions/$deprecated.md) -- [$discriminator](functions/$discriminator.md) -- [$doc](functions/$doc.md) -- [$encode](functions/$encode.md) -- [$encodedName](functions/$encodedName.md) -- [$error](functions/$error.md) -- [$errorsDoc](functions/$errorsDoc.md) -- [$format](functions/$format.md) -- [$friendlyName](functions/$friendlyName.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) -- [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) -- [defineCodeFix](functions/defineCodeFix.md) -- [defineLinter](functions/defineLinter.md) -- [emitFile](functions/emitFile.md) -- [ensureTrailingDirectorySeparator](functions/ensureTrailingDirectorySeparator.md) -- [exprIsBareIdentifier](functions/exprIsBareIdentifier.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) -- [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) -- [getPatternData](functions/getPatternData.md) -- [getPositionBeforeTrivia](functions/getPositionBeforeTrivia.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) -- [resolveEncodedName](functions/resolveEncodedName.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) -- [stringTemplateToString](functions/stringTemplateToString.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 deleted file mode 100644 index 86fc6406c12..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[I] AliasStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `AliasStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | -| `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md deleted file mode 100644 index be314414d28..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] AnyKeywordNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `UnknownKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 8fe9d88aa21..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ArrayExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `elementType` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ArrayExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 46cff03c487..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -jsApi: true -title: "[I] ArrayModelType" - ---- -## Extends - -- [`Model`](Model.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `baseModel?` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | [`Model`](Model.md).`baseModel` | [`Model`](Model.md).`baseModel` | -| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`Model`](Model.md).`decorators` | [`Model`](Model.md).`decorators` | -| `derivedModels` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](Model.md) | [`Model`](Model.md).`derivedModels` | [`Model`](Model.md).`derivedModels` | -| `indexer` | `Object` | - | [`Model`](Model.md).`indexer` | [`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` | [`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` | [`Model`](Model.md).`isFinished` | -| `kind` | `"Model"` | - | [`Model`](Model.md).`kind` | [`Model`](Model.md).`kind` | -| `name` | `string` | - | [`Model`](Model.md).`name` | [`Model`](Model.md).`name` | -| `namespace?` | [`Namespace`](Namespace.md) | - | [`Model`](Model.md).`namespace` | [`Model`](Model.md).`namespace` | -| `node?` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`Model`](Model.md).`node` | [`Model`](Model.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionBase` | [`Model`](Model.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionSource` | [`Model`](Model.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`Model`](Model.md).`projector` | [`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` | [`Model`](Model.md).`properties` | -| `sourceModel?` | [`Model`](Model.md) | The model that is referenced via `model is`. | [`Model`](Model.md).`sourceModel` | [`Model`](Model.md).`sourceModel` | -| `sourceModels` | [`SourceModel`](SourceModel.md)[] | Models that were used to build this model. This include any model referenced in `model is`, `...` or when intersecting models. | [`Model`](Model.md).`sourceModels` | [`Model`](Model.md).`sourceModels` | -| ~~`templateArguments?`~~ | [`Type`](../type-aliases/Type.md)[] | **Deprecated**
use templateMapper instead. | [`Model`](Model.md).`templateArguments` | [`Model`](Model.md).`templateArguments` | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`Model`](Model.md).`templateMapper` | [`Model`](Model.md).`templateMapper` | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`Model`](Model.md).`templateNode` | [`Model`](Model.md).`templateNode` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`Model`](Model.md).[`projectionsByName`](Model.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md deleted file mode 100644 index 8c4fc5910e8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] AugmentDecoratorStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `arguments` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `AugmentDecoratorStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `targetType` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md deleted file mode 100644 index 58834d48571..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] BaseNode" - ---- -## Extends - -- [`TextRange`](TextRange.md) - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`TextRange`](TextRange.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | -| `kind` | `readonly` | [`SyntaxKind`](../enumerations/SyntaxKind.md) | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | - | 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 deleted file mode 100644 index ef593435c07..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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) -- [`StringTemplate`](StringTemplate.md) -- [`StringTemplateSpanLiteral`](StringTemplateSpanLiteral.md) -- [`StringTemplateSpanValue`](StringTemplateSpanValue.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[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md deleted file mode 100644 index f3d222ac8cc..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -jsApi: true -title: "[I] BlockComment" - ---- -## Extends - -- [`TextRange`](TextRange.md) - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`TextRange`](TextRange.md).`end` | -| `kind` | `readonly` | `BlockComment` | - | - | -| `parsedAsDocs?` | `readonly` | `boolean` | If that comment was parsed as a doc comment. If parserOptions.docs=false this will always be false. | - | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md deleted file mode 100644 index 0187d5657b7..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] BooleanLiteral" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Boolean"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node?` | [`BooleanLiteralNode`](BooleanLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `value` | `boolean` | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md deleted file mode 100644 index 8b289407bed..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] BooleanLiteralNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `BooleanLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `value` | `readonly` | `boolean` | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md deleted file mode 100644 index 2f2498273cc..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -jsApi: true -title: "[I] CallableMessage" - ---- -## Type parameters - -| Type parameter | -| :------ | -| `T` extends `string`[] | - -```ts -interface CallableMessage(dict): string -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `dict` | `Record`<`T`\[`number`\], `string`\> | - -## Returns - -`string` - -## Properties - -| Property | Type | -| :------ | :------ | -| `keys` | `T` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md deleted file mode 100644 index 02a67c43415..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md +++ /dev/null @@ -1,655 +0,0 @@ ---- -jsApi: true -title: "[I] Checker" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `anyType` | [`UnknownType`](UnknownType.md) | -| `errorType` | [`ErrorType`](ErrorType.md) | -| `neverType` | [`NeverType`](NeverType.md) | -| `typePrototype` | `TypePrototype` | -| `voidType` | [`VoidType`](VoidType.md) | - -## Methods - -### checkProgram() - -```ts -checkProgram(): void -``` - -#### Returns - -`void` - -*** - -### checkSourceFile() - -```ts -checkSourceFile(file): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - -#### Returns - -`void` - -*** - -### cloneType() - -```ts -cloneType(type, additionalProps?): T -``` - -#### Type parameters - -| Type parameter | -| :------ | -| `T` extends [`Type`](../type-aliases/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 - -| Type parameter | -| :------ | -| `T` extends [`CreateTypeProps`](../type-aliases/CreateTypeProps.md) | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `typeDef` | `T` | - -#### Returns - -`T` & `TypePrototype` - -*** - -### createFunctionType() - -```ts -createFunctionType(fn): FunctionType -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `fn` | (...`args`) => [`Type`](../type-aliases/Type.md) | - -#### Returns - -[`FunctionType`](FunctionType.md) - -*** - -### createLiteralType() - -#### createLiteralType(value, node) - -```ts -createLiteralType(value, node?): StringLiteral -``` - -##### Parameters - -| Parameter | Type | -| :------ | :------ | -| `value` | `string` | -| `node`? | [`StringLiteralNode`](StringLiteralNode.md) | - -##### Returns - -[`StringLiteral`](StringLiteral.md) - -#### createLiteralType(value, node) - -```ts -createLiteralType(value, node?): NumericLiteral -``` - -##### Parameters - -| Parameter | Type | -| :------ | :------ | -| `value` | `number` | -| `node`? | [`NumericLiteralNode`](NumericLiteralNode.md) | - -##### Returns - -[`NumericLiteral`](NumericLiteral.md) - -#### createLiteralType(value, node) - -```ts -createLiteralType(value, node?): BooleanLiteral -``` - -##### Parameters - -| Parameter | Type | -| :------ | :------ | -| `value` | `boolean` | -| `node`? | [`BooleanLiteralNode`](BooleanLiteralNode.md) | - -##### Returns - -[`BooleanLiteral`](BooleanLiteral.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) | - -##### Returns - -[`StringLiteral`](StringLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`BooleanLiteral`](BooleanLiteral.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) | - -##### Returns - -[`StringLiteral`](StringLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`BooleanLiteral`](BooleanLiteral.md) - -*** - -### createType() - -```ts -createType(typeDef): T & TypePrototype & Object -``` - -#### Type parameters - -| Type parameter | -| :------ | -| `T` extends [`CreateTypeProps`](../type-aliases/CreateTypeProps.md) | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `typeDef` | `T` | - -#### Returns - -`T` & `TypePrototype` & `Object` - -*** - -### 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)[] | - -#### Returns - -[`Type`](../type-aliases/Type.md) - -*** - -### finishType() - -```ts -finishType(typeDef): T -``` - -#### Type parameters - -| Type parameter | -| :------ | -| `T` extends [`Type`](../type-aliases/Type.md) | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `typeDef` | `T` | - -#### Returns - -`T` - -*** - -### getGlobalNamespaceNode() - -```ts -getGlobalNamespaceNode(): NamespaceStatementNode -``` - -#### Returns - -[`NamespaceStatementNode`](NamespaceStatementNode.md) - -*** - -### getGlobalNamespaceType() - -```ts -getGlobalNamespaceType(): Namespace -``` - -#### Returns - -[`Namespace`](Namespace.md) - -*** - -### getLiteralType() - -#### getLiteralType(node) - -```ts -getLiteralType(node): StringLiteral -``` - -##### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`StringLiteralNode`](StringLiteralNode.md) | - -##### Returns - -[`StringLiteral`](StringLiteral.md) - -#### getLiteralType(node) - -```ts -getLiteralType(node): NumericLiteral -``` - -##### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`NumericLiteralNode`](NumericLiteralNode.md) | - -##### Returns - -[`NumericLiteral`](NumericLiteral.md) - -#### getLiteralType(node) - -```ts -getLiteralType(node): BooleanLiteral -``` - -##### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`BooleanLiteralNode`](BooleanLiteralNode.md) | - -##### Returns - -[`BooleanLiteral`](BooleanLiteral.md) - -#### getLiteralType(node) - -```ts -getLiteralType(node): LiteralType -``` - -##### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`LiteralNode`](../type-aliases/LiteralNode.md) | - -##### Returns - -[`LiteralType`](../type-aliases/LiteralType.md) - -*** - -### getMergedSymbol() - -```ts -getMergedSymbol(sym): undefined | Sym -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `sym` | `undefined` \| [`Sym`](Sym.md) | - -#### Returns - -`undefined` \| [`Sym`](Sym.md) - -*** - -### ~~getNamespaceString()~~ - -```ts -getNamespaceString(type, options?): string -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | `undefined` \| [`Namespace`](Namespace.md) | -| `options`? | [`TypeNameOptions`](TypeNameOptions.md) | - -#### Returns - -`string` - -#### Deprecated - -use `import { getNamespaceFullName } from "@typespec/compiler";` - -*** - -### getStdType() - -```ts -getStdType(name): StdTypes[T] -``` - -Std type - -#### Type parameters - -| Type parameter | -| :------ | -| `T` extends [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| `"Array"` \| `"Record"` | - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `name` | `T` | Name | - -#### Returns - -[`StdTypes`](../type-aliases/StdTypes.md)\[`T`\] - -*** - -### getTypeForNode() - -```ts -getTypeForNode(node): Type -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`Node`](../type-aliases/Node.md) | - -#### Returns - -[`Type`](../type-aliases/Type.md) - -*** - -### ~~getTypeName()~~ - -```ts -getTypeName(type, options?): string -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | -| `options`? | [`TypeNameOptions`](TypeNameOptions.md) | - -#### Returns - -`string` - -#### 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 | - -##### Returns - -`type is Scalar & Object` - -#### 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"` | - -##### 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-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 - -[`boolean`, readonly [`Diagnostic`](Diagnostic.md)[]] - -[related, list of diagnostics] - -*** - -### mergeSourceFile() - -```ts -mergeSourceFile(file): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`JsSourceFileNode`](JsSourceFileNode.md) | - -#### Returns - -`void` - -*** - -### 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))[] | - -#### Returns - -[`Type`](../type-aliases/Type.md) - -*** - -### resolveCompletions() - -```ts -resolveCompletions(node): Map -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`IdentifierNode`](IdentifierNode.md) | - -#### Returns - -`Map`<`string`, [`TypeSpecCompletionItem`](TypeSpecCompletionItem.md)\> - -*** - -### resolveIdentifier() - -```ts -resolveIdentifier(node): undefined | Sym -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `node` | [`IdentifierNode`](IdentifierNode.md) | - -#### Returns - -`undefined` \| [`Sym`](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`](TypeReferenceNode.md) | Node. | - -#### Returns - -[`undefined` \| [`Type`](../type-aliases/Type.md), readonly [`Diagnostic`](Diagnostic.md)[]] - -Resolved type and diagnostics if there was an error. - -*** - -### setUsingsForFile() - -```ts -setUsingsForFile(file): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFix.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFix.md deleted file mode 100644 index 37817220333..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFix.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] CodeFix" - ---- -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `fix` | `readonly` | (`fixContext`: [`CodeFixContext`](CodeFixContext.md)) => `void` \| `Promise`<`void`\> \| [`CodeFixEdit`](../type-aliases/CodeFixEdit.md) \| [`CodeFixEdit`](../type-aliases/CodeFixEdit.md)[] | -| `id` | `readonly` | `string` | -| `label` | `readonly` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFixContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFixContext.md deleted file mode 100644 index 0f07b09cdaa..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFixContext.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] CodeFixContext" - ---- -## Properties - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `appendText` | `readonly` | (`location`: [`SourceLocation`](SourceLocation.md) \| [`FilePos`](FilePos.md), `text`: `string`) => [`InsertTextCodeFixEdit`](InsertTextCodeFixEdit.md) | Add the given text after the range or pos given. | -| `prependText` | `readonly` | (`location`: [`SourceLocation`](SourceLocation.md) \| [`FilePos`](FilePos.md), `text`: `string`) => [`InsertTextCodeFixEdit`](InsertTextCodeFixEdit.md) | Add the given text before the range or pos given. | -| `replaceText` | `readonly` | (`location`: [`SourceLocation`](SourceLocation.md), `newText`: `string`) => [`ReplaceTextCodeFixEdit`](ReplaceTextCodeFixEdit.md) | Replace the text at the given range. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompileResult.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompileResult.md deleted file mode 100644 index b1a6aae8279..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompileResult.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] CompileResult" - ---- -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `document` | `readonly` | `TextDocument` | -| `program` | `readonly` | [`Program`](Program.md) | -| `script` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md deleted file mode 100644 index c2614061df8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -jsApi: true -title: "[I] CompilerHost" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `logSink` | [`LogSink`](LogSink.md) | - | -| `parseCache?` | `WeakMap`<[`SourceFile`](SourceFile.md), [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | Optional cache to reuse the results of parsing and binding across programs. | - -## Methods - -### fileURLToPath() - -```ts -fileURLToPath(url): string -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `url` | `string` | - -#### Returns - -`string` - -*** - -### getExecutionRoot() - -```ts -getExecutionRoot(): string -``` - -#### Returns - -`string` - -*** - -### getJsImport() - -```ts -getJsImport(path): Promise> -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -#### Returns - -`Promise`<`Record`<`string`, `any`\>\> - -*** - -### getLibDirs() - -```ts -getLibDirs(): string[] -``` - -#### Returns - -`string`[] - -*** - -### getSourceFileKind() - -```ts -getSourceFileKind(path): undefined | SourceFileKind -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -#### Returns - -`undefined` \| [`SourceFileKind`](../type-aliases/SourceFileKind.md) - -*** - -### mkdirp() - -```ts -mkdirp(path): Promise -``` - -create directory recursively. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `path` | `string` | Path to the directory. | - -#### Returns - -`Promise`<`undefined` \| `string`\> - -*** - -### pathToFileURL() - -```ts -pathToFileURL(path): string -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -#### Returns - -`string` - -*** - -### readDir() - -```ts -readDir(path): Promise -``` - -Read directory. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `path` | `string` | Path to the directory. | - -#### Returns - -`Promise`<`string`[]\> - -list of file/directory in the given directory. Returns the name not the full path. - -*** - -### readFile() - -```ts -readFile(path): Promise -``` - -read a utf-8 or utf-8 with bom encoded file - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -#### Returns - -`Promise`<[`SourceFile`](SourceFile.md)\> - -*** - -### readUrl() - -```ts -readUrl(url): Promise -``` - -read a file at the given url. - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `url` | `string` | - -#### Returns - -`Promise`<[`SourceFile`](SourceFile.md)\> - -*** - -### realpath() - -```ts -realpath(path): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -#### Returns - -`Promise`<`string`\> - -*** - -### rm() - -```ts -rm(path, options?): Promise -``` - -Deletes a directory or file. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `path` | `string` | Path to the directory or file. | -| `options`? | [`RmOptions`](RmOptions.md) | - | - -#### Returns - -`Promise`<`void`\> - -*** - -### stat() - -```ts -stat(path): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -#### Returns - -`Promise`<`Object`\> - -> | Member | Type | -> | :------ | :------ | -> | `isDirectory` | `boolean` | -> | `isFile` | `boolean` | -> - -*** - -### writeFile() - -```ts -writeFile(path, content): Promise -``` - -Write the file. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `path` | `string` | Path to the file. | -| `content` | `string` | Content of the file. | - -#### Returns - -`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md deleted file mode 100644 index 0850e9c3986..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/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/interfaces/CompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md deleted file mode 100644 index cc46a90fa1a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/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 used, this is also where the project root should be. | -| `designTimeBuild?` | `boolean` | When true, indicates that a compilation is being performed for live
analysis in the language server. | -| `emit?` | `string`[] | List or path to emitters to use. | -| ~~`emitters?`~~ | `Record`<`string`, `EmitterOptions`\> | **Deprecated**
use [emit](CompilerOptions.md) and [options](CompilerOptions.md) instead.

Will be removed in March 2022 sprint. | -| `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 deleted file mode 100644 index 66e164e8789..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -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 - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratedType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratedType.md deleted file mode 100644 index b1567ffc114..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratedType.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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 | -| :------ | :------ | -| `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 deleted file mode 100644 index 4a77e8572ed..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -jsApi: true -title: "[I] Decorator" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `implementation` | (...`args`: `unknown`[]) => `void` | - | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Decorator"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `name` | \`@${string}\` | - | - | - | -| `namespace` | [`Namespace`](Namespace.md) | - | - | - | -| `node` | [`DecoratorDeclarationStatementNode`](DecoratorDeclarationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `parameters` | [`FunctionParameter`](FunctionParameter.md)[] | - | - | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `target` | [`FunctionParameter`](FunctionParameter.md) | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md deleted file mode 100644 index 223e43baf49..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorApplication" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `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 deleted file mode 100644 index 1b43175dc54..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -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/interfaces/DecoratorContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md deleted file mode 100644 index 67203ee950d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorContext" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `decoratorTarget` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | Point to the decorator target | -| `program` | [`Program`](Program.md) | - | - -## Methods - -### call() - -```ts -call( - decorator, - target, ... - args): R -``` - -Helper to call out to another decorator - -#### Type parameters - -| Type parameter | -| :------ | -| `T` extends [`Type`](../type-aliases/Type.md) | -| `A` extends `any`[] | -| `R` | - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `decorator` | (`context`, `target`, ...`args`) => `R` | Other decorator function | -| `target` | `T` | - | -| ...`args` | `A` | Args to pass to other decorator function | - -#### Returns - -`R` - -*** - -### getArgumentTarget() - -```ts -getArgumentTarget(paramIndex): undefined | DiagnosticTarget -``` - -Function that can be used to retrieve the target for a parameter at the given index. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `paramIndex` | `number` | Parameter index in the typespec | - -#### Returns - -`undefined` \| [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) - -#### Example - -```ts -@foo("bar", 123) -> $foo(context, target, arg0: string, arg1: number); - getArgumentTarget(0) -> target for arg0 - getArgumentTarget(1) -> target for arg1 -``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md deleted file mode 100644 index aef40fd244e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/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`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `DecoratorDeclarationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `modifierFlags` | `readonly` | [`ModifierFlags`](../enumerations/ModifierFlags.md) | - | - | - | -| `modifiers` | `readonly` | readonly [`ExternKeywordNode`](ExternKeywordNode.md)[] | - | - | - | -| `parameters` | `readonly` | [`FunctionParameterNode`](FunctionParameterNode.md)[] | Additional parameters | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`FunctionParameterNode`](FunctionParameterNode.md) | Decorator target. First parameter. | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md deleted file mode 100644 index 76a1e932f84..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorDefinition" - ---- -## Type parameters - -| Type parameter | Value | -| :------ | :------ | -| `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 - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `args` | `readonly` | `P` | List of positional arguments in the function. | -| `name` | `readonly` | `string` | Name of the decorator. | -| `spreadArgs?` | `readonly` | `S` | **Optional**
Type of the spread args at the end of the function if applicable. | -| `target` | `readonly` | `T` \| readonly `T`[] | Decorator target. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md deleted file mode 100644 index 8a83fe508c2..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `arguments` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `DecoratorExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md deleted file mode 100644 index 2e156753f88..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorFunction" - ---- -```ts -interface DecoratorFunction( - program, - target, ... - customArgs): void -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`DecoratorContext`](DecoratorContext.md) | -| `target` | `any` | -| ...`customArgs` | `any`[] | - -## Returns - -`void` - -## Properties - -| Property | Type | -| :------ | :------ | -| `namespace?` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md deleted file mode 100644 index b23a5acaafc..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorParamDefinition" - ---- -## Type parameters - -| Type parameter | -| :------ | -| `K` extends [`TypeKind`](../type-aliases/TypeKind.md) | - -## Properties - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `kind` | `readonly` | `K` \| readonly `K`[] | Kind of the parameter | -| `optional?` | `readonly` | `boolean` | Is the parameter optional. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md deleted file mode 100644 index 323a428f3f2..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -jsApi: true -title: "[I] DecoratorValidator" - ---- -## Type parameters - -| Type parameter | Value | -| :------ | :------ | -| `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`\> | - -#### Returns - -`boolean` 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 deleted file mode 100644 index af54a3f9b95..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecatedDirective.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] DeprecatedDirective" - ---- -## Extends - -- [`DirectiveBase`](DirectiveBase.md) - -## Properties - -| Property | Type | Inherited from | -| :------ | :------ | :------ | -| `message` | `string` | - | -| `name` | `"deprecated"` | - | -| `node` | [`DirectiveExpressionNode`](DirectiveExpressionNode.md) | [`DirectiveBase`](DirectiveBase.md).`node` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md deleted file mode 100644 index b826f1f4cfe..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] DeprecationDetails" - ---- -Provides details on the deprecation of a given type. - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `message` | `string` | The deprecation message to display when the type is used. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md deleted file mode 100644 index a8a8d27f899..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[I] Diagnostic" - ---- -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `code` | `public` | `string` | -| `codefixes?` | `readonly` | readonly [`CodeFix`](CodeFix.md)[] | -| `message` | `public` | `string` | -| `severity` | `public` | [`DiagnosticSeverity`](../type-aliases/DiagnosticSeverity.md) | -| `target` | `public` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md deleted file mode 100644 index 3eba871e1ef..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -jsApi: true -title: "[I] DiagnosticCollector" - ---- -Helper object to collect diagnostics from function following the diagnostics accessor pattern(foo() => [T, Diagnostic[]]) - -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `diagnostics` | `readonly` | readonly [`Diagnostic`](Diagnostic.md)[] | - -## Methods - -### add() - -```ts -add(diagnostic): void -``` - -Add a diagnostic to the collection - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `diagnostic` | [`Diagnostic`](Diagnostic.md) | Diagnostic to add. | - -#### Returns - -`void` - -*** - -### pipe() - -```ts -pipe(result): T -``` - -Unwrap the Diagnostic result, add all the diagnostics and return the data. - -#### Type parameters - -| Type parameter | -| :------ | -| `T` | - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `result` | [`DiagnosticResult`](../type-aliases/DiagnosticResult.md)<`T`\> | Accessor diagnostic result | - -#### Returns - -`T` - -*** - -### wrap() - -```ts -wrap(value): DiagnosticResult -``` - -Wrap the given value in a tuple including the diagnostics following the TypeSpec accessor pattern. - -#### Type parameters - -| Type parameter | -| :------ | -| `T` | - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `value` | `T` | Accessor value to return | - -#### Returns - -[`DiagnosticResult`](../type-aliases/DiagnosticResult.md)<`T`\> - -#### Example - -```ts -return diagnostics.wrap(routes); -``` 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 deleted file mode 100644 index 8a84c03b525..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -jsApi: true -title: "[I] DiagnosticCreator" - ---- -## Type parameters - -| Type parameter | -| :------ | -| `T` extends `Object` | - -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `diagnostics` | `readonly` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | -| `type` | `readonly` | `T` | - -## Methods - -### createDiagnostic() - -```ts -createDiagnostic(diag): Diagnostic -``` - -#### Type parameters - -| Type parameter | Value | -| :------ | :------ | -| `C` extends `string` \| `number` \| `symbol` | - | -| `M` extends `string` \| `number` \| `symbol` | `"default"` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | - -#### Returns - -[`Diagnostic`](Diagnostic.md) - -*** - -### reportDiagnostic() - -```ts -reportDiagnostic(program, diag): void -``` - -#### Type parameters - -| Type parameter | Value | -| :------ | :------ | -| `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`\> | - -#### Returns - -`void` 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 deleted file mode 100644 index add275838f2..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -jsApi: true -title: "[I] DiagnosticDefinition" - ---- -## Type parameters - -| Type parameter | -| :------ | -| `M` extends [`DiagnosticMessages`](DiagnosticMessages.md) | - -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `messages` | `readonly` | `M` | -| `severity` | `readonly` | `"error"` \| `"warning"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticMessages.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticMessages.md deleted file mode 100644 index 55a0d323be8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticMessages.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -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 deleted file mode 100644 index 246c953a0a3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveBase.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[I] DirectiveBase" - ---- -## Extended by - -- [`SuppressDirective`](SuppressDirective.md) -- [`DeprecatedDirective`](DeprecatedDirective.md) - -## Properties - -| Property | Type | -| :------ | :------ | -| `node` | [`DirectiveExpressionNode`](DirectiveExpressionNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md deleted file mode 100644 index d44d2cbe35c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DirectiveExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `arguments` | `readonly` | readonly [`DirectiveArgument`](../type-aliases/DirectiveArgument.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `DirectiveExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md deleted file mode 100644 index 907d0c96186..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/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/interfaces/DiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiscriminatedUnion.md deleted file mode 100644 index fd142f32ee3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiscriminatedUnion.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] DiscriminatedUnion" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `propertyName` | `string` | -| `variants` | `Map`<`string`, [`Model`](Model.md)\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Discriminator.md deleted file mode 100644 index 6aa4d020ba5..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/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/interfaces/DocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocData.md deleted file mode 100644 index f5b48178f02..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocData.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] DocData" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `source` | `"decorator"` \| `"comment"` | How was the doc set.
- `decorator` 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 deleted file mode 100644 index 057467e38a0..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DocErrorsTagNode" - ---- -## Extends - -- [`DocTagBaseNode`](DocTagBaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | -| `kind` | `readonly` | `DocErrorsTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | -| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | 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 deleted file mode 100644 index 6cddb757c4d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DocNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `Doc` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `tags` | `readonly` | readonly [`DocTag`](../type-aliases/DocTag.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md deleted file mode 100644 index 44ed673b41e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] DocParamTagNode" - ---- -## Extends - -- [`DocTagBaseNode`](DocTagBaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | -| `kind` | `readonly` | `DocParamTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | -| `paramName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | -| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | 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 deleted file mode 100644 index 927f9c0d47d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DocReturnsTagNode" - ---- -## Extends - -- [`DocTagBaseNode`](DocTagBaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | -| `kind` | `readonly` | `DocReturnsTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | -| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | 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 deleted file mode 100644 index abd1a9ad796..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DocTagBaseNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | [`SyntaxKind`](../enumerations/SyntaxKind.md) | - | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | -| `tagName` | `readonly` | [`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 deleted file mode 100644 index 8b31fbd14e4..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] DocTemplateTagNode" - ---- -## Extends - -- [`DocTagBaseNode`](DocTagBaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | -| `kind` | `readonly` | `DocTemplateTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | -| `paramName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | -| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | 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 deleted file mode 100644 index eda08bf9267..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] DocTextNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `DocText` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `text` | `readonly` | `string` | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md deleted file mode 100644 index a6663f5d296..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] DocUnknownTagNode" - ---- -## Extends - -- [`DocTagBaseNode`](DocTagBaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | -| `kind` | `readonly` | `DocUnknownTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | -| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md deleted file mode 100644 index 4a499946d35..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -jsApi: true -title: "[I] EmitContext" - ---- -## Type parameters - -| Type parameter | Value | -| :------ | :------ | -| `TOptions` extends `object` | `Record`<`string`, `never`\> | - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `emitterOutputDir` | `string` | Configured output dir for the emitter. Emitter should emit all output under that directory. | -| `options` | `TOptions` | Emitter custom options defined in createTypeSpecLibrary | -| `program` | [`Program`](Program.md) | TypeSpec Program. | - -## Methods - -### getAssetEmitter() - -```ts -getAssetEmitter(TypeEmitterClass): AssetEmitter -``` - -Get an asset emitter to write emitted output to disk using a TypeEmitter - -#### Type parameters - -| Type parameter | -| :------ | -| `T` | - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `TypeEmitterClass` | *typeof* `TypeEmitter` | The TypeEmitter to construct your emitted output | - -#### Returns - -`AssetEmitter`<`T`, `TOptions`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md deleted file mode 100644 index b0201dad00b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] EmitFileOptions" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `content` | `string` | -| `newLine?` | [`NewLine`](../type-aliases/NewLine.md) | -| `path` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md deleted file mode 100644 index c81663646a3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] EmptyStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `EmptyStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 34e658d0dc0..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EncodeData.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] EncodeData" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `encoding` | `string` | -| `type` | [`Scalar`](Scalar.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md deleted file mode 100644 index edc9b7c2f11..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -jsApi: true -title: "[I] Enum" - ---- -## Extends - -- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Enum"` | - | [`BaseType`](BaseType.md).`kind` | [`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` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md deleted file mode 100644 index 981ee9fcfc0..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -jsApi: true -title: "[I] EnumMember" - ---- -## Extends - -- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `enum` | [`Enum`](Enum.md) | - | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"EnumMember"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `name` | `string` | - | - | - | -| `node` | [`EnumMemberNode`](EnumMemberNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`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[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md deleted file mode 100644 index cdfd58db3e6..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] EnumMemberNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `EnumMember` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`EnumStatementNode`](EnumStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `value?` | `readonly` | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md deleted file mode 100644 index 3b14c528cd8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] EnumSpreadMemberNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `EnumSpreadMember` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md deleted file mode 100644 index d99638407ac..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] EnumStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `EnumStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `members` | `readonly` | readonly ([`EnumMemberNode`](EnumMemberNode.md) \| [`EnumSpreadMemberNode`](EnumSpreadMemberNode.md))[] | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index b762058f77c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] ErrorType" - ---- -## Extends - -- [`IntrinsicType`](IntrinsicType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`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` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | -| `kind` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | -| `name` | `"ErrorType"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md deleted file mode 100644 index 07dd80d00aa..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ExternKeywordNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ExternKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 4c6209c5279..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[I] FileLibraryMetadata" - ---- -## Extends - -- `LibraryMetadataBase` - -## Properties - -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `bugs?` | `Object` | - | `LibraryMetadataBase.bugs` | -| `bugs.url?` | `string` | Url where to file bugs for this library. | - | -| `homepage?` | `string` | Library homepage. | `LibraryMetadataBase.homepage` | -| `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/FilePos.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FilePos.md deleted file mode 100644 index 602759b296b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FilePos.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] FilePos" - ---- -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `file` | `readonly` | [`SourceFile`](SourceFile.md) | -| `pos` | `readonly` | `number` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md deleted file mode 100644 index 488c6f1ca2c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/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`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `FunctionDeclarationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `modifierFlags` | `readonly` | [`ModifierFlags`](../enumerations/ModifierFlags.md) | - | - | - | -| `modifiers` | `readonly` | readonly [`ExternKeywordNode`](ExternKeywordNode.md)[] | - | - | - | -| `parameters` | `readonly` | [`FunctionParameterNode`](FunctionParameterNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `returnType?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index c48b11e6d1c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameter.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -jsApi: true -title: "[I] FunctionParameter" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"FunctionParameter"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `name` | `string` | - | - | - | -| `node` | [`FunctionParameterNode`](FunctionParameterNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `optional` | `boolean` | - | - | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `rest` | `boolean` | - | - | - | -| `type` | [`Type`](../type-aliases/Type.md) \| [`ValueType`](ValueType.md) | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md deleted file mode 100644 index 516735a4f0a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[I] FunctionParameterNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `FunctionParameter` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `optional` | `readonly` | `boolean` | Parameter defined with `?` | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `rest` | `readonly` | `boolean` | Parameter defined with `...` notation. | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `type?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md deleted file mode 100644 index 81da8d113f9..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -jsApi: true -title: "[I] FunctionType" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `implementation` | (...`args`: `unknown`[]) => `unknown` | - | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Function"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `name` | `string` | - | - | - | -| `namespace?` | [`Namespace`](Namespace.md) | - | - | - | -| `node?` | [`FunctionDeclarationStatementNode`](FunctionDeclarationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `parameters` | [`FunctionParameter`](FunctionParameter.md)[] | - | - | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `returnType` | [`Type`](../type-aliases/Type.md) | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierContext.md deleted file mode 100644 index 81f184c9c12..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierContext.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] IdentifierContext" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `kind` | [`IdentifierKind`](../enumerations/IdentifierKind.md) | -| `node` | [`Node`](../type-aliases/Node.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md deleted file mode 100644 index 43f918aff68..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] IdentifierNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `Identifier` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `sv` | `readonly` | `string` | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 3fbeb476d4c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ImportStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ImportStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `path` | `readonly` | [`StringLiteralNode`](StringLiteralNode.md) | - | - | - | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InsertTextCodeFixEdit.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InsertTextCodeFixEdit.md deleted file mode 100644 index ca209644841..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InsertTextCodeFixEdit.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] InsertTextCodeFixEdit" - ---- -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `file` | `readonly` | [`SourceFile`](SourceFile.md) | -| `kind` | `readonly` | `"insert-text"` | -| `pos` | `readonly` | `number` | -| `text` | `readonly` | `string` | 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 deleted file mode 100644 index 0c368032c97..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -jsApi: true -title: "[I] Interface" - ---- -## Extends - -- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Interface"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `name` | `string` | - | - | - | -| `namespace?` | [`Namespace`](Namespace.md) | - | - | - | -| `node` | [`InterfaceStatementNode`](InterfaceStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`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` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`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](Model.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` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md deleted file mode 100644 index 0fff74c3898..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[I] InterfaceStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `extends` | `readonly` | readonly [`TypeReferenceNode`](TypeReferenceNode.md)[] | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `InterfaceStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `operations` | `readonly` | readonly [`OperationStatementNode`](OperationStatementNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | 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 deleted file mode 100644 index 48161ccbb21..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] IntersectionExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `IntersectionExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `options` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 17820088b62..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] IntrinsicType" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Intrinsic"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `name` | \| `"unknown"` \| `"never"` \| `"null"` \| `"void"` \| `"ErrorType"` | - | - | - | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md deleted file mode 100644 index 02ee2b1857e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] InvalidStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `InvalidStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index ca3f1c31430..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] JsNamespaceDeclarationNode" - ---- -## Extends - -- [`DeclarationNode`](DeclarationNode.md).[`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `JsNamespaceDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index b8f8e53b764..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[I] JsSourceFileNode" - ---- -## Extends - -- [`DeclarationNode`](DeclarationNode.md).[`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `esmExports` | `readonly` | `any` | - | - | - | -| `file` | `readonly` | [`SourceFile`](SourceFile.md) | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `JsSourceFile` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `namespaceSymbols` | `readonly` | [`Sym`](Sym.md)[] | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index dce6dbb7834..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[I] LibraryInstance" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `definition?` | [`TypeSpecLibrary`](TypeSpecLibrary.md)<`any`, `Record`<`string`, `never`\>, `never`\> | -| `entrypoint` | `undefined` \| [`JsSourceFileNode`](JsSourceFileNode.md) | -| `linter` | [`LinterDefinition`](LinterDefinition.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 deleted file mode 100644 index d5743bd0c0e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] LibraryLocationContext" - ---- -Defined in a library. - -## Properties - -| Property | Type | -| :------ | :------ | -| `metadata` | [`ModuleLibraryMetadata`](ModuleLibraryMetadata.md) | -| `type` | `"library"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md deleted file mode 100644 index 908afd3e562..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -jsApi: true -title: "[I] LineAndCharacter" - ---- -Identifies the position within a source file by line number and offset from -beginning of line. - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `character` | `number` | The offset in UTF-16 code units to the character from the beginning of the
line. 0-based.

NOTE: This is not necessarily the same as what a given text editor might
call the "column". Tabs, combining characters, surrogate pairs, and so on
can all cause an editor to report the column differently. Indeed, different
text editors report different column numbers for the same position in a
given document. | -| `line` | `number` | The line number. 0-based. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md deleted file mode 100644 index 2e39f3502c8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] LineComment" - ---- -## Extends - -- [`TextRange`](TextRange.md) - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`TextRange`](TextRange.md).`end` | -| `kind` | `readonly` | `LineComment` | - | - | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md deleted file mode 100644 index 8074b6e3188..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] LinterDefinition" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `ruleSets?` | `Record`<`string`, [`LinterRuleSet`](LinterRuleSet.md)\> | -| `rules` | [`LinterRuleDefinition`](LinterRuleDefinition.md)<`string`, [`DiagnosticMessages`](DiagnosticMessages.md)\>[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md deleted file mode 100644 index 6f21a3b67ba..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -jsApi: true -title: "[I] LinterRule" - ---- -Resolved instance of a linter rule that will run. - -## Extends - -- [`LinterRuleDefinition`](LinterRuleDefinition.md)<`N`, `DM`\> - -## Type parameters - -| Type parameter | -| :------ | -| `N` extends `string` | -| `DM` extends [`DiagnosticMessages`](DiagnosticMessages.md) | - -## Properties - -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `description` | `string` | Short description of the rule | [`LinterRuleDefinition`](LinterRuleDefinition.md).`description` | -| `id` | `string` | Expanded rule id in format `:` | - | -| `messages` | `DM` | Messages that can be reported with the diagnostic. | [`LinterRuleDefinition`](LinterRuleDefinition.md).`messages` | -| `name` | `N` | Rule name (without the library name) | [`LinterRuleDefinition`](LinterRuleDefinition.md).`name` | -| `severity` | `"warning"` | Rule default severity. | [`LinterRuleDefinition`](LinterRuleDefinition.md).`severity` | -| `url?` | `string` | Specifies the URL at which the full documentation can be accessed. | [`LinterRuleDefinition`](LinterRuleDefinition.md).`url` | - -## Methods - -### create() - -```ts -create(context): SemanticNodeListener -``` - -Creator - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`LinterRuleContext`](LinterRuleContext.md)<`DM`\> | - -#### Returns - -[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) - -#### Inherited from - -[`LinterRuleDefinition`](LinterRuleDefinition.md).[`create`](LinterRuleDefinition.md#create) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md deleted file mode 100644 index 9c3c5f00a98..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -jsApi: true -title: "[I] LinterRuleContext" - ---- -## Type parameters - -| Type parameter | -| :------ | -| `DM` extends [`DiagnosticMessages`](DiagnosticMessages.md) | - -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `program` | `readonly` | [`Program`](Program.md) | - -## Methods - -### reportDiagnostic() - -```ts -reportDiagnostic(diag): void -``` - -#### Type parameters - -| Type parameter | -| :------ | -| `M` extends `string` \| `number` \| `symbol` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diag` | [`LinterRuleDiagnosticReport`](../type-aliases/LinterRuleDiagnosticReport.md)<`DM`, `M`\> | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md deleted file mode 100644 index 609a555a9e0..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -jsApi: true -title: "[I] LinterRuleDefinition" - ---- -## Extended by - -- [`LinterRule`](LinterRule.md) - -## Type parameters - -| Type parameter | -| :------ | -| `N` extends `string` | -| `DM` extends [`DiagnosticMessages`](DiagnosticMessages.md) | - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `description` | `string` | Short description of the rule | -| `messages` | `DM` | Messages that can be reported with the diagnostic. | -| `name` | `N` | Rule name (without the library name) | -| `severity` | `"warning"` | Rule default severity. | -| `url?` | `string` | Specifies the URL at which the full documentation can be accessed. | - -## Methods - -### create() - -```ts -create(context): SemanticNodeListener -``` - -Creator - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`LinterRuleContext`](LinterRuleContext.md)<`DM`\> | - -#### Returns - -[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md deleted file mode 100644 index 2c2e36aab32..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/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/interfaces/ListOperationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md deleted file mode 100644 index 4a1dc0f60b9..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] ListOperationOptions" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `recursive?` | `boolean` | If the container is a namespace look for operation in sub namespaces.

**Default**
` true ` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md deleted file mode 100644 index dc568fc8fbd..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] LogInfo" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `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/interfaces/LogSink.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md deleted file mode 100644 index baf372d6562..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] LogSink" - ---- -## Methods - -### log() - -```ts -log(log): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `log` | [`ProcessedLog`](ProcessedLog.md) | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md deleted file mode 100644 index f62b7a07399..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -jsApi: true -title: "[I] Logger" - ---- -## Methods - -### error() - -```ts -error(message): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `message` | `string` | - -#### Returns - -`void` - -*** - -### log() - -```ts -log(log): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `log` | [`LogInfo`](LogInfo.md) | - -#### Returns - -`void` - -*** - -### trace() - -```ts -trace(message): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `message` | `string` | - -#### Returns - -`void` - -*** - -### warn() - -```ts -warn(message): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `message` | `string` | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md deleted file mode 100644 index ee5c2ef11a8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] MemberExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `base` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `MemberExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `selector` | `readonly` | `"."` \| `"::"` | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 694e434aecc..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -jsApi: true -title: "[I] Model" - ---- -## Extends - -- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `baseModel?` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | - | - | -| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `derivedModels` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](Model.md) | - | - | -| `indexer?` | [`ModelIndexer`](../type-aliases/ModelIndexer.md) | - | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Model"` | - | [`BaseType`](BaseType.md).`kind` | [`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` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`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`. | - | - | -| `sourceModels` | [`SourceModel`](SourceModel.md)[] | Models that were used to build this model. This include any model referenced in `model is`, `...` or when intersecting models. | - | - | -| ~~`templateArguments?`~~ | [`Type`](../type-aliases/Type.md)[] | **Deprecated**
use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md deleted file mode 100644 index 2a4767340a1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ModelExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ModelExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `properties` | `readonly` | ([`ModelPropertyNode`](ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md))[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index c9f81fd7d78..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -jsApi: true -title: "[I] ModelProperty" - ---- -## Extends - -- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `default?` | [`Type`](../type-aliases/Type.md) | - | - | - | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"ModelProperty"` | - | [`BaseType`](BaseType.md).`kind` | [`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` | [`BaseType`](BaseType.md).`node` | -| `optional` | `boolean` | - | - | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `sourceProperty?` | [`ModelProperty`](ModelProperty.md) | - | - | - | -| `type` | [`Type`](../type-aliases/Type.md) | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md deleted file mode 100644 index 56af32b0a9d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[I] ModelPropertyNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `default?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `ModelProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `optional` | `readonly` | `boolean` | - | - | - | -| `parent?` | `readonly` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md deleted file mode 100644 index f293f5ec285..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ModelSpreadPropertyNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ModelSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md deleted file mode 100644 index d15df4d3abe..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -jsApi: true -title: "[I] ModelStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `extends?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `is?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `kind` | `readonly` | `ModelStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `properties` | `readonly` | readonly ([`ModelPropertyNode`](ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md))[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | 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 deleted file mode 100644 index e3b3a3a614c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/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 | Inherited from | -| :------ | :------ | :------ | :------ | -| `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 deleted file mode 100644 index d9fb6c8af04..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -jsApi: true -title: "[I] Namespace" - ---- -## Extends - -- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `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` | [`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` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Namespace"` | - | [`BaseType`](BaseType.md).`kind` | [`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` | [`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` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`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[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md deleted file mode 100644 index 4f2055ad123..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] NamespaceNavigationOptions" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `skipSubNamespaces?` | `boolean` | Recursively navigate sub namespaces.

**Default**
` false ` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md deleted file mode 100644 index 2dc40c4f319..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[I] NamespaceStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `NamespaceStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `statements?` | `readonly` | [`NamespaceStatementNode`](NamespaceStatementNode.md) \| readonly [`Statement`](../type-aliases/Statement.md)[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md deleted file mode 100644 index f41933be2a6..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] NavigationOptions" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `includeTemplateDeclaration?` | `boolean` | Skip non instantiated templates. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md deleted file mode 100644 index 7103f6dde07..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] NeverKeywordNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `NeverKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index b469ae9d442..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] NeverType" - ---- -## Extends - -- [`IntrinsicType`](IntrinsicType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`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` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | -| `kind` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | -| `name` | `"never"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md deleted file mode 100644 index 04a16ff7a5e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/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/interfaces/NullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md deleted file mode 100644 index d01ad0ad944..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] NullType" - ---- -## Extends - -- [`IntrinsicType`](IntrinsicType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`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` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | -| `kind` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | -| `name` | `"null"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md deleted file mode 100644 index 285c7e35ce8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -jsApi: true -title: "[I] NumericLiteral" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Number"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node?` | [`NumericLiteralNode`](NumericLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `value` | `number` | - | - | - | -| `valueAsString` | `string` | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md deleted file mode 100644 index 8106820728c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] NumericLiteralNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `NumericLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `value` | `readonly` | `number` | - | - | - | -| `valueAsString` | `readonly` | `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 deleted file mode 100644 index 1eea7178132..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] ObjectType" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Object"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `properties` | `Record`<`string`, [`Type`](../type-aliases/Type.md)\> | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md deleted file mode 100644 index 69dfe0359d5..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -jsApi: true -title: "[I] Operation" - ---- -## Extends - -- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Operation"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `name` | `string` | - | - | - | -| `namespace?` | [`Namespace`](Namespace.md) | - | - | - | -| `node` | [`OperationStatementNode`](OperationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `parameters` | [`Model`](Model.md) | - | - | - | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`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` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md deleted file mode 100644 index a54b113cbb3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] OperationSignatureDeclarationNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `OperationSignatureDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parameters` | `readonly` | [`ModelExpressionNode`](ModelExpressionNode.md) | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `returnType` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 802b6508399..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] OperationSignatureReferenceNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `baseOperation` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `OperationSignatureReference` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 18a9fea866d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[I] OperationStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `OperationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) \| [`InterfaceStatementNode`](InterfaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `signature` | `readonly` | [`OperationSignature`](../type-aliases/OperationSignature.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | 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 deleted file mode 100644 index 54b58fbf518..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ParseOptions.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] ParseOptions" - ---- -## Properties - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `comments?` | `readonly` | `boolean` | When true, collect comment ranges in [TypeSpecScriptNode.comments](TypeSpecScriptNode.md). | -| `docs?` | `readonly` | `boolean` | When true, parse doc comments into [Node.docs](BaseNode.md). | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PatternData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PatternData.md deleted file mode 100644 index 9cf3124d23c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PatternData.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] PatternData" - ---- -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `pattern` | `readonly` | `string` | -| `validationMessage?` | `readonly` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md deleted file mode 100644 index 205d34f9e07..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProcessedLog.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] ProcessedLog" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `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 deleted file mode 100644 index 8ffe2e660fb..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -jsApi: true -title: "[I] Program" - ---- -## Extended by - -- [`ProjectedProgram`](ProjectedProgram.md) - -## Properties - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `checker` | `public` | [`Checker`](Checker.md) | - | -| `compilerOptions` | `public` | [`CompilerOptions`](CompilerOptions.md) | - | -| `diagnostics` | `readonly` | readonly [`Diagnostic`](Diagnostic.md)[] | - | -| `emitters` | `public` | `EmitterRef`[] | - | -| `host` | `public` | [`CompilerHost`](CompilerHost.md) | - | -| `jsSourceFiles` | `public` | `Map`<`string`, [`JsSourceFileNode`](JsSourceFileNode.md)\> | - | -| `literalTypes` | `public` | `Map`<`string` \| `number` \| `boolean`, [`LiteralType`](../type-aliases/LiteralType.md)\> | - | -| `mainFile?` | `public` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | -| `projectRoot` | `readonly` | `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` | `public` | `Map`<`string`, [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | All source files in the program, keyed by their file path. | -| `stateMaps` | `public` | `Map`<`symbol`, `StateMap`\> | - | -| `stateSets` | `public` | `Map`<`symbol`, `StateSet`\> | - | -| `tracer` | `public` | [`Tracer`](Tracer.md) | - | - -## Methods - -### getGlobalNamespaceType() - -```ts -getGlobalNamespaceType(): Namespace -``` - -#### Returns - -[`Namespace`](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`](SourceFile.md) | - -#### Returns - -[`LocationContext`](../type-aliases/LocationContext.md) - -*** - -### hasError() - -```ts -hasError(): boolean -``` - -#### Returns - -`boolean` - -*** - -### loadTypeSpecScript() - -```ts -loadTypeSpecScript(typespecScript): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `typespecScript` | [`SourceFile`](SourceFile.md) | - -#### Returns - -`Promise`<[`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> - -*** - -### onValidate() - -```ts -onValidate(cb, LibraryMetadata): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `cb` | (`program`) => `void` \| `Promise`<`void`\> | -| `LibraryMetadata` | [`LibraryMetadata`](../type-aliases/LibraryMetadata.md) | - -#### Returns - -`void` - -*** - -### reportDiagnostic() - -```ts -reportDiagnostic(diagnostic): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diagnostic` | [`Diagnostic`](Diagnostic.md) | - -#### Returns - -`void` - -*** - -### reportDiagnostics() - -```ts -reportDiagnostics(diagnostics): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diagnostics` | readonly [`Diagnostic`](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-aliases/Type.md), readonly [`Diagnostic`](Diagnostic.md)[]] - -*** - -### stateMap() - -```ts -stateMap(key): Map -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `key` | `symbol` | - -#### Returns - -`Map`<[`Type`](../type-aliases/Type.md), `any`\> - -*** - -### stateSet() - -```ts -stateSet(key): Set -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `key` | `symbol` | - -#### Returns - -`Set`<[`Type`](../type-aliases/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/interfaces/ProjectLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md deleted file mode 100644 index 7af9129aa41..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectLocationContext" - ---- -Defined in the user project. - -## Properties - -| Property | Type | -| :------ | :------ | -| `type` | `"project"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md deleted file mode 100644 index 88f746a0e7e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectedNameView" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `program` | [`ProjectedProgram`](ProjectedProgram.md) | - -## Methods - -### getProjectedName() - -```ts -getProjectedName(target): string -``` - -Get the name of the given entity in that scope. -If there is a projected name it returns that one otherwise return the original name. - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `target` | [`Type`](../type-aliases/Type.md) & `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 deleted file mode 100644 index a3488471128..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md +++ /dev/null @@ -1,305 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectedProgram" - ---- -## Extends - -- [`Program`](Program.md) - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `checker` | `public` | [`Checker`](Checker.md) | - | [`Program`](Program.md).`checker` | -| `compilerOptions` | `public` | [`CompilerOptions`](CompilerOptions.md) | - | [`Program`](Program.md).`compilerOptions` | -| `diagnostics` | `readonly` | readonly [`Diagnostic`](Diagnostic.md)[] | - | [`Program`](Program.md).`diagnostics` | -| `emitters` | `public` | `EmitterRef`[] | - | [`Program`](Program.md).`emitters` | -| `host` | `public` | [`CompilerHost`](CompilerHost.md) | - | [`Program`](Program.md).`host` | -| `jsSourceFiles` | `public` | `Map`<`string`, [`JsSourceFileNode`](JsSourceFileNode.md)\> | - | [`Program`](Program.md).`jsSourceFiles` | -| `literalTypes` | `public` | `Map`<`string` \| `number` \| `boolean`, [`LiteralType`](../type-aliases/LiteralType.md)\> | - | [`Program`](Program.md).`literalTypes` | -| `mainFile?` | `public` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | [`Program`](Program.md).`mainFile` | -| `projectRoot` | `readonly` | `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` | -| `projector` | `public` | [`Projector`](Projector.md) | - | - | -| `sourceFiles` | `public` | `Map`<`string`, [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | All source files in the program, keyed by their file path. | [`Program`](Program.md).`sourceFiles` | -| `stateMaps` | `public` | `Map`<`symbol`, `StateMap`\> | - | [`Program`](Program.md).`stateMaps` | -| `stateSets` | `public` | `Map`<`symbol`, `StateSet`\> | - | [`Program`](Program.md).`stateSets` | -| `tracer` | `public` | [`Tracer`](Tracer.md) | - | [`Program`](Program.md).`tracer` | - -## Methods - -### getGlobalNamespaceType() - -```ts -getGlobalNamespaceType(): Namespace -``` - -#### Returns - -[`Namespace`](Namespace.md) - -#### Inherited from - -[`Program`](Program.md).[`getGlobalNamespaceType`](Program.md#getglobalnamespacetype) - -*** - -### getOption() - -```ts -getOption(key): undefined | string -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`undefined` \| `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) | - -#### Returns - -[`LocationContext`](../type-aliases/LocationContext.md) - -#### Inherited from - -[`Program`](Program.md).[`getSourceFileLocationContext`](Program.md#getsourcefilelocationcontext) - -*** - -### hasError() - -```ts -hasError(): boolean -``` - -#### Returns - -`boolean` - -#### Inherited from - -[`Program`](Program.md).[`hasError`](Program.md#haserror) - -*** - -### loadTypeSpecScript() - -```ts -loadTypeSpecScript(typespecScript): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `typespecScript` | [`SourceFile`](SourceFile.md) | - -#### Returns - -`Promise`<[`TypeSpecScriptNode`](TypeSpecScriptNode.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) | - -#### Returns - -`void` - -#### Inherited from - -[`Program`](Program.md).[`onValidate`](Program.md#onvalidate) - -*** - -### reportDiagnostic() - -```ts -reportDiagnostic(diagnostic): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diagnostic` | [`Diagnostic`](Diagnostic.md) | - -#### Returns - -`void` - -#### Inherited from - -[`Program`](Program.md).[`reportDiagnostic`](Program.md#reportdiagnostic) - -*** - -### reportDiagnostics() - -```ts -reportDiagnostics(diagnostics): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | - -#### Returns - -`void` - -#### Inherited from - -[`Program`](Program.md).[`reportDiagnostics`](Program.md#reportdiagnostics) - -*** - -### reportDuplicateSymbols() - -```ts -reportDuplicateSymbols(symbols): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `symbols` | `undefined` \| `SymbolTable` | - -#### Returns - -`void` - -#### Inherited from - -[`Program`](Program.md).[`reportDuplicateSymbols`](Program.md#reportduplicatesymbols) - -*** - -### resolveTypeReference() - -```ts -resolveTypeReference(reference): [undefined | Type, readonly Diagnostic[]] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `reference` | `string` | - -#### Returns - -[`undefined` \| [`Type`](../type-aliases/Type.md), readonly [`Diagnostic`](Diagnostic.md)[]] - -#### Inherited from - -[`Program`](Program.md).[`resolveTypeReference`](Program.md#resolvetypereference) - -*** - -### stateMap() - -```ts -stateMap(key): Map -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `key` | `symbol` | - -#### Returns - -`Map`<[`Type`](../type-aliases/Type.md), `any`\> - -#### Inherited from - -[`Program`](Program.md).[`stateMap`](Program.md#statemap) - -*** - -### stateSet() - -```ts -stateSet(key): Set -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `key` | `symbol` | - -#### Returns - -`Set`<[`Type`](../type-aliases/Type.md)\> - -#### Inherited from - -[`Program`](Program.md).[`stateSet`](Program.md#stateset) - -*** - -### trace() - -```ts -trace(area, message): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `area` | `string` | -| `message` | `string` | - -#### Returns - -`void` - -#### Inherited from - -[`Program`](Program.md).[`trace`](Program.md#trace) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md deleted file mode 100644 index e23357c04ae..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -jsApi: true -title: "[I] Projection" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Projection"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node` | `undefined` | - | [`BaseType`](BaseType.md).`node` | [`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` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md deleted file mode 100644 index 9e2fdd7d714..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionApplication" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `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 deleted file mode 100644 index 9c264d6c895..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionArithmeticExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionArithmeticExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `op` | `readonly` | `"/"` \| `"+"` \| `"-"` \| `"*"` | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 81a0a2ab9d1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionBlockExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionBlockExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `statements` | `readonly` | [`ProjectionExpressionStatementNode`](ProjectionExpressionStatementNode.md)[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 5f226aa151d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionCallExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `arguments` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md)[] | - | - | - | -| `callKind` | `readonly` | `"template"` \| `"method"` | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionCallExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md deleted file mode 100644 index d118fae8102..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionDecoratorReferenceExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionDecoratorReferenceExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md deleted file mode 100644 index 1b629b18cc3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionEnumMemberSelectorNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionEnumMemberSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index b0b4984bddd..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionEnumSelectorNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionEnumSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 9bd4c0bb8e3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionEqualityExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionEqualityExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `op` | `readonly` | `"=="` \| `"!="` | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index e5f88227c6f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionExpressionStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `expr` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionExpressionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 376b5df32fe..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionIfExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `alternate?` | `readonly` | [`ProjectionIfExpressionNode`](ProjectionIfExpressionNode.md) \| [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | - | -| `consequent` | `readonly` | [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionIfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `test` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md deleted file mode 100644 index a6b1941cdae..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionInterfaceSelectorNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionInterfaceSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 02211cc71df..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionLambdaExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `body` | `readonly` | [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionLambdaExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | - | - | -| `parameters` | `readonly` | readonly [`ProjectionLambdaParameterDeclarationNode`](ProjectionLambdaParameterDeclarationNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 83d687378ab..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionLambdaParameterDeclarationNode" - ---- -## Extends - -- [`DeclarationNode`](DeclarationNode.md).[`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `ProjectionLambdaParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index bf7fc4535e4..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionLogicalExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionLogicalExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `op` | `readonly` | `"||"` \| `"&&"` | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index e248552f0c7..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionMemberExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `base` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `ProjectionMemberExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `selector` | `readonly` | `"."` \| `"::"` | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index d60c95d4be3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionModelExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionModelExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `properties` | `readonly` | ([`ProjectionModelPropertyNode`](ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](ProjectionModelSpreadPropertyNode.md))[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 4e472b856b8..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionModelPropertyNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `default?` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `ProjectionModelProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `optional` | `readonly` | `boolean` | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `value` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md deleted file mode 100644 index 2041065856e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionModelPropertySelectorNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionModelPropertySelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 71c9a72db85..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionModelSelectorNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionModelSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index dd7c508c89b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionModelSpreadPropertyNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionModelSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md deleted file mode 100644 index a75ecb31cb1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `body` | `readonly` | readonly [`ProjectionExpressionStatementNode`](ProjectionExpressionStatementNode.md)[] | - | - | - | -| `direction` | `readonly` | \| `"to"` \| `"from"` \| `"pre_to"` \| `"pre_from"` \| `""` | - | - | - | -| `directionId` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `Projection` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | - | - | -| `modifierIds` | `readonly` | readonly [`IdentifierNode`](IdentifierNode.md)[] | - | - | - | -| `parameters` | `readonly` | [`ProjectionParameterDeclarationNode`](ProjectionParameterDeclarationNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 497f82f83eb..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionOperationSelectorNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionOperationSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 97decac28e5..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionParameterDeclarationNode" - ---- -## Extends - -- [`DeclarationNode`](DeclarationNode.md).[`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `ProjectionParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 7e33de94c9c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionReferenceNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `arguments` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionReference` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md deleted file mode 100644 index 5aad292a124..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionRelationalExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionRelationalExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `op` | `readonly` | `"<="` \| `">="` \| `"<"` \| `">"` | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md deleted file mode 100644 index 9ec87e34368..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionScalarSelectorNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionScalarSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index eae20bc8ccb..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `from?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `ProjectionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `preFrom?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | -| `preTo?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | -| `projections` | `readonly` | readonly [`ProjectionNode`](ProjectionNode.md)[] | - | - | - | -| `selector` | `readonly` | \| [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) \| [`ProjectionModelSelectorNode`](ProjectionModelSelectorNode.md) \| [`ProjectionModelPropertySelectorNode`](ProjectionModelPropertySelectorNode.md) \| [`ProjectionScalarSelectorNode`](ProjectionScalarSelectorNode.md) \| [`ProjectionInterfaceSelectorNode`](ProjectionInterfaceSelectorNode.md) \| [`ProjectionOperationSelectorNode`](ProjectionOperationSelectorNode.md) \| [`ProjectionEnumSelectorNode`](ProjectionEnumSelectorNode.md) \| [`ProjectionEnumMemberSelectorNode`](ProjectionEnumMemberSelectorNode.md) \| [`ProjectionUnionSelectorNode`](ProjectionUnionSelectorNode.md) \| [`ProjectionUnionVariantSelectorNode`](ProjectionUnionVariantSelectorNode.md) | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `to?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md deleted file mode 100644 index 2e5f14d8240..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionTupleExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionTupleExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `values` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md deleted file mode 100644 index e7542f01c08..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionUnaryExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionUnaryExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `op` | `readonly` | `"!"` | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md deleted file mode 100644 index 3f1d145652e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionUnionSelectorNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionUnionSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 90c33335298..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] ProjectionUnionVariantSelectorNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ProjectionUnionVariantSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 368b089f1ec..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -jsApi: true -title: "[I] Projector" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `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) | - -#### Returns - -[`Type`](../type-aliases/Type.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md deleted file mode 100644 index 00c49026006..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -jsApi: true -title: "[I] RecordModelType" - ---- -## Extends - -- [`Model`](Model.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `baseModel?` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | [`Model`](Model.md).`baseModel` | [`Model`](Model.md).`baseModel` | -| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`Model`](Model.md).`decorators` | [`Model`](Model.md).`decorators` | -| `derivedModels` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](Model.md) | [`Model`](Model.md).`derivedModels` | [`Model`](Model.md).`derivedModels` | -| `indexer` | `Object` | - | [`Model`](Model.md).`indexer` | [`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` | [`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` | [`Model`](Model.md).`isFinished` | -| `kind` | `"Model"` | - | [`Model`](Model.md).`kind` | [`Model`](Model.md).`kind` | -| `name` | `string` | - | [`Model`](Model.md).`name` | [`Model`](Model.md).`name` | -| `namespace?` | [`Namespace`](Namespace.md) | - | [`Model`](Model.md).`namespace` | [`Model`](Model.md).`namespace` | -| `node?` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) \| [`IntersectionExpressionNode`](IntersectionExpressionNode.md) \| [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) | - | [`Model`](Model.md).`node` | [`Model`](Model.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionBase` | [`Model`](Model.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`Model`](Model.md).`projectionSource` | [`Model`](Model.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`Model`](Model.md).`projector` | [`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` | [`Model`](Model.md).`properties` | -| `sourceModel?` | [`Model`](Model.md) | The model that is referenced via `model is`. | [`Model`](Model.md).`sourceModel` | [`Model`](Model.md).`sourceModel` | -| `sourceModels` | [`SourceModel`](SourceModel.md)[] | Models that were used to build this model. This include any model referenced in `model is`, `...` or when intersecting models. | [`Model`](Model.md).`sourceModels` | [`Model`](Model.md).`sourceModels` | -| ~~`templateArguments?`~~ | [`Type`](../type-aliases/Type.md)[] | **Deprecated**
use templateMapper instead. | [`Model`](Model.md).`templateArguments` | [`Model`](Model.md).`templateArguments` | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`Model`](Model.md).`templateMapper` | [`Model`](Model.md).`templateMapper` | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`Model`](Model.md).`templateNode` | [`Model`](Model.md).`templateNode` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`Model`](Model.md).[`projectionsByName`](Model.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md deleted file mode 100644 index 8ddf533238b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -jsApi: true -title: "[I] ReplaceTextCodeFixEdit" - ---- -## Extends - -- [`TextRange`](TextRange.md) - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`TextRange`](TextRange.md).`end` | -| `file` | `readonly` | [`SourceFile`](SourceFile.md) | - | - | -| `kind` | `readonly` | `"replace-text"` | - | - | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | -| `text` | `readonly` | `string` | - | - | 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 deleted file mode 100644 index 92f81ef4d6b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[I] ResolveCompilerOptionsOptions" - ---- -## Extends - -- `ConfigToOptionsOptions` - -## Properties - -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `args?` | `Record`<`string`, `string`\> | Any arguments to interpolate the config. | `ConfigToOptionsOptions.args` | -| `configPath?` | `string` | Explicit config path. | - | -| `cwd` | `string` | Current working directory. This will be used to interpolate `{cwd}` in the config. | `ConfigToOptionsOptions.cwd` | -| `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/interfaces/ResolveModuleHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md deleted file mode 100644 index 7add06b0d4d..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -jsApi: true -title: "[I] ResolveModuleHost" - ---- -## Methods - -### readFile() - -```ts -readFile(path): Promise -``` - -Read a utf-8 encoded file. - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -#### Returns - -`Promise`<`string`\> - -*** - -### realpath() - -```ts -realpath(path): Promise -``` - -Resolve the real path for the current host. - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -#### Returns - -`Promise`<`string`\> - -*** - -### stat() - -```ts -stat(path): Promise -``` - -Get information about the given path - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `path` | `string` | - -#### Returns - -`Promise`<`Object`\> - -> | Member | Type | -> | :------ | :------ | -> | `isDirectory` | `boolean` | -> | `isFile` | `boolean` | -> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md deleted file mode 100644 index 319217c4a4a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] ResolveModuleOptions" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `baseDir` | `string` | - | -| `directoryIndexFiles?` | `string`[] | When resolution reach a directory without package.json look for those files to load in order.

**Default**
` ["index.mjs", "index.js"] ` | -| `resolveMain?` | (`pkg`: `any`) => `string` | When resolution reach package.json returns the path to the file relative to it.

**Default**
` pkg.main ` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedFile.md deleted file mode 100644 index 23b4709d7c1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/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/interfaces/ResolvedModule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md deleted file mode 100644 index 15f57df7adb..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -jsApi: true -title: "[I] ResolvedModule" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `mainFile` | `string` | Resolved main file for the module. | -| `manifest` | [`NodePackage`](NodePackage.md) | Value of package.json. | -| `path` | `string` | Root of the package. (Same level as package.json) | -| `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 deleted file mode 100644 index 16f45667641..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ReturnExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `Return` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `value` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md deleted file mode 100644 index 4d562ad90b2..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] ReturnRecord" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `kind` | `"Return"` | -| `value` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md deleted file mode 100644 index 24a6d3dd98f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] RmOptions" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `recursive?` | `boolean` | If `true`, perform a recursive directory removal. In
recursive mode, errors are not reported if `path` does not exist, and
operations are retried on failure.

**Default**
` false ` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md deleted file mode 100644 index 63b250838d3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -jsApi: true -title: "[I] Scalar" - ---- -## Extends - -- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `baseScalar?` | [`Scalar`](Scalar.md) | Scalar this scalar extends. | - | - | -| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`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` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Scalar"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `name` | `string` | - | - | - | -| `namespace?` | [`Namespace`](Namespace.md) | Namespace the scalar was defined in. | - | - | -| `node` | [`ScalarStatementNode`](ScalarStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| ~~`templateArguments?`~~ | [`Type`](../type-aliases/Type.md)[] | **Deprecated**
use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md deleted file mode 100644 index 3b2bd32a8f7..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[I] ScalarStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `extends?` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `ScalarStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | 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 deleted file mode 100644 index 33019f04687..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -jsApi: true -title: "[I] Scanner" - ---- -## Properties - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `file` | `readonly` | [`SourceFile`](SourceFile.md) | The source code being scanned. | -| `position` | `readonly` | `number` | The offset in UTF-16 code units to the current position at the start of the next token. | -| `token` | `readonly` | [`Token`](../enumerations/Token.md) | The current token | -| `tokenFlags` | `readonly` | [`TokenFlags`](../enumerations/TokenFlags.md) | The flags on the current token. | -| `tokenPosition` | `readonly` | `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` - -*** - -### findTripleQuotedStringIndent() - -```ts -findTripleQuotedStringIndent(start, end): [number, number] -``` - -Finds the indent for the given triple quoted string. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `start` | `number` | | -| `end` | `number` | | - -#### Returns - -[`number`, `number`] - -*** - -### 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` - -*** - -### reScanStringTemplate() - -```ts -reScanStringTemplate(tokenFlags): StringTemplateToken -``` - -Unconditionally back up and scan a template expression portion. - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `tokenFlags` | [`TokenFlags`](../enumerations/TokenFlags.md) | Token Flags for head StringTemplateToken | - -#### Returns - -[`StringTemplateToken`](../type-aliases/StringTemplateToken.md) - -*** - -### scan() - -```ts -scan(): Token -``` - -Advance one token. - -#### Returns - -[`Token`](../enumerations/Token.md) - -*** - -### scanDoc() - -```ts -scanDoc(): DocToken -``` - -Advance one token inside DocComment. Use inside [scanRange](Scanner.md#scanrange) callback over DocComment range. - -#### Returns - -[`DocToken`](../type-aliases/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 - -| Type parameter | -| :------ | -| `T` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `range` | [`TextRange`](TextRange.md) | -| `callback` | () => `T` | - -#### Returns - -`T` - -*** - -### unindentAndUnescapeTripleQuotedString() - -```ts -unindentAndUnescapeTripleQuotedString( - start, - end, - indentationStart, - indentationEnd, - token, - tokenFlags): string -``` - -Unindent and unescape the triple quoted string rawText - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `start` | `number` | -| `end` | `number` | -| `indentationStart` | `number` | -| `indentationEnd` | `number` | -| `token` | `StringLiteral` \| [`StringTemplateToken`](../type-aliases/StringTemplateToken.md) | -| `tokenFlags` | [`TokenFlags`](../enumerations/TokenFlags.md) | - -#### Returns - -`string` 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 deleted file mode 100644 index e138fcc5e63..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SemanticToken.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] SemanticToken" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `end` | `number` | -| `kind` | [`SemanticTokenKind`](../enumerations/SemanticTokenKind.md) | -| `pos` | `number` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md deleted file mode 100644 index c2c3d036e24..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md +++ /dev/null @@ -1,426 +0,0 @@ ---- -jsApi: true -title: "[I] Server" - ---- -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `pendingMessages` | `readonly` | readonly `string`[] | -| `workspaceFolders` | `readonly` | readonly [`ServerWorkspaceFolder`](ServerWorkspaceFolder.md)[] | - -## Methods - -### buildSemanticTokens() - -```ts -buildSemanticTokens(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `SemanticTokensParams` | - -#### Returns - -`Promise`<`SemanticTokens`\> - -*** - -### checkChange() - -```ts -checkChange(change): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `change` | `TextDocumentChangeEvent`<`TextDocument`\> | - -#### Returns - -`Promise`<`void`\> - -*** - -### compile() - -```ts -compile(document): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `document` | `TextDocument` \| `TextDocumentIdentifier` | - -#### Returns - -`Promise`<`undefined` \| [`CompileResult`](CompileResult.md)\> - -*** - -### complete() - -```ts -complete(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `CompletionParams` | - -#### Returns - -`Promise`<`CompletionList`\> - -*** - -### documentClosed() - -```ts -documentClosed(change): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `change` | `TextDocumentChangeEvent`<`TextDocument`\> | - -#### Returns - -`void` - -*** - -### executeCommand() - -```ts -executeCommand(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `ExecuteCommandParams` | - -#### Returns - -`Promise`<`void`\> - -*** - -### findDocumentHighlight() - -```ts -findDocumentHighlight(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `DocumentHighlightParams` | - -#### Returns - -`Promise`<`DocumentHighlight`[]\> - -*** - -### findReferences() - -```ts -findReferences(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `ReferenceParams` | - -#### Returns - -`Promise`<`Location`[]\> - -*** - -### formatDocument() - -```ts -formatDocument(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `DocumentFormattingParams` | - -#### Returns - -`Promise`<`TextEdit`[]\> - -*** - -### getCodeActions() - -```ts -getCodeActions(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `CodeActionParams` | - -#### Returns - -`Promise`<`CodeAction`[]\> - -*** - -### getDocumentSymbols() - -```ts -getDocumentSymbols(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `DocumentSymbolParams` | - -#### Returns - -`Promise`<`DocumentSymbol`[]\> - -*** - -### getFoldingRanges() - -```ts -getFoldingRanges(getFoldingRanges): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `getFoldingRanges` | `FoldingRangeParams` | - -#### Returns - -`Promise`<`FoldingRange`[]\> - -*** - -### getHover() - -```ts -getHover(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `HoverParams` | - -#### Returns - -`Promise`<`Hover`\> - -*** - -### getSemanticTokens() - -```ts -getSemanticTokens(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `SemanticTokensParams` | - -#### Returns - -`Promise`<[`SemanticToken`](SemanticToken.md)[]\> - -*** - -### getSignatureHelp() - -```ts -getSignatureHelp(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `SignatureHelpParams` | - -#### Returns - -`Promise`<`undefined` \| `SignatureHelp`\> - -*** - -### gotoDefinition() - -```ts -gotoDefinition(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `DefinitionParams` | - -#### Returns - -`Promise`<`Location`[]\> - -*** - -### initialize() - -```ts -initialize(params): Promise> -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `InitializeParams` | - -#### Returns - -`Promise`<`InitializeResult`<`any`\>\> - -*** - -### initialized() - -```ts -initialized(params): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `InitializedParams` | - -#### Returns - -`void` - -*** - -### log() - -```ts -log(message, details?): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `message` | `string` | -| `details`? | `any` | - -#### Returns - -`void` - -*** - -### prepareRename() - -```ts -prepareRename(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `PrepareRenameParams` | - -#### Returns - -`Promise`<`undefined` \| `Range`\> - -*** - -### rename() - -```ts -rename(params): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `RenameParams` | - -#### Returns - -`Promise`<`WorkspaceEdit`\> - -*** - -### watchedFilesChanged() - -```ts -watchedFilesChanged(params): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `params` | `DidChangeWatchedFilesParams` | - -#### Returns - -`void` - -*** - -### workspaceFoldersChanged() - -```ts -workspaceFoldersChanged(e): Promise -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `e` | `WorkspaceFoldersChangeEvent` | - -#### Returns - -`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md deleted file mode 100644 index 5de1b749677..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[I] ServerHost" - ---- -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `applyEdit` | `readonly` | (`paramOrEdit`: `WorkspaceEdit` \| `ApplyWorkspaceEditParams`) => `Promise`<`ApplyWorkspaceEditResult`\> | -| `compilerHost` | `readonly` | [`CompilerHost`](CompilerHost.md) | -| `getOpenDocumentByURL` | `readonly` | (`url`: `string`) => `undefined` \| `TextDocument` | -| `log` | `readonly` | (`message`: `string`) => `void` | -| `sendDiagnostics` | `readonly` | (`params`: `PublishDiagnosticsParams`) => `void` | -| `throwInternalErrors?` | `readonly` | `boolean` | 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 deleted file mode 100644 index 2c9511b6c5c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -jsApi: true -title: "[I] ServerSourceFile" - ---- -## Extends - -- [`SourceFile`](SourceFile.md) - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `document?` | `readonly` | `TextDocument` | - | - | -| `path` | `readonly` | `string` | The source file path.

This is used only for diagnostics. The command line compiler will populate
it with the actual path from which the file was read, but it can actually
be an arbitrary name for other scenarios. | [`SourceFile`](SourceFile.md).`path` | -| `text` | `readonly` | `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` | - -#### Returns - -[`LineAndCharacter`](LineAndCharacter.md) - -#### 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. - -#### Returns - -readonly `number`[] - -#### Inherited from - -[`SourceFile`](SourceFile.md).[`getLineStarts`](SourceFile.md#getlinestarts) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md deleted file mode 100644 index 13ccbd5b1b6..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] ServerWorkspaceFolder" - ---- -## Extends - -- `WorkspaceFolder` - -## Properties - -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `name` | `string` | The name of the workspace folder. Used to refer to this
workspace folder in the user interface. | `WorkspaceFolder.name` | -| `path` | `string` | - | - | -| `uri` | `string` | The associated URI for this workspace folder. | `WorkspaceFolder.uri` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md deleted file mode 100644 index 0fee72a901b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] Service" - ---- -## Extends - -- [`ServiceDetails`](ServiceDetails.md) - -## Properties - -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `title?` | `string` | - | [`ServiceDetails`](ServiceDetails.md).`title` | -| `type` | [`Namespace`](Namespace.md) | - | - | -| ~~`version?`~~ | `string` | **Deprecated**
Service version is deprecated. If wanting to describe a service versioning you can use the `@typespec/versioning` library. If wanting to describe the project version you can use the package.json version | [`ServiceDetails`](ServiceDetails.md).`version` | 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 deleted file mode 100644 index e8bf5c8b9c0..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServiceDetails.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -jsApi: true -title: "[I] ServiceDetails" - ---- -## Extended by - -- [`Service`](Service.md) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `title?` | `string` | - | -| ~~`version?`~~ | `string` | **Deprecated**
Service version is deprecated. If wanting to describe a service versioning you can use the `@typespec/versioning` library. If wanting to describe the project version you can use the package.json version | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md deleted file mode 100644 index dcc43f6a419..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -jsApi: true -title: "[I] SourceFile" - ---- -## Extended by - -- [`ServerSourceFile`](ServerSourceFile.md) - -## Properties - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `path` | `readonly` | `string` | The source file path.

This is used only for diagnostics. The command line compiler will populate
it with the actual path from which the file was read, but it can actually
be an arbitrary name for other scenarios. | -| `text` | `readonly` | `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`](LineAndCharacter.md) - -*** - -### getLineStarts() - -```ts -getLineStarts(): readonly number[] -``` - -Array of positions in the text where each line begins. There is one entry -per line, in order of lines, and each entry represents the offset in UTF-16 -code units from the start of the document to the beginning of the line. - -#### Returns - -readonly `number`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md deleted file mode 100644 index 9ca562374f1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -jsApi: true -title: "[I] SourceLocation" - ---- -## Extends - -- [`TextRange`](TextRange.md) - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`TextRange`](TextRange.md).`end` | -| `file` | `public` | [`SourceFile`](SourceFile.md) | - | - | -| `isSynthetic?` | `public` | `boolean` | - | - | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md deleted file mode 100644 index 3cd8d892df6..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] SourceLocationOptions" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `locateId?` | `boolean` | If trying to resolve the location of a type with an ID, show the location of the ID node instead of the entire type.
This makes sure that the location range is not too large and hard to read. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md deleted file mode 100644 index 0a256f9e449..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] SourceModel" - ---- -## Properties - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `model` | `readonly` | [`Model`](Model.md) | Source model | -| `usage` | `readonly` | `"is"` \| `"intersection"` \| `"spread"` | How was this model used.
- is: `model A is B`
- spread: `model A {...B}`
- intersection: `alias A = B & C` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StateDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StateDef.md deleted file mode 100644 index c44b13cc79e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StateDef.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -jsApi: true -title: "[I] StateDef" - ---- -## Properties - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `description?` | `readonly` | `string` | Description for this state. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md deleted file mode 100644 index b07deeb8f71..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] StringLiteral" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"String"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node?` | [`StringLiteralNode`](StringLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `value` | `string` | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md deleted file mode 100644 index b4483793a39..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] StringLiteralNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `StringLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `value` | `readonly` | `string` | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md deleted file mode 100644 index 1f329a46bfc..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] StringTemplate" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"StringTemplate"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node` | [`StringTemplateExpressionNode`](StringTemplateExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `spans` | [`StringTemplateSpan`](../type-aliases/StringTemplateSpan.md)[] | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md deleted file mode 100644 index e49b889b4d0..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] StringTemplateExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `head` | `readonly` | [`StringTemplateHeadNode`](StringTemplateHeadNode.md) | - | - | - | -| `kind` | `readonly` | `StringTemplateExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `spans` | `readonly` | readonly [`StringTemplateSpanNode`](StringTemplateSpanNode.md)[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md deleted file mode 100644 index c12b6f94a91..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] StringTemplateHeadNode" - ---- -## Extends - -- [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | -| `kind` | `readonly` | `StringTemplateHead` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | -| `value` | `readonly` | `string` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md deleted file mode 100644 index a25a8cb00a7..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] StringTemplateLiteralLikeNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | [`SyntaxKind`](../enumerations/SyntaxKind.md) | - | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | -| `value` | `readonly` | `string` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md deleted file mode 100644 index 18342a3f16c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] StringTemplateMiddleNode" - ---- -## Extends - -- [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | -| `kind` | `readonly` | `StringTemplateMiddle` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | -| `value` | `readonly` | `string` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md deleted file mode 100644 index 5065678c34b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -jsApi: true -title: "[I] StringTemplateSpanLiteral" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `isInterpolated` | `false` | - | - | - | -| `kind` | `"StringTemplateSpan"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node` | [`StringTemplateHeadNode`](StringTemplateHeadNode.md) \| [`StringTemplateMiddleNode`](StringTemplateMiddleNode.md) \| [`StringTemplateTailNode`](StringTemplateTailNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `type` | [`StringLiteral`](StringLiteral.md) | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md deleted file mode 100644 index cdd53aa95c9..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] StringTemplateSpanNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `expression` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `StringTemplateSpan` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `literal` | `readonly` | [`StringTemplateMiddleNode`](StringTemplateMiddleNode.md) \| [`StringTemplateTailNode`](StringTemplateTailNode.md) | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md deleted file mode 100644 index 9dfb26225f9..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -jsApi: true -title: "[I] StringTemplateSpanValue" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `isInterpolated` | `true` | - | - | - | -| `kind` | `"StringTemplateSpan"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node` | [`Expression`](../type-aliases/Expression.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `type` | [`Type`](../type-aliases/Type.md) | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md deleted file mode 100644 index 868a57fc1b2..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] StringTemplateTailNode" - ---- -## Extends - -- [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | -| `kind` | `readonly` | `StringTemplateTail` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | -| `value` | `readonly` | `string` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | 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 deleted file mode 100644 index b3a5b1d525c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SuppressDirective.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -jsApi: true -title: "[I] SuppressDirective" - ---- -## Extends - -- [`DirectiveBase`](DirectiveBase.md) - -## Properties - -| Property | Type | Inherited from | -| :------ | :------ | :------ | -| `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 deleted file mode 100644 index 56e88536fd4..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -jsApi: true -title: "[I] Sym" - ---- -## Properties - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `declarations` | `readonly` | readonly [`Node`](../type-aliases/Node.md)[] | Nodes which contribute to this declaration | -| `exports?` | `readonly` | `SymbolTable` | Externally visible symbols contained inside this symbol. E.g. all declarations
in a namespace, or members of an enum. | -| `flags` | `readonly` | [`SymbolFlags`](../enumerations/SymbolFlags.md) | - | -| `id?` | `readonly` | `number` | A unique identifier for this symbol. Used to look up the symbol links. | -| `members?` | `readonly` | `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?` | `readonly` | `SymbolTable` | Symbol table | -| `name` | `readonly` | `string` | The name of the symbol | -| `parent?` | `readonly` | [`Sym`](Sym.md) | The symbol containing this symbol, if any. E.g. for things declared in
a namespace, this refers to the namespace. | -| `symbolSource?` | `readonly` | [`Sym`](Sym.md) | For using symbols, this is the used symbol. | -| `type?` | `readonly` | [`Type`](../type-aliases/Type.md) | For late-bound symbols, this is the type referenced by the symbol. | -| `value?` | `readonly` | (...`args`: `any`[]) => `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/interfaces/SymbolLinks.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md deleted file mode 100644 index 7b219042a7b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] SymbolLinks" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `declaredType?` | [`Type`](../type-aliases/Type.md) | -| `instantiations?` | [`TypeInstantiationMap`](TypeInstantiationMap.md) | -| `type?` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md deleted file mode 100644 index 8fd539e649a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] SyntheticLocationContext" - ---- -Refer to a type that was not declared in a file - -## Properties - -| Property | Type | -| :------ | :------ | -| `type` | `"synthetic"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md deleted file mode 100644 index 2bfb157efb6..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] TemplateArgumentNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `argument` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `TemplateArgument` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `name?` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index a39c1945b3a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -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 - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `locals?` | `readonly` | `SymbolTable` | -| `templateParameters` | `readonly` | 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 deleted file mode 100644 index e32a4b1d739..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -jsApi: true -title: "[I] TemplateParameter" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `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` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"TemplateParameter"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node` | [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md deleted file mode 100644 index 0a548e9f96f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] TemplateParameterDeclarationNode" - ---- -## Extends - -- [`DeclarationNode`](DeclarationNode.md).[`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `constraint?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `default?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `TemplateParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`TemplateableNode`](../type-aliases/TemplateableNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 82e49192ccd..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -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 deleted file mode 100644 index b10d1814d40..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[I] TextRange" - ---- -## Extended by - -- [`BaseNode`](BaseNode.md) -- [`LineComment`](LineComment.md) -- [`BlockComment`](BlockComment.md) -- [`SourceLocation`](SourceLocation.md) -- [`ReplaceTextCodeFixEdit`](ReplaceTextCodeFixEdit.md) - -## Properties - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md deleted file mode 100644 index 8b534aaa96b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -jsApi: true -title: "[I] Tracer" - ---- -## Methods - -### sub() - -```ts -sub(subarea): Tracer -``` - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `subarea` | `string` | | - -#### Returns - -[`Tracer`](Tracer.md) - -*** - -### trace() - -```ts -trace( - area, - message, - target?): void -``` - -Trace - -#### Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `area` | `string` | | -| `message` | `string` | | -| `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | - | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md deleted file mode 100644 index c494ca07ed1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/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/interfaces/Tuple.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md deleted file mode 100644 index 95b42dd170e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] Tuple" - ---- -## Extends - -- [`BaseType`](BaseType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"Tuple"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `node` | [`TupleExpressionNode`](TupleExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `values` | [`Type`](../type-aliases/Type.md)[] | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md deleted file mode 100644 index 8724e77270f..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] TupleExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `TupleExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `values` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md deleted file mode 100644 index 1b84e154b79..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -jsApi: true -title: "[I] TypeInstantiationMap" - ---- -Maps type arguments to instantiated type. - -## Methods - -### get() - -```ts -get(args): undefined | Type -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `args` | readonly [`Type`](../type-aliases/Type.md)[] | - -#### Returns - -`undefined` \| [`Type`](../type-aliases/Type.md) - -*** - -### set() - -```ts -set(args, type): void -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `args` | readonly [`Type`](../type-aliases/Type.md)[] | -| `type` | [`Type`](../type-aliases/Type.md) | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md deleted file mode 100644 index 31d586266ea..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -jsApi: true -title: "[I] TypeMapper" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `args` | readonly [`Type`](../type-aliases/Type.md)[] | -| `partial` | `boolean` | - -## Methods - -### getMappedType() - -```ts -getMappedType(type): Type -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `type` | [`TemplateParameter`](TemplateParameter.md) | - -#### Returns - -[`Type`](../type-aliases/Type.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md deleted file mode 100644 index c89bb8d3d7a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeNameOptions.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] TypeNameOptions" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `namespaceFilter?` | (`ns`: [`Namespace`](Namespace.md)) => `boolean` | -| `printable?` | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md deleted file mode 100644 index b6e1e7648b1..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -jsApi: true -title: "[I] TypeReferenceNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `arguments` | `readonly` | readonly [`TemplateArgumentNode`](TemplateArgumentNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `TypeReference` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md deleted file mode 100644 index 06c5b7f9755..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] TypeSpecCompletionItem" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `label?` | `string` | Optional label if different from the text to complete. | -| `suffix?` | `string` | Optional text to be appended to the completion if accepted. | -| `sym` | [`Sym`](Sym.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md deleted file mode 100644 index 910c3a07126..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -jsApi: true -title: "[I] TypeSpecLibrary" - ---- -## Extends - -- [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md)<`T`, `E`, `State`\> - -## Type parameters - -| Type parameter | Value | -| :------ | :------ | -| `T` extends `Object` | - | -| `E` extends `Record`<`string`, `any`\> | `Record`<`string`, `never`\> | -| `State` extends `string` | `never` | - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `diagnostics` | `readonly` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`diagnostics` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`diagnostics` | -| `emitter?` | `readonly` | `Object` | Emitter configuration if library is an emitter. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`emitter` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`emitter` | -| `emitter.options?` | `readonly` | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | - | - | -| ~~`linter?`~~ | `readonly` | [`LinterDefinition`](LinterDefinition.md) | Configuration if library is providing linting rules/rulesets.

**Deprecated**
Use `export const $linter` instead. This will cause circular reference with linters. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`linter` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`linter` | -| `name` | `readonly` | `string` | Library name | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`name` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`name` | -| `requireImports?` | `readonly` | readonly `string`[] | List of other library that should be imported when this is used as an emitter.
Compiler will emit an error if the libraries are not explicitly imported. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`requireImports` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`requireImports` | -| `state?` | `readonly` | `Record`<`State`, [`StateDef`](StateDef.md)\> | - | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`state` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`state` | -| `stateKeys` | `public` | `Record`<`State`, `symbol`\> | - | - | - | - -## Methods - -### createDiagnostic() - -```ts -createDiagnostic(diag): Diagnostic -``` - -#### Type parameters - -| Type parameter | -| :------ | -| `C` extends `string` \| `number` \| `symbol` | -| `M` extends `string` \| `number` \| `symbol` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | - -#### Returns - -[`Diagnostic`](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`](Program.md) | - -#### Returns - -[`Tracer`](Tracer.md) - -*** - -### reportDiagnostic() - -```ts -reportDiagnostic(program, diag): void -``` - -#### Type parameters - -| Type parameter | -| :------ | -| `C` extends `string` \| `number` \| `symbol` | -| `M` extends `string` \| `number` \| `symbol` | - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `program` | [`Program`](Program.md) | -| `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | - -#### Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md deleted file mode 100644 index 19df935f8a3..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -jsApi: true -title: "[I] TypeSpecLibraryDef" - ---- -## Extended by - -- [`TypeSpecLibrary`](TypeSpecLibrary.md) - -## Type parameters - -| Type parameter | Value | -| :------ | :------ | -| `T` extends `Object` | - | -| `E` extends `Record`<`string`, `any`\> | `Record`<`string`, `never`\> | -| `State` extends `string` | `never` | - -## Properties - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `diagnostics` | `readonly` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | -| `emitter?` | `readonly` | `Object` | Emitter configuration if library is an emitter. | -| `emitter.options?` | `readonly` | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | -| ~~`linter?`~~ | `readonly` | [`LinterDefinition`](LinterDefinition.md) | Configuration if library is providing linting rules/rulesets.

**Deprecated**
Use `export const $linter` instead. This will cause circular reference with linters. | -| `name` | `readonly` | `string` | Library name. MUST match package.json name. | -| `requireImports?` | `readonly` | readonly `string`[] | List of other library that should be imported when this is used as an emitter.
Compiler will emit an error if the libraries are not explicitly imported. | -| `state?` | `public` | `Record`<`State`, [`StateDef`](StateDef.md)\> | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md deleted file mode 100644 index 67130a08b89..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] TypeSpecManifest" - ---- -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `commit` | `string` | Full commit sha. | -| `pr?` | `number` | Number of the pull request, if the build was from a pull request. | -| `version` | `string` | Version of the tsp compiler. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md deleted file mode 100644 index d739c9bb09b..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -jsApi: true -title: "[I] TypeSpecScriptNode" - ---- -## Extends - -- [`DeclarationNode`](DeclarationNode.md).[`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `comments` | `readonly` | readonly [`Comment`](../type-aliases/Comment.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `file` | `readonly` | [`SourceFile`](SourceFile.md) | - | - | - | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `inScopeNamespaces` | `readonly` | readonly [`NamespaceStatementNode`](NamespaceStatementNode.md)[] | - | - | - | -| `kind` | `readonly` | `TypeSpecScript` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals` | `readonly` | `SymbolTable` | - | - | - | -| `namespaces` | `readonly` | [`NamespaceStatementNode`](NamespaceStatementNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `parseDiagnostics` | `readonly` | readonly [`Diagnostic`](Diagnostic.md)[] | - | - | - | -| `parseOptions` | `readonly` | [`ParseOptions`](ParseOptions.md) | - | - | - | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `printable` | `readonly` | `boolean` | - | - | - | -| `statements` | `readonly` | readonly [`Statement`](../type-aliases/Statement.md)[] | - | - | - | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `usings` | `readonly` | readonly [`UsingStatementNode`](UsingStatementNode.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md deleted file mode 100644 index 52c9ebd293e..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -jsApi: true -title: "[I] Union" - ---- -## Extends - -- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `expression` | `public` | `boolean` | - | - | - | -| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | -| `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `public` | `"Union"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `name?` | `public` | `string` | - | - | - | -| `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | -| `node` | `public` | [`UnionStatementNode`](UnionStatementNode.md) \| [`UnionExpressionNode`](UnionExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| ~~`options`~~ | `readonly` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**
use variants | - | - | -| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| ~~`templateArguments?`~~ | `public` | [`Type`](../type-aliases/Type.md)[] | **Deprecated**
use templateMapper instead. | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | -| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | -| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | -| `variants` | `public` | `RekeyableMap`<`string` \| `symbol`, [`UnionVariant`](UnionVariant.md)\> | The variants of the union.

Variants are ordered in order that they appear in source. | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md deleted file mode 100644 index 38f1514d5de..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] UnionExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `UnionExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `options` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index d6ae54da13a..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -jsApi: true -title: "[I] UnionStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | -| `kind` | `readonly` | `UnionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | -| `options` | `readonly` | readonly [`UnionVariantNode`](UnionVariantNode.md)[] | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | 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 deleted file mode 100644 index 703e6802cd5..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -jsApi: true -title: "[I] UnionVariant" - ---- -## Extends - -- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `decorators` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`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` | [`BaseType`](BaseType.md).`isFinished` | -| `kind` | `"UnionVariant"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | -| `name` | `string` \| `symbol` | - | - | - | -| `node` | `undefined` \| [`UnionVariantNode`](UnionVariantNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | -| `type` | [`Type`](../type-aliases/Type.md) | - | - | - | -| `union` | [`Union`](Union.md) | - | - | - | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md deleted file mode 100644 index f8483c9d4fc..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] UnionVariantNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `id?` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `kind` | `readonly` | `UnionVariant` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`UnionStatementNode`](UnionStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md deleted file mode 100644 index 27130a1f722..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] UnknownType" - ---- -## Extends - -- [`IntrinsicType`](IntrinsicType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`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` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | -| `kind` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | -| `name` | `"unknown"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md deleted file mode 100644 index 35e25dbd1b4..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -jsApi: true -title: "[I] UsageTracker" - ---- -## Properties - -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `types` | `readonly` | 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) | - -#### Returns - -`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md deleted file mode 100644 index 2f4240581d9..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] UsingStatementNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `UsingStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `name` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | -| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index de3d6ebb765..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -jsApi: true -title: "[I] ValueOfExpressionNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `ValueOfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | -| `target` | `readonly` | [`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 deleted file mode 100644 index 3d84eaae20c..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueType.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -jsApi: true -title: "[I] ValueType" - ---- -## Properties - -| Property | Type | -| :------ | :------ | -| `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 deleted file mode 100644 index ff4e2e4c099..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -jsApi: true -title: "[I] VoidKeywordNode" - ---- -## Extends - -- [`BaseNode`](BaseNode.md) - -## Properties - -| Property | Modifier | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | -| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | -| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | -| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | -| `kind` | `readonly` | `VoidKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | -| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | -| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the
start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | -| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 deleted file mode 100644 index 4ae3e1448ec..00000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -jsApi: true -title: "[I] VoidType" - ---- -## Extends - -- [`IntrinsicType`](IntrinsicType.md) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `instantiationParameters?` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`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` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | -| `kind` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | -| `name` | `"void"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | -| `node?` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | -| `projectionBase?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | -| `projectionSource?` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | -| `projector?` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | - -## Accessors - -### projections - -```ts -get projections(): ProjectionStatementNode[] -``` - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -## Methods - -### projectionsByName() - -```ts -projectionsByName(name): ProjectionStatementNode[] -``` - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -[`ProjectionStatementNode`](ProjectionStatementNode.md)[] - -#### Inherited from - -[`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibrary.md index d36ff80411f..8c297cb5d76 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibrary.md @@ -15,5 +15,5 @@ Use TypeSpecLibrary | Type parameter | Value | | :------ | :------ | -| `T` extends `Object` | - | -| `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-aliases/CadlLibraryDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibraryDef.md index 422de99c2ff..4be661aec47 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibraryDef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CadlLibraryDef.md @@ -15,5 +15,5 @@ Use TypeSpecLibraryDef | Type parameter | Value | | :------ | :------ | -| `T` extends `Object` | - | -| `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-aliases/CreateTypeProps.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/CreateTypeProps.md index 09077fab54b..106f2e44317 100644 --- 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 @@ -4,5 +4,5 @@ title: "[T] CreateTypeProps" --- ```ts -type CreateTypeProps: Omit; +type CreateTypeProps: Omit; ``` 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 index 02ab5c9b0f1..e19a31b0d51 100644 --- 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 @@ -17,6 +17,7 @@ type Declaration: | ProjectionLambdaParameterDeclarationNode | EnumStatementNode | AliasStatementNode + | ConstStatementNode | DecoratorDeclarationStatementNode | FunctionDeclarationStatementNode; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md index 3192e23b8a7..d3bac77296e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticFormat.md @@ -4,13 +4,13 @@ title: "[T] DiagnosticFormat" --- ```ts -type DiagnosticFormat: T[C][M] extends CallableMessage ? Object : Record; +type DiagnosticFormat: T[C][M] extends CallableMessage ? object : Record; ``` ## Type parameters | Type parameter | Value | | :------ | :------ | -| `T` extends `Object` | - | -| `C` extends keyof `T` | - | -| `M` extends keyof `T`\[`C`\] | `"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/DiagnosticMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticMap.md index 0ae423a8b97..ec1bc61bea4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticMap.md @@ -11,4 +11,4 @@ type DiagnosticMap: { readonly [code in keyof T]: DiagnosticDefinition: DiagnosticReportWithoutTarget & Object; +type DiagnosticReport: DiagnosticReportWithoutTarget & object; ``` ## Type declaration @@ -17,6 +17,6 @@ type DiagnosticReport: DiagnosticReportWithoutTarget & Object; | Type parameter | Value | | :------ | :------ | -| `T` extends `Object` | - | -| `C` extends keyof `T` | - | -| `M` extends keyof `T`\[`C`\] | `"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 index 4e6824334e0..46c3023cdfe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md @@ -4,7 +4,7 @@ title: "[T] DiagnosticReportWithoutTarget" --- ```ts -type DiagnosticReportWithoutTarget: Object & DiagnosticFormat; +type DiagnosticReportWithoutTarget: object & DiagnosticFormat; ``` ## Type declaration @@ -19,6 +19,6 @@ type DiagnosticReportWithoutTarget: Object & DiagnosticFormat; | Type parameter | Value | | :------ | :------ | -| `T` extends `Object` | - | -| `C` extends keyof `T` | - | -| `M` extends keyof `T`\[`C`\] | `"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/DocTag.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DocTag.md index 63dab4fe8f6..e6d138e6d1b 100644 --- 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 @@ -8,6 +8,7 @@ type DocTag: | DocReturnsTagNode | DocErrorsTagNode | DocParamTagNode + | DocPropTagNode | DocTemplateTagNode | DocUnknownTagNode; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Entity.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Entity.md new file mode 100644 index 00000000000..45e517a16c8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Entity.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[T] Entity" + +--- +```ts +type Entity: Type | Value | MixedParameterConstraint | IndeterminateEntity; +``` + +Represent every single entity that are part of the TypeSpec program. Those are composed of different elements: +- Types +- Values +- Value Constraints 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 index e8f24ce1df8..9b135cc2da2 100644 --- 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 @@ -8,11 +8,15 @@ type Expression: | ArrayExpressionNode | MemberExpressionNode | ModelExpressionNode + | ObjectLiteralNode + | ArrayLiteralNode | TupleExpressionNode | UnionExpressionNode | IntersectionExpressionNode | TypeReferenceNode | ValueOfExpressionNode + | TypeOfExpressionNode + | CallExpressionNode | StringLiteralNode | NumericLiteralNode | BooleanLiteralNode diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/FunctionParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/FunctionParameter.md new file mode 100644 index 00000000000..04bc405f497 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/FunctionParameter.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] FunctionParameter" + +--- +```ts +type FunctionParameter: MixedFunctionParameter | SignatureFunctionParameter; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredCadlValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredCadlValue.md index 2917cfe13ac..24220b3ad77 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredCadlValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredCadlValue.md @@ -15,4 +15,4 @@ Use InferredTypeSpecValue | Type parameter | | :------ | -| `K` extends [`TypeKind`](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 index 3dd9bc2decc..97d745c5760 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredTypeSpecValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/InferredTypeSpecValue.md @@ -4,11 +4,11 @@ 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 InferredTypeSpecValue: K extends "Any" ? TypeSpecValue : K extends infer T[] ? InferredTypeSpecValue : K extends "String" ? string : K extends "Number" ? number : K extends "Boolean" ? boolean : Type & object; ``` ## Type parameters | Type parameter | | :------ | -| `K` extends [`TypeKind`](TypeKind.md) | +| `K` *extends* [`TypeKind`](TypeKind.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md index 5bf25c21edd..03ff1eefd6d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticFormat.md @@ -4,12 +4,12 @@ title: "[T] LinterRuleDiagnosticFormat" --- ```ts -type LinterRuleDiagnosticFormat: T[M] extends CallableMessage ? Object : Record; +type LinterRuleDiagnosticFormat: T[M] extends CallableMessage ? object : Record; ``` ## Type parameters | Type parameter | Value | | :------ | :------ | -| `T` extends [`DiagnosticMessages`](../interfaces/DiagnosticMessages.md) | - | -| `M` extends keyof `T` | `"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 index b5681839a05..357031fd1cb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReport.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReport.md @@ -4,7 +4,7 @@ title: "[T] LinterRuleDiagnosticReport" --- ```ts -type LinterRuleDiagnosticReport: LinterRuleDiagnosticReportWithoutTarget & Object; +type LinterRuleDiagnosticReport: LinterRuleDiagnosticReportWithoutTarget & object; ``` ## Type declaration @@ -17,5 +17,5 @@ type LinterRuleDiagnosticReport: LinterRuleDiagnosticReportWithoutTarget: Object & LinterRuleDiagnosticFormat; +type LinterRuleDiagnosticReportWithoutTarget: object & LinterRuleDiagnosticFormat; ``` ## Type declaration @@ -18,5 +18,5 @@ type LinterRuleDiagnosticReportWithoutTarget: Object & LinterRuleDiagnosti | Type parameter | Value | | :------ | :------ | -| `T` extends [`DiagnosticMessages`](../interfaces/DiagnosticMessages.md) | - | -| `M` extends keyof `T` | `"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/MarshalledValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MarshalledValue.md index 9d73b8f6661..a34c5fd4aa8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MarshalledValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MarshalledValue.md @@ -4,11 +4,11 @@ title: "[T] MarshalledValue" --- ```ts -type MarshalledValue: Type extends StringLiteral ? string : Type extends NumericLiteral ? number : Type extends BooleanLiteral ? boolean : Type; +type MarshalledValue: Value extends StringValue ? string : Value extends NumericValue ? number | Numeric : Value extends BooleanValue ? boolean : Value extends ObjectValue ? Record : Value extends ArrayValue ? unknown[] : Value extends EnumValue ? EnumMember : Value extends NullValue ? null : Value extends ScalarValue ? Value : Value; ``` ## Type parameters | Type parameter | | :------ | -| `Type` | +| `Value` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerType.md index f91bcc9915b..835da3b2fa7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerType.md @@ -4,5 +4,10 @@ title: "[T] MemberContainerType" --- ```ts -type MemberContainerType: Model | Enum | Interface | Union; +type MemberContainerType: + | Model + | Enum + | Interface + | Union + | Scalar; ``` 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 index c43ba0af081..ebf166d087d 100644 --- 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 @@ -4,5 +4,10 @@ title: "[T] MemberNode" --- ```ts -type MemberNode: ModelPropertyNode | EnumMemberNode | OperationStatementNode | UnionVariantNode; +type MemberNode: + | ModelPropertyNode + | EnumMemberNode + | OperationStatementNode + | UnionVariantNode + | ScalarConstructorNode; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModelIndexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModelIndexer.md index c7fa4409c37..2697efea7d3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModelIndexer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ModelIndexer.md @@ -4,7 +4,7 @@ title: "[T] ModelIndexer" --- ```ts -type ModelIndexer: Object; +type ModelIndexer: object; ``` ## Type declaration diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NeverIndexer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NeverIndexer.md index 8129c8f7f20..7a1d39e0fa2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NeverIndexer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/NeverIndexer.md @@ -4,7 +4,7 @@ title: "[T] NeverIndexer" --- ```ts -type NeverIndexer: Object; +type NeverIndexer: object; ``` ## Type declaration 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 index 1b802da3efd..bd80ee36653 100644 --- 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 @@ -47,5 +47,10 @@ type Node: | ProjectionModelPropertyNode | ProjectionModelSpreadPropertyNode | ProjectionStatementNode - | ProjectionNode; + | ProjectionNode + | ObjectLiteralNode + | ObjectLiteralPropertyNode + | ObjectLiteralSpreadPropertyNode + | ScalarConstructorNode + | ArrayLiteralNode; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/RuleRef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/RuleRef.md index 35404a94e34..2ade74a10db 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/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 -type 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/SemanticNodeListener.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md index 13354edce80..79fba3a4432 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md @@ -4,7 +4,7 @@ title: "[T] SemanticNodeListener" --- ```ts -type SemanticNodeListener: Object & TypeListeners; +type SemanticNodeListener: object & TypeListeners; ``` ## Type declaration diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ServerLogLevel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ServerLogLevel.md new file mode 100644 index 00000000000..0d3df8bfb21 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/ServerLogLevel.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[T] ServerLogLevel" + +--- +```ts +type ServerLogLevel: + | "trace" + | "debug" + | "info" + | "warning" + | "error"; +``` 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 index 7ced5c24fee..42f2c0c0c61 100644 --- 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 @@ -18,6 +18,8 @@ type Statement: | DecoratorDeclarationStatementNode | FunctionDeclarationStatementNode | AugmentDecoratorStatementNode + | ConstStatementNode + | CallExpressionNode | EmptyStatementNode | InvalidStatementNode | ProjectionStatementNode; diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypes.md index 7ae5686e3dc..75028ec6a33 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/StdTypes.md @@ -4,7 +4,7 @@ title: "[T] StdTypes" --- ```ts -type StdTypes: Object & Record; +type StdTypes: object & Record; ``` ## Type declaration 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 index 90778a6b180..72c86396cab 100644 --- 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 @@ -5,27 +5,28 @@ title: "[T] Type" --- ```ts type Type: - | Model - | ModelProperty - | Scalar - | Interface + | BooleanLiteral + | Decorator | Enum | EnumMember - | TemplateParameter + | FunctionParameter + | FunctionType + | Interface + | IntrinsicType + | Model + | ModelProperty | Namespace + | NumericLiteral + | ObjectType | Operation + | Projection + | Scalar + | ScalarConstructor | StringLiteral - | NumericLiteral - | BooleanLiteral | StringTemplate | StringTemplateSpan + | TemplateParameter | Tuple | Union - | UnionVariant - | IntrinsicType - | FunctionType - | Decorator - | FunctionParameter - | ObjectType - | Projection; + | UnionVariant; ``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOfDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOfDiagnostics.md index d761b83a3f0..94d83e07fd9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOfDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeOfDiagnostics.md @@ -11,4 +11,4 @@ type TypeOfDiagnostics: T extends DiagnosticMap ? D : never; | Type parameter | | :------ | -| `T` extends [`DiagnosticMap`](DiagnosticMap.md)<`any`\> | +| `T` *extends* [`DiagnosticMap`](DiagnosticMap.md)<`any`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeSpecDiagnosticTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/TypeSpecDiagnosticTarget.md index d33434f2958..426ac4bc915 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/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 -type TypeSpecDiagnosticTarget: Node | Type | Sym; +type TypeSpecDiagnosticTarget: Node | Entity | 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-aliases/Value.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Value.md new file mode 100644 index 00000000000..e486f06dc05 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Value.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[T] Value" + +--- +```ts +type Value: + | ScalarValue + | NumericValue + | StringValue + | BooleanValue + | ObjectValue + | ArrayValue + | EnumValue + | NullValue; +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/altDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/altDirectorySeparator.md index 07ee28a1cb9..c6b47f75e6b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/variables/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_sidebars/version-latest-sidebars.json b/packages/website/versioned_sidebars/version-latest-sidebars.json index eebcfbea732..ab8c2b3780b 100644 --- a/packages/website/versioned_sidebars/version-latest-sidebars.json +++ b/packages/website/versioned_sidebars/version-latest-sidebars.json @@ -64,6 +64,7 @@ "language-basics/intersections", "language-basics/type-literals", "language-basics/aliases", + "language-basics/values", "language-basics/type-relations" ] }, diff --git a/packages/xml/CHANGELOG.md b/packages/xml/CHANGELOG.md index a130841955f..00eaedb95e3 100644 --- a/packages/xml/CHANGELOG.md +++ b/packages/xml/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog - @typespec/xml +## 0.57.0 + +### Bump dependencies + +- [#3401](https://github.com/microsoft/typespec/pull/3401) Update dependencies - May 2024 + + ## 0.56.0 diff --git a/packages/xml/package.json b/packages/xml/package.json index a6d09963630..8f9d68c1fd8 100644 --- a/packages/xml/package.json +++ b/packages/xml/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/xml", - "version": "0.56.0", + "version": "0.57.0", "author": "Microsoft Corporation", "description": "TypeSpec library providing xml bindings", "homepage": "https://typespec.io", From 2a7148bace52168ca3e94686dd37d88c1ed73b03 Mon Sep 17 00:00:00 2001 From: Allen Zhang Date: Thu, 13 Jun 2024 14:06:22 -0700 Subject: [PATCH 2/3] additional file change --- packages/compiler/templates/scaffolding.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/compiler/templates/scaffolding.json b/packages/compiler/templates/scaffolding.json index 3c277e14fa2..869a016ad26 100644 --- a/packages/compiler/templates/scaffolding.json +++ b/packages/compiler/templates/scaffolding.json @@ -3,12 +3,12 @@ "title": "Empty project", "description": "Create an empty project.", "libraries": [], - "compilerVersion": "0.56.0" + "compilerVersion": "0.57.0" }, "rest": { "title": "Generic REST API", "description": "Create a project representing a generic REST API", - "compilerVersion": "0.56.0", + "compilerVersion": "0.57.0", "libraries": [ "@typespec/http", "@typespec/rest", @@ -23,7 +23,7 @@ "library-ts": { "title": "TypeSpec Library (With TypeScript)", "description": "Create a new package to add decorators or linters to typespec.", - "compilerVersion": "0.56.0", + "compilerVersion": "0.57.0", "libraries": [], "files": [ { @@ -99,7 +99,7 @@ "emitter-ts": { "title": "TypeSpec Emitter (With TypeScript)", "description": "Create a new package that will be emitting typespec", - "compilerVersion": "0.56.0", + "compilerVersion": "0.57.0", "libraries": [], "files": [ { From 7950f38f0da1f1f6824df284b7e7db12ed2a7048 Mon Sep 17 00:00:00 2001 From: Timothee Guerin Date: Thu, 13 Jun 2024 14:32:20 -0700 Subject: [PATCH 3/3] Add missing docs --- .../reference/js-api/variables/$lib.md | 2 + .../reference/js-api/functions/$externRef.md | 25 + .../reference/js-api/functions/$field.md | 25 + .../reference/js-api/functions/$message.md | 19 + .../reference/js-api/functions/$onEmit.md | 20 + .../reference/js-api/functions/$onValidate.md | 20 + .../reference/js-api/functions/$package.md | 25 + .../reference/js-api/functions/$reserve.md | 23 + .../reference/js-api/functions/$service.md | 21 + .../reference/js-api/functions/$stream.md | 23 + .../reference/js-api/functions/isMap.md | 23 + .../js-api/classes/DuplicateTracker.md | 66 ++ .../reference/js-api/classes/EventEmitter.md | 78 +++ .../js-api/classes/ProjectionError.md | 68 ++ .../reference/js-api/classes/Queue.md | 77 ++ .../js-api/classes/ResolveModuleError.md | 68 ++ .../js-api/enumerations/IdentifierKind.md | 19 + .../js-api/enumerations/ListenerFlow.md | 10 + .../js-api/enumerations/ModifierFlags.md | 11 + .../js-api/enumerations/NodeFlags.md | 14 + .../js-api/enumerations/SemanticTokenKind.md | 31 + .../js-api/enumerations/SymbolFlags.md | 39 ++ .../js-api/enumerations/SyntaxKind.md | 113 +++ .../reference/js-api/enumerations/Token.md | 89 +++ .../js-api/enumerations/TokenFlags.md | 16 + .../js-api/enumerations/UsageFlags.md | 12 + .../reference/js-api/functions/$deprecated.md | 31 + .../js-api/functions/$discriminator.md | 23 + .../reference/js-api/functions/$doc.md | 40 ++ .../reference/js-api/functions/$encode.md | 25 + .../js-api/functions/$encodedName.md | 25 + .../reference/js-api/functions/$error.md | 22 + .../reference/js-api/functions/$errorsDoc.md | 23 + .../reference/js-api/functions/$format.md | 35 + .../js-api/functions/$friendlyName.md | 25 + .../js-api/functions/$inspectType.md | 23 + .../js-api/functions/$inspectTypeName.md | 23 + .../reference/js-api/functions/$key.md | 30 + .../js-api/functions/$knownValues.md | 30 + .../reference/js-api/functions/$list.md | 27 + .../reference/js-api/functions/$maxItems.md | 23 + .../reference/js-api/functions/$maxLength.md | 23 + .../reference/js-api/functions/$maxValue.md | 23 + .../js-api/functions/$maxValueExclusive.md | 23 + .../reference/js-api/functions/$minItems.md | 23 + .../reference/js-api/functions/$minLength.md | 23 + .../reference/js-api/functions/$minValue.md | 23 + .../js-api/functions/$minValueExclusive.md | 23 + .../reference/js-api/functions/$overload.md | 25 + .../js-api/functions/$parameterVisibility.md | 23 + .../reference/js-api/functions/$pattern.md | 25 + .../js-api/functions/$projectedName.md | 27 + .../js-api/functions/$returnTypeVisibility.md | 23 + .../reference/js-api/functions/$returnsDoc.md | 23 + .../reference/js-api/functions/$secret.md | 21 + .../reference/js-api/functions/$service.md | 23 + .../reference/js-api/functions/$summary.md | 39 ++ .../reference/js-api/functions/$tag.md | 23 + .../reference/js-api/functions/$visibility.md | 23 + .../functions/$withDefaultKeyVisibility.md | 23 + .../functions/$withOptionalProperties.md | 19 + .../js-api/functions/$withPickedProperties.md | 23 + .../functions/$withUpdateableProperties.md | 19 + .../js-api/functions/$withVisibility.md | 23 + .../js-api/functions/$withoutDefaultValues.md | 19 + .../functions/$withoutOmittedProperties.md | 23 + .../reference/js-api/functions/Numeric.md | 20 + .../reference/js-api/functions/addService.md | 25 + .../reference/js-api/functions/assertType.md | 55 ++ .../js-api/functions/cadlTypeToJson.md | 29 + .../js-api/functions/checkFormatCadl.md | 23 + .../js-api/functions/checkFormatTypeSpec.md | 23 + .../reference/js-api/functions/compile.md | 25 + .../js-api/functions/compilerAssert.md | 26 + .../js-api/functions/createCadlLibrary.md | 30 + .../js-api/functions/createChecker.md | 18 + .../functions/createDecoratorDefinition.md | 30 + .../functions/createDiagnosticCollector.md | 18 + .../functions/createProjectedNameProgram.md | 23 + .../js-api/functions/createRekeyableMap.md | 25 + .../reference/js-api/functions/createRule.md | 27 + .../js-api/functions/createScanner.md | 19 + .../js-api/functions/createServer.md | 18 + .../js-api/functions/createSourceFile.md | 19 + .../js-api/functions/createTypeSpecLibrary.md | 47 ++ .../js-api/functions/defineCodeFix.md | 18 + .../js-api/functions/defineLinter.md | 18 + .../js-api/functions/definePackageFlags.md | 18 + .../reference/js-api/functions/emitFile.md | 21 + .../ensureTrailingDirectorySeparator.md | 18 + .../explainStringTemplateNotSerializable.md | 20 + .../js-api/functions/exprIsBareIdentifier.md | 18 + .../js-api/functions/filterModelProperties.md | 27 + .../js-api/functions/finishTypeForProgram.md | 25 + .../js-api/functions/formatDiagnostic.md | 18 + .../js-api/functions/formatIdentifier.md | 18 + .../js-api/functions/formatTypeSpec.md | 19 + .../reference/js-api/functions/getAllTags.md | 19 + .../functions/getAnyExtensionFromPath.md | 28 + .../js-api/functions/getBaseFileName.md | 46 ++ .../js-api/functions/getDeprecated.md | 21 + .../js-api/functions/getDeprecationDetails.md | 21 + .../js-api/functions/getDirectoryPath.md | 18 + .../js-api/functions/getDiscriminatedTypes.md | 18 + .../js-api/functions/getDiscriminatedUnion.md | 19 + .../js-api/functions/getDiscriminator.md | 19 + .../reference/js-api/functions/getDoc.md | 23 + .../reference/js-api/functions/getDocData.md | 23 + .../js-api/functions/getEffectiveModelType.md | 34 + .../reference/js-api/functions/getEncode.md | 19 + .../js-api/functions/getEntityName.md | 19 + .../js-api/functions/getErrorsDoc.md | 23 + .../js-api/functions/getErrorsDocData.md | 23 + .../js-api/functions/getFirstAncestor.md | 23 + .../reference/js-api/functions/getFormat.md | 19 + .../js-api/functions/getFriendlyName.md | 19 + .../functions/getFullyQualifiedSymbolName.md | 20 + .../js-api/functions/getIdentifierContext.md | 18 + .../reference/js-api/functions/getKeyName.md | 19 + .../js-api/functions/getKnownValues.md | 19 + .../js-api/functions/getListOperationType.md | 23 + .../js-api/functions/getLocationContext.md | 19 + .../reference/js-api/functions/getMaxItems.md | 19 + .../js-api/functions/getMaxItemsAsNumeric.md | 19 + .../js-api/functions/getMaxLength.md | 19 + .../js-api/functions/getMaxLengthAsNumeric.md | 21 + .../reference/js-api/functions/getMaxValue.md | 19 + .../js-api/functions/getMaxValueAsNumeric.md | 19 + .../js-api/functions/getMaxValueExclusive.md | 19 + .../getMaxValueExclusiveAsNumeric.md | 19 + .../reference/js-api/functions/getMinItems.md | 19 + .../js-api/functions/getMinItemsAsNumeric.md | 19 + .../js-api/functions/getMinLength.md | 19 + .../js-api/functions/getMinLengthAsNumeric.md | 21 + .../reference/js-api/functions/getMinValue.md | 19 + .../js-api/functions/getMinValueAsNumeric.md | 19 + .../js-api/functions/getMinValueExclusive.md | 19 + .../getMinValueExclusiveAsNumeric.md | 19 + .../js-api/functions/getNamespaceFullName.md | 21 + .../js-api/functions/getNodeAtPosition.md | 54 ++ .../functions/getNodeAtPositionDetail.md | 23 + .../functions/getNormalizedAbsolutePath.md | 19 + .../getNormalizedAbsolutePathWithoutRoot.md | 19 + .../functions/getNormalizedPathComponents.md | 28 + .../functions/getOverloadedOperation.md | 23 + .../js-api/functions/getOverloads.md | 23 + .../js-api/functions/getOverriddenProperty.md | 21 + .../functions/getParameterVisibility.md | 25 + .../js-api/functions/getParentTemplateNode.md | 22 + .../js-api/functions/getPathComponents.md | 49 ++ .../functions/getPathFromPathComponents.md | 25 + .../reference/js-api/functions/getPattern.md | 27 + .../js-api/functions/getPatternData.md | 24 + .../functions/getPositionBeforeTrivia.md | 21 + .../js-api/functions/getProjectedName.md | 27 + .../js-api/functions/getProjectedNames.md | 21 + .../reference/js-api/functions/getProperty.md | 19 + .../js-api/functions/getPropertyType.md | 20 + .../functions/getRelativePathFromDirectory.md | 50 ++ .../functions/getReturnTypeVisibility.md | 25 + .../js-api/functions/getReturnsDoc.md | 23 + .../js-api/functions/getReturnsDocData.md | 23 + .../js-api/functions/getRootLength.md | 42 ++ .../reference/js-api/functions/getService.md | 23 + .../functions/getSourceFileKindFromExt.md | 18 + .../js-api/functions/getSourceLocation.md | 55 ++ .../reference/js-api/functions/getSummary.md | 19 + .../reference/js-api/functions/getTags.md | 19 + .../reference/js-api/functions/getTypeName.md | 19 + .../js-api/functions/getVisibility.md | 19 + .../js-api/functions/hasParseError.md | 18 + .../js-api/functions/hasProjectedName.md | 27 + .../hasTrailingDirectorySeparator.md | 20 + .../js-api/functions/ignoreDiagnostics.md | 28 + .../js-api/functions/interpolatePath.md | 21 + .../functions/isAnyDirectorySeparator.md | 20 + .../js-api/functions/isArrayModelType.md | 19 + .../js-api/functions/isCadlValueTypeOf.md | 29 + .../reference/js-api/functions/isComment.md | 18 + .../js-api/functions/isDeclaredInNamespace.md | 26 + .../js-api/functions/isDeclaredType.md | 22 + .../js-api/functions/isDeprecated.md | 21 + .../js-api/functions/isErrorModel.md | 21 + .../reference/js-api/functions/isErrorType.md | 18 + .../js-api/functions/isGlobalNamespace.md | 21 + .../js-api/functions/isImportStatement.md | 18 + .../js-api/functions/isIntrinsicType.md | 23 + .../reference/js-api/functions/isKey.md | 19 + .../reference/js-api/functions/isKeyword.md | 18 + .../js-api/functions/isListOperation.md | 23 + .../reference/js-api/functions/isModifier.md | 18 + .../reference/js-api/functions/isNeverType.md | 18 + .../reference/js-api/functions/isNullType.md | 18 + .../reference/js-api/functions/isNumeric.md | 20 + .../js-api/functions/isNumericType.md | 19 + .../js-api/functions/isPathAbsolute.md | 18 + .../js-api/functions/isProjectedProgram.md | 18 + .../js-api/functions/isPunctuation.md | 18 + .../js-api/functions/isRecordModelType.md | 21 + .../reference/js-api/functions/isSecret.md | 19 + .../reference/js-api/functions/isService.md | 23 + .../js-api/functions/isStatementKeyword.md | 18 + .../js-api/functions/isStdNamespace.md | 18 + .../js-api/functions/isStringType.md | 19 + .../js-api/functions/isTemplateDeclaration.md | 20 + .../isTemplateDeclarationOrInstance.md | 20 + .../js-api/functions/isTemplateInstance.md | 20 + .../reference/js-api/functions/isTrivia.md | 18 + .../reference/js-api/functions/isType.md | 18 + .../js-api/functions/isTypeSpecValueTypeOf.md | 29 + .../js-api/functions/isUnknownType.md | 18 + .../reference/js-api/functions/isUrl.md | 20 + .../reference/js-api/functions/isValue.md | 18 + .../reference/js-api/functions/isVisible.md | 23 + .../reference/js-api/functions/isVoidType.md | 18 + .../reference/js-api/functions/joinPaths.md | 36 + .../js-api/functions/listOperationsIn.md | 21 + .../js-api/functions/listServices.md | 22 + .../js-api/functions/logDiagnostics.md | 19 + .../js-api/functions/logVerboseTestOutput.md | 26 + .../mapEventEmitterToNodeListener.md | 22 + .../js-api/functions/markDeprecated.md | 25 + .../js-api/functions/navigateProgram.md | 25 + .../js-api/functions/navigateType.md | 25 + .../functions/navigateTypesInNamespace.md | 23 + .../js-api/functions/normalizePath.md | 18 + .../js-api/functions/normalizeSlashes.md | 20 + .../js-api/functions/paramMessage.md | 25 + .../reference/js-api/functions/parse.md | 19 + .../functions/parseStandaloneTypeReference.md | 18 + .../js-api/functions/positionInRange.md | 25 + .../js-api/functions/projectProgram.md | 23 + .../js-api/functions/reducePathComponents.md | 21 + .../removeTrailingDirectorySeparator.md | 25 + .../js-api/functions/reportDeprecated.md | 25 + .../functions/resolveCompilerOptions.md | 21 + .../js-api/functions/resolveEncodedName.md | 45 ++ .../functions/resolveLinterDefinition.md | 21 + .../js-api/functions/resolveModule.md | 25 + .../reference/js-api/functions/resolvePath.md | 28 + .../js-api/functions/resolveUsages.md | 23 + .../functions/scopeNavigationToNamespace.md | 33 + .../js-api/functions/setCadlNamespace.md | 23 + .../js-api/functions/setTypeSpecNamespace.md | 21 + .../functions/skipContinuousIdentifier.md | 23 + .../reference/js-api/functions/skipTrivia.md | 25 + .../js-api/functions/skipTriviaBackward.md | 25 + .../js-api/functions/skipWhiteSpace.md | 23 + .../functions/stringTemplateToString.md | 22 + .../js-api/functions/typespecTypeToJson.md | 28 + .../functions/validateDecoratorNotOnType.md | 30 + .../functions/validateDecoratorParamCount.md | 25 + .../functions/validateDecoratorParamType.md | 67 ++ .../functions/validateDecoratorTarget.md | 33 + .../validateDecoratorTargetIntrinsic.md | 29 + .../validateDecoratorUniqueOnNode.md | 23 + .../js-api/functions/visitChildren.md | 25 + .../functions/walkPropertiesInherited.md | 25 + .../reference/js-api/index.md | 614 ++++++++++++++++ .../js-api/interfaces/AliasStatementNode.md | 26 + .../js-api/interfaces/AnyKeywordNode.md | 21 + .../js-api/interfaces/ArrayExpressionNode.md | 22 + .../js-api/interfaces/ArrayLiteralNode.md | 22 + .../js-api/interfaces/ArrayModelType.md | 69 ++ .../reference/js-api/interfaces/ArrayValue.md | 18 + .../AugmentDecoratorStatementNode.md | 24 + .../reference/js-api/interfaces/BaseNode.md | 115 +++ .../reference/js-api/interfaces/BaseType.md | 75 ++ .../js-api/interfaces/BlockComment.md | 17 + .../js-api/interfaces/BooleanLiteral.md | 56 ++ .../js-api/interfaces/BooleanLiteralNode.md | 22 + .../js-api/interfaces/BooleanValue.md | 18 + .../js-api/interfaces/CallExpressionNode.md | 23 + .../js-api/interfaces/CallableMessage.md | 30 + .../reference/js-api/interfaces/Checker.md | 656 ++++++++++++++++++ .../reference/js-api/interfaces/CodeFix.md | 12 + .../js-api/interfaces/CodeFixContext.md | 12 + .../js-api/interfaces/CompileResult.md | 12 + .../js-api/interfaces/CompilerHost.md | 272 ++++++++ .../interfaces/CompilerLocationContext.md | 12 + .../js-api/interfaces/CompilerOptions.md | 25 + .../js-api/interfaces/ConstStatementNode.md | 24 + .../js-api/interfaces/DeclarationNode.md | 31 + .../js-api/interfaces/DecoratedType.md | 23 + .../reference/js-api/interfaces/Decorator.md | 60 ++ .../js-api/interfaces/DecoratorApplication.md | 13 + .../js-api/interfaces/DecoratorArgument.md | 12 + .../js-api/interfaces/DecoratorContext.md | 72 ++ .../DecoratorDeclarationStatementNode.md | 34 + .../js-api/interfaces/DecoratorDefinition.md | 21 + .../interfaces/DecoratorExpressionNode.md | 23 + .../js-api/interfaces/DecoratorFunction.md | 29 + .../interfaces/DecoratorParamDefinition.md | 17 + .../js-api/interfaces/DecoratorValidator.md | 35 + .../js-api/interfaces/DeprecatedDirective.md | 16 + .../js-api/interfaces/DeprecationDetails.md | 12 + .../reference/js-api/interfaces/Diagnostic.md | 14 + .../js-api/interfaces/DiagnosticCollector.md | 90 +++ .../js-api/interfaces/DiagnosticCreator.md | 68 ++ .../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 | 34 + .../js-api/interfaces/DiscriminatedUnion.md | 11 + .../js-api/interfaces/Discriminator.md | 10 + .../js-api/interfaces/DocErrorsTagNode.md | 23 + .../reference/js-api/interfaces/DocNode.md | 23 + .../js-api/interfaces/DocParamTagNode.md | 24 + .../js-api/interfaces/DocPropTagNode.md | 24 + .../js-api/interfaces/DocReturnsTagNode.md | 23 + .../js-api/interfaces/DocTagBaseNode.md | 32 + .../js-api/interfaces/DocTemplateTagNode.md | 24 + .../js-api/interfaces/DocTextNode.md | 22 + .../js-api/interfaces/DocUnknownTagNode.md | 23 + .../js-api/interfaces/EmitContext.md | 44 ++ .../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 | 59 ++ .../reference/js-api/interfaces/EnumMember.md | 60 ++ .../js-api/interfaces/EnumMemberNode.md | 24 + .../js-api/interfaces/EnumSpreadMemberNode.md | 22 + .../js-api/interfaces/EnumStatementNode.md | 24 + .../reference/js-api/interfaces/EnumValue.md | 17 + .../reference/js-api/interfaces/ErrorType.md | 56 ++ .../js-api/interfaces/ExternKeywordNode.md | 21 + .../js-api/interfaces/FileLibraryMetadata.md | 19 + .../reference/js-api/interfaces/FilePos.md | 11 + .../FunctionDeclarationStatementNode.md | 34 + .../interfaces/FunctionParameterBase.md | 63 ++ .../interfaces/FunctionParameterNode.md | 25 + .../js-api/interfaces/FunctionType.md | 60 ++ .../js-api/interfaces/IdentifierContext.md | 11 + .../js-api/interfaces/IdentifierNode.md | 22 + .../js-api/interfaces/ImportStatementNode.md | 22 + .../js-api/interfaces/IndeterminateEntity.md | 13 + .../interfaces/InsertTextCodeFixEdit.md | 13 + .../reference/js-api/interfaces/Interface.md | 63 ++ .../interfaces/InterfaceStatementNode.md | 29 + .../interfaces/IntersectionExpressionNode.md | 22 + .../js-api/interfaces/IntrinsicType.md | 64 ++ .../js-api/interfaces/InvalidStatementNode.md | 22 + .../interfaces/JsNamespaceDeclarationNode.md | 22 + .../js-api/interfaces/JsSourceFileNode.md | 25 + .../js-api/interfaces/LibraryInstance.md | 14 + .../interfaces/LibraryLocationContext.md | 14 + .../js-api/interfaces/LineAndCharacter.md | 14 + .../js-api/interfaces/LineComment.md | 16 + .../js-api/interfaces/LinterDefinition.md | 11 + .../interfaces/LinterResolvedDefinition.md | 11 + .../reference/js-api/interfaces/LinterRule.md | 52 ++ .../js-api/interfaces/LinterRuleContext.md | 40 ++ .../js-api/interfaces/LinterRuleDefinition.md | 45 ++ .../js-api/interfaces/LinterRuleSet.md | 12 + .../js-api/interfaces/ListOperationOptions.md | 10 + .../reference/js-api/interfaces/LogInfo.md | 13 + .../reference/js-api/interfaces/LogSink.md | 22 + .../reference/js-api/interfaces/Logger.md | 76 ++ .../js-api/interfaces/MemberExpressionNode.md | 24 + .../interfaces/MixedFunctionParameter.md | 62 ++ .../interfaces/MixedParameterConstraint.md | 13 + .../reference/js-api/interfaces/Model.md | 72 ++ .../js-api/interfaces/ModelExpressionNode.md | 23 + .../js-api/interfaces/ModelProperty.md | 63 ++ .../js-api/interfaces/ModelPropertyNode.md | 26 + .../interfaces/ModelSpreadPropertyNode.md | 22 + .../js-api/interfaces/ModelStatementNode.md | 30 + .../interfaces/ModuleLibraryMetadata.md | 21 + .../reference/js-api/interfaces/Namespace.md | 67 ++ .../interfaces/NamespaceNavigationOptions.md | 10 + .../interfaces/NamespaceStatementNode.md | 25 + .../js-api/interfaces/NavigationOptions.md | 10 + .../js-api/interfaces/NeverKeywordNode.md | 21 + .../reference/js-api/interfaces/NeverType.md | 56 ++ .../js-api/interfaces/NodePackage.md | 25 + .../reference/js-api/interfaces/NullType.md | 56 ++ .../reference/js-api/interfaces/NullValue.md | 17 + .../reference/js-api/interfaces/Numeric.md | 140 ++++ .../js-api/interfaces/NumericLiteral.md | 58 ++ .../js-api/interfaces/NumericLiteralNode.md | 23 + .../js-api/interfaces/NumericValue.md | 18 + .../js-api/interfaces/ObjectLiteralNode.md | 23 + .../interfaces/ObjectLiteralPropertyNode.md | 23 + .../ObjectLiteralSpreadPropertyNode.md | 22 + .../reference/js-api/interfaces/ObjectType.md | 56 ++ .../js-api/interfaces/ObjectValue.md | 18 + .../ObjectValuePropertyDescriptor.md | 12 + .../reference/js-api/interfaces/Operation.md | 65 ++ .../OperationSignatureDeclarationNode.md | 23 + .../OperationSignatureReferenceNode.md | 22 + .../interfaces/OperationStatementNode.md | 27 + .../js-api/interfaces/PackageFlags.md | 10 + .../js-api/interfaces/ParseOptions.md | 11 + .../js-api/interfaces/PatternData.md | 11 + .../js-api/interfaces/PositionDetail.md | 21 + .../js-api/interfaces/ProcessedLog.md | 13 + .../reference/js-api/interfaces/Program.md | 252 +++++++ .../interfaces/ProjectLocationContext.md | 13 + .../js-api/interfaces/ProjectedNameView.md | 31 + .../js-api/interfaces/ProjectedProgram.md | 305 ++++++++ .../reference/js-api/interfaces/Projection.md | 57 ++ .../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 + .../ProjectionScalarSelectorNode.md | 21 + .../interfaces/ProjectionStatementNode.md | 28 + .../ProjectionTupleExpressionNode.md | 22 + .../ProjectionUnaryExpressionNode.md | 23 + .../interfaces/ProjectionUnionSelectorNode.md | 21 + .../ProjectionUnionVariantSelectorNode.md | 21 + .../reference/js-api/interfaces/Projector.md | 32 + .../js-api/interfaces/RecordModelType.md | 69 ++ .../interfaces/ReplaceTextCodeFixEdit.md | 18 + .../ResolveCompilerOptionsOptions.md | 19 + .../js-api/interfaces/ResolveModuleHost.md | 69 ++ .../js-api/interfaces/ResolveModuleOptions.md | 12 + .../js-api/interfaces/ResolvedFile.md | 11 + .../js-api/interfaces/ResolvedModule.md | 13 + .../js-api/interfaces/ReturnExpressionNode.md | 22 + .../js-api/interfaces/ReturnRecord.md | 11 + .../reference/js-api/interfaces/RmOptions.md | 10 + .../reference/js-api/interfaces/Scalar.md | 64 ++ .../js-api/interfaces/ScalarConstructor.md | 58 ++ .../interfaces/ScalarConstructorNode.md | 23 + .../js-api/interfaces/ScalarStatementNode.md | 29 + .../js-api/interfaces/ScalarValue.md | 20 + .../reference/js-api/interfaces/Scanner.md | 187 +++++ .../js-api/interfaces/SemanticToken.md | 12 + .../reference/js-api/interfaces/Server.md | 425 ++++++++++++ .../reference/js-api/interfaces/ServerHost.md | 15 + .../reference/js-api/interfaces/ServerLog.md | 12 + .../js-api/interfaces/ServerSourceFile.md | 61 ++ .../interfaces/ServerWorkspaceFolder.md | 16 + .../reference/js-api/interfaces/Service.md | 16 + .../js-api/interfaces/ServiceDetails.md | 15 + .../interfaces/SignatureFunctionParameter.md | 62 ++ .../reference/js-api/interfaces/SourceFile.md | 52 ++ .../js-api/interfaces/SourceLocation.md | 17 + .../interfaces/SourceLocationOptions.md | 10 + .../js-api/interfaces/SourceModel.md | 11 + .../reference/js-api/interfaces/StateDef.md | 10 + .../js-api/interfaces/StringLiteral.md | 56 ++ .../js-api/interfaces/StringLiteralNode.md | 22 + .../js-api/interfaces/StringTemplate.md | 57 ++ .../StringTemplateExpressionNode.md | 23 + .../interfaces/StringTemplateHeadNode.md | 22 + .../StringTemplateLiteralLikeNode.md | 28 + .../interfaces/StringTemplateMiddleNode.md | 22 + .../interfaces/StringTemplateSpanLiteral.md | 57 ++ .../interfaces/StringTemplateSpanNode.md | 23 + .../interfaces/StringTemplateSpanValue.md | 57 ++ .../interfaces/StringTemplateTailNode.md | 22 + .../js-api/interfaces/StringValue.md | 18 + .../js-api/interfaces/SuppressDirective.md | 17 + .../reference/js-api/interfaces/Sym.md | 20 + .../js-api/interfaces/SymbolLinks.md | 13 + .../interfaces/SyntheticLocationContext.md | 12 + .../js-api/interfaces/TemplateArgumentNode.md | 23 + .../interfaces/TemplateDeclarationNode.md | 21 + .../js-api/interfaces/TemplateParameter.md | 57 ++ .../TemplateParameterDeclarationNode.md | 24 + .../js-api/interfaces/TemplatedTypeBase.md | 20 + .../reference/js-api/interfaces/TextRange.md | 19 + .../reference/js-api/interfaces/Tracer.md | 47 ++ .../js-api/interfaces/TracerOptions.md | 10 + .../reference/js-api/interfaces/Tuple.md | 56 ++ .../js-api/interfaces/TupleExpressionNode.md | 22 + .../js-api/interfaces/TypeInstantiationMap.md | 43 ++ .../reference/js-api/interfaces/TypeMapper.md | 29 + .../js-api/interfaces/TypeNameOptions.md | 11 + .../js-api/interfaces/TypeOfExpressionNode.md | 22 + .../js-api/interfaces/TypeReferenceNode.md | 23 + .../interfaces/TypeSpecCompletionItem.md | 12 + .../js-api/interfaces/TypeSpecLibrary.md | 121 ++++ .../js-api/interfaces/TypeSpecLibraryDef.md | 28 + .../js-api/interfaces/TypeSpecManifest.md | 12 + .../js-api/interfaces/TypeSpecScriptNode.md | 32 + .../reference/js-api/interfaces/Union.md | 64 ++ .../js-api/interfaces/UnionExpressionNode.md | 22 + .../js-api/interfaces/UnionStatementNode.md | 27 + .../js-api/interfaces/UnionVariant.md | 59 ++ .../js-api/interfaces/UnionVariantNode.md | 24 + .../js-api/interfaces/UnknownType.md | 56 ++ .../js-api/interfaces/UsageTracker.md | 29 + .../js-api/interfaces/UsingStatementNode.md | 22 + .../interfaces/ValueOfExpressionNode.md | 22 + .../js-api/interfaces/VoidKeywordNode.md | 21 + .../reference/js-api/interfaces/VoidType.md | 56 ++ .../type-aliases/MemberContainerNode.md | 3 +- .../js-api/type-aliases/MemberType.md | 7 +- 513 files changed, 16264 insertions(+), 2 deletions(-) create mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md 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/$inspectType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withPickedProperties.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md 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/Numeric.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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/definePackageFlags.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/explainStringTemplateNotSerializable.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md 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/getEntityName.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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItemsAsNumeric.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLengthAsNumeric.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueAsNumeric.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusiveAsNumeric.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItemsAsNumeric.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLengthAsNumeric.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueAsNumeric.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusiveAsNumeric.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPositionDetail.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumeric.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isValue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/positionInRange.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md 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/resolveEncodedName.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveLinterDefinition.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipContinuousIdentifier.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTriviaBackward.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md 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/ArrayLiteralNode.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/ArrayValue.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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanValue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFix.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFixContext.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompileResult.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md 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/ConstStatementNode.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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md 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/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/DocPropTagNode.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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md 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/EnumValue.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/FilePos.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/FunctionParameterBase.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/IndeterminateEntity.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InsertTextCodeFixEdit.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 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md 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/LinterResolvedDefinition.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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md 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/MixedFunctionParameter.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedParameterConstraint.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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md 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/NullValue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Numeric.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/NumericValue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralPropertyNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralSpreadPropertyNode.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/ObjectValue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValuePropertyDescriptor.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/PackageFlags.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/PatternData.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PositionDetail.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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md 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/ProjectionScalarSelectorNode.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/ReplaceTextCodeFixEdit.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveCompilerOptionsOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedFile.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md 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/ScalarConstructor.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructorNode.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/ScalarValue.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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerLog.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SignatureFunctionParameter.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StateDef.md 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/StringTemplate.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringValue.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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md 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/TypeOfExpressionNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md 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 create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md 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/VoidKeywordNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md index 00430970aff..d937506ac8b 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md @@ -27,6 +27,8 @@ const $lib: TypeSpecLibrary; | `invalid-default.default` | `CallableMessage`<[`"type"`]\> | ... | | `invalid-format` | `object` | ... | | `invalid-format.default` | `CallableMessage`<[`"value"`, `"paramType"`]\> | ... | +| `invalid-model-property` | `object` | ... | +| `invalid-model-property.default` | `CallableMessage`<[`"type"`]\> | ... | | `invalid-schema` | `object` | ... | | `invalid-schema.default` | `CallableMessage`<[`"type"`]\> | ... | | `invalid-server-variable` | `object` | ... | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md new file mode 100644 index 00000000000..1f986a6d7bc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $externRef" + +--- +```ts +function $externRef( + ctx, + target, + path, + name): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `ctx` | `DecoratorContext` | +| `target` | `Model` | +| `path` | `StringLiteral` | +| `name` | `StringLiteral` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md new file mode 100644 index 00000000000..126640d9cde --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $field" + +--- +```ts +function $field( + context, + target, + index): void +``` + +Decorate a model property with a field index. Field indices are required for all fields of emitted messages. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | `DecoratorContext` | - | +| `target` | `ModelProperty` | | +| `index` | `number` | - | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md new file mode 100644 index 00000000000..ec6b2c1dc43 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $message" + +--- +```ts +function $message(context, target): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Type` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md new file mode 100644 index 00000000000..fe68dd6fb38 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] $onEmit" + +--- +```ts +function $onEmit(ctx): Promise +``` + +Emitter main function. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `ctx` | `EmitContext`<`ProtobufEmitterOptions`\> | + +## Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md new file mode 100644 index 00000000000..dcb28874748 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] $onValidate" + +--- +```ts +function $onValidate(program): Promise +``` + +Validation function + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | + +## Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md new file mode 100644 index 00000000000..58b621f3ab8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $package" + +--- +```ts +function $package( + context, + target, + details?): void +``` + +Declare a Protobuf package. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | `DecoratorContext` | - | +| `target` | `Namespace` | target decorator namespace | +| `details`? | `Type` | - | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md new file mode 100644 index 00000000000..7f2f6380140 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $reserve" + +--- +```ts +function $reserve( + context, + target, ... + reservations): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Type` | +| ...`reservations` | `unknown`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md new file mode 100644 index 00000000000..1cf0977d94f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] $service" + +--- +```ts +function $service(ctx, target): void +``` + +Decorate an interface as a service, indicating that it represents a Protobuf `service` declaration. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `ctx` | `DecoratorContext` | decorator context | +| `target` | `Interface` | the decorated interface | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md new file mode 100644 index 00000000000..c5f5b6d0e1d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $stream" + +--- +```ts +function $stream( + context, + target, + mode): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Operation` | +| `mode` | `Type` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md new file mode 100644 index 00000000000..0cc93686044 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] isMap" + +--- +```ts +function isMap(program, m): boolean +``` + +Determines whether a type represents a Protobuf map. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | `Program` | the program context | +| `m` | `Type` | the type to test | + +## 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/reference/js-api/classes/DuplicateTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md new file mode 100644 index 00000000000..1307f1548f7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md @@ -0,0 +1,66 @@ +--- +jsApi: true +title: "[C] DuplicateTracker" + +--- +Helper class to track duplicate instance + +## Type parameters + +| Type parameter | +| :------ | +| `K` | +| `V` | + +## Constructors + +### new DuplicateTracker() + +```ts +new DuplicateTracker(): DuplicateTracker +``` + +#### Returns + +[`DuplicateTracker`](DuplicateTracker.md)<`K`, `V`\> + +## Properties + +| Property | Modifier | Type | Default value | +| :------ | :------ | :------ | :------ | +| `#entries` | `private` | `Map`<`K`, `V`[]\> | `...` | + +## Methods + +### entries() + +```ts +entries(): Iterable<[K, V[]]> +``` + +Return iterator of all the duplicate entries. + +#### Returns + +`Iterable`<[`K`, `V`[]]\> + +*** + +### track() + +```ts +track(k, v): void +``` + +Track usage of K. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `k` | `K` | key that is being checked for duplicate. | +| `v` | `V` | value that map to the key | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md new file mode 100644 index 00000000000..38800630829 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md @@ -0,0 +1,78 @@ +--- +jsApi: true +title: "[C] EventEmitter" + +--- +## Type parameters + +| Type parameter | +| :------ | +| `T` *extends* `object` | + +## Constructors + +### new EventEmitter() + +```ts +new EventEmitter(): EventEmitter +``` + +#### Returns + +[`EventEmitter`](EventEmitter.md)<`T`\> + +## Properties + +| Property | Modifier | Type | Default value | +| :------ | :------ | :------ | :------ | +| `listeners` | `private` | `Map` `any`[]\> | `...` | + +## Methods + +### emit() + +```ts +emit(name, ...args): void +``` + +#### Type parameters + +| Type parameter | +| :------ | +| `K` *extends* `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `K` | +| ...`args` | `Parameters`<`T`\[`K`\]\> | + +#### Returns + +`void` + +*** + +### on() + +```ts +on(name, listener): void +``` + +#### Type parameters + +| Type parameter | +| :------ | +| `K` *extends* `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `K` | +| `listener` | (...`args`) => `any` | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md new file mode 100644 index 00000000000..a90ce7a8bd9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md @@ -0,0 +1,68 @@ +--- +jsApi: true +title: "[C] ProjectionError" + +--- +Represents a failure while interpreting a projection. + +## Extends + +- `Error` + +## Constructors + +### new ProjectionError() + +```ts +new ProjectionError(message): ProjectionError +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `message` | `string` | + +#### Returns + +[`ProjectionError`](ProjectionError.md) + +#### Overrides + +`Error.constructor` + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `cause?` | `public` | `unknown` | - | `Error.cause` | +| `message` | `public` | `string` | - | `Error.message` | +| `name` | `public` | `string` | - | `Error.name` | +| `stack?` | `public` | `string` | - | `Error.stack` | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` |

Optional override for formatting stack traces

**See**

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

| `Error.prepareStackTrace` | +| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md new file mode 100644 index 00000000000..4f22f2b0e99 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md @@ -0,0 +1,77 @@ +--- +jsApi: true +title: "[C] Queue" + +--- +## Type parameters + +| Type parameter | +| :------ | +| `T` | + +## Constructors + +### new Queue() + +```ts +new Queue(elements?): Queue +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `elements`? | `T`[] | + +#### Returns + +[`Queue`](Queue.md)<`T`\> + +## Properties + +| Property | Modifier | Type | Default value | +| :------ | :------ | :------ | :------ | +| `#elements` | `private` | `T`[] | `undefined` | +| `#headIndex` | `private` | `number` | `0` | + +## Methods + +### dequeue() + +```ts +dequeue(): T +``` + +#### Returns + +`T` + +*** + +### enqueue() + +```ts +enqueue(...items): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| ...`items` | `T`[] | + +#### Returns + +`void` + +*** + +### isEmpty() + +```ts +isEmpty(): boolean +``` + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md new file mode 100644 index 00000000000..535e5d430ed --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md @@ -0,0 +1,68 @@ +--- +jsApi: true +title: "[C] ResolveModuleError" + +--- +## Extends + +- `Error` + +## Constructors + +### new ResolveModuleError() + +```ts +new ResolveModuleError(code, message): ResolveModuleError +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `code` | `ResolveModuleErrorCode` | +| `message` | `string` | + +#### Returns + +[`ResolveModuleError`](ResolveModuleError.md) + +#### Overrides + +`Error.constructor` + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `cause?` | `public` | `unknown` | - | `Error.cause` | +| `code` | `public` | `ResolveModuleErrorCode` | - | - | +| `message` | `public` | `string` | - | `Error.message` | +| `name` | `public` | `string` | - | `Error.name` | +| `stack?` | `public` | `string` | - | `Error.stack` | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` |

Optional override for formatting stack traces

**See**

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

| `Error.prepareStackTrace` | +| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | + +## Methods + +### captureStackTrace() + +```ts +static captureStackTrace(targetObject, constructorOpt?): void +``` + +Create .stack property on a target object + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt`? | `Function` | + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md new file mode 100644 index 00000000000..f3d2b91ff1c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[E] IdentifierKind" + +--- +## Enumeration Members + +| Enumeration Member | Value | +| :------ | :------ | +| `Declaration` | `5` | +| `Decorator` | `2` | +| `Function` | `3` | +| `ModelExpressionProperty` | `6` | +| `ModelStatementProperty` | `7` | +| `ObjectLiteralProperty` | `8` | +| `Other` | `9` | +| `TemplateArgument` | `1` | +| `TypeReference` | `0` | +| `Using` | `4` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md new file mode 100644 index 00000000000..428237836b4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ListenerFlow.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[E] ListenerFlow" + +--- +## Enumeration Members + +| Enumeration Member | Value | Description | +| :------ | :------ | :------ | +| `NoRecursion` | `1` | Do not navigate any containing or referenced type. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md new file mode 100644 index 00000000000..cf0eb278a60 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/ModifierFlags.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[E] ModifierFlags" + +--- +## Enumeration Members + +| Enumeration Member | Value | +| :------ | :------ | +| `Extern` | `2` | +| `None` | `0` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md new file mode 100644 index 00000000000..f691f8e9ebd --- /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 + +| Enumeration Member | Value | Description | +| :------ | :------ | :------ | +| `DescendantErrorsExamined` | `1` |

If this is set, the DescendantHasError bit can be trusted. If this not set, children need to be visited still to see if DescendantHasError should be set.

Use the parser's `hasParseError` API instead of using this flag directly.

| +| `DescendantHasError` | `4` |

Indicates that a child of this node (or one of its children, transitively) has a parse error.

Use the parser's `hasParseError` API instead of using this flag directly.

| +| `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 00000000000..a75f252552f --- /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 + +| Enumeration 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 00000000000..95a9e3e310b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SymbolFlags.md @@ -0,0 +1,39 @@ +--- +jsApi: true +title: "[E] SymbolFlags" + +--- +## Enumeration Members + +| Enumeration Member | Value | Description | +| :------ | :------ | :------ | +| `Alias` | `2048` | - | +| `Const` | `16777216` | - | +| `Declaration` | `4194304` | - | +| `Decorator` | `16384` | - | +| `DuplicateUsing` | `1048576` | - | +| `Enum` | `32` | - | +| `EnumMember` | `64` | - | +| `ExportContainer` | `2101248` | - | +| `Function` | `131072` | - | +| `FunctionParameter` | `262144` | - | +| `Implementation` | `8388608` | - | +| `Interface` | `128` | - | +| `InterfaceMember` | `256` | - | +| `LateBound` | `67108864` | A symbol which was late-bound, in which case, the type referred to by this symbol is stored directly in the symbol. | +| `Member` | `33555780` | - | +| `MemberContainer` | `682` | 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` | - | +| `ScalarMember` | `33554432` | - | +| `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 00000000000..716e2841e8a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md @@ -0,0 +1,113 @@ +--- +jsApi: true +title: "[E] SyntaxKind" + +--- +AST types + +## Enumeration Members + +| Enumeration Member | Value | Description | +| :------ | :------ | :------ | +| `AliasStatement` | `24` | - | +| `ArrayExpression` | `31` | - | +| `ArrayLiteral` | `97` | - | +| `AugmentDecoratorStatement` | `4` | - | +| `BlockComment` | `51` | - | +| `BooleanLiteral` | `34` | - | +| `CadlScript` | `0` |

**Deprecated**

Use TypeSpecScript

| +| `CallExpression` | `99` | - | +| `ConstStatement` | `98` | - | +| `DecoratorDeclarationStatement` | `25` | - | +| `DecoratorExpression` | `5` | - | +| `DirectiveExpression` | `6` | - | +| `Doc` | `52` | - | +| `DocErrorsTag` | `57` | - | +| `DocParamTag` | `54` | - | +| `DocPropTag` | `55` | - | +| `DocReturnsTag` | `56` | - | +| `DocTemplateTag` | `58` | - | +| `DocText` | `53` | - | +| `DocUnknownTag` | `59` | - | +| `EmptyStatement` | `48` | - | +| `EnumMember` | `22` | - | +| `EnumSpreadMember` | `23` | - | +| `EnumStatement` | `21` | - | +| `ExternKeyword` | `40` | - | +| `FunctionDeclarationStatement` | `26` | - | +| `FunctionParameter` | `27` | - | +| `Identifier` | `3` | - | +| `ImportStatement` | `2` | - | +| `InterfaceStatement` | `18` | - | +| `IntersectionExpression` | `29` | - | +| `InvalidStatement` | `49` | - | +| `JsNamespaceDeclaration` | `91` | - | +| `JsSourceFile` | `1` | - | +| `LineComment` | `50` | - | +| `MemberExpression` | `7` | - | +| `ModelExpression` | `14` | - | +| `ModelProperty` | `15` | - | +| `ModelSpreadProperty` | `16` | - | +| `ModelStatement` | `13` | - | +| `NamespaceStatement` | `8` | - | +| `NeverKeyword` | `42` | - | +| `NumericLiteral` | `33` | - | +| `ObjectLiteral` | `94` | - | +| `ObjectLiteralProperty` | `95` | - | +| `ObjectLiteralSpreadProperty` | `96` | - | +| `OperationSignatureDeclaration` | `11` | - | +| `OperationSignatureReference` | `12` | - | +| `OperationStatement` | `10` | - | +| `Projection` | `60` | - | +| `ProjectionArithmeticExpression` | `79` | - | +| `ProjectionBlockExpression` | `73` | - | +| `ProjectionCallExpression` | `80` | - | +| `ProjectionDecoratorReferenceExpression` | `89` | - | +| `ProjectionEnumMemberSelector` | `70` | - | +| `ProjectionEnumSelector` | `69` | - | +| `ProjectionEqualityExpression` | `76` | - | +| `ProjectionExpressionStatement` | `71` | - | +| `ProjectionIfExpression` | `72` | - | +| `ProjectionInterfaceSelector` | `68` | - | +| `ProjectionLambdaExpression` | `81` | - | +| `ProjectionLambdaParameterDeclaration` | `82` | - | +| `ProjectionLogicalExpression` | `75` | - | +| `ProjectionMemberExpression` | `74` | - | +| `ProjectionModelExpression` | `83` | - | +| `ProjectionModelProperty` | `84` | - | +| `ProjectionModelPropertySelector` | `63` | - | +| `ProjectionModelSelector` | `62` | - | +| `ProjectionModelSpreadProperty` | `85` | - | +| `ProjectionOperationSelector` | `65` | - | +| `ProjectionParameterDeclaration` | `61` | - | +| `ProjectionReference` | `46` | - | +| `ProjectionRelationalExpression` | `78` | - | +| `ProjectionScalarSelector` | `64` | - | +| `ProjectionSpreadProperty` | `86` | - | +| `ProjectionStatement` | `88` | - | +| `ProjectionTupleExpression` | `87` | - | +| `ProjectionUnaryExpression` | `77` | - | +| `ProjectionUnionSelector` | `66` | - | +| `ProjectionUnionVariantSelector` | `67` | - | +| `Return` | `90` | - | +| `ScalarConstructor` | `100` | - | +| `ScalarStatement` | `17` | - | +| `StringLiteral` | `32` | - | +| `StringTemplateExpression` | `35` | - | +| `StringTemplateHead` | `36` | - | +| `StringTemplateMiddle` | `37` | - | +| `StringTemplateSpan` | `39` | - | +| `StringTemplateTail` | `38` | - | +| `TemplateArgument` | `92` | - | +| `TemplateParameterDeclaration` | `47` | - | +| `TupleExpression` | `30` | - | +| `TypeOfExpression` | `93` | - | +| `TypeReference` | `45` | - | +| `TypeSpecScript` | `0` | - | +| `UnionExpression` | `28` | - | +| `UnionStatement` | `19` | - | +| `UnionVariant` | `20` | - | +| `UnknownKeyword` | `43` | - | +| `UsingStatement` | `9` | - | +| `ValueOfExpression` | `44` | - | +| `VoidKeyword` | `41` | - | 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 00000000000..e57e8cd1084 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md @@ -0,0 +1,89 @@ +--- +jsApi: true +title: "[E] Token" + +--- +## Enumeration Members + +| Enumeration Member | Value | +| :------ | :------ | +| `AliasKeyword` | `59` | +| `Ampersand` | `30` | +| `AmpsersandAmpersand` | `47` | +| `At` | `35` | +| `AtAt` | `36` | +| `Bar` | `31` | +| `BarBar` | `48` | +| `CloseBrace` | `18` | +| `CloseBracket` | `22` | +| `CloseParen` | `20` | +| `Colon` | `33` | +| `ColonColon` | `34` | +| `Comma` | `26` | +| `ConflictMarker` | `13` | +| `ConstKeyword` | `68` | +| `DecKeyword` | `66` | +| `DocCodeFenceDelimiter` | `16` | +| `DocCodeSpan` | `15` | +| `DocText` | `14` | +| `Dot` | `23` | +| `Ellipsis` | `24` | +| `ElseKeyword` | `64` | +| `EndOfFile` | `2` | +| `EnumKeyword` | `58` | +| `Equals` | `29` | +| `EqualsEquals` | `49` | +| `EqualsGreaterThan` | `51` | +| `Exclamation` | `44` | +| `ExclamationEquals` | `50` | +| `ExtendsKeyword` | `71` | +| `ExternKeyword` | `70` | +| `FalseKeyword` | `73` | +| `FnKeyword` | `67` | +| `ForwardSlash` | `41` | +| `GreaterThan` | `28` | +| `GreaterThanEquals` | `46` | +| `Hash` | `37` | +| `HashBrace` | `38` | +| `HashBracket` | `39` | +| `Hyphen` | `43` | +| `Identifier` | `3` | +| `IfKeyword` | `65` | +| `ImportKeyword` | `52` | +| `InitKeyword` | `69` | +| `InterfaceKeyword` | `61` | +| `Invalid` | `1` | +| `IsKeyword` | `60` | +| `LessThan` | `27` | +| `LessThanEquals` | `45` | +| `ModelKeyword` | `53` | +| `MultiLineComment` | `10` | +| `NamespaceKeyword` | `55` | +| `NeverKeyword` | `76` | +| `NewLine` | `11` | +| `None` | `0` | +| `NumericLiteral` | `4` | +| `OpKeyword` | `57` | +| `OpenBrace` | `17` | +| `OpenBracket` | `21` | +| `OpenParen` | `19` | +| `Plus` | `42` | +| `ProjectionKeyword` | `63` | +| `Question` | `32` | +| `ReturnKeyword` | `74` | +| `ScalarKeyword` | `54` | +| `Semicolon` | `25` | +| `SingleLineComment` | `9` | +| `Star` | `40` | +| `StringLiteral` | `5` | +| `StringTemplateHead` | `6` | +| `StringTemplateMiddle` | `7` | +| `StringTemplateTail` | `8` | +| `TrueKeyword` | `72` | +| `TypeOfKeyword` | `79` | +| `UnionKeyword` | `62` | +| `UnknownKeyword` | `77` | +| `UsingKeyword` | `56` | +| `ValueOfKeyword` | `78` | +| `VoidKeyword` | `75` | +| `Whitespace` | `12` | 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 00000000000..6efba971af2 --- /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 + +| Enumeration 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/enumerations/UsageFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md new file mode 100644 index 00000000000..4e8a9584229 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/UsageFlags.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[E] UsageFlags" + +--- +## Enumeration Members + +| Enumeration Member | Value | +| :------ | :------ | +| `Input` | `2` | +| `None` | `0` | +| `Output` | `4` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md new file mode 100644 index 00000000000..a725191bfba --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md @@ -0,0 +1,31 @@ +--- +jsApi: true +title: "[F] $deprecated" + +--- +```ts +function $deprecated( + context, + target, + message): void +``` + +Mark a type as deprecated + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | +| `target` | [`Type`](../type-aliases/Type.md) | Decorator target | +| `message` | `string` | Deprecation target. | + +## Returns + +`void` + +## Example + +``` @deprecated("Foo is deprecated, use Bar instead.") + model Foo {} +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md new file mode 100644 index 00000000000..aaab5228979 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $discriminator" + +--- +```ts +function $discriminator( + context, + target, + propertyName): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md) | +| `propertyName` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md new file mode 100644 index 00000000000..0f11022108b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md @@ -0,0 +1,40 @@ +--- +jsApi: true +title: "[F] $doc" + +--- +```ts +function $doc( + context, + target, + doc, + formatArgs?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.md) | +| `doc` | `string` | +| `formatArgs`? | [`Type`](../type-aliases/Type.md) | + +## Returns + +`void` + +## Doc + +attaches a documentation string. Works great with multi-line string literals. + +The first argument to + +## Doc + +is a string, which may contain template parameters, enclosed in braces, +which are replaced with an attribute for the type (commonly "name") passed as the second (optional) argument. + +## Doc + +can be specified on any language element -- a model, an operation, a namespace, etc. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md new file mode 100644 index 00000000000..8756de5726b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $encode" + +--- +```ts +function $encode( + context, + target, + encoding, + encodedAs?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `encoding` | [`Type`](../type-aliases/Type.md) | +| `encodedAs`? | [`Scalar`](../interfaces/Scalar.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md new file mode 100644 index 00000000000..b3fb8d69708 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $encodedName" + +--- +```ts +function $encodedName( + context, + target, + mimeType, + name): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.md) | +| `mimeType` | `string` | +| `name` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md new file mode 100644 index 00000000000..a1ebf827dec --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[F] $error" + +--- +```ts +function $error(context, target): void +``` + +`@error` decorator marks a model as an error type. + Any derived models (using extends) will also be seen as error types. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md new file mode 100644 index 00000000000..1127000903e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $errorsDoc" + +--- +```ts +function $errorsDoc( + context, + target, + doc): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | +| `doc` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md new file mode 100644 index 00000000000..c08e80927dc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md @@ -0,0 +1,35 @@ +--- +jsApi: true +title: "[F] $format" + +--- +```ts +function $format( + context, + target, + format): void +``` + +`@format` - specify the data format hint for a string type + +The first argument is a string that identifies the format that the string type expects. Any string +can be entered here, but a TypeSpec emitter must know how to interpret + +For TypeSpec specs that will be used with an OpenAPI emitter, the OpenAPI specification describes possible +valid values for a string type's format: + +https://github.com/OAI/OpenAPI-Specification/blob/3.0.3/versions/3.0.3.md#dataTypes + +`@format` can be specified on a type that extends from `string` or a `string`-typed model property. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../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 00000000000..76c89ed3a24 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $friendlyName" + +--- +```ts +function $friendlyName( + context, + target, + name, + formatArgs?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.md) | +| `name` | `string` | +| `formatArgs`? | [`Type`](../type-aliases/Type.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md new file mode 100644 index 00000000000..2b3348e1651 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $inspectType" + +--- +```ts +function $inspectType( + context, + target, + text): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.md) | +| `text` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md new file mode 100644 index 00000000000..9065d9e9698 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $inspectTypeName" + +--- +```ts +function $inspectTypeName( + context, + target, + text): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.md) | +| `text` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md new file mode 100644 index 00000000000..62aaff926c2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[F] $key" + +--- +```ts +function $key( + context, + target, + altName?): void +``` + +`@key` - mark a model property as the key to identify instances of that type + +The optional first argument accepts an alternate key name which may be used by emitters. +Otherwise, the name of the target property will be used. + +`@key` can only be applied to model properties. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) | +| `altName`? | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md new file mode 100644 index 00000000000..ee7f754fc15 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[F] $knownValues" + +--- +```ts +function $knownValues( + context, + target, + knownValues): void +``` + +`@knownValues` marks a string type with an enum that contains all known values + +The first parameter is a reference to an enum type that describes all possible values that the +type accepts. + +`@knownValues` can only be applied to model types that extend `string`. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | - | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | Decorator target. Must be a string. (model Foo extends string) | +| `knownValues` | [`Enum`](../interfaces/Enum.md) | Must be an enum. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md new file mode 100644 index 00000000000..d71be9ead3c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] $list" + +--- +```ts +function $list( + context, + target, + listedType?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | +| `listedType`? | [`Model`](../interfaces/Model.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/functions/$maxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md new file mode 100644 index 00000000000..266e539dfdd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $maxItems" + +--- +```ts +function $maxItems( + context, + target, + value): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md new file mode 100644 index 00000000000..9b237d7e3d1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $maxLength" + +--- +```ts +function $maxLength( + context, + target, + value): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md new file mode 100644 index 00000000000..9d001e6f54d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $maxValue" + +--- +```ts +function $maxValue( + context, + target, + value): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md new file mode 100644 index 00000000000..840786780cc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $maxValueExclusive" + +--- +```ts +function $maxValueExclusive( + context, + target, + value): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md new file mode 100644 index 00000000000..ea4a0f84149 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $minItems" + +--- +```ts +function $minItems( + context, + target, + value): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md new file mode 100644 index 00000000000..19353213d39 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $minLength" + +--- +```ts +function $minLength( + context, + target, + value): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md new file mode 100644 index 00000000000..c860e955eb7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $minValue" + +--- +```ts +function $minValue( + context, + target, + value): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md new file mode 100644 index 00000000000..6a0945c0777 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $minValueExclusive" + +--- +```ts +function $minValueExclusive( + context, + target, + value): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md new file mode 100644 index 00000000000..91956d7f737 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $overload" + +--- +```ts +function $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) | - | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md new file mode 100644 index 00000000000..cd4457272a4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $parameterVisibility" + +--- +```ts +function $parameterVisibility( + context, + target, ... + visibilities): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | +| ...`visibilities` | `string`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md new file mode 100644 index 00000000000..fc989abe468 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $pattern" + +--- +```ts +function $pattern( + context, + target, + pattern, + validationMessage?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `pattern` | `string` | +| `validationMessage`? | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md new file mode 100644 index 00000000000..6cf7d2484cd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] $projectedName" + +--- +```ts +function $projectedName( + context, + target, + targetName, + projectedName): void +``` + +`@projectedName` - Indicate that this entity should be renamed according to the given projection. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | +| `target` | [`Type`](../type-aliases/Type.md) | The that should have a different name. | +| `targetName` | `string` | - | +| `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 00000000000..64a2afca0cd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $returnTypeVisibility" + +--- +```ts +function $returnTypeVisibility( + context, + target, ... + visibilities): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | +| ...`visibilities` | `string`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md new file mode 100644 index 00000000000..b9412fcf6c2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $returnsDoc" + +--- +```ts +function $returnsDoc( + context, + target, + doc): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | +| `doc` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md new file mode 100644 index 00000000000..1f9d26907e9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] $secret" + +--- +```ts +function $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. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md new file mode 100644 index 00000000000..5308f57e9fa --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $service" + +--- +```ts +function $service( + context, + target, + options?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Namespace`](../interfaces/Namespace.md) | +| `options`? | [`Type`](../type-aliases/Type.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md new file mode 100644 index 00000000000..73d18a00587 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md @@ -0,0 +1,39 @@ +--- +jsApi: true +title: "[F] $summary" + +--- +```ts +function $summary( + context, + target, + summary): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Type`](../type-aliases/Type.md) | +| `summary` | `string` | + +## Returns + +`void` + +## Summary + +attaches a documentation string. It is typically used to give a short, single-line +description, and can be used in combination with or instead of @doc. + +The first argument to + +## Summary + +is a string, which may contain template parameters, enclosed in braces, +which are replaced with an attribute for the type (commonly "name") passed as the second (optional) argument. + +## Summary + +can be specified on any language element -- a model, an operation, a namespace, etc. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md new file mode 100644 index 00000000000..681fed85706 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $tag" + +--- +```ts +function $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` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md new file mode 100644 index 00000000000..0b8e7576717 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $visibility" + +--- +```ts +function $visibility( + context, + target, ... + visibilities): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) | +| ...`visibilities` | `string`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md new file mode 100644 index 00000000000..2b4e6c816d9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $withDefaultKeyVisibility" + +--- +```ts +function $withDefaultKeyVisibility( + context, + target, + visibility): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) | +| `visibility` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md new file mode 100644 index 00000000000..59f56917d99 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $withOptionalProperties" + +--- +```ts +function $withOptionalProperties(context, target): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withPickedProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withPickedProperties.md new file mode 100644 index 00000000000..616e7b834dc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withPickedProperties.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $withPickedProperties" + +--- +```ts +function $withPickedProperties( + context, + target, + pick): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) | +| `pick` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md new file mode 100644 index 00000000000..ce061b22b23 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $withUpdateableProperties" + +--- +```ts +function $withUpdateableProperties(context, target): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md new file mode 100644 index 00000000000..48b2b8f4f7a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $withVisibility" + +--- +```ts +function $withVisibility( + context, + target, ... + visibilities): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) | +| ...`visibilities` | `string`[] | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md new file mode 100644 index 00000000000..d9a8d639e16 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $withoutDefaultValues" + +--- +```ts +function $withoutDefaultValues(context, target): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md new file mode 100644 index 00000000000..6a3f1ec3366 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $withoutOmittedProperties" + +--- +```ts +function $withoutOmittedProperties( + context, + target, + omit): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `target` | [`Model`](../interfaces/Model.md) | +| `omit` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/Numeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/Numeric.md new file mode 100644 index 00000000000..038d5dd13cf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/Numeric.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] Numeric" + +--- +```ts +function Numeric(stringValue): Numeric +``` + +Represent any possible numeric value + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `stringValue` | `string` | + +## Returns + +[`Numeric`](../interfaces/Numeric.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 00000000000..415c603e49a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] addService" + +--- +```ts +function 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 | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md new file mode 100644 index 00000000000..4a93d6ae218 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[F] assertType" + +--- +```ts +function assertType( + typeDescription, + t, ... + kinds): asserts t is Type & Object +``` + +Assert that the input type has one of the kinds provided + +## Type parameters + +| Type parameter | +| :------ | +| `TKind` *extends* ( + \| `"Boolean"` + \| `"Decorator"` + \| `"Enum"` + \| `"EnumMember"` + \| `"FunctionParameter"` + \| `"Function"` + \| `"Interface"` + \| `"Intrinsic"` + \| `"Model"` + \| `"ModelProperty"` + \| `"Namespace"` + \| `"Number"` + \| `"Object"` + \| `"Operation"` + \| `"Projection"` + \| `"Scalar"` + \| `"ScalarConstructor"` + \| `"String"` + \| `"StringTemplate"` + \| `"StringTemplateSpan"` + \| `"TemplateParameter"` + \| `"Tuple"` + \| `"Union"` + \| `"UnionVariant"`)[] | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeDescription` | `string` | +| `t` | [`Type`](../type-aliases/Type.md) | +| ...`kinds` | `TKind` | + +## Returns + +`asserts t is Type & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md new file mode 100644 index 00000000000..7a1ccff9da8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[F] cadlTypeToJson" + +--- +```ts +function cadlTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] +``` + +## Type parameters + +| Type parameter | +| :------ | +| `T` | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `typespecType` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | +| `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | + +## Returns + +[`T` \| `undefined`, [`Diagnostic`](../interfaces/Diagnostic.md)[]] + +## Deprecated + +use typespecTypeToJson diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md new file mode 100644 index 00000000000..90395ee2752 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] checkFormatCadl" + +--- +```ts +function checkFormatCadl(code, prettierConfig?): Promise +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `code` | `string` | +| `prettierConfig`? | `Options` | + +## Returns + +`Promise`<`boolean`\> + +## Deprecated + +use checkFormatTypeSpec diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md new file mode 100644 index 00000000000..cc13d8aa943 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] checkFormatTypeSpec" + +--- +```ts +function checkFormatTypeSpec(code, prettierConfig?): Promise +``` + +Check the given is correctly formatted. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `code` | `string` | +| `prettierConfig`? | `Options` | + +## Returns + +`Promise`<`boolean`\> + +true if code is formatted correctly. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md new file mode 100644 index 00000000000..92ee6a7bd44 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] compile" + +--- +```ts +function 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) | + +## Returns + +`Promise`<[`Program`](../interfaces/Program.md)\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md new file mode 100644 index 00000000000..3cc1923e278 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[F] compilerAssert" + +--- +```ts +function compilerAssert( + condition, + message, + target?): asserts condition +``` + +Use this to report bugs in the compiler, and not errors in the source code +being compiled. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `condition` | `any` | Throw if this is not true. | +| `message` | `string` | Error message. | +| `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) |

Optional location in source code that might give a clue about

what got the compiler off track.

| + +## Returns + +`asserts condition` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md new file mode 100644 index 00000000000..2c78196520b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[F] createCadlLibrary" + +--- +```ts +function createCadlLibrary(lib): TypeSpecLibrary +``` + +## Type parameters + +| Type parameter | Value | +| :------ | :------ | +| `T` *extends* `object` | - | +| `E` *extends* `Record`<`string`, `any`\> | - | +| `State` *extends* `string` | `never` | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `lib` | `Readonly`<[`TypeSpecLibraryDef`](../interfaces/TypeSpecLibraryDef.md)<`T`, `E`, `State`\>\> | + +## Returns + +[`TypeSpecLibrary`](../interfaces/TypeSpecLibrary.md)<`T`, `E`, `State`\> + +## Deprecated + +use createTypeSpecLibrary diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md new file mode 100644 index 00000000000..2f0f0831729 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] createChecker" + +--- +```ts +function createChecker(program): Checker +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | + +## Returns + +[`Checker`](../interfaces/Checker.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md new file mode 100644 index 00000000000..a16bc33c8ab --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[F] createDecoratorDefinition" + +--- +```ts +function createDecoratorDefinition(definition): DecoratorValidator +``` + +## Type parameters + +| Type parameter | +| :------ | +| `T` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | +| `P` *extends* readonly [`DecoratorParamDefinition`](../interfaces/DecoratorParamDefinition.md)<[`TypeKind`](../type-aliases/TypeKind.md)\>[] | +| `S` *extends* `undefined` \| [`DecoratorParamDefinition`](../interfaces/DecoratorParamDefinition.md)<[`TypeKind`](../type-aliases/TypeKind.md)\> | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `definition` | [`DecoratorDefinition`](../interfaces/DecoratorDefinition.md)<`T`, `P`, `S`\> | + +## Returns + +[`DecoratorValidator`](../interfaces/DecoratorValidator.md)<`T`, `P`, `S`\> + +## Deprecated + +use extern dec definition in TypeSpec instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md new file mode 100644 index 00000000000..7970bff1988 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] createDiagnosticCollector" + +--- +```ts +function createDiagnosticCollector(): DiagnosticCollector +``` + +Create a new instance of the + +## Returns + +[`DiagnosticCollector`](../interfaces/DiagnosticCollector.md) + +## See + +DiagnosticCollector. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md new file mode 100644 index 00000000000..cd030131a35 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] createProjectedNameProgram" + +--- +```ts +function createProjectedNameProgram(program, target): ProjectedNameView +``` + +Create an helper to manager project names. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | `string` | Name of the projected name target(e.g. json, csharp, etc.) | + +## Returns + +[`ProjectedNameView`](../interfaces/ProjectedNameView.md) + +ProjectedNameView diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md new file mode 100644 index 00000000000..4be68f01f82 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] createRekeyableMap" + +--- +```ts +function createRekeyableMap(entries?): RekeyableMap +``` + +## Type parameters + +| Type parameter | +| :------ | +| `K` | +| `V` | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `entries`? | [`K`, `V`][] | + +## Returns + +`RekeyableMap`<`K`, `V`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md new file mode 100644 index 00000000000..cbc62e70914 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] createRule" + +--- +```ts +function createRule(definition): LinterRuleDefinition +``` + +Create a new linter rule. + +## Type parameters + +| Type parameter | +| :------ | +| `N` *extends* `string` | +| `T` *extends* [`DiagnosticMessages`](../interfaces/DiagnosticMessages.md) | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `definition` | [`LinterRuleDefinition`](../interfaces/LinterRuleDefinition.md)<`N`, `T`\> | + +## Returns + +[`LinterRuleDefinition`](../interfaces/LinterRuleDefinition.md)<`N`, `T`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md new file mode 100644 index 00000000000..32df624cbfa --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] createScanner" + +--- +```ts +function createScanner(source, diagnosticHandler): Scanner +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `source` | `string` \| [`SourceFile`](../interfaces/SourceFile.md) | +| `diagnosticHandler` | [`DiagnosticHandler`](../type-aliases/DiagnosticHandler.md) | + +## Returns + +[`Scanner`](../interfaces/Scanner.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md new file mode 100644 index 00000000000..4ee7171401a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] createServer" + +--- +```ts +function createServer(host): Server +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `host` | [`ServerHost`](../interfaces/ServerHost.md) | + +## Returns + +[`Server`](../interfaces/Server.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md new file mode 100644 index 00000000000..3510e5c258c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] createSourceFile" + +--- +```ts +function createSourceFile(text, path): SourceFile +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `text` | `string` | +| `path` | `string` | + +## Returns + +[`SourceFile`](../interfaces/SourceFile.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md new file mode 100644 index 00000000000..1eb7d5aa1d8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md @@ -0,0 +1,47 @@ +--- +jsApi: true +title: "[F] createTypeSpecLibrary" + +--- +```ts +function createTypeSpecLibrary(lib): TypeSpecLibrary +``` + +Create a new TypeSpec library definition. + +## Type parameters + +| Type parameter | Value | +| :------ | :------ | +| `T` *extends* `object` | - | +| `E` *extends* `Record`<`string`, `any`\> | - | +| `State` *extends* `string` | `never` | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `lib` | `Readonly`<[`TypeSpecLibraryDef`](../interfaces/TypeSpecLibraryDef.md)<`T`, `E`, `State`\>\> | Library definition. | + +## Returns + +[`TypeSpecLibrary`](../interfaces/TypeSpecLibrary.md)<`T`, `E`, `State`\> + +Library with utility functions. + +## Tutorial + +Create the lib object with `as const` to get the full typing. + +## Example + +```ts +const libDef = { + name: "myLib", + diagnostics: { + "my-code": {serverity: "error", messages: {default: "Foo bar"}} + }, +} as const; + +const lib = createTypeSpecLibrary(libDef); +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md new file mode 100644 index 00000000000..eaede79a3b3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] defineCodeFix" + +--- +```ts +function defineCodeFix(fix): CodeFix +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `fix` | [`CodeFix`](../interfaces/CodeFix.md) | + +## Returns + +[`CodeFix`](../interfaces/CodeFix.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md new file mode 100644 index 00000000000..ae1aa53c4d2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] defineLinter" + +--- +```ts +function defineLinter(def): LinterDefinition +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `def` | [`LinterDefinition`](../interfaces/LinterDefinition.md) | + +## Returns + +[`LinterDefinition`](../interfaces/LinterDefinition.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/definePackageFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/definePackageFlags.md new file mode 100644 index 00000000000..1d7b0e70f08 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/definePackageFlags.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] definePackageFlags" + +--- +```ts +function definePackageFlags(flags): PackageFlags +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `flags` | [`PackageFlags`](../interfaces/PackageFlags.md) | + +## Returns + +[`PackageFlags`](../interfaces/PackageFlags.md) 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 00000000000..c756a997a38 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] emitFile" + +--- +```ts +function 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 | + +## Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md new file mode 100644 index 00000000000..f5686ff142e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] ensureTrailingDirectorySeparator" + +--- +```ts +function ensureTrailingDirectorySeparator(path): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/explainStringTemplateNotSerializable.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/explainStringTemplateNotSerializable.md new file mode 100644 index 00000000000..41ff0e766ea --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/explainStringTemplateNotSerializable.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] explainStringTemplateNotSerializable" + +--- +```ts +function explainStringTemplateNotSerializable(stringTemplate): readonly Diagnostic[] +``` + +get a list of diagnostic explaining why this string template cannot be converted to a string. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `stringTemplate` | [`StringTemplate`](../interfaces/StringTemplate.md) | + +## Returns + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md new file mode 100644 index 00000000000..e10b9cd9624 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] exprIsBareIdentifier" + +--- +```ts +function exprIsBareIdentifier(expr): expr is TypeReferenceNode & Object +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `expr` | [`Expression`](../type-aliases/Expression.md) | + +## Returns + +`expr is TypeReferenceNode & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md new file mode 100644 index 00000000000..6a5edd01f43 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] filterModelProperties" + +--- +```ts +function filterModelProperties( + program, + model, + filter): Model +``` + +Applies a filter to the properties of a given type. If no properties +are filtered out, then return the input unchanged. Otherwise, return +a new anonymous model with only the filtered properties. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | - | +| `model` | [`Model`](../interfaces/Model.md) | The input model to filter. | +| `filter` | (`property`) => `boolean` | The filter to apply. Properties are kept when this returns true. | + +## Returns + +[`Model`](../interfaces/Model.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md new file mode 100644 index 00000000000..da2fbd9f0ee --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] finishTypeForProgram" + +--- +```ts +function finishTypeForProgram(program, typeDef): T +``` + +## Type parameters + +| Type parameter | +| :------ | +| `T` *extends* [`Type`](../type-aliases/Type.md) | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `typeDef` | `T` | + +## Returns + +`T` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md new file mode 100644 index 00000000000..87f5dc4a959 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] formatDiagnostic" + +--- +```ts +function formatDiagnostic(diagnostic): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostic` | [`Diagnostic`](../interfaces/Diagnostic.md) | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md new file mode 100644 index 00000000000..c4a9549ae48 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] formatIdentifier" + +--- +```ts +function formatIdentifier(sv): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `sv` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md new file mode 100644 index 00000000000..0faafa3f2e2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] formatTypeSpec" + +--- +```ts +function formatTypeSpec(code, prettierConfig?): Promise +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `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 00000000000..696e70645d6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getAllTags" + +--- +```ts +function getAllTags(program, target): string[] | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Interface`](../interfaces/Interface.md) \| [`Namespace`](../interfaces/Namespace.md) \| [`Operation`](../interfaces/Operation.md) | + +## Returns + +`string`[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md new file mode 100644 index 00000000000..db729975b86 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] getAnyExtensionFromPath" + +--- +```ts +function getAnyExtensionFromPath(path): string +``` + +Gets the file extension for a path. +Normalizes it to lower case. + +```ts +getAnyExtensionFromPath("/path/to/file.ext") === ".ext" +getAnyExtensionFromPath("/path/to/file.ext/") === ".ext" +getAnyExtensionFromPath("/path/to/file") === "" +getAnyExtensionFromPath("/path/to.ext/file") === "" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md new file mode 100644 index 00000000000..7a5f5fc4343 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md @@ -0,0 +1,46 @@ +--- +jsApi: true +title: "[F] getBaseFileName" + +--- +```ts +function getBaseFileName(path): string +``` + +Returns the path except for its containing directory name. +Semantics align with NodeJS's `path.basename` except that we support URL's as well. + +```ts +// POSIX +getBaseFileName("/path/to/file.ext") === "file.ext" +getBaseFileName("/path/to/") === "to" +getBaseFileName("/") === "" +// DOS +getBaseFileName("c:/path/to/file.ext") === "file.ext" +getBaseFileName("c:/path/to/") === "to" +getBaseFileName("c:/") === "" +getBaseFileName("c:") === "" +// URL +getBaseFileName("http://typescriptlang.org/path/to/file.ext") === "file.ext" +getBaseFileName("http://typescriptlang.org/path/to/") === "to" +getBaseFileName("http://typescriptlang.org/") === "" +getBaseFileName("http://typescriptlang.org") === "" +getBaseFileName("file://server/path/to/file.ext") === "file.ext" +getBaseFileName("file://server/path/to/") === "to" +getBaseFileName("file://server/") === "" +getBaseFileName("file://server") === "" +getBaseFileName("file:///path/to/file.ext") === "file.ext" +getBaseFileName("file:///path/to/") === "to" +getBaseFileName("file:///") === "" +getBaseFileName("file://") === "" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md new file mode 100644 index 00000000000..e6dd42af2e7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getDeprecated" + +--- +```ts +function getDeprecated(program, type): string | undefined +``` + +Return the deprecated message or undefined if not deprecated + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `type` | [`Type`](../type-aliases/Type.md) | Type | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md new file mode 100644 index 00000000000..dfe3afbb121 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getDeprecationDetails" + +--- +```ts +function getDeprecationDetails(program, typeOrNode): DeprecationDetails | undefined +``` + +Returns complete deprecation details for the given type or node + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `typeOrNode` | [`Type`](../type-aliases/Type.md) \| [`Node`](../type-aliases/Node.md) | A Type or Node to check for deprecation | + +## Returns + +[`DeprecationDetails`](../interfaces/DeprecationDetails.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md new file mode 100644 index 00000000000..c1bdae35248 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] getDirectoryPath" + +--- +```ts +function getDirectoryPath(path): string +``` + +## Parameters + +| 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 00000000000..931bfb788f6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] getDiscriminatedTypes" + +--- +```ts +function getDiscriminatedTypes(program): [Model | Union, Discriminator][] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | + +## Returns + +[[`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md), [`Discriminator`](../interfaces/Discriminator.md)][] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md new file mode 100644 index 00000000000..f8fa1bedef8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getDiscriminatedUnion" + +--- +```ts +function getDiscriminatedUnion(type, discriminator): [DiscriminatedUnion, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md) | +| `discriminator` | [`Discriminator`](../interfaces/Discriminator.md) | + +## Returns + +[[`DiscriminatedUnion`](../interfaces/DiscriminatedUnion.md), readonly [`Diagnostic`](../interfaces/Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md new file mode 100644 index 00000000000..7630d2496d0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getDiscriminator" + +--- +```ts +function getDiscriminator(program, entity): Discriminator | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `entity` | [`Type`](../type-aliases/Type.md) | + +## Returns + +[`Discriminator`](../interfaces/Discriminator.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md new file mode 100644 index 00000000000..a6790e8eb29 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getDoc" + +--- +```ts +function getDoc(program, target): string | undefined +``` + +Get the documentation string for the given type. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Type`](../type-aliases/Type.md) | Type | + +## Returns + +`string` \| `undefined` + +Documentation value diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md new file mode 100644 index 00000000000..e46fc2a953c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getDocData" + +--- +```ts +function getDocData(program, target): 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 | + +## Returns + +`DocData` \| `undefined` + +Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md new file mode 100644 index 00000000000..83eed921679 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md @@ -0,0 +1,34 @@ +--- +jsApi: true +title: "[F] getEffectiveModelType" + +--- +```ts +function getEffectiveModelType( + program, + model, + filter?): Model +``` + +If the input is anonymous (or the provided filter removes properties) +and there exists a named model with the same set of properties +(ignoring filtered properties), then return that named model. +Otherwise, return the input unchanged. + +This can be used by emitters to find a better name for a set of +properties after filtering. For example, given `{ @metadata prop: +string} & SomeName`, and an emitter that wishes to discard properties +marked with `@metadata`, the emitter can use this to recover that the +best name for the remaining properties is `SomeName`. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | - | +| `model` | [`Model`](../interfaces/Model.md) | The input model | +| `filter`? | (`property`) => `boolean` | An optional filter to apply to the input model's properties. | + +## Returns + +[`Model`](../interfaces/Model.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md new file mode 100644 index 00000000000..efd937febc5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getEncode" + +--- +```ts +function getEncode(program, target): EncodeData | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | + +## Returns + +[`EncodeData`](../interfaces/EncodeData.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEntityName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEntityName.md new file mode 100644 index 00000000000..02cf184174c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEntityName.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getEntityName" + +--- +```ts +function getEntityName(entity, options?): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `entity` | [`Entity`](../type-aliases/Entity.md) | +| `options`? | [`TypeNameOptions`](../interfaces/TypeNameOptions.md) | + +## Returns + +`string` 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 00000000000..2f928131124 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getErrorsDoc" + +--- +```ts +function 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 + +`string` \| `undefined` + +Documentation value diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md new file mode 100644 index 00000000000..58a2cf81d5b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getErrorsDocData" + +--- +```ts +function 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 + +`DocData` \| `undefined` + +Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md new file mode 100644 index 00000000000..45ebc57967b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getFirstAncestor" + +--- +```ts +function getFirstAncestor( + node, + test, + includeSelf): Node | undefined +``` + +## Parameters + +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `node` | [`Node`](../type-aliases/Node.md) | `undefined` | +| `test` | [`NodeCallback`](../type-aliases/NodeCallback.md)<`boolean`\> | `undefined` | +| `includeSelf` | `boolean` | `false` | + +## Returns + +[`Node`](../type-aliases/Node.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md new file mode 100644 index 00000000000..e44f5921950 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getFormat" + +--- +```ts +function getFormat(program, target): string | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md new file mode 100644 index 00000000000..80f41cb705c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getFriendlyName" + +--- +```ts +function getFriendlyName(program, target): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md new file mode 100644 index 00000000000..aa26f4ed287 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] getFullyQualifiedSymbolName" + +--- +```ts +function getFullyQualifiedSymbolName(sym, options?): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `sym` | `undefined` \| [`Sym`](../interfaces/Sym.md) | +| `options`? | `object` | +| `options.useGlobalPrefixAtTopLevel`? | `boolean` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md new file mode 100644 index 00000000000..703d580a533 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] getIdentifierContext" + +--- +```ts +function getIdentifierContext(id): IdentifierContext +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `id` | [`IdentifierNode`](../interfaces/IdentifierNode.md) | + +## Returns + +[`IdentifierContext`](../interfaces/IdentifierContext.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md new file mode 100644 index 00000000000..25269d87b2a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getKeyName" + +--- +```ts +function getKeyName(program, property): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md new file mode 100644 index 00000000000..5b68d4b8b6f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getKnownValues" + +--- +```ts +function getKnownValues(program, target): Enum | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | + +## Returns + +[`Enum`](../interfaces/Enum.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md new file mode 100644 index 00000000000..3619f11c950 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getListOperationType" + +--- +```ts +function getListOperationType(program, target): Model | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +[`Model`](../interfaces/Model.md) \| `undefined` + +## Deprecated + +This function is unused and will be removed in a future release. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md new file mode 100644 index 00000000000..a42790b242f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getLocationContext" + +--- +```ts +function getLocationContext(program, type): LocationContext +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `type` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | + +## Returns + +[`LocationContext`](../type-aliases/LocationContext.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md new file mode 100644 index 00000000000..92658b17d4b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMaxItems" + +--- +```ts +function getMaxItems(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItemsAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItemsAsNumeric.md new file mode 100644 index 00000000000..ab5c7ede0a2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItemsAsNumeric.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMaxItemsAsNumeric" + +--- +```ts +function getMaxItemsAsNumeric(program, target): Numeric | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +[`Numeric`](../interfaces/Numeric.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md new file mode 100644 index 00000000000..f61a5c40482 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMaxLength" + +--- +```ts +function getMaxLength(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLengthAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLengthAsNumeric.md new file mode 100644 index 00000000000..5f46692eb16 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLengthAsNumeric.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getMaxLengthAsNumeric" + +--- +```ts +function getMaxLengthAsNumeric(program, target): Numeric | undefined +``` + +Get the minimum length of a string type as a [Numeric](Numeric.md) value. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Current program | +| `target` | [`Type`](../type-aliases/Type.md) | Type with the `@maxLength` decorator | + +## Returns + +[`Numeric`](../interfaces/Numeric.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md new file mode 100644 index 00000000000..fd5bb3dacb4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMaxValue" + +--- +```ts +function getMaxValue(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueAsNumeric.md new file mode 100644 index 00000000000..e6341ea1af2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueAsNumeric.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMaxValueAsNumeric" + +--- +```ts +function getMaxValueAsNumeric(program, target): Numeric | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +[`Numeric`](../interfaces/Numeric.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md new file mode 100644 index 00000000000..7db657f8f9f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMaxValueExclusive" + +--- +```ts +function getMaxValueExclusive(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusiveAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusiveAsNumeric.md new file mode 100644 index 00000000000..7a4623d757f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusiveAsNumeric.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMaxValueExclusiveAsNumeric" + +--- +```ts +function getMaxValueExclusiveAsNumeric(program, target): Numeric | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +[`Numeric`](../interfaces/Numeric.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md new file mode 100644 index 00000000000..4d6eafafb39 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMinItems" + +--- +```ts +function getMinItems(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItemsAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItemsAsNumeric.md new file mode 100644 index 00000000000..ca98f81066b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItemsAsNumeric.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMinItemsAsNumeric" + +--- +```ts +function getMinItemsAsNumeric(program, target): Numeric | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +[`Numeric`](../interfaces/Numeric.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md new file mode 100644 index 00000000000..b0e1ff6e05e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMinLength" + +--- +```ts +function getMinLength(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLengthAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLengthAsNumeric.md new file mode 100644 index 00000000000..058bf710200 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLengthAsNumeric.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getMinLengthAsNumeric" + +--- +```ts +function getMinLengthAsNumeric(program, target): Numeric | undefined +``` + +Get the minimum length of a string type as a [Numeric](Numeric.md) value. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Current program | +| `target` | [`Type`](../type-aliases/Type.md) | Type with the `@minLength` decorator | + +## Returns + +[`Numeric`](../interfaces/Numeric.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md new file mode 100644 index 00000000000..094b9ae81b6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMinValue" + +--- +```ts +function getMinValue(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueAsNumeric.md new file mode 100644 index 00000000000..250f06b4a09 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueAsNumeric.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMinValueAsNumeric" + +--- +```ts +function getMinValueAsNumeric(program, target): Numeric | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +[`Numeric`](../interfaces/Numeric.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md new file mode 100644 index 00000000000..586108ed9e9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMinValueExclusive" + +--- +```ts +function getMinValueExclusive(program, target): number | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`number` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusiveAsNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusiveAsNumeric.md new file mode 100644 index 00000000000..a95985cbf0b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusiveAsNumeric.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMinValueExclusiveAsNumeric" + +--- +```ts +function getMinValueExclusiveAsNumeric(program, target): Numeric | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +[`Numeric`](../interfaces/Numeric.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md new file mode 100644 index 00000000000..bd73f8e815d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getNamespaceFullName" + +--- +```ts +function getNamespaceFullName(type, options?): string +``` + +Return the full name of the namespace(e.g. "Foo.Bar") + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `type` | [`Namespace`](../interfaces/Namespace.md) | namespace type | +| `options`? | [`TypeNameOptions`](../interfaces/TypeNameOptions.md) | | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md new file mode 100644 index 00000000000..eda4e5f6a5c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md @@ -0,0 +1,54 @@ +--- +jsApi: true +title: "[F] getNodeAtPosition" + +--- +## getNodeAtPosition(script, position, filter) + +```ts +function getNodeAtPosition( + script, + position, + filter?): Node | undefined +``` + +Resolve the node in the syntax tree that that is at the given position. + +### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `script` | [`TypeSpecScriptNode`](../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-aliases/Node.md) \| `undefined` + +## getNodeAtPosition(script, position, filter) + +```ts +function getNodeAtPosition( + script, + position, + filter): T | undefined +``` + +### Type parameters + +| Type parameter | +| :------ | +| `T` *extends* [`Node`](../type-aliases/Node.md) | + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | +| `position` | `number` | +| `filter` | (`node`) => `node is T` | + +### Returns + +`T` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPositionDetail.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPositionDetail.md new file mode 100644 index 00000000000..af0b4203600 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPositionDetail.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getNodeAtPositionDetail" + +--- +```ts +function getNodeAtPositionDetail( + script, + position, + filter): PositionDetail +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | +| `position` | `number` | +| `filter` | (`node`, `flag`) => `boolean` | + +## Returns + +[`PositionDetail`](../interfaces/PositionDetail.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md new file mode 100644 index 00000000000..2a5da517802 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getNormalizedAbsolutePath" + +--- +```ts +function getNormalizedAbsolutePath(fileName, currentDirectory): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `fileName` | `string` | +| `currentDirectory` | `undefined` \| `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md new file mode 100644 index 00000000000..fec2043371d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getNormalizedAbsolutePathWithoutRoot" + +--- +```ts +function getNormalizedAbsolutePathWithoutRoot(fileName, currentDirectory): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `fileName` | `string` | +| `currentDirectory` | `undefined` \| `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md new file mode 100644 index 00000000000..827f54bb9dc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] getNormalizedPathComponents" + +--- +```ts +function getNormalizedPathComponents(path, currentDirectory): string[] +``` + +Parse a path into an array containing a root component (at index 0) and zero or more path +components (at indices > 0). The result is normalized. +If the path is relative, the root component is `""`. +If the path is absolute, the root component includes the first path separator (`/`). + +```ts +getNormalizedPathComponents("to/dir/../file.ext", "/path/") === ["/", "path", "to", "file.ext"] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | +| `currentDirectory` | `undefined` \| `string` | + +## Returns + +`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md new file mode 100644 index 00000000000..f2e3245300f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getOverloadedOperation" + +--- +```ts +function getOverloadedOperation(program, operation): Operation | undefined +``` + +If the given operation overloads another operation, return that operation. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `operation` | [`Operation`](../interfaces/Operation.md) | The operation to check for an overload target. | + +## Returns + +[`Operation`](../interfaces/Operation.md) \| `undefined` + +The operation this operation overloads, if any. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md new file mode 100644 index 00000000000..ae1267531ba --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getOverloads" + +--- +```ts +function getOverloads(program, operation): Operation[] | undefined +``` + +Get all operations that are marked as overloads of the given operation + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `operation` | [`Operation`](../interfaces/Operation.md) | Operation | + +## Returns + +[`Operation`](../interfaces/Operation.md)[] \| `undefined` + +An array of operations that overload the given operation. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md new file mode 100644 index 00000000000..2d5344c5f6a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getOverriddenProperty" + +--- +```ts +function getOverriddenProperty(property): ModelProperty | undefined +``` + +Gets the property from the nearest base type that is overridden by the +given property, if any. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | + +## Returns + +[`ModelProperty`](../interfaces/ModelProperty.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md new file mode 100644 index 00000000000..7d21e463c93 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] getParameterVisibility" + +--- +```ts +function getParameterVisibility(program, entity): string[] | undefined +``` + +Returns the visibilities of the parameters of the given operation, if provided with `@parameterVisibility`. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `entity` | [`Operation`](../interfaces/Operation.md) | + +## Returns + +`string`[] \| `undefined` + +## See + +[$parameterVisibility]($parameterVisibility.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md new file mode 100644 index 00000000000..4ac4e27aaf6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[F] getParentTemplateNode" + +--- +```ts +function getParentTemplateNode(node): Node & TemplateDeclarationNode | undefined +``` + +Lookup and find the node + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `node` | [`Node`](../type-aliases/Node.md) | Node | + +## Returns + +[`Node`](../type-aliases/Node.md) & [`TemplateDeclarationNode`](../interfaces/TemplateDeclarationNode.md) \| `undefined` + +Template Parent node if applicable diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md new file mode 100644 index 00000000000..29a3dfdc3e2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md @@ -0,0 +1,49 @@ +--- +jsApi: true +title: "[F] getPathComponents" + +--- +```ts +function getPathComponents(path, currentDirectory): string[] +``` + +Parse a path into an array containing a root component (at index 0) and zero or more path +components (at indices > 0). The result is not normalized. +If the path is relative, the root component is `""`. +If the path is absolute, the root component includes the first path separator (`/`). + +```ts +// POSIX +getPathComponents("/path/to/file.ext") === ["/", "path", "to", "file.ext"] +getPathComponents("/path/to/") === ["/", "path", "to"] +getPathComponents("/") === ["/"] +// DOS +getPathComponents("c:/path/to/file.ext") === ["c:/", "path", "to", "file.ext"] +getPathComponents("c:/path/to/") === ["c:/", "path", "to"] +getPathComponents("c:/") === ["c:/"] +getPathComponents("c:") === ["c:"] +// URL +getPathComponents("http://typescriptlang.org/path/to/file.ext") === ["http://typescriptlang.org/", "path", "to", "file.ext"] +getPathComponents("http://typescriptlang.org/path/to/") === ["http://typescriptlang.org/", "path", "to"] +getPathComponents("http://typescriptlang.org/") === ["http://typescriptlang.org/"] +getPathComponents("http://typescriptlang.org") === ["http://typescriptlang.org"] +getPathComponents("file://server/path/to/file.ext") === ["file://server/", "path", "to", "file.ext"] +getPathComponents("file://server/path/to/") === ["file://server/", "path", "to"] +getPathComponents("file://server/") === ["file://server/"] +getPathComponents("file://server") === ["file://server"] +getPathComponents("file:///path/to/file.ext") === ["file:///", "path", "to", "file.ext"] +getPathComponents("file:///path/to/") === ["file:///", "path", "to"] +getPathComponents("file:///") === ["file:///"] +getPathComponents("file://") === ["file://"] +``` + +## Parameters + +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `path` | `string` | `undefined` | +| `currentDirectory` | `string` | `""` | + +## Returns + +`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md new file mode 100644 index 00000000000..d9b96b6885f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] getPathFromPathComponents" + +--- +```ts +function getPathFromPathComponents(pathComponents): string +``` + +Formats a parsed path consisting of a root component (at index 0) and zero or more path +segments (at indices > 0). + +```ts +getPathFromPathComponents(["/", "path", "to", "file.ext"]) === "/path/to/file.ext" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `pathComponents` | readonly `string`[] | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md new file mode 100644 index 00000000000..16b6c9b1423 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] getPattern" + +--- +```ts +function getPattern(program, target): string | undefined +``` + +Gets the pattern regular expression associated with a given type, if one has been set. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | the Program containing the target Type | +| `target` | [`Type`](../type-aliases/Type.md) | the type to get the pattern for | + +## Returns + +`string` \| `undefined` + +the pattern string, if one was set + +## See + +getPatternData diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md new file mode 100644 index 00000000000..bc7de4ca2f4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[F] getPatternData" + +--- +```ts +function getPatternData(program, target): PatternData | undefined +``` + +Gets the associated pattern data, including the pattern regular expression and optional validation message, if any +has been set. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | the Program containing the target Type | +| `target` | [`Type`](../type-aliases/Type.md) | the type to get the pattern data for | + +## Returns + +[`PatternData`](../interfaces/PatternData.md) \| `undefined` + +the pattern data, if any was set diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md new file mode 100644 index 00000000000..46de18bdbd0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getPositionBeforeTrivia" + +--- +```ts +function getPositionBeforeTrivia(script, pos): number +``` + +Adjust the given postion backwards before any trivia. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | +| `pos` | `number` | + +## Returns + +`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md new file mode 100644 index 00000000000..471dd9632a6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] getProjectedName" + +--- +```ts +function getProjectedName( + program, + target, + projectionName): string | undefined +``` + +Get the projected name of the given entity for the given projection. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Type`](../type-aliases/Type.md) | Target | +| `projectionName` | `string` | - | + +## 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 00000000000..a975852e6fe --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getProjectedNames" + +--- +```ts +function getProjectedNames(program, target): ReadonlyMap | undefined +``` + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Type`](../type-aliases/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/functions/getProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md new file mode 100644 index 00000000000..3da14e77411 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getProperty" + +--- +```ts +function getProperty(type, propertyName): ModelProperty | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Model`](../interfaces/Model.md) | +| `propertyName` | `string` | + +## Returns + +[`ModelProperty`](../interfaces/ModelProperty.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md new file mode 100644 index 00000000000..b72a0dcaf74 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] getPropertyType" + +--- +```ts +function getPropertyType(target): Type +``` + +Return the type of the property or the model itself. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | + +## Returns + +[`Type`](../type-aliases/Type.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md new file mode 100644 index 00000000000..1f1210381b1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md @@ -0,0 +1,50 @@ +--- +jsApi: true +title: "[F] getRelativePathFromDirectory" + +--- +## getRelativePathFromDirectory(from, to, ignoreCase) + +```ts +function getRelativePathFromDirectory( + from, + to, + ignoreCase): string +``` + +Gets a relative path that can be used to traverse between `from` and `to`. + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `from` | `string` | +| `to` | `string` | +| `ignoreCase` | `boolean` | + +### Returns + +`string` + +## getRelativePathFromDirectory(fromDirectory, to, getCanonicalFileName) + +```ts +function getRelativePathFromDirectory( + fromDirectory, + to, + getCanonicalFileName): string +``` + +Gets a relative path that can be used to traverse between `from` and `to`. + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `fromDirectory` | `string` | +| `to` | `string` | +| `getCanonicalFileName` | `GetCanonicalFileName` | + +### Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md new file mode 100644 index 00000000000..ca43fb69056 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] getReturnTypeVisibility" + +--- +```ts +function getReturnTypeVisibility(program, entity): string[] | undefined +``` + +Returns the visibilities of the return type of the given operation, if provided with `@returnTypeVisibility`. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `entity` | [`Operation`](../interfaces/Operation.md) | + +## Returns + +`string`[] \| `undefined` + +## See + +[$returnTypeVisibility]($returnTypeVisibility.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md new file mode 100644 index 00000000000..83dace9fb6f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getReturnsDoc" + +--- +```ts +function 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 + +`string` \| `undefined` + +Documentation value diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md new file mode 100644 index 00000000000..5990ac691be --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getReturnsDocData" + +--- +```ts +function 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 + +`DocData` \| `undefined` + +Doc data with source information. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md new file mode 100644 index 00000000000..572edfd5f02 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md @@ -0,0 +1,42 @@ +--- +jsApi: true +title: "[F] getRootLength" + +--- +```ts +function getRootLength(path): number +``` + +Returns length of the root part of a path or URL (i.e. length of "/", "x:/", "//server/share/, file:///user/files"). + +For example: +```ts +getRootLength("a") === 0 // "" +getRootLength("/") === 1 // "/" +getRootLength("c:") === 2 // "c:" +getRootLength("c:d") === 0 // "" +getRootLength("c:/") === 3 // "c:/" +getRootLength("c:\\") === 3 // "c:\\" +getRootLength("//server") === 7 // "//server" +getRootLength("//server/share") === 8 // "//server/" +getRootLength("\\\\server") === 7 // "\\\\server" +getRootLength("\\\\server\\share") === 8 // "\\\\server\\" +getRootLength("file:///path") === 8 // "file:///" +getRootLength("file:///c:") === 10 // "file:///c:" +getRootLength("file:///c:d") === 8 // "file:///" +getRootLength("file:///c:/path") === 11 // "file:///c:/" +getRootLength("file://server") === 13 // "file://server" +getRootLength("file://server/path") === 14 // "file://server/" +getRootLength("http://server") === 13 // "http://server" +getRootLength("http://server/path") === 14 // "http://server/" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md new file mode 100644 index 00000000000..35d9003f726 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getService" + +--- +```ts +function getService(program, namespace): Service | undefined +``` + +Get the service information for the given namespace. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `namespace` | [`Namespace`](../interfaces/Namespace.md) | Service namespace | + +## Returns + +[`Service`](../interfaces/Service.md) \| `undefined` + +Service information or undefined if namespace is not a service namespace. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md new file mode 100644 index 00000000000..c5ee3bd5233 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] getSourceFileKindFromExt" + +--- +```ts +function getSourceFileKindFromExt(path): SourceFileKind | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +[`SourceFileKind`](../type-aliases/SourceFileKind.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md new file mode 100644 index 00000000000..30cb67334e5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md @@ -0,0 +1,55 @@ +--- +jsApi: true +title: "[F] getSourceLocation" + +--- +## getSourceLocation(target, options) + +```ts +function getSourceLocation(target, options?): SourceLocation +``` + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | +| `options`? | [`SourceLocationOptions`](../interfaces/SourceLocationOptions.md) | + +### Returns + +[`SourceLocation`](../interfaces/SourceLocation.md) + +## getSourceLocation(target, options) + +```ts +function getSourceLocation(target, options?): undefined +``` + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | `undefined` \| *typeof* [`NoTarget`](../variables/NoTarget.md) | +| `options`? | [`SourceLocationOptions`](../interfaces/SourceLocationOptions.md) | + +### Returns + +`undefined` + +## getSourceLocation(target, options) + +```ts +function getSourceLocation(target, options?): SourceLocation | undefined +``` + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | `undefined` \| [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | +| `options`? | [`SourceLocationOptions`](../interfaces/SourceLocationOptions.md) | + +### Returns + +[`SourceLocation`](../interfaces/SourceLocation.md) \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md new file mode 100644 index 00000000000..c6796052dfd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getSummary" + +--- +```ts +function getSummary(program, type): string | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `type` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md new file mode 100644 index 00000000000..1c6f1a632cd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getTags" + +--- +```ts +function getTags(program, target): string[] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md new file mode 100644 index 00000000000..8378f0431e9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getTypeName" + +--- +```ts +function getTypeName(type, options?): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](../type-aliases/Type.md) | +| `options`? | [`TypeNameOptions`](../interfaces/TypeNameOptions.md) | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md new file mode 100644 index 00000000000..cc0a0d37872 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getVisibility" + +--- +```ts +function getVisibility(program, target): string[] | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`string`[] \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md new file mode 100644 index 00000000000..6f8d34e8d33 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] hasParseError" + +--- +```ts +function hasParseError(node): number | true +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`Node`](../type-aliases/Node.md) | + +## Returns + +`number` \| `true` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md new file mode 100644 index 00000000000..e02f2252028 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[F] hasProjectedName" + +--- +```ts +function hasProjectedName( + program, + target, + projectionName): boolean +``` + +Get the projected name of the given entity for the given projection. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `target` | [`Type`](../type-aliases/Type.md) | Target | +| `projectionName` | `string` | - | + +## Returns + +`boolean` + +Projected name for the given projection diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md new file mode 100644 index 00000000000..c61f1cb264b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] hasTrailingDirectorySeparator" + +--- +```ts +function hasTrailingDirectorySeparator(path): boolean +``` + +Determines whether a path has a trailing separator (`/` or `\\`). + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md new file mode 100644 index 00000000000..400c613824e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] ignoreDiagnostics" + +--- +```ts +function ignoreDiagnostics(result): T +``` + +Ignore the diagnostics emitted by the diagnostic accessor pattern and just return the actual result. + +## Type parameters + +| Type parameter | +| :------ | +| `T` | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `result` | [`DiagnosticResult`](../type-aliases/DiagnosticResult.md)<`T`\> | Accessor pattern tuple result including the actual result and the list of diagnostics. | + +## Returns + +`T` + +Actual result. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md new file mode 100644 index 00000000000..8df4f5a1f86 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] interpolatePath" + +--- +```ts +function interpolatePath(pathTemplate, predefinedVariables): string +``` + +Interpolate a path template + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `pathTemplate` | `string` | Path template | +| `predefinedVariables` | `Record`<`string`, `undefined` \| `string`\> | Variables that can be used in the path template. | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md new file mode 100644 index 00000000000..d58bd82f36f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] isAnyDirectorySeparator" + +--- +```ts +function isAnyDirectorySeparator(charCode): boolean +``` + +Determines whether a charCode corresponds to `/` or ``. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `charCode` | `number` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md new file mode 100644 index 00000000000..901d4caf4db --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isArrayModelType" + +--- +```ts +function isArrayModelType(program, type): type is ArrayModelType +``` + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | - | +| `type` | [`Model`](../interfaces/Model.md) | Model type | + +## Returns + +`type is ArrayModelType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md new file mode 100644 index 00000000000..82669edb1c6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[F] isCadlValueTypeOf" + +--- +```ts +function isCadlValueTypeOf(target, expectedType): target is InferredTypeSpecValue +``` + +## Type parameters + +| Type parameter | +| :------ | +| `K` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `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/functions/isComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md new file mode 100644 index 00000000000..8f644f595f0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isComment" + +--- +```ts +function isComment(token): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `token` | [`Token`](../enumerations/Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md new file mode 100644 index 00000000000..d1223a85155 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[F] isDeclaredInNamespace" + +--- +```ts +function isDeclaredInNamespace( + type, + namespace, + options): boolean +``` + +Check if the given type is declared in the specified namespace or, optionally, its child namespaces. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `type` | \| [`Enum`](../interfaces/Enum.md) \| [`Interface`](../interfaces/Interface.md) \| [`Model`](../interfaces/Model.md) \| [`Namespace`](../interfaces/Namespace.md) \| [`Operation`](../interfaces/Operation.md) | Type | +| `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | +| `options` | `object` | - | +| `options.recursive`? | `boolean` | - | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md new file mode 100644 index 00000000000..f457a276f16 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[F] isDeclaredType" + +--- +```ts +function isDeclaredType(type): boolean +``` + +Check if the type is a declared type. This include: +- non templated type +- template declaration + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md new file mode 100644 index 00000000000..0409f08b21d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] isDeprecated" + +--- +```ts +function isDeprecated(program, type): boolean +``` + +Check if the given type is deprecated + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `type` | [`Type`](../type-aliases/Type.md) | Type | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md new file mode 100644 index 00000000000..e4acdd83020 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] isErrorModel" + +--- +```ts +function isErrorModel(program, target): boolean +``` + +Check if the type is an error model or a descendant of an error model. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md new file mode 100644 index 00000000000..08ee7caea3d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isErrorType" + +--- +```ts +function isErrorType(type): type is ErrorType +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Entity`](../type-aliases/Entity.md) | + +## Returns + +`type is ErrorType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md new file mode 100644 index 00000000000..051f4d4c754 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] isGlobalNamespace" + +--- +```ts +function isGlobalNamespace(program, namespace): namespace is Namespace & Object +``` + +Check if the given namespace is the global namespace + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | + +## Returns + +`namespace is Namespace & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md new file mode 100644 index 00000000000..bbff894c873 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isImportStatement" + +--- +```ts +function isImportStatement(node): node is ImportStatementNode +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`Node`](../type-aliases/Node.md) | + +## Returns + +`node is ImportStatementNode` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md new file mode 100644 index 00000000000..c21ea5549fd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] isIntrinsicType" + +--- +```ts +function isIntrinsicType( + program, + type, + kind): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `type` | [`Scalar`](../interfaces/Scalar.md) | +| `kind` | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md new file mode 100644 index 00000000000..c93c8edaaf8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isKey" + +--- +```ts +function isKey(program, property): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md new file mode 100644 index 00000000000..6799df9a3cb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isKeyword" + +--- +```ts +function isKeyword(token): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `token` | [`Token`](../enumerations/Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md new file mode 100644 index 00000000000..e2da253476e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] isListOperation" + +--- +```ts +function isListOperation(program, target): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `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/functions/isModifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md new file mode 100644 index 00000000000..cb3765325b1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isModifier" + +--- +```ts +function isModifier(token): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `token` | [`Token`](../enumerations/Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md new file mode 100644 index 00000000000..d6a600458cf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isNeverType" + +--- +```ts +function isNeverType(type): type is NeverType +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Entity`](../type-aliases/Entity.md) | + +## Returns + +`type is NeverType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md new file mode 100644 index 00000000000..6eb63cc8429 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isNullType" + +--- +```ts +function isNullType(type): type is NullType +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Entity`](../type-aliases/Entity.md) | + +## Returns + +`type is NullType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumeric.md new file mode 100644 index 00000000000..b82cdcc2b6d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumeric.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] isNumeric" + +--- +```ts +function isNumeric(arg): arg is Numeric +``` + +Check if the given arg is a Numeric + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `arg` | `unknown` | + +## Returns + +`arg is Numeric` 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 00000000000..20586a42aeb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isNumericType" + +--- +```ts +function isNumericType(program, target): target is Scalar +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`target is Scalar` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md new file mode 100644 index 00000000000..ced9f651154 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isPathAbsolute" + +--- +```ts +function isPathAbsolute(path): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md new file mode 100644 index 00000000000..50f8fbc75e9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isProjectedProgram" + +--- +```ts +function isProjectedProgram(program): program is ProjectedProgram +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | + +## Returns + +`program is ProjectedProgram` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md new file mode 100644 index 00000000000..b22d681c92e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isPunctuation" + +--- +```ts +function isPunctuation(token): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `token` | [`Token`](../enumerations/Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md new file mode 100644 index 00000000000..f778bb369e8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] isRecordModelType" + +--- +```ts +function isRecordModelType(program, type): type is ArrayModelType +``` + +Check if a model is an array type. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | - | +| `type` | [`Model`](../interfaces/Model.md) | Model type | + +## Returns + +`type is ArrayModelType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md new file mode 100644 index 00000000000..54d2b1d436f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isSecret" + +--- +```ts +function isSecret(program, target): boolean | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`boolean` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md new file mode 100644 index 00000000000..e21fa691640 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] isService" + +--- +```ts +function isService(program, namespace): boolean +``` + +Check if the namespace is defined as a service. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | +| `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace | + +## Returns + +`boolean` + +Boolean diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md new file mode 100644 index 00000000000..9de4e0b44b2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isStatementKeyword" + +--- +```ts +function isStatementKeyword(token): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `token` | [`Token`](../enumerations/Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md new file mode 100644 index 00000000000..a051e6e8be2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isStdNamespace" + +--- +```ts +function isStdNamespace(namespace): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `namespace` | [`Namespace`](../interfaces/Namespace.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md new file mode 100644 index 00000000000..2886e1194e1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isStringType" + +--- +```ts +function isStringType(program, target): target is Scalar +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) \| [`ProjectedProgram`](../interfaces/ProjectedProgram.md) | +| `target` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`target is Scalar` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md new file mode 100644 index 00000000000..493e3c5c2e3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] isTemplateDeclaration" + +--- +```ts +function isTemplateDeclaration(type): type is TemplatedType & Object +``` + +Resolve if the type is a template type declaration(Non initialized template type). + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`TemplatedType`](../type-aliases/TemplatedType.md) | + +## Returns + +`type is TemplatedType & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md new file mode 100644 index 00000000000..2db06f844b0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] isTemplateDeclarationOrInstance" + +--- +```ts +function isTemplateDeclarationOrInstance(type): boolean +``` + +Resolve if the type was created from a template type or is a template type declaration. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`TemplatedType`](../type-aliases/TemplatedType.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md new file mode 100644 index 00000000000..3525c3149c2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] isTemplateInstance" + +--- +```ts +function isTemplateInstance(type): type is TemplatedType & Object +``` + +Check the given type is a finished template instance. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](../type-aliases/Type.md) | + +## Returns + +`type is TemplatedType & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md new file mode 100644 index 00000000000..4875a8e524b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isTrivia" + +--- +```ts +function isTrivia(token): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `token` | [`Token`](../enumerations/Token.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isType.md new file mode 100644 index 00000000000..3a896924d64 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isType.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isType" + +--- +```ts +function isType(entity): entity is Type +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `entity` | [`Entity`](../type-aliases/Entity.md) | + +## Returns + +`entity is Type` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md new file mode 100644 index 00000000000..d07d87a182f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[F] isTypeSpecValueTypeOf" + +--- +```ts +function isTypeSpecValueTypeOf(target, expectedType): target is InferredTypeSpecValue +``` + +Check if the given target is of any of the TypeSpec types. + +## Type parameters + +| Type parameter | +| :------ | +| `K` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `target` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | Target to validate. | +| `expectedType` | `K` \| readonly `K`[] | One or multiple allowed TypeSpec types. | + +## Returns + +`target is InferredTypeSpecValue` + +boolean if the target is of one of the allowed types. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md new file mode 100644 index 00000000000..38105615849 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isUnknownType" + +--- +```ts +function isUnknownType(type): type is UnknownType +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Entity`](../type-aliases/Entity.md) | + +## Returns + +`type is UnknownType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md new file mode 100644 index 00000000000..d880610ea5c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] isUrl" + +--- +```ts +function isUrl(path): boolean +``` + +Determines whether a path starts with a URL scheme (e.g. starts with `http://`, `ftp://`, `file://`, etc.). + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isValue.md new file mode 100644 index 00000000000..efb9515f794 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isValue.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isValue" + +--- +```ts +function isValue(entity): entity is Value +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `entity` | [`Entity`](../type-aliases/Entity.md) | + +## Returns + +`entity is Value` 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 00000000000..5a5bb4aada2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] isVisible" + +--- +```ts +function isVisible( + program, + property, + visibilities): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `property` | [`ModelProperty`](../interfaces/ModelProperty.md) | +| `visibilities` | readonly `string`[] | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md new file mode 100644 index 00000000000..3f101edaaac --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] isVoidType" + +--- +```ts +function isVoidType(type): type is VoidType +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Entity`](../type-aliases/Entity.md) | + +## Returns + +`type is VoidType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md new file mode 100644 index 00000000000..4ecc31a2ec3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md @@ -0,0 +1,36 @@ +--- +jsApi: true +title: "[F] joinPaths" + +--- +```ts +function joinPaths(path, ...paths): string +``` + +Combines paths. If a path is absolute, it replaces any previous path. Relative paths are not simplified. + +```ts +// Non-rooted +joinPaths("path", "to", "file.ext") === "path/to/file.ext" +joinPaths("path", "dir", "..", "to", "file.ext") === "path/dir/../to/file.ext" +// POSIX +joinPaths("/path", "to", "file.ext") === "/path/to/file.ext" +joinPaths("/path", "/to", "file.ext") === "/to/file.ext" +// DOS +joinPaths("c:/path", "to", "file.ext") === "c:/path/to/file.ext" +joinPaths("c:/path", "c:/to", "file.ext") === "c:/to/file.ext" +// URL +joinPaths("file:///path", "to", "file.ext") === "file:///path/to/file.ext" +joinPaths("file:///path", "file:///to", "file.ext") === "file:///to/file.ext" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | +| ...`paths` | (`undefined` \| `string`)[] | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md new file mode 100644 index 00000000000..428f5688048 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] listOperationsIn" + +--- +```ts +function 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. | + +## Returns + +[`Operation`](../interfaces/Operation.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md new file mode 100644 index 00000000000..16bbbb28d59 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[F] listServices" + +--- +```ts +function listServices(program): Service[] +``` + +List all the services defined in the TypeSpec program + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | Program | + +## Returns + +[`Service`](../interfaces/Service.md)[] + +List of service. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md new file mode 100644 index 00000000000..b72c0e88de2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] logDiagnostics" + +--- +```ts +function logDiagnostics(diagnostics, logger): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostics` | readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] | +| `logger` | [`LogSink`](../interfaces/LogSink.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md new file mode 100644 index 00000000000..dc3b7a12f19 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[F] logVerboseTestOutput" + +--- +```ts +function logVerboseTestOutput(messageOrCallback): void +``` + +Verbose output is enabled by default for runs in mocha explorer in VS Code, +where the output is nicely associated with the individual test, and disabled +by default for command line runs where we don't want to spam the console. + +If the steps taken to produce the message are expensive, pass a callback +instead of producing the message then passing it here only to be dropped +when verbose output is disabled. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `messageOrCallback` | `string` \| (`log`) => `void` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md new file mode 100644 index 00000000000..dc66d211fa6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[F] mapEventEmitterToNodeListener" + +--- +```ts +function mapEventEmitterToNodeListener(eventEmitter): SemanticNodeListener +``` + +Create a Semantic node listener from an event emitter. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `eventEmitter` | [`EventEmitter`](../classes/EventEmitter.md)<[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md)\> | Event emitter. | + +## Returns + +[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) + +Semantic node listener. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md new file mode 100644 index 00000000000..a8718dc07bf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] markDeprecated" + +--- +```ts +function 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 | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md new file mode 100644 index 00000000000..85f79449633 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] navigateProgram" + +--- +```ts +function 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. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md new file mode 100644 index 00000000000..ecc4d5f7c9e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] navigateType" + +--- +```ts +function 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 | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md new file mode 100644 index 00000000000..86249732ec6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] navigateTypesInNamespace" + +--- +```ts +function 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` & `object` & `object` & `object` & `object` & `object` | +| `options` | [`NamespaceNavigationOptions`](../interfaces/NamespaceNavigationOptions.md) & [`NavigationOptions`](../interfaces/NavigationOptions.md) | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md new file mode 100644 index 00000000000..dc2ae9deb30 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] normalizePath" + +--- +```ts +function normalizePath(path): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md new file mode 100644 index 00000000000..eae45037c44 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] normalizeSlashes" + +--- +```ts +function normalizeSlashes(path): string +``` + +Normalize path separators, converting `\` into `/`. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md new file mode 100644 index 00000000000..ba5a2fd758b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] paramMessage" + +--- +```ts +function paramMessage(strings, ...keys): CallableMessage +``` + +## Type parameters + +| Type parameter | +| :------ | +| `T` *extends* `string`[] | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `strings` | readonly `string`[] | +| ...`keys` | `T` | + +## Returns + +[`CallableMessage`](../interfaces/CallableMessage.md)<`T`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md new file mode 100644 index 00000000000..4be9ea71c95 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] parse" + +--- +```ts +function parse(code, options): TypeSpecScriptNode +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `code` | `string` \| [`SourceFile`](../interfaces/SourceFile.md) | +| `options` | [`ParseOptions`](../interfaces/ParseOptions.md) | + +## Returns + +[`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md new file mode 100644 index 00000000000..ba97e27a22c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] parseStandaloneTypeReference" + +--- +```ts +function parseStandaloneTypeReference(code): [TypeReferenceNode, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `code` | `string` \| [`SourceFile`](../interfaces/SourceFile.md) | + +## Returns + +[[`TypeReferenceNode`](../interfaces/TypeReferenceNode.md), readonly [`Diagnostic`](../interfaces/Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/positionInRange.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/positionInRange.md new file mode 100644 index 00000000000..179a20faa2d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/positionInRange.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] positionInRange" + +--- +```ts +function positionInRange(position, range): boolean +``` + +check whether a position belongs to a range (excluding the start and end pos) +i.e. {...} + +remark: if range.pos is -1 means no start point found, so return false + if range.end is -1 means no end point found, so return true if position is greater than range.pos + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `position` | `number` | +| `range` | [`TextRange`](../interfaces/TextRange.md) | + +## Returns + +`boolean` 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 00000000000..7a1c0db09a7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] projectProgram" + +--- +```ts +function projectProgram( + program, + projections, + startNode?): ProjectedProgram +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `projections` | [`ProjectionApplication`](../interfaces/ProjectionApplication.md)[] | +| `startNode`? | [`Type`](../type-aliases/Type.md) | + +## Returns + +[`ProjectedProgram`](../interfaces/ProjectedProgram.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md new file mode 100644 index 00000000000..78e584526cc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] reducePathComponents" + +--- +```ts +function reducePathComponents(components): string[] +``` + +Reduce an array of path components to a more simplified path by navigating any +`"."` or `".."` entries in the path. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `components` | readonly `string`[] | + +## Returns + +`string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md new file mode 100644 index 00000000000..2c53c2cbb0d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] removeTrailingDirectorySeparator" + +--- +```ts +function removeTrailingDirectorySeparator(path): string +``` + +Removes a trailing directory separator from a path, if it does not already have one. + +```ts +removeTrailingDirectorySeparator("/path/to/file.ext") === "/path/to/file.ext" +removeTrailingDirectorySeparator("/path/to/file.ext/") === "/path/to/file.ext" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md new file mode 100644 index 00000000000..f7e65b5d83f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] reportDeprecated" + +--- +```ts +function 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. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md new file mode 100644 index 00000000000..5b382390bec --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] resolveCompilerOptions" + +--- +```ts +function 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) | | + +## Returns + +`Promise`<[[`CompilerOptions`](../interfaces/CompilerOptions.md), readonly [`Diagnostic`](../interfaces/Diagnostic.md)[]]\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md new file mode 100644 index 00000000000..f1f69a4b4d6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md @@ -0,0 +1,45 @@ +--- +jsApi: true +title: "[F] resolveEncodedName" + +--- +```ts +function resolveEncodedName( + program, + target, + mimeType): string +``` + +Resolve the encoded name for the given type when serialized to the given mime type. +If a specific value was provided by `@encodedName` decorator for that mime type it will return that otherwise it will return the name of the type. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `target` | [`Type`](../type-aliases/Type.md) & `object` | +| `mimeType` | `string` | + +## Returns + +`string` + +## Example + +For the given +```tsp +model Certificate { + @encodedName("application/json", "exp") + @encodedName("application/xml", "expiry") + expireAt: utcDateTime; + +} +``` + +```ts +resolveEncodedName(program, type, "application/json") // exp +resolveEncodedName(program, type, "application/merge-patch+json") // exp +resolveEncodedName(program, type, "application/xml") // expireAt +resolveEncodedName(program, type, "application/yaml") // expiry +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveLinterDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveLinterDefinition.md new file mode 100644 index 00000000000..02a10a5f9eb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveLinterDefinition.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] resolveLinterDefinition" + +--- +```ts +function resolveLinterDefinition(libName, linter): LinterResolvedDefinition +``` + +Resolve the linter definition + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `libName` | `string` | +| `linter` | [`LinterDefinition`](../interfaces/LinterDefinition.md) | + +## Returns + +[`LinterResolvedDefinition`](../interfaces/LinterResolvedDefinition.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 00000000000..fd707845980 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] resolveModule" + +--- +```ts +function 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 + +`Promise`<[`ModuleResolutionResult`](../type-aliases/ModuleResolutionResult.md)\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md new file mode 100644 index 00000000000..08308fb9e18 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] resolvePath" + +--- +```ts +function resolvePath(path, ...paths): string +``` + +Combines and resolves paths. If a path is absolute, it replaces any previous path. Any +`.` and `..` path components are resolved. Trailing directory separators are preserved. + +```ts +resolvePath("/path", "to", "file.ext") === "path/to/file.ext" +resolvePath("/path", "to", "file.ext/") === "path/to/file.ext/" +resolvePath("/path", "dir", "..", "to", "file.ext") === "path/to/file.ext" +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | +| ...`paths` | (`undefined` \| `string`)[] | + +## Returns + +`string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md new file mode 100644 index 00000000000..5d615894917 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] resolveUsages" + +--- +```ts +function resolveUsages(types): UsageTracker +``` + +Resolve usage(input, output or both) of various types in the given namespace. +Will recursively scan all namespace, interfaces and operations contained inside the namespace. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `types` | [`OperationContainer`](../type-aliases/OperationContainer.md) \| [`OperationContainer`](../type-aliases/OperationContainer.md)[] | Entrypoint(s) namespace, interface or operations to get usage from. | + +## Returns + +[`UsageTracker`](../interfaces/UsageTracker.md) + +Map of types to usage. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md new file mode 100644 index 00000000000..6d4449d1384 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md @@ -0,0 +1,33 @@ +--- +jsApi: true +title: "[F] scopeNavigationToNamespace" + +--- +```ts +function scopeNavigationToNamespace( + namespace, + listeners, + options): T +``` + +Scope the current navigation to the given namespace. + +## Type parameters + +| Type parameter | +| :------ | +| `T` *extends* `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` & `object` | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `namespace` | [`Namespace`](../interfaces/Namespace.md) | Namespace the traversal shouldn't leave. | +| `listeners` | `T` | Type listeners. | +| `options` | [`NamespaceNavigationOptions`](../interfaces/NamespaceNavigationOptions.md) | Scope options | + +## Returns + +`T` + +wrapped listeners that that can be used with `navigateType` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md new file mode 100644 index 00000000000..616332b4f07 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] setCadlNamespace" + +--- +```ts +function setCadlNamespace(namespace, ...functions): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `namespace` | `string` | +| ...`functions` | (...`args`) => `any`[] | + +## Returns + +`void` + +## Deprecated + +use setTypeSpecNamespace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md new file mode 100644 index 00000000000..07a9edfd169 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] setTypeSpecNamespace" + +--- +```ts +function setTypeSpecNamespace(namespace, ...functions): void +``` + +Set the TypeSpec namespace for that function. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `namespace` | `string` | Namespace string (e.g. "Foo.Bar") | +| ...`functions` | (...`args`) => `any`[] | Functions | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipContinuousIdentifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipContinuousIdentifier.md new file mode 100644 index 00000000000..7c00a1f1f29 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipContinuousIdentifier.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] skipContinuousIdentifier" + +--- +```ts +function skipContinuousIdentifier( + input, + position, + isBackward): number +``` + +## Parameters + +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `input` | `string` | `undefined` | +| `position` | `number` | `undefined` | +| `isBackward` | `boolean` | `false` | + +## Returns + +`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md new file mode 100644 index 00000000000..25e217faf4b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] skipTrivia" + +--- +```ts +function skipTrivia( + input, + position, + endPosition): number +``` + +## Parameters + +| Parameter | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `input` | `string` | `undefined` | | +| `position` | `number` | `undefined` | | +| `endPosition` | `number` | `input.length` | exclude | + +## Returns + +`number` + +return === endPosition (or input.length) means not found non-trivia until endPosition - 1 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTriviaBackward.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTriviaBackward.md new file mode 100644 index 00000000000..ad8615e09ea --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTriviaBackward.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] skipTriviaBackward" + +--- +```ts +function skipTriviaBackward( + script, + position, + endPosition): number +``` + +## Parameters + +| Parameter | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `script` | [`TypeSpecScriptNode`](../interfaces/TypeSpecScriptNode.md) | `undefined` | | +| `position` | `number` | `undefined` | | +| `endPosition` | `number` | `-1` | exclude | + +## Returns + +`number` + +return === endPosition (or -1) means not found non-trivia until endPosition + 1 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md new file mode 100644 index 00000000000..5cef2cd6ba9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] skipWhiteSpace" + +--- +```ts +function skipWhiteSpace( + input, + position, + endPosition): number +``` + +## Parameters + +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `input` | `string` | `undefined` | +| `position` | `number` | `undefined` | +| `endPosition` | `number` | `input.length` | + +## Returns + +`number` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md new file mode 100644 index 00000000000..d821c2a5def --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[F] stringTemplateToString" + +--- +```ts +function stringTemplateToString(stringTemplate): [string, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `stringTemplate` | [`StringTemplate`](../interfaces/StringTemplate.md) | + +## Returns + +[`string`, readonly [`Diagnostic`](../interfaces/Diagnostic.md)[]] + +## Deprecated + +use `[["stringValue"]](../interfaces/StringTemplate.md) property on [StringTemplate](../interfaces/StringTemplate.md) instead. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md new file mode 100644 index 00000000000..a9bd6a4c1ab --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[F] typespecTypeToJson" + +--- +```ts +function typespecTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] +``` + +Convert a TypeSpec type to a serializable Json object. +Emits diagnostics if the given type is invalid + +## Type parameters + +| Type parameter | +| :------ | +| `T` | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `typespecType` | [`TypeSpecValue`](../type-aliases/TypeSpecValue.md) | The type to convert to Json data | +| `target` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | The diagnostic target in case of errors. | + +## Returns + +[`T` \| `undefined`, [`Diagnostic`](../interfaces/Diagnostic.md)[]] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md new file mode 100644 index 00000000000..e79ce211734 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[F] validateDecoratorNotOnType" + +--- +```ts +function 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 + +`boolean` + +Whether the decorator application is valid diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md new file mode 100644 index 00000000000..21d861e3547 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] validateDecoratorParamCount" + +--- +```ts +function validateDecoratorParamCount( + context, + min, + max, + parameters): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `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 00000000000..6d7022c3f07 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md @@ -0,0 +1,67 @@ +--- +jsApi: true +title: "[F] validateDecoratorParamType" + +--- +```ts +function validateDecoratorParamType( + program, + target, + value, + expectedType): value is InferredTypeSpecValue +``` + +Validate a decorator parameter has the correct type. + +## Type parameters + +| Type parameter | +| :------ | +| `K` *extends* + \| `"Boolean"` + \| `"Decorator"` + \| `"Enum"` + \| `"EnumMember"` + \| `"FunctionParameter"` + \| `"Function"` + \| `"Interface"` + \| `"Intrinsic"` + \| `"Model"` + \| `"ModelProperty"` + \| `"Namespace"` + \| `"Number"` + \| `"Object"` + \| `"Operation"` + \| `"Projection"` + \| `"Scalar"` + \| `"ScalarConstructor"` + \| `"String"` + \| `"StringTemplate"` + \| `"StringTemplateSpan"` + \| `"TemplateParameter"` + \| `"Tuple"` + \| `"Union"` + \| `"UnionVariant"` | + +## 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 + +`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/functions/validateDecoratorTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md new file mode 100644 index 00000000000..aeaeca9663b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md @@ -0,0 +1,33 @@ +--- +jsApi: true +title: "[F] validateDecoratorTarget" + +--- +```ts +function validateDecoratorTarget( + context, + target, + decoratorName, + expectedType): target is K extends "Any" ? Type : Type & Object +``` + +Validate the decorator target is matching the expected value. + +## Type parameters + +| Type parameter | +| :------ | +| `K` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | +| `target` | [`Type`](../type-aliases/Type.md) | | +| `decoratorName` | `string` | | +| `expectedType` | `K` \| readonly `K`[] | | + +## Returns + +`target is K extends "Any" ? Type : Type & Object` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md new file mode 100644 index 00000000000..41b753da946 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[F] validateDecoratorTargetIntrinsic" + +--- +```ts +function 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 + +`boolean` + +## Deprecated + +this function is deprecated use decorator definition in TypeSpec instead or check assignability directly. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md new file mode 100644 index 00000000000..cdb59d96b14 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] validateDecoratorUniqueOnNode" + +--- +```ts +function validateDecoratorUniqueOnNode( + context, + type, + decorator): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | +| `type` | [`Type`](../type-aliases/Type.md) | +| `decorator` | [`DecoratorFunction`](../interfaces/DecoratorFunction.md) | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md new file mode 100644 index 00000000000..c40dfb2c25c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] visitChildren" + +--- +```ts +function visitChildren(node, cb): T | undefined +``` + +## Type parameters + +| Type parameter | +| :------ | +| `T` | + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`Node`](../type-aliases/Node.md) | +| `cb` | [`NodeCallback`](../type-aliases/NodeCallback.md)<`T`\> | + +## Returns + +`T` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md new file mode 100644 index 00000000000..c29c3214d64 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] walkPropertiesInherited" + +--- +```ts +function walkPropertiesInherited(model): Generator +``` + +Enumerates the properties declared by model or inherited from its base. + +Properties declared by more derived types are enumerated before properties +of less derived types. + +Properties that are overridden are not enumerated. + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `model` | [`Model`](../interfaces/Model.md) | + +## Returns + +`Generator`<[`ModelProperty`](../interfaces/ModelProperty.md), `void`, `unknown`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md new file mode 100644 index 00000000000..afb5be83acd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md @@ -0,0 +1,614 @@ +--- +jsApi: true +title: "[P] JS API" + +--- +## Enumerations + +- [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](classes/DuplicateTracker.md) +- [EventEmitter](classes/EventEmitter.md) +- [ProjectionError](classes/ProjectionError.md) +- [Queue](classes/Queue.md) +- [ResolveModuleError](classes/ResolveModuleError.md) + +## Interfaces + +- [AliasStatementNode](interfaces/AliasStatementNode.md) +- [AnyKeywordNode](interfaces/AnyKeywordNode.md) +- [ArrayExpressionNode](interfaces/ArrayExpressionNode.md) +- [ArrayLiteralNode](interfaces/ArrayLiteralNode.md) +- [ArrayModelType](interfaces/ArrayModelType.md) +- [ArrayValue](interfaces/ArrayValue.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) +- [BooleanValue](interfaces/BooleanValue.md) +- [CallExpressionNode](interfaces/CallExpressionNode.md) +- [CallableMessage](interfaces/CallableMessage.md) +- [Checker](interfaces/Checker.md) +- [CodeFix](interfaces/CodeFix.md) +- [CodeFixContext](interfaces/CodeFixContext.md) +- [CompileResult](interfaces/CompileResult.md) +- [CompilerHost](interfaces/CompilerHost.md) +- [CompilerLocationContext](interfaces/CompilerLocationContext.md) +- [CompilerOptions](interfaces/CompilerOptions.md) +- [ConstStatementNode](interfaces/ConstStatementNode.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) +- [DocErrorsTagNode](interfaces/DocErrorsTagNode.md) +- [DocNode](interfaces/DocNode.md) +- [DocParamTagNode](interfaces/DocParamTagNode.md) +- [DocPropTagNode](interfaces/DocPropTagNode.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) +- [EnumValue](interfaces/EnumValue.md) +- [ErrorType](interfaces/ErrorType.md) +- [ExternKeywordNode](interfaces/ExternKeywordNode.md) +- [FileLibraryMetadata](interfaces/FileLibraryMetadata.md) +- [FilePos](interfaces/FilePos.md) +- [FunctionDeclarationStatementNode](interfaces/FunctionDeclarationStatementNode.md) +- [FunctionParameterBase](interfaces/FunctionParameterBase.md) +- [FunctionParameterNode](interfaces/FunctionParameterNode.md) +- [FunctionType](interfaces/FunctionType.md) +- [IdentifierContext](interfaces/IdentifierContext.md) +- [IdentifierNode](interfaces/IdentifierNode.md) +- [ImportStatementNode](interfaces/ImportStatementNode.md) +- [IndeterminateEntity](interfaces/IndeterminateEntity.md) +- [InsertTextCodeFixEdit](interfaces/InsertTextCodeFixEdit.md) +- [Interface](interfaces/Interface.md) +- [InterfaceStatementNode](interfaces/InterfaceStatementNode.md) +- [IntersectionExpressionNode](interfaces/IntersectionExpressionNode.md) +- [IntrinsicType](interfaces/IntrinsicType.md) +- [InvalidStatementNode](interfaces/InvalidStatementNode.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) +- [LinterResolvedDefinition](interfaces/LinterResolvedDefinition.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) +- [MixedFunctionParameter](interfaces/MixedFunctionParameter.md) +- [MixedParameterConstraint](interfaces/MixedParameterConstraint.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) +- [NullValue](interfaces/NullValue.md) +- [Numeric](interfaces/Numeric.md) +- [NumericLiteral](interfaces/NumericLiteral.md) +- [NumericLiteralNode](interfaces/NumericLiteralNode.md) +- [NumericValue](interfaces/NumericValue.md) +- [ObjectLiteralNode](interfaces/ObjectLiteralNode.md) +- [ObjectLiteralPropertyNode](interfaces/ObjectLiteralPropertyNode.md) +- [ObjectLiteralSpreadPropertyNode](interfaces/ObjectLiteralSpreadPropertyNode.md) +- [ObjectType](interfaces/ObjectType.md) +- [ObjectValue](interfaces/ObjectValue.md) +- [ObjectValuePropertyDescriptor](interfaces/ObjectValuePropertyDescriptor.md) +- [Operation](interfaces/Operation.md) +- [OperationSignatureDeclarationNode](interfaces/OperationSignatureDeclarationNode.md) +- [OperationSignatureReferenceNode](interfaces/OperationSignatureReferenceNode.md) +- [OperationStatementNode](interfaces/OperationStatementNode.md) +- [PackageFlags](interfaces/PackageFlags.md) +- [ParseOptions](interfaces/ParseOptions.md) +- [PatternData](interfaces/PatternData.md) +- [PositionDetail](interfaces/PositionDetail.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) +- [ProjectionScalarSelectorNode](interfaces/ProjectionScalarSelectorNode.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) +- [ReplaceTextCodeFixEdit](interfaces/ReplaceTextCodeFixEdit.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) +- [ScalarConstructor](interfaces/ScalarConstructor.md) +- [ScalarConstructorNode](interfaces/ScalarConstructorNode.md) +- [ScalarStatementNode](interfaces/ScalarStatementNode.md) +- [ScalarValue](interfaces/ScalarValue.md) +- [Scanner](interfaces/Scanner.md) +- [SemanticToken](interfaces/SemanticToken.md) +- [Server](interfaces/Server.md) +- [ServerHost](interfaces/ServerHost.md) +- [ServerLog](interfaces/ServerLog.md) +- [ServerSourceFile](interfaces/ServerSourceFile.md) +- [ServerWorkspaceFolder](interfaces/ServerWorkspaceFolder.md) +- [Service](interfaces/Service.md) +- [ServiceDetails](interfaces/ServiceDetails.md) +- [SignatureFunctionParameter](interfaces/SignatureFunctionParameter.md) +- [SourceFile](interfaces/SourceFile.md) +- [SourceLocation](interfaces/SourceLocation.md) +- [SourceLocationOptions](interfaces/SourceLocationOptions.md) +- [SourceModel](interfaces/SourceModel.md) +- [StateDef](interfaces/StateDef.md) +- [StringLiteral](interfaces/StringLiteral.md) +- [StringLiteralNode](interfaces/StringLiteralNode.md) +- [StringTemplate](interfaces/StringTemplate.md) +- [StringTemplateExpressionNode](interfaces/StringTemplateExpressionNode.md) +- [StringTemplateHeadNode](interfaces/StringTemplateHeadNode.md) +- [StringTemplateLiteralLikeNode](interfaces/StringTemplateLiteralLikeNode.md) +- [StringTemplateMiddleNode](interfaces/StringTemplateMiddleNode.md) +- [StringTemplateSpanLiteral](interfaces/StringTemplateSpanLiteral.md) +- [StringTemplateSpanNode](interfaces/StringTemplateSpanNode.md) +- [StringTemplateSpanValue](interfaces/StringTemplateSpanValue.md) +- [StringTemplateTailNode](interfaces/StringTemplateTailNode.md) +- [StringValue](interfaces/StringValue.md) +- [SuppressDirective](interfaces/SuppressDirective.md) +- [Sym](interfaces/Sym.md) +- [SymbolLinks](interfaces/SymbolLinks.md) +- [SyntheticLocationContext](interfaces/SyntheticLocationContext.md) +- [TemplateArgumentNode](interfaces/TemplateArgumentNode.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) +- [TypeOfExpressionNode](interfaces/TypeOfExpressionNode.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) +- [VoidKeywordNode](interfaces/VoidKeywordNode.md) +- [VoidType](interfaces/VoidType.md) + +## Type Aliases + +- [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) +- [CodeFixEdit](type-aliases/CodeFixEdit.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) +- [Entity](type-aliases/Entity.md) +- [Expression](type-aliases/Expression.md) +- [FunctionParameter](type-aliases/FunctionParameter.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) +- [ServerLogLevel](type-aliases/ServerLogLevel.md) +- [SourceFileKind](type-aliases/SourceFileKind.md) +- [Statement](type-aliases/Statement.md) +- [StdTypeName](type-aliases/StdTypeName.md) +- [StdTypes](type-aliases/StdTypes.md) +- [StringTemplateSpan](type-aliases/StringTemplateSpan.md) +- [StringTemplateToken](type-aliases/StringTemplateToken.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) +- [Value](type-aliases/Value.md) +- [WriteLine](type-aliases/WriteLine.md) + +## Variables + +- [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 + +- [$deprecated](functions/$deprecated.md) +- [$discriminator](functions/$discriminator.md) +- [$doc](functions/$doc.md) +- [$encode](functions/$encode.md) +- [$encodedName](functions/$encodedName.md) +- [$error](functions/$error.md) +- [$errorsDoc](functions/$errorsDoc.md) +- [$format](functions/$format.md) +- [$friendlyName](functions/$friendlyName.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) +- [$withPickedProperties](functions/$withPickedProperties.md) +- [$withUpdateableProperties](functions/$withUpdateableProperties.md) +- [$withVisibility](functions/$withVisibility.md) +- [$withoutDefaultValues](functions/$withoutDefaultValues.md) +- [$withoutOmittedProperties](functions/$withoutOmittedProperties.md) +- [Numeric](functions/Numeric.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) +- [createProjectedNameProgram](functions/createProjectedNameProgram.md) +- [createRekeyableMap](functions/createRekeyableMap.md) +- [createRule](functions/createRule.md) +- [createScanner](functions/createScanner.md) +- [createServer](functions/createServer.md) +- [createSourceFile](functions/createSourceFile.md) +- [createTypeSpecLibrary](functions/createTypeSpecLibrary.md) +- [defineCodeFix](functions/defineCodeFix.md) +- [defineLinter](functions/defineLinter.md) +- [definePackageFlags](functions/definePackageFlags.md) +- [emitFile](functions/emitFile.md) +- [ensureTrailingDirectorySeparator](functions/ensureTrailingDirectorySeparator.md) +- [explainStringTemplateNotSerializable](functions/explainStringTemplateNotSerializable.md) +- [exprIsBareIdentifier](functions/exprIsBareIdentifier.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) +- [getEffectiveModelType](functions/getEffectiveModelType.md) +- [getEncode](functions/getEncode.md) +- [getEntityName](functions/getEntityName.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) +- [getKeyName](functions/getKeyName.md) +- [getKnownValues](functions/getKnownValues.md) +- [getListOperationType](functions/getListOperationType.md) +- [getLocationContext](functions/getLocationContext.md) +- [getMaxItems](functions/getMaxItems.md) +- [getMaxItemsAsNumeric](functions/getMaxItemsAsNumeric.md) +- [getMaxLength](functions/getMaxLength.md) +- [getMaxLengthAsNumeric](functions/getMaxLengthAsNumeric.md) +- [getMaxValue](functions/getMaxValue.md) +- [getMaxValueAsNumeric](functions/getMaxValueAsNumeric.md) +- [getMaxValueExclusive](functions/getMaxValueExclusive.md) +- [getMaxValueExclusiveAsNumeric](functions/getMaxValueExclusiveAsNumeric.md) +- [getMinItems](functions/getMinItems.md) +- [getMinItemsAsNumeric](functions/getMinItemsAsNumeric.md) +- [getMinLength](functions/getMinLength.md) +- [getMinLengthAsNumeric](functions/getMinLengthAsNumeric.md) +- [getMinValue](functions/getMinValue.md) +- [getMinValueAsNumeric](functions/getMinValueAsNumeric.md) +- [getMinValueExclusive](functions/getMinValueExclusive.md) +- [getMinValueExclusiveAsNumeric](functions/getMinValueExclusiveAsNumeric.md) +- [getNamespaceFullName](functions/getNamespaceFullName.md) +- [getNodeAtPosition](functions/getNodeAtPosition.md) +- [getNodeAtPositionDetail](functions/getNodeAtPositionDetail.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) +- [getPatternData](functions/getPatternData.md) +- [getPositionBeforeTrivia](functions/getPositionBeforeTrivia.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) +- [isNumeric](functions/isNumeric.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) +- [isType](functions/isType.md) +- [isTypeSpecValueTypeOf](functions/isTypeSpecValueTypeOf.md) +- [isUnknownType](functions/isUnknownType.md) +- [isUrl](functions/isUrl.md) +- [isValue](functions/isValue.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) +- [positionInRange](functions/positionInRange.md) +- [projectProgram](functions/projectProgram.md) +- [reducePathComponents](functions/reducePathComponents.md) +- [removeTrailingDirectorySeparator](functions/removeTrailingDirectorySeparator.md) +- [reportDeprecated](functions/reportDeprecated.md) +- [resolveCompilerOptions](functions/resolveCompilerOptions.md) +- [resolveEncodedName](functions/resolveEncodedName.md) +- [resolveLinterDefinition](functions/resolveLinterDefinition.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) +- [skipContinuousIdentifier](functions/skipContinuousIdentifier.md) +- [skipTrivia](functions/skipTrivia.md) +- [skipTriviaBackward](functions/skipTriviaBackward.md) +- [skipWhiteSpace](functions/skipWhiteSpace.md) +- [stringTemplateToString](functions/stringTemplateToString.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 00000000000..330c3191294 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[I] AliasStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `AliasStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | +| `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md new file mode 100644 index 00000000000..aca32333dbc --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `UnknownKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..40416ef50dc --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `elementType` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ArrayExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayLiteralNode.md new file mode 100644 index 00000000000..5d640900b21 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayLiteralNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ArrayLiteralNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ArrayLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `values` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md new file mode 100644 index 00000000000..952505395ce --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md @@ -0,0 +1,69 @@ +--- +jsApi: true +title: "[I] ArrayModelType" + +--- +## Extends + +- [`Model`](Model.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `baseModel?` | `public` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | [`Model`](Model.md).`baseModel` | [`Model`](Model.md).`baseModel` | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`Model`](Model.md).`decorators` | [`Model`](Model.md).`decorators` | +| `derivedModels` | `public` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](Model.md) | [`Model`](Model.md).`derivedModels` | [`Model`](Model.md).`derivedModels` | +| `entityKind` | `readonly` | `"Type"` | - | [`Model`](Model.md).`entityKind` | [`Model`](Model.md).`entityKind` | +| `indexer` | `public` | `object` | - | [`Model`](Model.md).`indexer` | [`Model`](Model.md).`indexer` | +| `indexer.key` | `public` | [`Scalar`](Scalar.md) | - | - | - | +| `indexer.value` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`Model`](Model.md).`instantiationParameters` | [`Model`](Model.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

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

The properties of the model.

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

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

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

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

**Deprecated**

use templateMapper instead.

| [`Model`](Model.md).`templateArguments` | [`Model`](Model.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`Model`](Model.md).`templateMapper` | [`Model`](Model.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`Model`](Model.md).`templateNode` | [`Model`](Model.md).`templateNode` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`Model`](Model.md).[`projectionsByName`](Model.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayValue.md new file mode 100644 index 00000000000..b5fe7f41378 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayValue.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] ArrayValue" + +--- +## Extends + +- `BaseValue` + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| `node` | `public` | [`ArrayLiteralNode`](ArrayLiteralNode.md) | - | - | - | +| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

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

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

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

 | `BaseValue.type` | `BaseValue.type` | +| `valueKind` | `public` | `"ArrayValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | +| `values` | `public` | [`Value`](../type-aliases/Value.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md new file mode 100644 index 00000000000..bc54dc3a87b --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `arguments` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `AugmentDecoratorStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `targetType` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md new file mode 100644 index 00000000000..f6837fc6a16 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md @@ -0,0 +1,115 @@ +--- +jsApi: true +title: "[I] BaseNode" + +--- +## Extends + +- [`TextRange`](TextRange.md) + +## Extended by + +- [`TypeSpecScriptNode`](TypeSpecScriptNode.md) +- [`ImportStatementNode`](ImportStatementNode.md) +- [`IdentifierNode`](IdentifierNode.md) +- [`DecoratorExpressionNode`](DecoratorExpressionNode.md) +- [`AugmentDecoratorStatementNode`](AugmentDecoratorStatementNode.md) +- [`DirectiveExpressionNode`](DirectiveExpressionNode.md) +- [`MemberExpressionNode`](MemberExpressionNode.md) +- [`NamespaceStatementNode`](NamespaceStatementNode.md) +- [`UsingStatementNode`](UsingStatementNode.md) +- [`OperationSignatureDeclarationNode`](OperationSignatureDeclarationNode.md) +- [`OperationSignatureReferenceNode`](OperationSignatureReferenceNode.md) +- [`OperationStatementNode`](OperationStatementNode.md) +- [`ModelStatementNode`](ModelStatementNode.md) +- [`ScalarStatementNode`](ScalarStatementNode.md) +- [`ScalarConstructorNode`](ScalarConstructorNode.md) +- [`InterfaceStatementNode`](InterfaceStatementNode.md) +- [`UnionStatementNode`](UnionStatementNode.md) +- [`UnionVariantNode`](UnionVariantNode.md) +- [`EnumStatementNode`](EnumStatementNode.md) +- [`EnumMemberNode`](EnumMemberNode.md) +- [`EnumSpreadMemberNode`](EnumSpreadMemberNode.md) +- [`AliasStatementNode`](AliasStatementNode.md) +- [`ConstStatementNode`](ConstStatementNode.md) +- [`CallExpressionNode`](CallExpressionNode.md) +- [`InvalidStatementNode`](InvalidStatementNode.md) +- [`EmptyStatementNode`](EmptyStatementNode.md) +- [`ModelExpressionNode`](ModelExpressionNode.md) +- [`ArrayExpressionNode`](ArrayExpressionNode.md) +- [`TupleExpressionNode`](TupleExpressionNode.md) +- [`ModelPropertyNode`](ModelPropertyNode.md) +- [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md) +- [`ObjectLiteralNode`](ObjectLiteralNode.md) +- [`ObjectLiteralPropertyNode`](ObjectLiteralPropertyNode.md) +- [`ObjectLiteralSpreadPropertyNode`](ObjectLiteralSpreadPropertyNode.md) +- [`ArrayLiteralNode`](ArrayLiteralNode.md) +- [`StringLiteralNode`](StringLiteralNode.md) +- [`NumericLiteralNode`](NumericLiteralNode.md) +- [`BooleanLiteralNode`](BooleanLiteralNode.md) +- [`StringTemplateExpressionNode`](StringTemplateExpressionNode.md) +- [`StringTemplateSpanNode`](StringTemplateSpanNode.md) +- [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md) +- [`ExternKeywordNode`](ExternKeywordNode.md) +- [`VoidKeywordNode`](VoidKeywordNode.md) +- [`NeverKeywordNode`](NeverKeywordNode.md) +- [`AnyKeywordNode`](AnyKeywordNode.md) +- [`ReturnExpressionNode`](ReturnExpressionNode.md) +- [`UnionExpressionNode`](UnionExpressionNode.md) +- [`IntersectionExpressionNode`](IntersectionExpressionNode.md) +- [`ValueOfExpressionNode`](ValueOfExpressionNode.md) +- [`TypeOfExpressionNode`](TypeOfExpressionNode.md) +- [`TypeReferenceNode`](TypeReferenceNode.md) +- [`TemplateArgumentNode`](TemplateArgumentNode.md) +- [`ProjectionReferenceNode`](ProjectionReferenceNode.md) +- [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md) +- [`DecoratorDeclarationStatementNode`](DecoratorDeclarationStatementNode.md) +- [`FunctionParameterNode`](FunctionParameterNode.md) +- [`FunctionDeclarationStatementNode`](FunctionDeclarationStatementNode.md) +- [`ProjectionModelSelectorNode`](ProjectionModelSelectorNode.md) +- [`ProjectionScalarSelectorNode`](ProjectionScalarSelectorNode.md) +- [`ProjectionModelPropertySelectorNode`](ProjectionModelPropertySelectorNode.md) +- [`ProjectionInterfaceSelectorNode`](ProjectionInterfaceSelectorNode.md) +- [`ProjectionOperationSelectorNode`](ProjectionOperationSelectorNode.md) +- [`ProjectionUnionSelectorNode`](ProjectionUnionSelectorNode.md) +- [`ProjectionUnionVariantSelectorNode`](ProjectionUnionVariantSelectorNode.md) +- [`ProjectionEnumSelectorNode`](ProjectionEnumSelectorNode.md) +- [`ProjectionEnumMemberSelectorNode`](ProjectionEnumMemberSelectorNode.md) +- [`ProjectionParameterDeclarationNode`](ProjectionParameterDeclarationNode.md) +- [`ProjectionExpressionStatementNode`](ProjectionExpressionStatementNode.md) +- [`ProjectionLogicalExpressionNode`](ProjectionLogicalExpressionNode.md) +- [`ProjectionRelationalExpressionNode`](ProjectionRelationalExpressionNode.md) +- [`ProjectionEqualityExpressionNode`](ProjectionEqualityExpressionNode.md) +- [`ProjectionArithmeticExpressionNode`](ProjectionArithmeticExpressionNode.md) +- [`ProjectionUnaryExpressionNode`](ProjectionUnaryExpressionNode.md) +- [`ProjectionCallExpressionNode`](ProjectionCallExpressionNode.md) +- [`ProjectionMemberExpressionNode`](ProjectionMemberExpressionNode.md) +- [`ProjectionModelExpressionNode`](ProjectionModelExpressionNode.md) +- [`ProjectionTupleExpressionNode`](ProjectionTupleExpressionNode.md) +- [`ProjectionModelPropertyNode`](ProjectionModelPropertyNode.md) +- [`ProjectionModelSpreadPropertyNode`](ProjectionModelSpreadPropertyNode.md) +- [`ProjectionIfExpressionNode`](ProjectionIfExpressionNode.md) +- [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) +- [`ProjectionLambdaExpressionNode`](ProjectionLambdaExpressionNode.md) +- [`ProjectionLambdaParameterDeclarationNode`](ProjectionLambdaParameterDeclarationNode.md) +- [`ProjectionNode`](ProjectionNode.md) +- [`ProjectionStatementNode`](ProjectionStatementNode.md) +- [`ProjectionDecoratorReferenceExpressionNode`](ProjectionDecoratorReferenceExpressionNode.md) +- [`DocNode`](DocNode.md) +- [`DocTagBaseNode`](DocTagBaseNode.md) +- [`DocTextNode`](DocTextNode.md) +- [`JsSourceFileNode`](JsSourceFileNode.md) +- [`JsNamespaceDeclarationNode`](JsNamespaceDeclarationNode.md) + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | - | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | - | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`TextRange`](TextRange.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | +| `kind` | `readonly` | [`SyntaxKind`](../enumerations/SyntaxKind.md) | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | - | 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 00000000000..fb915a81832 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md @@ -0,0 +1,75 @@ +--- +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) +- [`ScalarConstructor`](ScalarConstructor.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) +- [`StringTemplate`](StringTemplate.md) +- [`StringTemplateSpanLiteral`](StringTemplateSpanLiteral.md) +- [`StringTemplateSpanValue`](StringTemplateSpanValue.md) +- [`Tuple`](Tuple.md) +- [`Union`](Union.md) +- [`UnionVariant`](UnionVariant.md) +- [`TemplateParameter`](TemplateParameter.md) +- [`Decorator`](Decorator.md) +- [`FunctionType`](FunctionType.md) +- [`FunctionParameterBase`](FunctionParameterBase.md) + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| +| `kind` | `public` | `string` | - | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | +| `projector?` | `public` | [`Projector`](Projector.md) | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md new file mode 100644 index 00000000000..630a54d7561 --- /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 + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`TextRange`](TextRange.md).`end` | +| `kind` | `readonly` | `BlockComment` | - | - | +| `parsedAsDocs?` | `readonly` | `boolean` | If that comment was parsed as a doc comment. If parserOptions.docs=false this will always be false. | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md new file mode 100644 index 00000000000..3b01934fc97 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md @@ -0,0 +1,56 @@ +--- +jsApi: true +title: "[I] BooleanLiteral" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Boolean"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `node?` | `public` | [`BooleanLiteralNode`](BooleanLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `value` | `public` | `boolean` | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md new file mode 100644 index 00000000000..2f8ec848b0a --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `BooleanLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `value` | `readonly` | `boolean` | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanValue.md new file mode 100644 index 00000000000..41784e7a5e2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanValue.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] BooleanValue" + +--- +## Extends + +- `BaseValue` + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| `scalar` | `public` | `undefined` \| [`Scalar`](Scalar.md) | - | - | - | +| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

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

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

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

 | `BaseValue.type` | `BaseValue.type` | +| `value` | `public` | `boolean` | - | - | - | +| `valueKind` | `public` | `"BooleanValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallExpressionNode.md new file mode 100644 index 00000000000..3c4b4058ae1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallExpressionNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] CallExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `arguments` | `readonly` | [`Expression`](../type-aliases/Expression.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `CallExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md new file mode 100644 index 00000000000..1ed513dcd0c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[I] CallableMessage" + +--- +## Type parameters + +| Type parameter | +| :------ | +| `T` *extends* `string`[] | + +```ts +interface CallableMessage(dict): string +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `dict` | `Record`<`T`\[`number`\], `string`\> | + +## Returns + +`string` + +## Properties + +| Property | Type | +| :------ | :------ | +| `keys` | `T` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md new file mode 100644 index 00000000000..e2e74af7505 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md @@ -0,0 +1,656 @@ +--- +jsApi: true +title: "[I] Checker" + +--- +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `anyType` | `readonly` | [`UnknownType`](UnknownType.md) | +| `errorType` | `readonly` | [`ErrorType`](ErrorType.md) | +| `neverType` | `readonly` | [`NeverType`](NeverType.md) | +| `nullType` | `readonly` | [`NullType`](NullType.md) | +| `typePrototype` | `public` | `TypePrototype` | +| `voidType` | `readonly` | [`VoidType`](VoidType.md) | + +## Methods + +### checkProgram() + +```ts +checkProgram(): void +``` + +#### Returns + +`void` + +*** + +### checkSourceFile() + +```ts +checkSourceFile(file): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | + +#### Returns + +`void` + +*** + +### cloneType() + +```ts +cloneType(type, additionalProps?): T +``` + +#### Type parameters + +| Type parameter | +| :------ | +| `T` *extends* [`Type`](../type-aliases/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 + +| Type parameter | +| :------ | +| `T` *extends* [`CreateTypeProps`](../type-aliases/CreateTypeProps.md) | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeDef` | `T` | + +#### Returns + +`T` & `TypePrototype` + +*** + +### createFunctionType() + +```ts +createFunctionType(fn): FunctionType +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `fn` | (...`args`) => [`Type`](../type-aliases/Type.md) | + +#### Returns + +[`FunctionType`](FunctionType.md) + +*** + +### createLiteralType() + +#### createLiteralType(value, node) + +```ts +createLiteralType(value, node?): StringLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `string` | +| `node`? | [`StringLiteralNode`](StringLiteralNode.md) | + +##### Returns + +[`StringLiteral`](StringLiteral.md) + +#### createLiteralType(value, node) + +```ts +createLiteralType(value, node?): NumericLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `number` | +| `node`? | [`NumericLiteralNode`](NumericLiteralNode.md) | + +##### Returns + +[`NumericLiteral`](NumericLiteral.md) + +#### createLiteralType(value, node) + +```ts +createLiteralType(value, node?): BooleanLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `boolean` | +| `node`? | [`BooleanLiteralNode`](BooleanLiteralNode.md) | + +##### Returns + +[`BooleanLiteral`](BooleanLiteral.md) + +#### createLiteralType(value, node) + +```ts +createLiteralType(value, node?): BooleanLiteral | NumericLiteral | StringLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `string` \| `number` \| `boolean` | +| `node`? | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) \| [`BooleanLiteralNode`](BooleanLiteralNode.md) | + +##### Returns + +[`BooleanLiteral`](BooleanLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`StringLiteral`](StringLiteral.md) + +#### createLiteralType(value, node) + +```ts +createLiteralType(value, node?): BooleanLiteral | NumericLiteral | StringLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | `string` \| `number` \| `boolean` | +| `node`? | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) \| [`BooleanLiteralNode`](BooleanLiteralNode.md) | + +##### Returns + +[`BooleanLiteral`](BooleanLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`StringLiteral`](StringLiteral.md) + +*** + +### createType() + +```ts +createType(typeDef): T & TypePrototype & object +``` + +#### Type parameters + +| Type parameter | +| :------ | +| `T` *extends* [`CreateTypeProps`](../type-aliases/CreateTypeProps.md) | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeDef` | `T` | + +#### Returns + +`T` & `TypePrototype` & `object` + +*** + +### 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)[] | + +#### Returns + +[`Type`](../type-aliases/Type.md) + +*** + +### finishType() + +```ts +finishType(typeDef): T +``` + +#### Type parameters + +| Type parameter | +| :------ | +| `T` *extends* [`Type`](../type-aliases/Type.md) | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeDef` | `T` | + +#### Returns + +`T` + +*** + +### getGlobalNamespaceNode() + +```ts +getGlobalNamespaceNode(): NamespaceStatementNode +``` + +#### Returns + +[`NamespaceStatementNode`](NamespaceStatementNode.md) + +*** + +### getGlobalNamespaceType() + +```ts +getGlobalNamespaceType(): Namespace +``` + +#### Returns + +[`Namespace`](Namespace.md) + +*** + +### getLiteralType() + +#### getLiteralType(node) + +```ts +getLiteralType(node): StringLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`StringLiteralNode`](StringLiteralNode.md) | + +##### Returns + +[`StringLiteral`](StringLiteral.md) + +#### getLiteralType(node) + +```ts +getLiteralType(node): NumericLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`NumericLiteralNode`](NumericLiteralNode.md) | + +##### Returns + +[`NumericLiteral`](NumericLiteral.md) + +#### getLiteralType(node) + +```ts +getLiteralType(node): BooleanLiteral +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`BooleanLiteralNode`](BooleanLiteralNode.md) | + +##### Returns + +[`BooleanLiteral`](BooleanLiteral.md) + +#### getLiteralType(node) + +```ts +getLiteralType(node): LiteralType +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`LiteralNode`](../type-aliases/LiteralNode.md) | + +##### Returns + +[`LiteralType`](../type-aliases/LiteralType.md) + +*** + +### getMergedSymbol() + +```ts +getMergedSymbol(sym): undefined | Sym +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `sym` | `undefined` \| [`Sym`](Sym.md) | + +#### Returns + +`undefined` \| [`Sym`](Sym.md) + +*** + +### ~~getNamespaceString()~~ + +```ts +getNamespaceString(type, options?): string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | `undefined` \| [`Namespace`](Namespace.md) | +| `options`? | [`TypeNameOptions`](TypeNameOptions.md) | + +#### Returns + +`string` + +#### Deprecated + +use `import { getNamespaceFullName } from "@typespec/compiler";` + +*** + +### getStdType() + +```ts +getStdType(name): StdTypes[T] +``` + +Std type + +#### Type parameters + +| Type parameter | +| :------ | +| `T` *extends* `"Array"` \| [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| `"Record"` | + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `name` | `T` | Name | + +#### Returns + +[`StdTypes`](../type-aliases/StdTypes.md)\[`T`\] + +*** + +### getTypeForNode() + +```ts +getTypeForNode(node): Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`Node`](../type-aliases/Node.md) | + +#### Returns + +[`Type`](../type-aliases/Type.md) + +*** + +### ~~getTypeName()~~ + +```ts +getTypeName(type, options?): string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](../type-aliases/Type.md) | +| `options`? | [`TypeNameOptions`](TypeNameOptions.md) | + +#### Returns + +`string` + +#### 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 | + +##### Returns + +`type is Scalar & Object` + +#### isStdType(type, stdType) + +```ts +isStdType(type, stdType?): type is Type & Object +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](../type-aliases/Type.md) | +| `stdType`? | `"Array"` \| [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| `"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` | [`Entity`](../type-aliases/Entity.md) | Source type, should be assignable to the target. | +| `target` | [`Entity`](../type-aliases/Entity.md) | Target type | +| `diagnosticTarget` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | Target for the diagnostic, unless something better can be inferred. | + +#### Returns + +[`boolean`, readonly [`Diagnostic`](Diagnostic.md)[]] + +[related, list of diagnostics] + +*** + +### mergeSourceFile() + +```ts +mergeSourceFile(file): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`JsSourceFileNode`](JsSourceFileNode.md) | + +#### Returns + +`void` + +*** + +### 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))[] | + +#### Returns + +[`Type`](../type-aliases/Type.md) + +*** + +### resolveCompletions() + +```ts +resolveCompletions(node): Map +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`IdentifierNode`](IdentifierNode.md) | + +#### Returns + +`Map`<`string`, [`TypeSpecCompletionItem`](TypeSpecCompletionItem.md)\> + +*** + +### resolveIdentifier() + +```ts +resolveIdentifier(node): undefined | Sym +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `node` | [`IdentifierNode`](IdentifierNode.md) | + +#### Returns + +`undefined` \| [`Sym`](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`](TypeReferenceNode.md) | Node. | + +#### Returns + +[`undefined` \| [`Type`](../type-aliases/Type.md), readonly [`Diagnostic`](Diagnostic.md)[]] + +Resolved type and diagnostics if there was an error. + +*** + +### setUsingsForFile() + +```ts +setUsingsForFile(file): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `file` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFix.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFix.md new file mode 100644 index 00000000000..37817220333 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFix.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] CodeFix" + +--- +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `fix` | `readonly` | (`fixContext`: [`CodeFixContext`](CodeFixContext.md)) => `void` \| `Promise`<`void`\> \| [`CodeFixEdit`](../type-aliases/CodeFixEdit.md) \| [`CodeFixEdit`](../type-aliases/CodeFixEdit.md)[] | +| `id` | `readonly` | `string` | +| `label` | `readonly` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFixContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFixContext.md new file mode 100644 index 00000000000..0f07b09cdaa --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CodeFixContext.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] CodeFixContext" + +--- +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `appendText` | `readonly` | (`location`: [`SourceLocation`](SourceLocation.md) \| [`FilePos`](FilePos.md), `text`: `string`) => [`InsertTextCodeFixEdit`](InsertTextCodeFixEdit.md) | Add the given text after the range or pos given. | +| `prependText` | `readonly` | (`location`: [`SourceLocation`](SourceLocation.md) \| [`FilePos`](FilePos.md), `text`: `string`) => [`InsertTextCodeFixEdit`](InsertTextCodeFixEdit.md) | Add the given text before the range or pos given. | +| `replaceText` | `readonly` | (`location`: [`SourceLocation`](SourceLocation.md), `newText`: `string`) => [`ReplaceTextCodeFixEdit`](ReplaceTextCodeFixEdit.md) | Replace the text at the given range. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompileResult.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompileResult.md new file mode 100644 index 00000000000..b1a6aae8279 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompileResult.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] CompileResult" + +--- +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `document` | `readonly` | `TextDocument` | +| `program` | `readonly` | [`Program`](Program.md) | +| `script` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md new file mode 100644 index 00000000000..d9cbaeceb45 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md @@ -0,0 +1,272 @@ +--- +jsApi: true +title: "[I] CompilerHost" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `logSink` | [`LogSink`](LogSink.md) | - | +| `parseCache?` | `WeakMap`<[`SourceFile`](SourceFile.md), [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | Optional cache to reuse the results of parsing and binding across programs. | + +## Methods + +### fileURLToPath() + +```ts +fileURLToPath(url): string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `url` | `string` | + +#### Returns + +`string` + +*** + +### getExecutionRoot() + +```ts +getExecutionRoot(): string +``` + +#### Returns + +`string` + +*** + +### getJsImport() + +```ts +getJsImport(path): Promise> +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`<`Record`<`string`, `any`\>\> + +*** + +### getLibDirs() + +```ts +getLibDirs(): string[] +``` + +#### Returns + +`string`[] + +*** + +### getSourceFileKind() + +```ts +getSourceFileKind(path): undefined | SourceFileKind +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`undefined` \| [`SourceFileKind`](../type-aliases/SourceFileKind.md) + +*** + +### mkdirp() + +```ts +mkdirp(path): Promise +``` + +create directory recursively. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `path` | `string` | Path to the directory. | + +#### Returns + +`Promise`<`undefined` \| `string`\> + +*** + +### pathToFileURL() + +```ts +pathToFileURL(path): string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`string` + +*** + +### readDir() + +```ts +readDir(path): Promise +``` + +Read directory. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `path` | `string` | Path to the directory. | + +#### Returns + +`Promise`<`string`[]\> + +list of file/directory in the given directory. Returns the name not the full path. + +*** + +### readFile() + +```ts +readFile(path): Promise +``` + +read a utf-8 or utf-8 with bom encoded file + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`<[`SourceFile`](SourceFile.md)\> + +*** + +### readUrl() + +```ts +readUrl(url): Promise +``` + +read a file at the given url. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `url` | `string` | + +#### Returns + +`Promise`<[`SourceFile`](SourceFile.md)\> + +*** + +### realpath() + +```ts +realpath(path): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`<`string`\> + +*** + +### rm() + +```ts +rm(path, options?): Promise +``` + +Deletes a directory or file. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `path` | `string` | Path to the directory or file. | +| `options`? | [`RmOptions`](RmOptions.md) | - | + +#### Returns + +`Promise`<`void`\> + +*** + +### stat() + +```ts +stat(path): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`<`object`\> + +| Member | Type | +| :------ | :------ | +| `isDirectory` | `boolean` | +| `isFile` | `boolean` | + +*** + +### writeFile() + +```ts +writeFile(path, content): Promise +``` + +Write the file. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `path` | `string` | Path to the file. | +| `content` | `string` | Content of the file. | + +#### Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md new file mode 100644 index 00000000000..de4f9170146 --- /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 | Modifier | Type | +| :------ | :------ | :------ | +| `type` | `readonly` | `"compiler"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md new file mode 100644 index 00000000000..7e4750b127e --- /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 used, this is also where the project root should be. | +| `designTimeBuild?` | `boolean` | When true, indicates that a compilation is being performed for live analysis in the language server. | +| `emit?` | `string`[] | List or path to emitters to use. | +| ~~`emitters?`~~ | `Record`<`string`, `EmitterOptions`\> |

**Deprecated**

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

Will be removed in March 2022 sprint.

| +| `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/ConstStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ConstStatementNode.md new file mode 100644 index 00000000000..42af8d2e2a2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ConstStatementNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] ConstStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `ConstStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `type?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | +| `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md new file mode 100644 index 00000000000..0f3773e91f2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md @@ -0,0 +1,31 @@ +--- +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) +- [`ConstStatementNode`](ConstStatementNode.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 + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratedType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratedType.md new file mode 100644 index 00000000000..b1567ffc114 --- /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 | +| :------ | :------ | +| `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 00000000000..08bcd733529 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md @@ -0,0 +1,60 @@ +--- +jsApi: true +title: "[I] Decorator" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `implementation` | `public` | (...`args`: `unknown`[]) => `void` | - | - | - | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Decorator"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `name` | `public` | \`@$\{string\}\` | - | - | - | +| `namespace` | `public` | [`Namespace`](Namespace.md) | - | - | - | +| `node` | `public` | [`DecoratorDeclarationStatementNode`](DecoratorDeclarationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `parameters` | `public` | [`MixedFunctionParameter`](MixedFunctionParameter.md)[] | - | - | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `target` | `public` | [`MixedFunctionParameter`](MixedFunctionParameter.md) | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorApplication.md new file mode 100644 index 00000000000..223e43baf49 --- /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 | +| :------ | :------ | +| `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 00000000000..ad6bdb06d2a --- /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` | \| `null` \| `string` \| `number` \| `boolean` \| `unknown`[] \| [`Numeric`](Numeric.md) \| [`Type`](../type-aliases/Type.md) \| `Record`<`string`, `unknown`\> \| [`Value`](../type-aliases/Value.md) | Marshalled value for use in Javascript. | +| `node?` | [`Node`](../type-aliases/Node.md) | - | +| `value` | [`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md new file mode 100644 index 00000000000..6e77e12baba --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md @@ -0,0 +1,72 @@ +--- +jsApi: true +title: "[I] DecoratorContext" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `decoratorTarget` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | Point to the decorator target | +| `program` | [`Program`](Program.md) | - | + +## Methods + +### call() + +```ts +call( + decorator, + target, ... + args): R +``` + +Helper to call out to another decorator + +#### Type parameters + +| Type parameter | +| :------ | +| `T` *extends* [`Type`](../type-aliases/Type.md) | +| `A` *extends* `any`[] | +| `R` | + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `decorator` | (`context`, `target`, ...`args`) => `R` | Other decorator function | +| `target` | `T` | - | +| ...`args` | `A` | Args to pass to other decorator function | + +#### Returns + +`R` + +*** + +### getArgumentTarget() + +```ts +getArgumentTarget(paramIndex): undefined | DiagnosticTarget +``` + +Function that can be used to retrieve the target for a parameter at the given index. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `paramIndex` | `number` | Parameter index in the typespec | + +#### Returns + +`undefined` \| [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) + +#### Example + +```ts +@foo("bar", 123) -> $foo(context, target, arg0: string, arg1: number); + getArgumentTarget(0) -> target for arg0 + getArgumentTarget(1) -> target for arg1 +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md new file mode 100644 index 00000000000..c02dafc1ed1 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `DecoratorDeclarationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `modifierFlags` | `readonly` | [`ModifierFlags`](../enumerations/ModifierFlags.md) | - | - | - | +| `modifiers` | `readonly` | readonly [`ExternKeywordNode`](ExternKeywordNode.md)[] | - | - | - | +| `parameters` | `readonly` | [`FunctionParameterNode`](FunctionParameterNode.md)[] | Additional parameters | - | - | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`FunctionParameterNode`](FunctionParameterNode.md) | Decorator target. First parameter. | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md new file mode 100644 index 00000000000..9a5a4aa87aa --- /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 + +| Type parameter | Value | +| :------ | :------ | +| `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 + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `args` | `readonly` | `P` | List of positional arguments in the function. | +| `name` | `readonly` | `string` | Name of the decorator. | +| `spreadArgs?` | `readonly` | `S` |

**Optional**

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

| +| `target` | `readonly` | `T` \| readonly `T`[] | Decorator target. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md new file mode 100644 index 00000000000..4fd36fb7583 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `arguments` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `DecoratorExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md new file mode 100644 index 00000000000..2e156753f88 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorFunction.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[I] DecoratorFunction" + +--- +```ts +interface DecoratorFunction( + program, + target, ... + customArgs): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`DecoratorContext`](DecoratorContext.md) | +| `target` | `any` | +| ...`customArgs` | `any`[] | + +## Returns + +`void` + +## Properties + +| Property | Type | +| :------ | :------ | +| `namespace?` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md new file mode 100644 index 00000000000..cefc0a69a8f --- /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 + +| Type parameter | +| :------ | +| `K` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `kind` | `readonly` | `K` \| readonly `K`[] | Kind of the parameter | +| `optional?` | `readonly` | `boolean` | Is the parameter optional. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md new file mode 100644 index 00000000000..2c1b7f3d141 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md @@ -0,0 +1,35 @@ +--- +jsApi: true +title: "[I] DecoratorValidator" + +--- +## Type parameters + +| Type parameter | Value | +| :------ | :------ | +| `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`\> | + +#### Returns + +`boolean` 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 00000000000..af54a3f9b95 --- /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 | Inherited from | +| :------ | :------ | :------ | +| `message` | `string` | - | +| `name` | `"deprecated"` | - | +| `node` | [`DirectiveExpressionNode`](DirectiveExpressionNode.md) | [`DirectiveBase`](DirectiveBase.md).`node` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md new file mode 100644 index 00000000000..b826f1f4cfe --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeprecationDetails.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] DeprecationDetails" + +--- +Provides details on the deprecation of a given type. + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `message` | `string` | The deprecation message to display when the type is used. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md new file mode 100644 index 00000000000..a8a8d27f899 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Diagnostic.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[I] Diagnostic" + +--- +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `code` | `public` | `string` | +| `codefixes?` | `readonly` | readonly [`CodeFix`](CodeFix.md)[] | +| `message` | `public` | `string` | +| `severity` | `public` | [`DiagnosticSeverity`](../type-aliases/DiagnosticSeverity.md) | +| `target` | `public` | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) \| *typeof* [`NoTarget`](../variables/NoTarget.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md new file mode 100644 index 00000000000..3eba871e1ef --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCollector.md @@ -0,0 +1,90 @@ +--- +jsApi: true +title: "[I] DiagnosticCollector" + +--- +Helper object to collect diagnostics from function following the diagnostics accessor pattern(foo() => [T, Diagnostic[]]) + +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `diagnostics` | `readonly` | readonly [`Diagnostic`](Diagnostic.md)[] | + +## Methods + +### add() + +```ts +add(diagnostic): void +``` + +Add a diagnostic to the collection + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `diagnostic` | [`Diagnostic`](Diagnostic.md) | Diagnostic to add. | + +#### Returns + +`void` + +*** + +### pipe() + +```ts +pipe(result): T +``` + +Unwrap the Diagnostic result, add all the diagnostics and return the data. + +#### Type parameters + +| Type parameter | +| :------ | +| `T` | + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `result` | [`DiagnosticResult`](../type-aliases/DiagnosticResult.md)<`T`\> | Accessor diagnostic result | + +#### Returns + +`T` + +*** + +### wrap() + +```ts +wrap(value): DiagnosticResult +``` + +Wrap the given value in a tuple including the diagnostics following the TypeSpec accessor pattern. + +#### Type parameters + +| Type parameter | +| :------ | +| `T` | + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `value` | `T` | Accessor value to return | + +#### Returns + +[`DiagnosticResult`](../type-aliases/DiagnosticResult.md)<`T`\> + +#### Example + +```ts +return diagnostics.wrap(routes); +``` 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 00000000000..8f1d81e00e8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md @@ -0,0 +1,68 @@ +--- +jsApi: true +title: "[I] DiagnosticCreator" + +--- +## Type parameters + +| Type parameter | +| :------ | +| `T` *extends* `object` | + +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `diagnostics` | `readonly` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | +| `type` | `readonly` | `T` | + +## Methods + +### createDiagnostic() + +```ts +createDiagnostic(diag): Diagnostic +``` + +#### Type parameters + +| Type parameter | Value | +| :------ | :------ | +| `C` *extends* `string` \| `number` \| `symbol` | - | +| `M` *extends* `string` \| `number` \| `symbol` | `"default"` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | + +#### Returns + +[`Diagnostic`](Diagnostic.md) + +*** + +### reportDiagnostic() + +```ts +reportDiagnostic(program, diag): void +``` + +#### Type parameters + +| Type parameter | Value | +| :------ | :------ | +| `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`\> | + +#### Returns + +`void` 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 00000000000..566044675ee --- /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 + +| Type parameter | +| :------ | +| `M` *extends* [`DiagnosticMessages`](DiagnosticMessages.md) | + +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `messages` | `readonly` | `M` | +| `severity` | `readonly` | `"error"` \| `"warning"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticMessages.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticMessages.md new file mode 100644 index 00000000000..55a0d323be8 --- /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 00000000000..246c953a0a3 --- /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 | +| :------ | :------ | +| `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 00000000000..b63abe9c8a2 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `arguments` | `readonly` | readonly [`DirectiveArgument`](../type-aliases/DirectiveArgument.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `DirectiveExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md new file mode 100644 index 00000000000..907d0c96186 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Dirent.md @@ -0,0 +1,34 @@ +--- +jsApi: true +title: "[I] Dirent" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `name` | `string` | + +## Methods + +### isDirectory() + +```ts +isDirectory(): boolean +``` + +#### Returns + +`boolean` + +*** + +### isFile() + +```ts +isFile(): boolean +``` + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiscriminatedUnion.md new file mode 100644 index 00000000000..fd142f32ee3 --- /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 | +| :------ | :------ | +| `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 00000000000..a8f1b0c5e7f --- /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 | Modifier | Type | +| :------ | :------ | :------ | +| `propertyName` | `readonly` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md new file mode 100644 index 00000000000..e4bdffb828f --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `kind` | `readonly` | `DocErrorsTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | 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 00000000000..f93cf312937 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `Doc` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `tags` | `readonly` | readonly [`DocTag`](../type-aliases/DocTag.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md new file mode 100644 index 00000000000..07ee121f974 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `kind` | `readonly` | `DocParamTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| `paramName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocPropTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocPropTagNode.md new file mode 100644 index 00000000000..60381d7a2d6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocPropTagNode.md @@ -0,0 +1,24 @@ +--- +jsApi: true +title: "[I] DocPropTagNode" + +--- +## Extends + +- [`DocTagBaseNode`](DocTagBaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `kind` | `readonly` | `DocPropTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `propName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | 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 00000000000..9e707d65db5 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `kind` | `readonly` | `DocReturnsTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | 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 00000000000..fcf7fcd34db --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md @@ -0,0 +1,32 @@ +--- +jsApi: true +title: "[I] DocTagBaseNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Extended by + +- [`DocReturnsTagNode`](DocReturnsTagNode.md) +- [`DocErrorsTagNode`](DocErrorsTagNode.md) +- [`DocParamTagNode`](DocParamTagNode.md) +- [`DocPropTagNode`](DocPropTagNode.md) +- [`DocTemplateTagNode`](DocTemplateTagNode.md) +- [`DocUnknownTagNode`](DocUnknownTagNode.md) + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | [`SyntaxKind`](../enumerations/SyntaxKind.md) | - | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `tagName` | `readonly` | [`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 00000000000..dcd53f3be6c --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `kind` | `readonly` | `DocTemplateTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| `paramName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | 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 00000000000..a8af628fabe --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `DocText` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `text` | `readonly` | `string` | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md new file mode 100644 index 00000000000..ac5e0bd470d --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `content` | `readonly` | readonly [`DocTextNode`](DocTextNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | [`DocTagBaseNode`](DocTagBaseNode.md).`content` | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | [`DocTagBaseNode`](DocTagBaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | [`DocTagBaseNode`](DocTagBaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | [`DocTagBaseNode`](DocTagBaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | [`DocTagBaseNode`](DocTagBaseNode.md).`flags` | +| `kind` | `readonly` | `DocUnknownTag` | - | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | [`DocTagBaseNode`](DocTagBaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | [`DocTagBaseNode`](DocTagBaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | [`DocTagBaseNode`](DocTagBaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | [`DocTagBaseNode`](DocTagBaseNode.md).`symbol` | +| `tagName` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | [`DocTagBaseNode`](DocTagBaseNode.md).`tagName` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md new file mode 100644 index 00000000000..e7dcc0a6d37 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md @@ -0,0 +1,44 @@ +--- +jsApi: true +title: "[I] EmitContext" + +--- +## Type parameters + +| Type parameter | Value | +| :------ | :------ | +| `TOptions` *extends* `object` | `Record`<`string`, `never`\> | + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `emitterOutputDir` | `string` | Configured output dir for the emitter. Emitter should emit all output under that directory. | +| `options` | `TOptions` | Emitter custom options defined in createTypeSpecLibrary | +| `program` | [`Program`](Program.md) | TypeSpec Program. | + +## Methods + +### getAssetEmitter() + +```ts +getAssetEmitter(TypeEmitterClass): AssetEmitter +``` + +Get an asset emitter to write emitted output to disk using a TypeEmitter + +#### Type parameters + +| Type parameter | +| :------ | +| `T` | + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `TypeEmitterClass` | *typeof* `TypeEmitter` | The TypeEmitter to construct your emitted output | + +#### Returns + +`AssetEmitter`<`T`, `TOptions`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitFileOptions.md new file mode 100644 index 00000000000..b0201dad00b --- /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 | +| :------ | :------ | +| `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 00000000000..fc9ff60ba15 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `EmptyStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..34e658d0dc0 --- /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 | +| :------ | :------ | +| `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 00000000000..99b447442ac --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md @@ -0,0 +1,59 @@ +--- +jsApi: true +title: "[I] Enum" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

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

The members of the enum.

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

| - | - | +| `name` | `public` | `string` | - | - | - | +| `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | +| `node` | `public` | [`EnumStatementNode`](EnumStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md new file mode 100644 index 00000000000..c44756b0f8f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md @@ -0,0 +1,60 @@ +--- +jsApi: true +title: "[I] EnumMember" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `enum` | `public` | [`Enum`](Enum.md) | - | - | - | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"EnumMember"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `name` | `public` | `string` | - | - | - | +| `node` | `public` | [`EnumMemberNode`](EnumMemberNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `sourceMember?` | `public` | [`EnumMember`](EnumMember.md) | when spread operators make new enum members, this tracks the enum member we copied from. | - | - | +| `value?` | `public` | `string` \| `number` | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md new file mode 100644 index 00000000000..d6de42707f7 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `kind` | `readonly` | `EnumMember` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`EnumStatementNode`](EnumStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `value?` | `readonly` | [`StringLiteralNode`](StringLiteralNode.md) \| [`NumericLiteralNode`](NumericLiteralNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md new file mode 100644 index 00000000000..f10bc53762d --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `EnumSpreadMember` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md new file mode 100644 index 00000000000..e9082446611 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `EnumStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `members` | `readonly` | readonly ([`EnumMemberNode`](EnumMemberNode.md) \| [`EnumSpreadMemberNode`](EnumSpreadMemberNode.md))[] | - | - | - | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumValue.md new file mode 100644 index 00000000000..f15bc407035 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumValue.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] EnumValue" + +--- +## Extends + +- `BaseValue` + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

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

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

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

 | `BaseValue.type` | `BaseValue.type` | +| `value` | `public` | [`EnumMember`](EnumMember.md) | - | - | - | +| `valueKind` | `public` | `"EnumValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md new file mode 100644 index 00000000000..8e205cd693e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md @@ -0,0 +1,56 @@ +--- +jsApi: true +title: "[I] ErrorType" + +--- +## Extends + +- [`IntrinsicType`](IntrinsicType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | [`IntrinsicType`](IntrinsicType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`IntrinsicType`](IntrinsicType.md).`isFinished` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | +| `kind` | `public` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | +| `name` | `public` | `"ErrorType"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md new file mode 100644 index 00000000000..171e434524d --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ExternKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..3da19853aa8 --- /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 | Inherited from | +| :------ | :------ | :------ | :------ | +| `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/FilePos.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FilePos.md new file mode 100644 index 00000000000..602759b296b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FilePos.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] FilePos" + +--- +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `file` | `readonly` | [`SourceFile`](SourceFile.md) | +| `pos` | `readonly` | `number` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md new file mode 100644 index 00000000000..f5845ab0d04 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `FunctionDeclarationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `modifierFlags` | `readonly` | [`ModifierFlags`](../enumerations/ModifierFlags.md) | - | - | - | +| `modifiers` | `readonly` | readonly [`ExternKeywordNode`](ExternKeywordNode.md)[] | - | - | - | +| `parameters` | `readonly` | [`FunctionParameterNode`](FunctionParameterNode.md)[] | - | - | - | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `returnType?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterBase.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterBase.md new file mode 100644 index 00000000000..2064ffc4d55 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterBase.md @@ -0,0 +1,63 @@ +--- +jsApi: true +title: "[I] FunctionParameterBase" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Extended by + +- [`MixedFunctionParameter`](MixedFunctionParameter.md) +- [`SignatureFunctionParameter`](SignatureFunctionParameter.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"FunctionParameter"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `name` | `public` | `string` | - | - | - | +| `node` | `public` | [`FunctionParameterNode`](FunctionParameterNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `optional` | `public` | `boolean` | - | - | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `rest` | `public` | `boolean` | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md new file mode 100644 index 00000000000..f776e5dcd32 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `kind` | `readonly` | `FunctionParameter` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `optional` | `readonly` | `boolean` | Parameter defined with `?` | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `rest` | `readonly` | `boolean` | Parameter defined with `...` notation. | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `type?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md new file mode 100644 index 00000000000..6cb650d8e8d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md @@ -0,0 +1,60 @@ +--- +jsApi: true +title: "[I] FunctionType" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `implementation` | `public` | (...`args`: `unknown`[]) => `unknown` | - | - | - | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Function"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `name` | `public` | `string` | - | - | - | +| `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | +| `node?` | `public` | [`FunctionDeclarationStatementNode`](FunctionDeclarationStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `parameters` | `public` | [`MixedFunctionParameter`](MixedFunctionParameter.md)[] | - | - | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `returnType` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierContext.md new file mode 100644 index 00000000000..81f184c9c12 --- /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 | +| :------ | :------ | +| `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 00000000000..fcb2775bdfb --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `Identifier` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `sv` | `readonly` | `string` | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..15f2a1b662c --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ImportStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `path` | `readonly` | [`StringLiteralNode`](StringLiteralNode.md) | - | - | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IndeterminateEntity.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IndeterminateEntity.md new file mode 100644 index 00000000000..6a395ba5f7c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IndeterminateEntity.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] IndeterminateEntity" + +--- +When an entity that could be used as a type or value has not figured out if it is a value or type yet. + +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Indeterminate"` | +| `type` | `readonly` | \| [`BooleanLiteral`](BooleanLiteral.md) \| [`EnumMember`](EnumMember.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`StringLiteral`](StringLiteral.md) \| [`StringTemplate`](StringTemplate.md) \| [`UnionVariant`](UnionVariant.md) \| [`NullType`](NullType.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InsertTextCodeFixEdit.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InsertTextCodeFixEdit.md new file mode 100644 index 00000000000..ca209644841 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InsertTextCodeFixEdit.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] InsertTextCodeFixEdit" + +--- +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `file` | `readonly` | [`SourceFile`](SourceFile.md) | +| `kind` | `readonly` | `"insert-text"` | +| `pos` | `readonly` | `number` | +| `text` | `readonly` | `string` | 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 00000000000..688fafb8be7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md @@ -0,0 +1,63 @@ +--- +jsApi: true +title: "[I] Interface" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Interface"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `name` | `public` | `string` | - | - | - | +| `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | +| `node` | `public` | [`InterfaceStatementNode`](InterfaceStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `operations` | `public` | `RekeyableMap`<`string`, [`Operation`](Operation.md)\> |

The operations of the interface.

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

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

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

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

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

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

**Deprecated**

use templateMapper instead.

| [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md new file mode 100644 index 00000000000..916826896c0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[I] InterfaceStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `bodyRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | - | +| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `extends` | `readonly` | readonly [`TypeReferenceNode`](TypeReferenceNode.md)[] | - | - | - | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `InterfaceStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `operations` | `readonly` | readonly [`OperationStatementNode`](OperationStatementNode.md)[] | - | - | - | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | 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 00000000000..8d2bec36a13 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `IntersectionExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `options` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..2ed0d199a85 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md @@ -0,0 +1,64 @@ +--- +jsApi: true +title: "[I] IntrinsicType" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Extended by + +- [`ErrorType`](ErrorType.md) +- [`VoidType`](VoidType.md) +- [`NeverType`](NeverType.md) +- [`UnknownType`](UnknownType.md) +- [`NullType`](NullType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Intrinsic"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `name` | `public` | \| `"unknown"` \| `"never"` \| `"null"` \| `"ErrorType"` \| `"void"` | - | - | - | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md new file mode 100644 index 00000000000..370ca1e367e --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `InvalidStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..bfc30cd892c --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `JsNamespaceDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..19a0394b9ff --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `esmExports` | `readonly` | `any` | - | - | - | +| `file` | `readonly` | [`SourceFile`](SourceFile.md) | - | - | - | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `JsSourceFile` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `namespaceSymbols` | `readonly` | [`Sym`](Sym.md)[] | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..b13e6c72c19 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[I] LibraryInstance" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `definition?` | [`TypeSpecLibrary`](TypeSpecLibrary.md)<`any`, `Record`<`string`, `never`\>, `never`\> | +| `entrypoint` | `undefined` \| [`JsSourceFileNode`](JsSourceFileNode.md) | +| `linter` | [`LinterResolvedDefinition`](LinterResolvedDefinition.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 00000000000..2f739d4c069 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[I] LibraryLocationContext" + +--- +Defined in a library. + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `flags?` | `readonly` | [`PackageFlags`](PackageFlags.md) | Module definition | +| `metadata` | `readonly` | [`ModuleLibraryMetadata`](ModuleLibraryMetadata.md) | Library metadata | +| `type` | `readonly` | `"library"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md new file mode 100644 index 00000000000..ca73a889b98 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[I] LineAndCharacter" + +--- +Identifies the position within a source file by line number and offset from +beginning of line. + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `character` | `number` |

The offset in UTF-16 code units to the character from the beginning of the line. 0-based.

NOTE: This is not necessarily the same as what a given text editor might call the "column". Tabs, combining characters, surrogate pairs, and so on can all cause an editor to report the column differently. Indeed, different text editors report different column numbers for the same position in a given document.

| +| `line` | `number` | The line number. 0-based. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md new file mode 100644 index 00000000000..2fd85e4f2f6 --- /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 + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`TextRange`](TextRange.md).`end` | +| `kind` | `readonly` | `LineComment` | - | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md new file mode 100644 index 00000000000..8074b6e3188 --- /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 | +| :------ | :------ | +| `ruleSets?` | `Record`<`string`, [`LinterRuleSet`](LinterRuleSet.md)\> | +| `rules` | [`LinterRuleDefinition`](LinterRuleDefinition.md)<`string`, [`DiagnosticMessages`](DiagnosticMessages.md)\>[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterResolvedDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterResolvedDefinition.md new file mode 100644 index 00000000000..e370e6f072b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterResolvedDefinition.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] LinterResolvedDefinition" + +--- +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `ruleSets` | `readonly` | `object` | +| `rules` | `readonly` | [`LinterRule`](LinterRule.md)<`string`, [`DiagnosticMessages`](DiagnosticMessages.md)\>[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md new file mode 100644 index 00000000000..58739acdc75 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md @@ -0,0 +1,52 @@ +--- +jsApi: true +title: "[I] LinterRule" + +--- +Resolved instance of a linter rule that will run. + +## Extends + +- [`LinterRuleDefinition`](LinterRuleDefinition.md)<`N`, `DM`\> + +## Type parameters + +| Type parameter | +| :------ | +| `N` *extends* `string` | +| `DM` *extends* [`DiagnosticMessages`](DiagnosticMessages.md) | + +## Properties + +| Property | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | +| `description` | `string` | Short description of the rule | [`LinterRuleDefinition`](LinterRuleDefinition.md).`description` | +| `id` | `string` | Expanded rule id in format `:` | - | +| `messages` | `DM` | Messages that can be reported with the diagnostic. | [`LinterRuleDefinition`](LinterRuleDefinition.md).`messages` | +| `name` | `N` | Rule name (without the library name) | [`LinterRuleDefinition`](LinterRuleDefinition.md).`name` | +| `severity` | `"warning"` | Rule default severity. | [`LinterRuleDefinition`](LinterRuleDefinition.md).`severity` | +| `url?` | `string` | Specifies the URL at which the full documentation can be accessed. | [`LinterRuleDefinition`](LinterRuleDefinition.md).`url` | + +## Methods + +### create() + +```ts +create(context): SemanticNodeListener +``` + +Creator + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`LinterRuleContext`](LinterRuleContext.md)<`DM`\> | + +#### Returns + +[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) + +#### Inherited from + +[`LinterRuleDefinition`](LinterRuleDefinition.md).[`create`](LinterRuleDefinition.md#create) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md new file mode 100644 index 00000000000..fb552590075 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md @@ -0,0 +1,40 @@ +--- +jsApi: true +title: "[I] LinterRuleContext" + +--- +## Type parameters + +| Type parameter | +| :------ | +| `DM` *extends* [`DiagnosticMessages`](DiagnosticMessages.md) | + +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `program` | `readonly` | [`Program`](Program.md) | + +## Methods + +### reportDiagnostic() + +```ts +reportDiagnostic(diag): void +``` + +#### Type parameters + +| Type parameter | +| :------ | +| `M` *extends* `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diag` | [`LinterRuleDiagnosticReport`](../type-aliases/LinterRuleDiagnosticReport.md)<`DM`, `M`\> | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md new file mode 100644 index 00000000000..750591acd83 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md @@ -0,0 +1,45 @@ +--- +jsApi: true +title: "[I] LinterRuleDefinition" + +--- +## Extended by + +- [`LinterRule`](LinterRule.md) + +## Type parameters + +| Type parameter | +| :------ | +| `N` *extends* `string` | +| `DM` *extends* [`DiagnosticMessages`](DiagnosticMessages.md) | + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `description` | `string` | Short description of the rule | +| `messages` | `DM` | Messages that can be reported with the diagnostic. | +| `name` | `N` | Rule name (without the library name) | +| `severity` | `"warning"` | Rule default severity. | +| `url?` | `string` | Specifies the URL at which the full documentation can be accessed. | + +## Methods + +### create() + +```ts +create(context): SemanticNodeListener +``` + +Creator + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`LinterRuleContext`](LinterRuleContext.md)<`DM`\> | + +#### Returns + +[`SemanticNodeListener`](../type-aliases/SemanticNodeListener.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md new file mode 100644 index 00000000000..3f2028a16ea --- /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/interfaces/ListOperationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md new file mode 100644 index 00000000000..a979bc00e30 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] ListOperationOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `recursive?` | `boolean` |

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

**Default**

true | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogInfo.md new file mode 100644 index 00000000000..dc568fc8fbd --- /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 | +| :------ | :------ | +| `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/interfaces/LogSink.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md new file mode 100644 index 00000000000..baf372d6562 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LogSink.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] LogSink" + +--- +## Methods + +### log() + +```ts +log(log): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `log` | [`ProcessedLog`](ProcessedLog.md) | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md new file mode 100644 index 00000000000..f62b7a07399 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Logger.md @@ -0,0 +1,76 @@ +--- +jsApi: true +title: "[I] Logger" + +--- +## Methods + +### error() + +```ts +error(message): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `message` | `string` | + +#### Returns + +`void` + +*** + +### log() + +```ts +log(log): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `log` | [`LogInfo`](LogInfo.md) | + +#### Returns + +`void` + +*** + +### trace() + +```ts +trace(message): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `message` | `string` | + +#### Returns + +`void` + +*** + +### warn() + +```ts +warn(message): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `message` | `string` | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md new file mode 100644 index 00000000000..7c6dfca8c1a --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `base` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `kind` | `readonly` | `MemberExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `selector` | `readonly` | `"."` \| `"::"` | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedFunctionParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedFunctionParameter.md new file mode 100644 index 00000000000..ab70b496e7d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedFunctionParameter.md @@ -0,0 +1,62 @@ +--- +jsApi: true +title: "[I] MixedFunctionParameter" + +--- +Represent a function parameter that could accept types or values in the TypeSpec program. + +## Extends + +- [`FunctionParameterBase`](FunctionParameterBase.md) + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`FunctionParameterBase`](FunctionParameterBase.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`FunctionParameterBase`](FunctionParameterBase.md).`isFinished` | +| `kind` | `public` | `"FunctionParameter"` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`kind` | +| `mixed` | `public` | `true` | - | - | +| `name` | `public` | `string` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`name` | +| `node` | `public` | [`FunctionParameterNode`](FunctionParameterNode.md) | - | [`FunctionParameterBase`](FunctionParameterBase.md).`node` | +| `optional` | `public` | `boolean` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`optional` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`FunctionParameterBase`](FunctionParameterBase.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`FunctionParameterBase`](FunctionParameterBase.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`FunctionParameterBase`](FunctionParameterBase.md).`projector` | +| `rest` | `public` | `boolean` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`rest` | +| `type` | `public` | [`MixedParameterConstraint`](MixedParameterConstraint.md) | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`FunctionParameterBase`](FunctionParameterBase.md).[`projectionsByName`](FunctionParameterBase.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedParameterConstraint.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedParameterConstraint.md new file mode 100644 index 00000000000..fb1ef97a310 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MixedParameterConstraint.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] MixedParameterConstraint" + +--- +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"MixedParameterConstraint"` | - | +| `node?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | +| `type?` | `readonly` | [`Type`](../type-aliases/Type.md) | Type constraints | +| `valueType?` | `readonly` | [`Type`](../type-aliases/Type.md) | Expecting value | 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 00000000000..e2014613c28 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md @@ -0,0 +1,72 @@ +--- +jsApi: true +title: "[I] Model" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) + +## Extended by + +- [`ArrayModelType`](ArrayModelType.md) +- [`RecordModelType`](RecordModelType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `baseModel?` | `public` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | - | - | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | +| `derivedModels` | `public` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](Model.md) | - | - | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `indexer?` | `public` | [`ModelIndexer`](../type-aliases/ModelIndexer.md) | - | - | - | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

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

The properties of the model.

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

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

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

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

**Deprecated**

use templateMapper instead.

| [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md new file mode 100644 index 00000000000..60f3a011cb4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] ModelExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `bodyRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ModelExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `properties` | `readonly` | ([`ModelPropertyNode`](ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md))[] | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..ab8f5ef647a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md @@ -0,0 +1,63 @@ +--- +jsApi: true +title: "[I] ModelProperty" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | +| ~~`default?`~~ | `public` | [`Type`](../type-aliases/Type.md) |

**Deprecated**

use [defaultValue](ModelProperty.md) instead.

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

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"ModelProperty"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `model?` | `public` | [`Model`](Model.md) | - | - | - | +| `name` | `public` | `string` | - | - | - | +| `node` | `public` | \| [`ModelPropertyNode`](ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md) \| [`ProjectionModelPropertyNode`](ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](ProjectionModelSpreadPropertyNode.md) \| [`ObjectLiteralPropertyNode`](ObjectLiteralPropertyNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `optional` | `public` | `boolean` | - | - | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `sourceProperty?` | `public` | [`ModelProperty`](ModelProperty.md) | - | - | - | +| `type` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md new file mode 100644 index 00000000000..5b80206bf8d --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | +| `default?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `kind` | `readonly` | `ModelProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `optional` | `readonly` | `boolean` | - | - | - | +| `parent?` | `readonly` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md new file mode 100644 index 00000000000..d8dc2254d43 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ModelSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`ModelStatementNode`](ModelStatementNode.md) \| [`ModelExpressionNode`](ModelExpressionNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md new file mode 100644 index 00000000000..93527ecef5f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md @@ -0,0 +1,30 @@ +--- +jsApi: true +title: "[I] ModelStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `bodyRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | - | +| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `extends?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `is?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | +| `kind` | `readonly` | `ModelStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `properties` | `readonly` | readonly ([`ModelPropertyNode`](ModelPropertyNode.md) \| [`ModelSpreadPropertyNode`](ModelSpreadPropertyNode.md))[] | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | 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 00000000000..2f15167be41 --- /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 | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `bugs?` | `public` | `object` | - | `LibraryMetadataBase.bugs` | +| `bugs.url?` | `public` | `string` | Url where to file bugs for this library. | - | +| `homepage?` | `readonly` | `string` | Library homepage. | `LibraryMetadataBase.homepage` | +| `name` | `readonly` | `string` | Library name as specified in the package.json or in exported $lib. | - | +| `type` | `public` | `"module"` | - | - | +| `version?` | `public` | `string` | Library version | `LibraryMetadataBase.version` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md new file mode 100644 index 00000000000..2a8afb25c08 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md @@ -0,0 +1,67 @@ +--- +jsApi: true +title: "[I] Namespace" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decoratorDeclarations` | `public` | `Map`<`string`, [`Decorator`](Decorator.md)\> |

The decorators declared in the namespace.

Order is implementation-defined and may change.

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

The enums in the namespace.

Order is implementation-defined and may change.

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

The functions declared in the namespace.

Order is implementation-defined and may change.

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

The interfaces in the namespace.

Order is implementation-defined and may change.

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

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

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

The models in the namespace.

Order is implementation-defined and may change.

| - | - | +| `name` | `public` | `string` | - | - | - | +| `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | +| `namespaces` | `public` | `Map`<`string`, [`Namespace`](Namespace.md)\> |

The sub-namespaces in the namespace.

Order is implementation-defined and may change.

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

The operations in the namespace.

Order is implementation-defined and may change.

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

The scalars in the namespace.

Order is implementation-defined and may change.

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

The unions in the namespace.

Order is implementation-defined and may change.

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

Recursively navigate sub namespaces.

**Default**

false | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md new file mode 100644 index 00000000000..739305e13b5 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `NamespaceStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `locals?` | `readonly` | `SymbolTable` | - | - | - | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `statements?` | `readonly` | [`NamespaceStatementNode`](NamespaceStatementNode.md) \| readonly [`Statement`](../type-aliases/Statement.md)[] | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md new file mode 100644 index 00000000000..f41933be2a6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NavigationOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] NavigationOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `includeTemplateDeclaration?` | `boolean` | Skip non instantiated templates. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md new file mode 100644 index 00000000000..2e776919572 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `NeverKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..04282944820 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md @@ -0,0 +1,56 @@ +--- +jsApi: true +title: "[I] NeverType" + +--- +## Extends + +- [`IntrinsicType`](IntrinsicType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | [`IntrinsicType`](IntrinsicType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`IntrinsicType`](IntrinsicType.md).`isFinished` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | +| `kind` | `public` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | +| `name` | `public` | `"never"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md new file mode 100644 index 00000000000..89743a77d14 --- /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 | +| :------ | :------ | +| `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 00000000000..50b8c022faf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md @@ -0,0 +1,56 @@ +--- +jsApi: true +title: "[I] NullType" + +--- +## Extends + +- [`IntrinsicType`](IntrinsicType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | [`IntrinsicType`](IntrinsicType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`IntrinsicType`](IntrinsicType.md).`isFinished` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | +| `kind` | `public` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | +| `name` | `public` | `"null"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullValue.md new file mode 100644 index 00000000000..c30784c0686 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullValue.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] NullValue" + +--- +## Extends + +- `BaseValue` + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

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

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

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

 | `BaseValue.type` | `BaseValue.type` | +| `value` | `public` | `null` | - | - | - | +| `valueKind` | `public` | `"NullValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Numeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Numeric.md new file mode 100644 index 00000000000..0dbe9eb316d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Numeric.md @@ -0,0 +1,140 @@ +--- +jsApi: true +title: "[I] Numeric" + +--- +## Constructors + +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `isInteger` | `readonly` | `boolean` | + +## Methods + +### asBigInt() + +```ts +asBigInt(): null | bigint +``` + +#### Returns + +`null` \| `bigint` + +*** + +### asNumber() + +```ts +asNumber(): null | number +``` + +Return the value as JavaScript number or null if it cannot be represented without loosing precision. + +#### Returns + +`null` \| `number` + +*** + +### equals() + +```ts +equals(value): boolean +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | [`Numeric`](Numeric.md) | + +#### Returns + +`boolean` + +*** + +### gt() + +```ts +gt(value): boolean +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | [`Numeric`](Numeric.md) | + +#### Returns + +`boolean` + +*** + +### gte() + +```ts +gte(value): boolean +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | [`Numeric`](Numeric.md) | + +#### Returns + +`boolean` + +*** + +### lt() + +```ts +lt(value): boolean +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | [`Numeric`](Numeric.md) | + +#### Returns + +`boolean` + +*** + +### lte() + +```ts +lte(value): boolean +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `value` | [`Numeric`](Numeric.md) | + +#### Returns + +`boolean` + +*** + +### toString() + +```ts +toString(): string +``` + +#### Returns + +`string` 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 00000000000..7e17af5c52f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md @@ -0,0 +1,58 @@ +--- +jsApi: true +title: "[I] NumericLiteral" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Number"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `node?` | `public` | [`NumericLiteralNode`](NumericLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `numericValue` | `public` | [`Numeric`](Numeric.md) | - | - | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `value` | `public` | `number` | - | - | - | +| `valueAsString` | `public` | `string` | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md new file mode 100644 index 00000000000..802bc7bf0dc --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `NumericLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `value` | `readonly` | `number` | - | - | - | +| `valueAsString` | `readonly` | `string` | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericValue.md new file mode 100644 index 00000000000..b641c2c85ef --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericValue.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] NumericValue" + +--- +## Extends + +- `BaseValue` + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| `scalar` | `public` | `undefined` \| [`Scalar`](Scalar.md) | - | - | - | +| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

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

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

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

 | `BaseValue.type` | `BaseValue.type` | +| `value` | `public` | [`Numeric`](Numeric.md) | - | - | - | +| `valueKind` | `public` | `"NumericValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralNode.md new file mode 100644 index 00000000000..0673dc47b12 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] ObjectLiteralNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `bodyRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ObjectLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `properties` | `readonly` | ([`ObjectLiteralPropertyNode`](ObjectLiteralPropertyNode.md) \| [`ObjectLiteralSpreadPropertyNode`](ObjectLiteralSpreadPropertyNode.md))[] | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralPropertyNode.md new file mode 100644 index 00000000000..44ff6c491b6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralPropertyNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] ObjectLiteralPropertyNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `kind` | `readonly` | `ObjectLiteralProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`ObjectLiteralNode`](ObjectLiteralNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralSpreadPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralSpreadPropertyNode.md new file mode 100644 index 00000000000..4b48f6a4dc4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectLiteralSpreadPropertyNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] ObjectLiteralSpreadPropertyNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ObjectLiteralSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`ObjectLiteralNode`](ObjectLiteralNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md new file mode 100644 index 00000000000..d39584abde8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md @@ -0,0 +1,56 @@ +--- +jsApi: true +title: "[I] ObjectType" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Object"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `properties` | `public` | `Record`<`string`, [`Type`](../type-aliases/Type.md)\> | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValue.md new file mode 100644 index 00000000000..2516734bc94 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValue.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] ObjectValue" + +--- +## Extends + +- `BaseValue` + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| `node` | `public` | [`ObjectLiteralNode`](ObjectLiteralNode.md) | - | - | - | +| `properties` | `public` | `Map`<`string`, [`ObjectValuePropertyDescriptor`](ObjectValuePropertyDescriptor.md)\> | - | - | - | +| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

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

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

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

 | `BaseValue.type` | `BaseValue.type` | +| `valueKind` | `public` | `"ObjectValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValuePropertyDescriptor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValuePropertyDescriptor.md new file mode 100644 index 00000000000..8ee7f9bd10a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectValuePropertyDescriptor.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] ObjectValuePropertyDescriptor" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `name` | `string` | +| `node` | [`ObjectLiteralPropertyNode`](ObjectLiteralPropertyNode.md) | +| `value` | [`Value`](../type-aliases/Value.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md new file mode 100644 index 00000000000..c3904633451 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md @@ -0,0 +1,65 @@ +--- +jsApi: true +title: "[I] Operation" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `interface?` | `public` | [`Interface`](Interface.md) | - | - | - | +| `isFinished` | `public` | `boolean` |

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

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

**Deprecated**

use templateMapper instead.

| [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md new file mode 100644 index 00000000000..1dca2600e2a --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `OperationSignatureDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parameters` | `readonly` | [`ModelExpressionNode`](ModelExpressionNode.md) | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `returnType` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..e5eb7641b3f --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `baseOperation` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `OperationSignatureReference` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..ea4fceb8efc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[I] OperationStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `OperationStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) \| [`InterfaceStatementNode`](InterfaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `signature` | `readonly` | [`OperationSignature`](../type-aliases/OperationSignature.md) | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageFlags.md new file mode 100644 index 00000000000..06b88bf1726 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageFlags.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] PackageFlags" + +--- +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `decoratorArgMarshalling?` | `readonly` | `"new"` \| `"legacy"` |

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

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

**Default**

legacy | 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 00000000000..54b58fbf518 --- /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 + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `comments?` | `readonly` | `boolean` | When true, collect comment ranges in [TypeSpecScriptNode.comments](TypeSpecScriptNode.md). | +| `docs?` | `readonly` | `boolean` | When true, parse doc comments into [Node.docs](BaseNode.md). | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PatternData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PatternData.md new file mode 100644 index 00000000000..9cf3124d23c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PatternData.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] PatternData" + +--- +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `pattern` | `readonly` | `string` | +| `validationMessage?` | `readonly` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PositionDetail.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PositionDetail.md new file mode 100644 index 00000000000..a584105f18c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PositionDetail.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] PositionDetail" + +--- +owner node and other related information according to the position + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `char` | `readonly` | `number` | - | +| `getPositionDetailAfterTrivia` | `readonly` | () => [`PositionDetail`](PositionDetail.md) | get the PositionDetail of positionAfterTrivia | +| `getPositionDetailBeforeTrivia` | `readonly` | () => [`PositionDetail`](PositionDetail.md) | get the PositionDetail of positionBeforeTrivia | +| `inTrivia` | `readonly` | `boolean` | - | +| `nextChar` | `readonly` | `number` | - | +| `node` | `readonly` | `undefined` \| [`Node`](../type-aliases/Node.md) | - | +| `position` | `readonly` | `number` | - | +| `preChar` | `readonly` | `number` | - | +| `triviaEndPosition` | `readonly` | `number` |

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

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

also comments are considered as trivia

| +| `triviaStartPosition` | `readonly` | `number` |

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

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

also comments are considered as trivia

| 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 00000000000..205d34f9e07 --- /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 | +| :------ | :------ | +| `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 00000000000..8ffe2e660fb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Program.md @@ -0,0 +1,252 @@ +--- +jsApi: true +title: "[I] Program" + +--- +## Extended by + +- [`ProjectedProgram`](ProjectedProgram.md) + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `checker` | `public` | [`Checker`](Checker.md) | - | +| `compilerOptions` | `public` | [`CompilerOptions`](CompilerOptions.md) | - | +| `diagnostics` | `readonly` | readonly [`Diagnostic`](Diagnostic.md)[] | - | +| `emitters` | `public` | `EmitterRef`[] | - | +| `host` | `public` | [`CompilerHost`](CompilerHost.md) | - | +| `jsSourceFiles` | `public` | `Map`<`string`, [`JsSourceFileNode`](JsSourceFileNode.md)\> | - | +| `literalTypes` | `public` | `Map`<`string` \| `number` \| `boolean`, [`LiteralType`](../type-aliases/LiteralType.md)\> | - | +| `mainFile?` | `public` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | +| `projectRoot` | `readonly` | `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` | `public` | `Map`<`string`, [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | All source files in the program, keyed by their file path. | +| `stateMaps` | `public` | `Map`<`symbol`, `StateMap`\> | - | +| `stateSets` | `public` | `Map`<`symbol`, `StateSet`\> | - | +| `tracer` | `public` | [`Tracer`](Tracer.md) | - | + +## Methods + +### getGlobalNamespaceType() + +```ts +getGlobalNamespaceType(): Namespace +``` + +#### Returns + +[`Namespace`](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`](SourceFile.md) | + +#### Returns + +[`LocationContext`](../type-aliases/LocationContext.md) + +*** + +### hasError() + +```ts +hasError(): boolean +``` + +#### Returns + +`boolean` + +*** + +### loadTypeSpecScript() + +```ts +loadTypeSpecScript(typespecScript): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typespecScript` | [`SourceFile`](SourceFile.md) | + +#### Returns + +`Promise`<[`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> + +*** + +### onValidate() + +```ts +onValidate(cb, LibraryMetadata): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `cb` | (`program`) => `void` \| `Promise`<`void`\> | +| `LibraryMetadata` | [`LibraryMetadata`](../type-aliases/LibraryMetadata.md) | + +#### Returns + +`void` + +*** + +### reportDiagnostic() + +```ts +reportDiagnostic(diagnostic): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostic` | [`Diagnostic`](Diagnostic.md) | + +#### Returns + +`void` + +*** + +### reportDiagnostics() + +```ts +reportDiagnostics(diagnostics): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostics` | readonly [`Diagnostic`](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-aliases/Type.md), readonly [`Diagnostic`](Diagnostic.md)[]] + +*** + +### stateMap() + +```ts +stateMap(key): Map +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `symbol` | + +#### Returns + +`Map`<[`Type`](../type-aliases/Type.md), `any`\> + +*** + +### stateSet() + +```ts +stateSet(key): Set +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `symbol` | + +#### Returns + +`Set`<[`Type`](../type-aliases/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/interfaces/ProjectLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md new file mode 100644 index 00000000000..8937430ee8d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] ProjectLocationContext" + +--- +Defined in the user project. + +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `flags?` | `readonly` | [`PackageFlags`](PackageFlags.md) | +| `type` | `readonly` | `"project"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md new file mode 100644 index 00000000000..ff84e67f18a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md @@ -0,0 +1,31 @@ +--- +jsApi: true +title: "[I] ProjectedNameView" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `program` | [`ProjectedProgram`](ProjectedProgram.md) | + +## Methods + +### getProjectedName() + +```ts +getProjectedName(target): string +``` + +Get the name of the given entity in that scope. +If there is a projected name it returns that one otherwise return the original name. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `target` | [`Type`](../type-aliases/Type.md) & `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 00000000000..a3488471128 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md @@ -0,0 +1,305 @@ +--- +jsApi: true +title: "[I] ProjectedProgram" + +--- +## Extends + +- [`Program`](Program.md) + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `checker` | `public` | [`Checker`](Checker.md) | - | [`Program`](Program.md).`checker` | +| `compilerOptions` | `public` | [`CompilerOptions`](CompilerOptions.md) | - | [`Program`](Program.md).`compilerOptions` | +| `diagnostics` | `readonly` | readonly [`Diagnostic`](Diagnostic.md)[] | - | [`Program`](Program.md).`diagnostics` | +| `emitters` | `public` | `EmitterRef`[] | - | [`Program`](Program.md).`emitters` | +| `host` | `public` | [`CompilerHost`](CompilerHost.md) | - | [`Program`](Program.md).`host` | +| `jsSourceFiles` | `public` | `Map`<`string`, [`JsSourceFileNode`](JsSourceFileNode.md)\> | - | [`Program`](Program.md).`jsSourceFiles` | +| `literalTypes` | `public` | `Map`<`string` \| `number` \| `boolean`, [`LiteralType`](../type-aliases/LiteralType.md)\> | - | [`Program`](Program.md).`literalTypes` | +| `mainFile?` | `public` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | [`Program`](Program.md).`mainFile` | +| `projectRoot` | `readonly` | `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` | +| `projector` | `public` | [`Projector`](Projector.md) | - | - | +| `sourceFiles` | `public` | `Map`<`string`, [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | All source files in the program, keyed by their file path. | [`Program`](Program.md).`sourceFiles` | +| `stateMaps` | `public` | `Map`<`symbol`, `StateMap`\> | - | [`Program`](Program.md).`stateMaps` | +| `stateSets` | `public` | `Map`<`symbol`, `StateSet`\> | - | [`Program`](Program.md).`stateSets` | +| `tracer` | `public` | [`Tracer`](Tracer.md) | - | [`Program`](Program.md).`tracer` | + +## Methods + +### getGlobalNamespaceType() + +```ts +getGlobalNamespaceType(): Namespace +``` + +#### Returns + +[`Namespace`](Namespace.md) + +#### Inherited from + +[`Program`](Program.md).[`getGlobalNamespaceType`](Program.md#getglobalnamespacetype) + +*** + +### getOption() + +```ts +getOption(key): undefined | string +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +`undefined` \| `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) | + +#### Returns + +[`LocationContext`](../type-aliases/LocationContext.md) + +#### Inherited from + +[`Program`](Program.md).[`getSourceFileLocationContext`](Program.md#getsourcefilelocationcontext) + +*** + +### hasError() + +```ts +hasError(): boolean +``` + +#### Returns + +`boolean` + +#### Inherited from + +[`Program`](Program.md).[`hasError`](Program.md#haserror) + +*** + +### loadTypeSpecScript() + +```ts +loadTypeSpecScript(typespecScript): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typespecScript` | [`SourceFile`](SourceFile.md) | + +#### Returns + +`Promise`<[`TypeSpecScriptNode`](TypeSpecScriptNode.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) | + +#### Returns + +`void` + +#### Inherited from + +[`Program`](Program.md).[`onValidate`](Program.md#onvalidate) + +*** + +### reportDiagnostic() + +```ts +reportDiagnostic(diagnostic): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostic` | [`Diagnostic`](Diagnostic.md) | + +#### Returns + +`void` + +#### Inherited from + +[`Program`](Program.md).[`reportDiagnostic`](Program.md#reportdiagnostic) + +*** + +### reportDiagnostics() + +```ts +reportDiagnostics(diagnostics): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diagnostics` | readonly [`Diagnostic`](Diagnostic.md)[] | + +#### Returns + +`void` + +#### Inherited from + +[`Program`](Program.md).[`reportDiagnostics`](Program.md#reportdiagnostics) + +*** + +### reportDuplicateSymbols() + +```ts +reportDuplicateSymbols(symbols): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `symbols` | `undefined` \| `SymbolTable` | + +#### Returns + +`void` + +#### Inherited from + +[`Program`](Program.md).[`reportDuplicateSymbols`](Program.md#reportduplicatesymbols) + +*** + +### resolveTypeReference() + +```ts +resolveTypeReference(reference): [undefined | Type, readonly Diagnostic[]] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `reference` | `string` | + +#### Returns + +[`undefined` \| [`Type`](../type-aliases/Type.md), readonly [`Diagnostic`](Diagnostic.md)[]] + +#### Inherited from + +[`Program`](Program.md).[`resolveTypeReference`](Program.md#resolvetypereference) + +*** + +### stateMap() + +```ts +stateMap(key): Map +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `symbol` | + +#### Returns + +`Map`<[`Type`](../type-aliases/Type.md), `any`\> + +#### Inherited from + +[`Program`](Program.md).[`stateMap`](Program.md#statemap) + +*** + +### stateSet() + +```ts +stateSet(key): Set +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `key` | `symbol` | + +#### Returns + +`Set`<[`Type`](../type-aliases/Type.md)\> + +#### Inherited from + +[`Program`](Program.md).[`stateSet`](Program.md#stateset) + +*** + +### trace() + +```ts +trace(area, message): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `area` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[`Program`](Program.md).[`trace`](Program.md#trace) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md new file mode 100644 index 00000000000..1be376e9e5d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md @@ -0,0 +1,57 @@ +--- +jsApi: true +title: "[I] Projection" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Projection"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `node` | `public` | `undefined` | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `nodeByKind` | `public` | `Map`<`string`, [`ProjectionStatementNode`](ProjectionStatementNode.md)\> | - | - | - | +| `nodeByType` | `public` | `Map`<[`Type`](../type-aliases/Type.md), [`ProjectionStatementNode`](ProjectionStatementNode.md)\> | - | - | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionApplication.md new file mode 100644 index 00000000000..9e2fdd7d714 --- /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 | +| :------ | :------ | +| `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 00000000000..761bd7f3d48 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionArithmeticExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | +| `op` | `readonly` | `"-"` \| `"/"` \| `"+"` \| `"*"` | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..bbdd2f0264e --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionBlockExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `statements` | `readonly` | [`ProjectionExpressionStatementNode`](ProjectionExpressionStatementNode.md)[] | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..ffd2450b6ff --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `arguments` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md)[] | - | - | - | +| `callKind` | `readonly` | `"template"` \| `"method"` | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionCallExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md new file mode 100644 index 00000000000..e5de9f0f9c3 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionDecoratorReferenceExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md new file mode 100644 index 00000000000..c81e1ae310d --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionEnumMemberSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..1b7f510b3d1 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionEnumSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..59692aa29a8 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionEqualityExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | +| `op` | `readonly` | `"=="` \| `"!="` | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..979a244e8fc --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `expr` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionExpressionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..c5a8804c0a7 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `alternate?` | `readonly` | [`ProjectionIfExpressionNode`](ProjectionIfExpressionNode.md) \| [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | - | +| `consequent` | `readonly` | [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionIfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `test` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md new file mode 100644 index 00000000000..9b6aceea93c --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionInterfaceSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..a37a984ae84 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `body` | `readonly` | [`ProjectionBlockExpressionNode`](ProjectionBlockExpressionNode.md) | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionLambdaExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `locals?` | `readonly` | `SymbolTable` | - | - | - | +| `parameters` | `readonly` | readonly [`ProjectionLambdaParameterDeclarationNode`](ProjectionLambdaParameterDeclarationNode.md)[] | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..bb4ef90507a --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `ProjectionLambdaParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..d4405dda1eb --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionLogicalExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | +| `op` | `readonly` | "\|\|" \| `"&&"` | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..5fb330f96ab --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `base` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `kind` | `readonly` | `ProjectionMemberExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `selector` | `readonly` | `"."` \| `"::"` | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..1fba7bdc11b --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionModelExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `properties` | `readonly` | ([`ProjectionModelPropertyNode`](ProjectionModelPropertyNode.md) \| [`ProjectionModelSpreadPropertyNode`](ProjectionModelSpreadPropertyNode.md))[] | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..7e45d475f89 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | +| `default?` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `kind` | `readonly` | `ProjectionModelProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `optional` | `readonly` | `boolean` | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `value` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md new file mode 100644 index 00000000000..884f03bae5c --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionModelPropertySelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..5254bb2d556 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionModelSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..3add21a13af --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionModelSpreadProperty` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md new file mode 100644 index 00000000000..3421ce4f222 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `body` | `readonly` | readonly [`ProjectionExpressionStatementNode`](ProjectionExpressionStatementNode.md)[] | - | - | - | +| `direction` | `readonly` | \| `"to"` \| `"from"` \| `"pre_to"` \| `"pre_from"` \| `""` | - | - | - | +| `directionId` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `Projection` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `locals?` | `readonly` | `SymbolTable` | - | - | - | +| `modifierIds` | `readonly` | readonly [`IdentifierNode`](IdentifierNode.md)[] | - | - | - | +| `parameters` | `readonly` | [`ProjectionParameterDeclarationNode`](ProjectionParameterDeclarationNode.md)[] | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..74e93572183 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionOperationSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..13ca83ed9e6 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `ProjectionParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..43a3b47bfe6 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `arguments` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionReference` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md new file mode 100644 index 00000000000..8fbb0a7a89c --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionRelationalExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | +| `op` | `readonly` | `"<="` \| `">="` \| `"<"` \| `">"` | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md new file mode 100644 index 00000000000..b93e0b83202 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionScalarSelectorNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionScalarSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..2d47c393736 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `from?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `ProjectionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `preFrom?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | +| `preTo?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | +| `projections` | `readonly` | readonly [`ProjectionNode`](ProjectionNode.md)[] | - | - | - | +| `selector` | `readonly` | \| [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) \| [`ProjectionModelSelectorNode`](ProjectionModelSelectorNode.md) \| [`ProjectionModelPropertySelectorNode`](ProjectionModelPropertySelectorNode.md) \| [`ProjectionScalarSelectorNode`](ProjectionScalarSelectorNode.md) \| [`ProjectionInterfaceSelectorNode`](ProjectionInterfaceSelectorNode.md) \| [`ProjectionOperationSelectorNode`](ProjectionOperationSelectorNode.md) \| [`ProjectionEnumSelectorNode`](ProjectionEnumSelectorNode.md) \| [`ProjectionEnumMemberSelectorNode`](ProjectionEnumMemberSelectorNode.md) \| [`ProjectionUnionSelectorNode`](ProjectionUnionSelectorNode.md) \| [`ProjectionUnionVariantSelectorNode`](ProjectionUnionVariantSelectorNode.md) | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `to?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md new file mode 100644 index 00000000000..8b689cb99e5 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionTupleExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `values` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md new file mode 100644 index 00000000000..4d8026e04b8 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionUnaryExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `op` | `readonly` | `"!"` | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md new file mode 100644 index 00000000000..29ba0e4fd7e --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionUnionSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..b7569f21045 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionUnionVariantSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..814cc63b759 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md @@ -0,0 +1,32 @@ +--- +jsApi: true +title: "[I] Projector" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `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 | Value +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) | + +#### Returns + +[`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md new file mode 100644 index 00000000000..e73fe72a14b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md @@ -0,0 +1,69 @@ +--- +jsApi: true +title: "[I] RecordModelType" + +--- +## Extends + +- [`Model`](Model.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `baseModel?` | `public` | [`Model`](Model.md) | Model this model extends. This represent inheritance. | [`Model`](Model.md).`baseModel` | [`Model`](Model.md).`baseModel` | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`Model`](Model.md).`decorators` | [`Model`](Model.md).`decorators` | +| `derivedModels` | `public` | [`Model`](Model.md)[] | Direct children. This is the reverse relation of [baseModel](Model.md) | [`Model`](Model.md).`derivedModels` | [`Model`](Model.md).`derivedModels` | +| `entityKind` | `readonly` | `"Type"` | - | [`Model`](Model.md).`entityKind` | [`Model`](Model.md).`entityKind` | +| `indexer` | `public` | `object` | - | [`Model`](Model.md).`indexer` | [`Model`](Model.md).`indexer` | +| `indexer.key` | `public` | [`Scalar`](Scalar.md) | - | - | - | +| `indexer.value` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`Model`](Model.md).`instantiationParameters` | [`Model`](Model.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

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

The properties of the model.

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

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

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

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

**Deprecated**

use templateMapper instead.

| [`Model`](Model.md).`templateArguments` | [`Model`](Model.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`Model`](Model.md).`templateMapper` | [`Model`](Model.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`Model`](Model.md).`templateNode` | [`Model`](Model.md).`templateNode` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`Model`](Model.md).[`projectionsByName`](Model.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md new file mode 100644 index 00000000000..a647bd00e9e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] ReplaceTextCodeFixEdit" + +--- +## Extends + +- [`TextRange`](TextRange.md) + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`TextRange`](TextRange.md).`end` | +| `file` | `readonly` | [`SourceFile`](SourceFile.md) | - | - | +| `kind` | `readonly` | `"replace-text"` | - | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | +| `text` | `readonly` | `string` | - | - | 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 00000000000..92f81ef4d6b --- /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 | Inherited from | +| :------ | :------ | :------ | :------ | +| `args?` | `Record`<`string`, `string`\> | Any arguments to interpolate the config. | `ConfigToOptionsOptions.args` | +| `configPath?` | `string` | Explicit config path. | - | +| `cwd` | `string` | Current working directory. This will be used to interpolate `{cwd}` in the config. | `ConfigToOptionsOptions.cwd` | +| `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/interfaces/ResolveModuleHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md new file mode 100644 index 00000000000..7bb7f4514f7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md @@ -0,0 +1,69 @@ +--- +jsApi: true +title: "[I] ResolveModuleHost" + +--- +## Methods + +### readFile() + +```ts +readFile(path): Promise +``` + +Read a utf-8 encoded file. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`<`string`\> + +*** + +### realpath() + +```ts +realpath(path): Promise +``` + +Resolve the real path for the current host. + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`<`string`\> + +*** + +### stat() + +```ts +stat(path): Promise +``` + +Get information about the given path + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`<`object`\> + +| Member | Type | +| :------ | :------ | +| `isDirectory` | `boolean` | +| `isFile` | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md new file mode 100644 index 00000000000..b8261b73c1f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] ResolveModuleOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `baseDir` | `string` | - | +| `directoryIndexFiles?` | `string`[] |

When resolution reach a directory without package.json look for those files to load in order.

**Default**

["index.mjs", "index.js"] | +| `resolveMain?` | (`pkg`: `any`) => `string` |

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

**Default**

pkg.main | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedFile.md new file mode 100644 index 00000000000..23b4709d7c1 --- /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 | +| :------ | :------ | +| `path` | `string` | +| `type` | `"file"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md new file mode 100644 index 00000000000..15f57df7adb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] ResolvedModule" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `mainFile` | `string` | Resolved main file for the module. | +| `manifest` | [`NodePackage`](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 00000000000..e4ea2b1ec13 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `Return` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `value` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnRecord.md new file mode 100644 index 00000000000..4d562ad90b2 --- /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 | +| :------ | :------ | +| `kind` | `"Return"` | +| `value` | [`Type`](../type-aliases/Type.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md new file mode 100644 index 00000000000..56d73f5c061 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] RmOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `recursive?` | `boolean` |

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

**Default**

false | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md new file mode 100644 index 00000000000..bcfbbc8745d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md @@ -0,0 +1,64 @@ +--- +jsApi: true +title: "[I] Scalar" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `baseScalar?` | `public` | [`Scalar`](Scalar.md) | Scalar this scalar extends. | - | - | +| `constructors` | `public` | `Map`<`string`, [`ScalarConstructor`](ScalarConstructor.md)\> | - | - | - | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | +| `derivedScalars` | `public` | [`Scalar`](Scalar.md)[] |

Direct children. This is the reverse relation of

**See**

baseScalar

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

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Scalar"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `name` | `public` | `string` | - | - | - | +| `namespace?` | `public` | [`Namespace`](Namespace.md) | Namespace the scalar was defined in. | - | - | +| `node` | `public` | [`ScalarStatementNode`](ScalarStatementNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| ~~`templateArguments?`~~ | `public` | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] |

**Deprecated**

use templateMapper instead.

| [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateArguments` | +| `templateMapper?` | `public` | [`TypeMapper`](TypeMapper.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateMapper` | +| `templateNode?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | [`TemplatedTypeBase`](TemplatedTypeBase.md).`templateNode` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructor.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructor.md new file mode 100644 index 00000000000..fbeaa0e2d11 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructor.md @@ -0,0 +1,58 @@ +--- +jsApi: true +title: "[I] ScalarConstructor" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"ScalarConstructor"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `name` | `public` | `string` | - | - | - | +| `node` | `public` | [`ScalarConstructorNode`](ScalarConstructorNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `parameters` | `public` | [`SignatureFunctionParameter`](SignatureFunctionParameter.md)[] | - | - | - | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `scalar` | `public` | [`Scalar`](Scalar.md) | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructorNode.md new file mode 100644 index 00000000000..87024979696 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarConstructorNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] ScalarConstructorNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `kind` | `readonly` | `ScalarConstructor` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parameters` | `readonly` | [`FunctionParameterNode`](FunctionParameterNode.md)[] | - | - | - | +| `parent?` | `readonly` | [`ScalarStatementNode`](ScalarStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..f4fd7c6a62e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[I] ScalarStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `bodyRange` | `readonly` | [`TextRange`](TextRange.md) | - | - | - | +| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `extends?` | `readonly` | [`TypeReferenceNode`](TypeReferenceNode.md) | - | - | - | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `ScalarStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `members` | `readonly` | readonly [`ScalarConstructorNode`](ScalarConstructorNode.md)[] | - | - | - | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarValue.md new file mode 100644 index 00000000000..30cba84bb1d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarValue.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[I] ScalarValue" + +--- +## Extends + +- `BaseValue` + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| `scalar` | `public` | [`Scalar`](Scalar.md) | - | - | - | +| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

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

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

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

 | `BaseValue.type` | `BaseValue.type` | +| `value` | `public` | `object` | - | - | - | +| `value.args` | `public` | [`Value`](../type-aliases/Value.md)[] | - | - | - | +| `value.name` | `public` | `string` | - | - | - | +| `valueKind` | `public` | `"ScalarValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md new file mode 100644 index 00000000000..33019f04687 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scanner.md @@ -0,0 +1,187 @@ +--- +jsApi: true +title: "[I] Scanner" + +--- +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `file` | `readonly` | [`SourceFile`](SourceFile.md) | The source code being scanned. | +| `position` | `readonly` | `number` | The offset in UTF-16 code units to the current position at the start of the next token. | +| `token` | `readonly` | [`Token`](../enumerations/Token.md) | The current token | +| `tokenFlags` | `readonly` | [`TokenFlags`](../enumerations/TokenFlags.md) | The flags on the current token. | +| `tokenPosition` | `readonly` | `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` + +*** + +### findTripleQuotedStringIndent() + +```ts +findTripleQuotedStringIndent(start, end): [number, number] +``` + +Finds the indent for the given triple quoted string. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `start` | `number` | | +| `end` | `number` | | + +#### Returns + +[`number`, `number`] + +*** + +### 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` + +*** + +### reScanStringTemplate() + +```ts +reScanStringTemplate(tokenFlags): StringTemplateToken +``` + +Unconditionally back up and scan a template expression portion. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `tokenFlags` | [`TokenFlags`](../enumerations/TokenFlags.md) | Token Flags for head StringTemplateToken | + +#### Returns + +[`StringTemplateToken`](../type-aliases/StringTemplateToken.md) + +*** + +### scan() + +```ts +scan(): Token +``` + +Advance one token. + +#### Returns + +[`Token`](../enumerations/Token.md) + +*** + +### scanDoc() + +```ts +scanDoc(): DocToken +``` + +Advance one token inside DocComment. Use inside [scanRange](Scanner.md#scanrange) callback over DocComment range. + +#### Returns + +[`DocToken`](../type-aliases/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 + +| Type parameter | +| :------ | +| `T` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `range` | [`TextRange`](TextRange.md) | +| `callback` | () => `T` | + +#### Returns + +`T` + +*** + +### unindentAndUnescapeTripleQuotedString() + +```ts +unindentAndUnescapeTripleQuotedString( + start, + end, + indentationStart, + indentationEnd, + token, + tokenFlags): string +``` + +Unindent and unescape the triple quoted string rawText + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `start` | `number` | +| `end` | `number` | +| `indentationStart` | `number` | +| `indentationEnd` | `number` | +| `token` | `StringLiteral` \| [`StringTemplateToken`](../type-aliases/StringTemplateToken.md) | +| `tokenFlags` | [`TokenFlags`](../enumerations/TokenFlags.md) | + +#### Returns + +`string` 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 00000000000..e138fcc5e63 --- /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 | +| :------ | :------ | +| `end` | `number` | +| `kind` | [`SemanticTokenKind`](../enumerations/SemanticTokenKind.md) | +| `pos` | `number` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md new file mode 100644 index 00000000000..13ac805166a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md @@ -0,0 +1,425 @@ +--- +jsApi: true +title: "[I] Server" + +--- +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `pendingMessages` | `readonly` | readonly [`ServerLog`](ServerLog.md)[] | +| `workspaceFolders` | `readonly` | readonly [`ServerWorkspaceFolder`](ServerWorkspaceFolder.md)[] | + +## Methods + +### buildSemanticTokens() + +```ts +buildSemanticTokens(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `SemanticTokensParams` | + +#### Returns + +`Promise`<`SemanticTokens`\> + +*** + +### checkChange() + +```ts +checkChange(change): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `change` | `TextDocumentChangeEvent`<`TextDocument`\> | + +#### Returns + +`Promise`<`void`\> + +*** + +### compile() + +```ts +compile(document): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `document` | `TextDocument` \| `TextDocumentIdentifier` | + +#### Returns + +`Promise`<`undefined` \| [`CompileResult`](CompileResult.md)\> + +*** + +### complete() + +```ts +complete(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `CompletionParams` | + +#### Returns + +`Promise`<`CompletionList`\> + +*** + +### documentClosed() + +```ts +documentClosed(change): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `change` | `TextDocumentChangeEvent`<`TextDocument`\> | + +#### Returns + +`void` + +*** + +### executeCommand() + +```ts +executeCommand(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `ExecuteCommandParams` | + +#### Returns + +`Promise`<`void`\> + +*** + +### findDocumentHighlight() + +```ts +findDocumentHighlight(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `DocumentHighlightParams` | + +#### Returns + +`Promise`<`DocumentHighlight`[]\> + +*** + +### findReferences() + +```ts +findReferences(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `ReferenceParams` | + +#### Returns + +`Promise`<`Location`[]\> + +*** + +### formatDocument() + +```ts +formatDocument(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `DocumentFormattingParams` | + +#### Returns + +`Promise`<`TextEdit`[]\> + +*** + +### getCodeActions() + +```ts +getCodeActions(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `CodeActionParams` | + +#### Returns + +`Promise`<`CodeAction`[]\> + +*** + +### getDocumentSymbols() + +```ts +getDocumentSymbols(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `DocumentSymbolParams` | + +#### Returns + +`Promise`<`DocumentSymbol`[]\> + +*** + +### getFoldingRanges() + +```ts +getFoldingRanges(getFoldingRanges): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `getFoldingRanges` | `FoldingRangeParams` | + +#### Returns + +`Promise`<`FoldingRange`[]\> + +*** + +### getHover() + +```ts +getHover(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `HoverParams` | + +#### Returns + +`Promise`<`Hover`\> + +*** + +### getSemanticTokens() + +```ts +getSemanticTokens(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `SemanticTokensParams` | + +#### Returns + +`Promise`<[`SemanticToken`](SemanticToken.md)[]\> + +*** + +### getSignatureHelp() + +```ts +getSignatureHelp(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `SignatureHelpParams` | + +#### Returns + +`Promise`<`undefined` \| `SignatureHelp`\> + +*** + +### gotoDefinition() + +```ts +gotoDefinition(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `DefinitionParams` | + +#### Returns + +`Promise`<`Location`[]\> + +*** + +### initialize() + +```ts +initialize(params): Promise> +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `InitializeParams` | + +#### Returns + +`Promise`<`InitializeResult`<`any`\>\> + +*** + +### initialized() + +```ts +initialized(params): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `InitializedParams` | + +#### Returns + +`void` + +*** + +### log() + +```ts +log(log): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `log` | [`ServerLog`](ServerLog.md) | + +#### Returns + +`void` + +*** + +### prepareRename() + +```ts +prepareRename(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `PrepareRenameParams` | + +#### Returns + +`Promise`<`undefined` \| `Range`\> + +*** + +### rename() + +```ts +rename(params): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `RenameParams` | + +#### Returns + +`Promise`<`WorkspaceEdit`\> + +*** + +### watchedFilesChanged() + +```ts +watchedFilesChanged(params): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `DidChangeWatchedFilesParams` | + +#### Returns + +`void` + +*** + +### workspaceFoldersChanged() + +```ts +workspaceFoldersChanged(e): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `e` | `WorkspaceFoldersChangeEvent` | + +#### Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md new file mode 100644 index 00000000000..0ee0da2fab2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[I] ServerHost" + +--- +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `applyEdit` | `readonly` | (`paramOrEdit`: `WorkspaceEdit` \| `ApplyWorkspaceEditParams`) => `Promise`<`ApplyWorkspaceEditResult`\> | +| `compilerHost` | `readonly` | [`CompilerHost`](CompilerHost.md) | +| `getOpenDocumentByURL` | `readonly` | (`url`: `string`) => `undefined` \| `TextDocument` | +| `log` | `readonly` | (`log`: [`ServerLog`](ServerLog.md)) => `void` | +| `sendDiagnostics` | `readonly` | (`params`: `PublishDiagnosticsParams`) => `void` | +| `throwInternalErrors?` | `readonly` | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerLog.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerLog.md new file mode 100644 index 00000000000..9fc1806b8f9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerLog.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] ServerLog" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `detail?` | `unknown` | +| `level` | [`ServerLogLevel`](../type-aliases/ServerLogLevel.md) | +| `message` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md new file mode 100644 index 00000000000..4fa14fb0637 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md @@ -0,0 +1,61 @@ +--- +jsApi: true +title: "[I] ServerSourceFile" + +--- +## Extends + +- [`SourceFile`](SourceFile.md) + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `document?` | `readonly` | `TextDocument` | - | - | +| `path` | `readonly` | `string` |

The source file path.

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

| [`SourceFile`](SourceFile.md).`path` | +| `text` | `readonly` | `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` | + +#### Returns + +[`LineAndCharacter`](LineAndCharacter.md) + +#### 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. + +#### Returns + +readonly `number`[] + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getLineStarts`](SourceFile.md#getlinestarts) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md new file mode 100644 index 00000000000..d68e4b2a49c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] ServerWorkspaceFolder" + +--- +## Extends + +- `WorkspaceFolder` + +## Properties + +| Property | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | +| `name` | `string` | The name of the workspace folder. Used to refer to this workspace folder in the user interface. | `WorkspaceFolder.name` | +| `path` | `string` | - | - | +| `uri` | `string` | The associated URI for this workspace folder. | `WorkspaceFolder.uri` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md new file mode 100644 index 00000000000..6e164000d16 --- /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 | Inherited from | +| :------ | :------ | :------ | :------ | +| `title?` | `string` | - | [`ServiceDetails`](ServiceDetails.md).`title` | +| `type` | [`Namespace`](Namespace.md) | - | - | +| ~~`version?`~~ | `string` |

**Deprecated**

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

| [`ServiceDetails`](ServiceDetails.md).`version` | 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 00000000000..cf14e4e628a --- /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` |

**Deprecated**

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

| diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SignatureFunctionParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SignatureFunctionParameter.md new file mode 100644 index 00000000000..f4b8325d834 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SignatureFunctionParameter.md @@ -0,0 +1,62 @@ +--- +jsApi: true +title: "[I] SignatureFunctionParameter" + +--- +Represent a function parameter that represent the parameter signature(i.e the type would be the type of the value passed) + +## Extends + +- [`FunctionParameterBase`](FunctionParameterBase.md) + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`FunctionParameterBase`](FunctionParameterBase.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`FunctionParameterBase`](FunctionParameterBase.md).`isFinished` | +| `kind` | `public` | `"FunctionParameter"` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`kind` | +| `mixed` | `public` | `false` | - | - | +| `name` | `public` | `string` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`name` | +| `node` | `public` | [`FunctionParameterNode`](FunctionParameterNode.md) | - | [`FunctionParameterBase`](FunctionParameterBase.md).`node` | +| `optional` | `public` | `boolean` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`optional` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`FunctionParameterBase`](FunctionParameterBase.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`FunctionParameterBase`](FunctionParameterBase.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`FunctionParameterBase`](FunctionParameterBase.md).`projector` | +| `rest` | `public` | `boolean` | - | [`FunctionParameterBase`](FunctionParameterBase.md).`rest` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`FunctionParameterBase`](FunctionParameterBase.md).[`projectionsByName`](FunctionParameterBase.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md new file mode 100644 index 00000000000..8fb0d5951c0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md @@ -0,0 +1,52 @@ +--- +jsApi: true +title: "[I] SourceFile" + +--- +## Extended by + +- [`ServerSourceFile`](ServerSourceFile.md) + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `path` | `readonly` | `string` |

The source file path.

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

| +| `text` | `readonly` | `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`](LineAndCharacter.md) + +*** + +### getLineStarts() + +```ts +getLineStarts(): readonly number[] +``` + +Array of positions in the text where each line begins. There is one entry +per line, in order of lines, and each entry represents the offset in UTF-16 +code units from the start of the document to the beginning of the line. + +#### Returns + +readonly `number`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md new file mode 100644 index 00000000000..f875ee721ed --- /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 + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`TextRange`](TextRange.md).`end` | +| `file` | `public` | [`SourceFile`](SourceFile.md) | - | - | +| `isSynthetic?` | `public` | `boolean` | - | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`TextRange`](TextRange.md).`pos` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md new file mode 100644 index 00000000000..5360bcea7d5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] SourceLocationOptions" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `locateId?` | `boolean` | If trying to resolve the location of a type with an ID, show the location of the ID node instead of the entire type. This makes sure that the location range is not too large and hard to read. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md new file mode 100644 index 00000000000..ebe8d745940 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] SourceModel" + +--- +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `model` | `readonly` | [`Model`](Model.md) | Source model | +| `usage` | `readonly` | `"is"` \| `"spread"` \| `"intersection"` |

How was this model used.

  • is: `model A is B`
  • spread: `model A {...B}`
  • intersection: `alias A = B & C`
| diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StateDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StateDef.md new file mode 100644 index 00000000000..c44b13cc79e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StateDef.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] StateDef" + +--- +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `description?` | `readonly` | `string` | Description for this state. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md new file mode 100644 index 00000000000..038f66917ff --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md @@ -0,0 +1,56 @@ +--- +jsApi: true +title: "[I] StringLiteral" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"String"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `node?` | `public` | [`StringLiteralNode`](StringLiteralNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `value` | `public` | `string` | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md new file mode 100644 index 00000000000..7f964996110 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `StringLiteral` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `value` | `readonly` | `string` | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md new file mode 100644 index 00000000000..19e0f66a512 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md @@ -0,0 +1,57 @@ +--- +jsApi: true +title: "[I] StringTemplate" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"StringTemplate"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `node` | `public` | [`StringTemplateExpressionNode`](StringTemplateExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `spans` | `public` | [`StringTemplateSpan`](../type-aliases/StringTemplateSpan.md)[] | - | - | - | +| `stringValue?` | `public` | `string` | If the template can be render as as string this is the string value | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md new file mode 100644 index 00000000000..eb9a19a7dea --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] StringTemplateExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `head` | `readonly` | [`StringTemplateHeadNode`](StringTemplateHeadNode.md) | - | - | - | +| `kind` | `readonly` | `StringTemplateExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `spans` | `readonly` | readonly [`StringTemplateSpanNode`](StringTemplateSpanNode.md)[] | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md new file mode 100644 index 00000000000..735f12f017c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] StringTemplateHeadNode" + +--- +## Extends + +- [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | +| `kind` | `readonly` | `StringTemplateHead` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | +| `value` | `readonly` | `string` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md new file mode 100644 index 00000000000..dc7de2af72f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md @@ -0,0 +1,28 @@ +--- +jsApi: true +title: "[I] StringTemplateLiteralLikeNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Extended by + +- [`StringTemplateHeadNode`](StringTemplateHeadNode.md) +- [`StringTemplateMiddleNode`](StringTemplateMiddleNode.md) +- [`StringTemplateTailNode`](StringTemplateTailNode.md) + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | [`SyntaxKind`](../enumerations/SyntaxKind.md) | - | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | +| `value` | `readonly` | `string` | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md new file mode 100644 index 00000000000..ecdeda446ef --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] StringTemplateMiddleNode" + +--- +## Extends + +- [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | +| `kind` | `readonly` | `StringTemplateMiddle` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | +| `value` | `readonly` | `string` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md new file mode 100644 index 00000000000..afd8591588f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md @@ -0,0 +1,57 @@ +--- +jsApi: true +title: "[I] StringTemplateSpanLiteral" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `isInterpolated` | `public` | `false` | - | - | - | +| `kind` | `public` | `"StringTemplateSpan"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `node` | `public` | [`StringTemplateHeadNode`](StringTemplateHeadNode.md) \| [`StringTemplateMiddleNode`](StringTemplateMiddleNode.md) \| [`StringTemplateTailNode`](StringTemplateTailNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `type` | `public` | [`StringLiteral`](StringLiteral.md) | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md new file mode 100644 index 00000000000..b03f7f27499 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] StringTemplateSpanNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `expression` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `StringTemplateSpan` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `literal` | `readonly` | [`StringTemplateMiddleNode`](StringTemplateMiddleNode.md) \| [`StringTemplateTailNode`](StringTemplateTailNode.md) | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md new file mode 100644 index 00000000000..4d7c5ddb3d6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md @@ -0,0 +1,57 @@ +--- +jsApi: true +title: "[I] StringTemplateSpanValue" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `isInterpolated` | `public` | `true` | - | - | - | +| `kind` | `public` | `"StringTemplateSpan"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `node` | `public` | [`Expression`](../type-aliases/Expression.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md new file mode 100644 index 00000000000..1baf165c8a0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] StringTemplateTailNode" + +--- +## Extends + +- [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`flags` | +| `kind` | `readonly` | `StringTemplateTail` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`symbol` | +| `value` | `readonly` | `string` | - | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | [`StringTemplateLiteralLikeNode`](StringTemplateLiteralLikeNode.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringValue.md new file mode 100644 index 00000000000..7c4932bcdc0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringValue.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] StringValue" + +--- +## Extends + +- `BaseValue` + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Value"` | - | `BaseValue.entityKind` | `BaseValue.entityKind` | +| `scalar` | `public` | `undefined` \| [`Scalar`](Scalar.md) | - | - | - | +| `type` | `public` | [`Type`](../type-aliases/Type.md) |

Represent the storage type of a value.

**Example**

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

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

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

 | `BaseValue.type` | `BaseValue.type` | +| `value` | `public` | `string` | - | - | - | +| `valueKind` | `public` | `"StringValue"` | - | `BaseValue.valueKind` | `BaseValue.valueKind` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SuppressDirective.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SuppressDirective.md new file mode 100644 index 00000000000..b3a5b1d525c --- /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 | Inherited from | +| :------ | :------ | :------ | +| `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 00000000000..956cbc24a7e --- /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 + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `declarations` | `readonly` | readonly [`Node`](../type-aliases/Node.md)[] | Nodes which contribute to this declaration | +| `exports?` | `readonly` | `SymbolTable` | Externally visible symbols contained inside this symbol. E.g. all declarations in a namespace, or members of an enum. | +| `flags` | `readonly` | [`SymbolFlags`](../enumerations/SymbolFlags.md) | - | +| `id?` | `readonly` | `number` | A unique identifier for this symbol. Used to look up the symbol links. | +| `members?` | `readonly` | `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?` | `readonly` | `SymbolTable` | Symbol table | +| `name` | `readonly` | `string` | The name of the symbol | +| `parent?` | `readonly` | [`Sym`](Sym.md) | The symbol containing this symbol, if any. E.g. for things declared in a namespace, this refers to the namespace. | +| `symbolSource?` | `readonly` | [`Sym`](Sym.md) | For using symbols, this is the used symbol. | +| `type?` | `readonly` | [`Type`](../type-aliases/Type.md) | For late-bound symbols, this is the type referenced by the symbol. | +| `value?` | `readonly` | (...`args`: `any`[]) => `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/interfaces/SymbolLinks.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md new file mode 100644 index 00000000000..aac93be565b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] SymbolLinks" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `declaredType?` | [`Type`](../type-aliases/Type.md) | For types that can be instanitated this is the type of the declaration | +| `instantiations?` | [`TypeInstantiationMap`](TypeInstantiationMap.md) | For types that can be instanitated those are the types per instantiation | +| `type?` | [`Type`](../type-aliases/Type.md) | - | +| `value?` | `null` \| [`Value`](../type-aliases/Value.md) | For const statements the value of the const | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md new file mode 100644 index 00000000000..a0c66d47ac1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] SyntheticLocationContext" + +--- +Refer to a type that was not declared in a file + +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `type` | `readonly` | `"synthetic"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md new file mode 100644 index 00000000000..46f339f01e8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[I] TemplateArgumentNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `argument` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `TemplateArgument` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `name?` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..463e2870d39 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md @@ -0,0 +1,21 @@ +--- +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 + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `locals?` | `readonly` | `SymbolTable` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md new file mode 100644 index 00000000000..a64d9d5fbee --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md @@ -0,0 +1,57 @@ +--- +jsApi: true +title: "[I] TemplateParameter" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `constraint?` | `public` | [`MixedParameterConstraint`](MixedParameterConstraint.md) | - | - | - | +| `default?` | `public` | [`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md) | - | - | - | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"TemplateParameter"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `node` | `public` | [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md new file mode 100644 index 00000000000..246168ebb20 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `constraint?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | +| `default?` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `TemplateParameterDeclaration` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`TemplateableNode`](../type-aliases/TemplateableNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..93bfea11cf1 --- /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) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] |

**Deprecated**

use templateMapper instead.

| +| `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | +| `templateNode?` | [`Node`](../type-aliases/Node.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md new file mode 100644 index 00000000000..b4eab27efd6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[I] TextRange" + +--- +## Extended by + +- [`BaseNode`](BaseNode.md) +- [`LineComment`](LineComment.md) +- [`BlockComment`](BlockComment.md) +- [`SourceLocation`](SourceLocation.md) +- [`ReplaceTextCodeFixEdit`](ReplaceTextCodeFixEdit.md) + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md new file mode 100644 index 00000000000..8b534aaa96b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tracer.md @@ -0,0 +1,47 @@ +--- +jsApi: true +title: "[I] Tracer" + +--- +## Methods + +### sub() + +```ts +sub(subarea): Tracer +``` + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `subarea` | `string` | | + +#### Returns + +[`Tracer`](Tracer.md) + +*** + +### trace() + +```ts +trace( + area, + message, + target?): void +``` + +Trace + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `area` | `string` | | +| `message` | `string` | | +| `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | - | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TracerOptions.md new file mode 100644 index 00000000000..c494ca07ed1 --- /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 | +| :------ | :------ | +| `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 00000000000..a58713e874f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md @@ -0,0 +1,56 @@ +--- +jsApi: true +title: "[I] Tuple" + +--- +## Extends + +- [`BaseType`](BaseType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Tuple"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `node` | `public` | [`ArrayLiteralNode`](ArrayLiteralNode.md) \| [`TupleExpressionNode`](TupleExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `values` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md new file mode 100644 index 00000000000..c115a127e4b --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `TupleExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `values` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md new file mode 100644 index 00000000000..8246154d2db --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md @@ -0,0 +1,43 @@ +--- +jsApi: true +title: "[I] TypeInstantiationMap" + +--- +Maps type arguments to instantiated type. + +## Methods + +### get() + +```ts +get(args): undefined | Type +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `args` | readonly ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | + +#### Returns + +`undefined` \| [`Type`](../type-aliases/Type.md) + +*** + +### set() + +```ts +set(args, type): void +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `args` | readonly ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | +| `type` | [`Type`](../type-aliases/Type.md) | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md new file mode 100644 index 00000000000..1d4ce346cc8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[I] TypeMapper" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `args` | readonly ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | +| `partial` | `boolean` | + +## Methods + +### getMappedType() + +```ts +getMappedType(type): Type | Value | IndeterminateEntity +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`TemplateParameter`](TemplateParameter.md) | + +#### Returns + +[`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.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 00000000000..c89bb8d3d7a --- /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 | +| :------ | :------ | +| `namespaceFilter?` | (`ns`: [`Namespace`](Namespace.md)) => `boolean` | +| `printable?` | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeOfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeOfExpressionNode.md new file mode 100644 index 00000000000..5ac489c6f06 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeOfExpressionNode.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] TypeOfExpressionNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `TypeOfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md new file mode 100644 index 00000000000..1f93afb3378 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `arguments` | `readonly` | readonly [`TemplateArgumentNode`](TemplateArgumentNode.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `TypeReference` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md new file mode 100644 index 00000000000..06c5b7f9755 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecCompletionItem.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] TypeSpecCompletionItem" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `label?` | `string` | Optional label if different from the text to complete. | +| `suffix?` | `string` | Optional text to be appended to the completion if accepted. | +| `sym` | [`Sym`](Sym.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md new file mode 100644 index 00000000000..cf523aa69e0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md @@ -0,0 +1,121 @@ +--- +jsApi: true +title: "[I] TypeSpecLibrary" + +--- +## Extends + +- [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md)<`T`, `E`, `State`\> + +## Type parameters + +| Type parameter | Value | +| :------ | :------ | +| `T` *extends* `object` | - | +| `E` *extends* `Record`<`string`, `any`\> | `Record`<`string`, `never`\> | +| `State` *extends* `string` | `never` | + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `diagnostics` | `readonly` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`diagnostics` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`diagnostics` | +| `emitter?` | `readonly` | `object` | Emitter configuration if library is an emitter. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`emitter` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`emitter` | +| `emitter.options?` | `readonly` | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | - | - | +| ~~`linter?`~~ | `readonly` | [`LinterDefinition`](LinterDefinition.md) |

Configuration if library is providing linting rules/rulesets.

**Deprecated**

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

| [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`linter` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`linter` | +| `name` | `readonly` | `string` | Library name | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`name` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`name` | +| `requireImports?` | `readonly` | readonly `string`[] | List of other library that should be imported when this is used as an emitter. Compiler will emit an error if the libraries are not explicitly imported. | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`requireImports` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`requireImports` | +| `state?` | `readonly` | `Record`<`State`, [`StateDef`](StateDef.md)\> | - | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`state` | [`TypeSpecLibraryDef`](TypeSpecLibraryDef.md).`state` | +| `stateKeys` | `public` | `Record`<`State`, `symbol`\> | - | - | - | + +## Methods + +### createDiagnostic() + +```ts +createDiagnostic(diag): Diagnostic +``` + +#### Type parameters + +| Type parameter | +| :------ | +| `C` *extends* `string` \| `number` \| `symbol` | +| `M` *extends* `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | + +#### Returns + +[`Diagnostic`](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`](Program.md) | + +#### Returns + +[`Tracer`](Tracer.md) + +*** + +### reportDiagnostic() + +```ts +reportDiagnostic(program, diag): void +``` + +#### Type parameters + +| Type parameter | +| :------ | +| `C` *extends* `string` \| `number` \| `symbol` | +| `M` *extends* `string` \| `number` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | [`Program`](Program.md) | +| `diag` | [`DiagnosticReport`](../type-aliases/DiagnosticReport.md)<`T`, `C`, `M`\> | + +#### Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md new file mode 100644 index 00000000000..ada1776bab5 --- /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" + +--- +## Extended by + +- [`TypeSpecLibrary`](TypeSpecLibrary.md) + +## Type parameters + +| Type parameter | Value | +| :------ | :------ | +| `T` *extends* `object` | - | +| `E` *extends* `Record`<`string`, `any`\> | `Record`<`string`, `never`\> | +| `State` *extends* `string` | `never` | + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `diagnostics` | `readonly` | [`DiagnosticMap`](../type-aliases/DiagnosticMap.md)<`T`\> | Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code. | +| `emitter?` | `readonly` | `object` | Emitter configuration if library is an emitter. | +| `emitter.options?` | `readonly` | [`JSONSchemaType`](../type-aliases/JSONSchemaType.md)<`E`\> | - | +| ~~`linter?`~~ | `readonly` | [`LinterDefinition`](LinterDefinition.md) |

Configuration if library is providing linting rules/rulesets.

**Deprecated**

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

| +| `name` | `readonly` | `string` | Library name. MUST match package.json name. | +| `requireImports?` | `readonly` | readonly `string`[] | List of other library that should be imported when this is used as an emitter. Compiler will emit an error if the libraries are not explicitly imported. | +| `state?` | `public` | `Record`<`State`, [`StateDef`](StateDef.md)\> | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md new file mode 100644 index 00000000000..67130a08b89 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecManifest.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] TypeSpecManifest" + +--- +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `commit` | `string` | Full commit sha. | +| `pr?` | `number` | Number of the pull request, if the build was from a pull request. | +| `version` | `string` | Version of the tsp compiler. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md new file mode 100644 index 00000000000..22c0342f1e4 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `comments` | `readonly` | readonly [`Comment`](../type-aliases/Comment.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `file` | `readonly` | [`SourceFile`](SourceFile.md) | - | - | - | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `inScopeNamespaces` | `readonly` | readonly [`NamespaceStatementNode`](NamespaceStatementNode.md)[] | - | - | - | +| `kind` | `readonly` | `TypeSpecScript` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `locals` | `readonly` | `SymbolTable` | - | - | - | +| `namespaces` | `readonly` | [`NamespaceStatementNode`](NamespaceStatementNode.md)[] | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `parseDiagnostics` | `readonly` | readonly [`Diagnostic`](Diagnostic.md)[] | - | - | - | +| `parseOptions` | `readonly` | [`ParseOptions`](ParseOptions.md) | - | - | - | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `printable` | `readonly` | `boolean` | - | - | - | +| `statements` | `readonly` | readonly [`Statement`](../type-aliases/Statement.md)[] | - | - | - | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `usings` | `readonly` | readonly [`UsingStatementNode`](UsingStatementNode.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md new file mode 100644 index 00000000000..06bfddd9c2b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md @@ -0,0 +1,64 @@ +--- +jsApi: true +title: "[I] Union" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `expression` | `public` | `boolean` | - | - | - | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"Union"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `name?` | `public` | `string` | - | - | - | +| `namespace?` | `public` | [`Namespace`](Namespace.md) | - | - | - | +| `node` | `public` | [`UnionStatementNode`](UnionStatementNode.md) \| [`UnionExpressionNode`](UnionExpressionNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| ~~`options`~~ | `readonly` | [`Type`](../type-aliases/Type.md)[] |

**Deprecated**

use variants

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

**Deprecated**

use templateMapper instead.

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

The variants of the union.

Variants are ordered in order that they appear in source.

| - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md new file mode 100644 index 00000000000..6105306b390 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `UnionExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `options` | `readonly` | readonly [`Expression`](../type-aliases/Expression.md)[] | - | - | - | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..94d6c1a6fdb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md @@ -0,0 +1,27 @@ +--- +jsApi: true +title: "[I] UnionStatementNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md).[`DeclarationNode`](DeclarationNode.md).[`TemplateDeclarationNode`](TemplateDeclarationNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | [`DeclarationNode`](DeclarationNode.md).`id` | [`DeclarationNode`](DeclarationNode.md).`id` | +| `kind` | `readonly` | `UnionStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `locals?` | `readonly` | `SymbolTable` | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`locals` | +| `options` | `readonly` | readonly [`UnionVariantNode`](UnionVariantNode.md)[] | - | - | - | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParameters` | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | - | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | [`TemplateDeclarationNode`](TemplateDeclarationNode.md).`templateParametersRange` | 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 00000000000..a7bb332848e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md @@ -0,0 +1,59 @@ +--- +jsApi: true +title: "[I] UnionVariant" + +--- +## Extends + +- [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `public` | [`DecoratorApplication`](DecoratorApplication.md)[] | - | [`DecoratedType`](DecoratedType.md).`decorators` | [`DecoratedType`](DecoratedType.md).`decorators` | +| `entityKind` | `readonly` | `"Type"` | - | [`BaseType`](BaseType.md).`entityKind` | [`BaseType`](BaseType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`BaseType`](BaseType.md).`instantiationParameters` | [`BaseType`](BaseType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`BaseType`](BaseType.md).`isFinished` | [`BaseType`](BaseType.md).`isFinished` | +| `kind` | `public` | `"UnionVariant"` | - | [`BaseType`](BaseType.md).`kind` | [`BaseType`](BaseType.md).`kind` | +| `name` | `public` | `string` \| `symbol` | - | - | - | +| `node` | `public` | `undefined` \| [`UnionVariantNode`](UnionVariantNode.md) | - | [`BaseType`](BaseType.md).`node` | [`BaseType`](BaseType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionBase` | [`BaseType`](BaseType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`BaseType`](BaseType.md).`projectionSource` | [`BaseType`](BaseType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`BaseType`](BaseType.md).`projector` | [`BaseType`](BaseType.md).`projector` | +| `type` | `public` | [`Type`](../type-aliases/Type.md) | - | - | - | +| `union` | `public` | [`Union`](Union.md) | - | - | - | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`BaseType`](BaseType.md).[`projectionsByName`](BaseType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md new file mode 100644 index 00000000000..7b56e045259 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `decorators` | `readonly` | readonly [`DecoratorExpressionNode`](DecoratorExpressionNode.md)[] | - | - | - | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `id?` | `readonly` | [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `kind` | `readonly` | `UnionVariant` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`UnionStatementNode`](UnionStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `value` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md new file mode 100644 index 00000000000..eddee13ea4d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md @@ -0,0 +1,56 @@ +--- +jsApi: true +title: "[I] UnknownType" + +--- +## Extends + +- [`IntrinsicType`](IntrinsicType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | [`IntrinsicType`](IntrinsicType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`IntrinsicType`](IntrinsicType.md).`isFinished` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | +| `kind` | `public` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | +| `name` | `public` | `"unknown"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md new file mode 100644 index 00000000000..35e25dbd1b4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsageTracker.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[I] UsageTracker" + +--- +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `types` | `readonly` | 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) | + +#### Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md new file mode 100644 index 00000000000..e2c2feeb802 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `UsingStatement` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `name` | `readonly` | [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) | - | - | - | +| `parent?` | `readonly` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) \| [`NamespaceStatementNode`](NamespaceStatementNode.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..859ca1fff81 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ValueOfExpression` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | +| `target` | `readonly` | [`Expression`](../type-aliases/Expression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md new file mode 100644 index 00000000000..424d1be3c55 --- /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 + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `VoidKeyword` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`BaseNode`](BaseNode.md).`parent` | +| `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | [`BaseNode`](BaseNode.md).`pos` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | 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 00000000000..875097424e9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md @@ -0,0 +1,56 @@ +--- +jsApi: true +title: "[I] VoidType" + +--- +## Extends + +- [`IntrinsicType`](IntrinsicType.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `entityKind` | `readonly` | `"Type"` | - | [`IntrinsicType`](IntrinsicType.md).`entityKind` | [`IntrinsicType`](IntrinsicType.md).`entityKind` | +| `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | [`IntrinsicType`](IntrinsicType.md).`instantiationParameters` | +| `isFinished` | `public` | `boolean` |

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

  • a template declaration will not
  • a template instance that argument that are still template parameters
  • a template instance that is only partially instantiated(like a templated operation inside a templated interface)
| [`IntrinsicType`](IntrinsicType.md).`isFinished` | [`IntrinsicType`](IntrinsicType.md).`isFinished` | +| `kind` | `public` | `"Intrinsic"` | - | [`IntrinsicType`](IntrinsicType.md).`kind` | [`IntrinsicType`](IntrinsicType.md).`kind` | +| `name` | `public` | `"void"` | - | [`IntrinsicType`](IntrinsicType.md).`name` | [`IntrinsicType`](IntrinsicType.md).`name` | +| `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | [`IntrinsicType`](IntrinsicType.md).`node` | [`IntrinsicType`](IntrinsicType.md).`node` | +| `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | [`IntrinsicType`](IntrinsicType.md).`projectionBase` | +| `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | [`IntrinsicType`](IntrinsicType.md).`projectionSource` | +| `projector?` | `public` | [`Projector`](Projector.md) | - | [`IntrinsicType`](IntrinsicType.md).`projector` | [`IntrinsicType`](IntrinsicType.md).`projector` | + +## Accessors + +### projections + +```ts +get projections(): ProjectionStatementNode[] +``` + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +## Methods + +### projectionsByName() + +```ts +projectionsByName(name): ProjectionStatementNode[] +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`ProjectionStatementNode`](ProjectionStatementNode.md)[] + +#### Inherited from + +[`IntrinsicType`](IntrinsicType.md).[`projectionsByName`](IntrinsicType.md#projectionsbyname) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerNode.md index a2e623dab81..01967c4a28b 100644 --- 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 @@ -9,7 +9,8 @@ type MemberContainerNode: | ModelExpressionNode | InterfaceStatementNode | EnumStatementNode - | UnionStatementNode; + | UnionStatementNode + | ScalarStatementNode; ``` Node types that can have referencable members diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberType.md index 80140f981e7..c4e77ab59d6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberType.md @@ -4,7 +4,12 @@ title: "[T] MemberType" --- ```ts -type MemberType: ModelProperty | EnumMember | Operation | UnionVariant; +type MemberType: + | ModelProperty + | EnumMember + | Operation + | UnionVariant + | ScalarConstructor; ``` Type that can be used as members of a container type.