From 9c701cc27264e0d635e622e823270d0c054f64a9 Mon Sep 17 00:00:00 2001 From: Allen Zhang Date: Thu, 13 Jun 2024 14:47:55 -0700 Subject: [PATCH] TypeSpec 0.57 - June 2024 Release publish branch (#3578) Co-authored-by: Timothee Guerin --- ...-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/compiler/templates/scaffolding.json | 8 +- 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 | 19 ++ .../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 | 56 ++-- .../reference/js-api/functions/$externRef.md | 2 +- .../reference/js-api/functions/$field.md | 2 +- .../reference/js-api/functions/$message.md | 2 +- .../reference/js-api/functions/$onEmit.md | 2 +- .../reference/js-api/functions/$onValidate.md | 2 +- .../reference/js-api/functions/$package.md | 2 +- .../reference/js-api/functions/$reserve.md | 2 +- .../reference/js-api/functions/$service.md | 2 +- .../reference/js-api/functions/$stream.md | 2 +- .../reference/js-api/functions/isMap.md | 2 +- .../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 +- .../js-api/functions/$multipartBody.md | 19 ++ .../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 | 23 ++ .../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 | 6 +- .../reference/js-api/classes/EventEmitter.md | 12 +- .../js-api/classes/ProjectionError.md | 4 +- .../reference/js-api/classes/Queue.md | 10 +- .../js-api/classes/ResolveModuleError.md | 4 +- .../js-api/enumerations/IdentifierKind.md | 5 +- .../js-api/enumerations/NodeFlags.md | 6 +- .../js-api/enumerations/SymbolFlags.md | 8 +- .../js-api/enumerations/SyntaxKind.md | 85 +++--- .../reference/js-api/enumerations/Token.md | 79 +++--- .../reference/js-api/functions/$deprecated.md | 2 +- .../js-api/functions/$discriminator.md | 2 +- .../reference/js-api/functions/$doc.md | 2 +- .../reference/js-api/functions/$encode.md | 4 +- .../js-api/functions/$encodedName.md | 2 +- .../reference/js-api/functions/$error.md | 2 +- .../reference/js-api/functions/$errorsDoc.md | 2 +- .../reference/js-api/functions/$format.md | 4 +- .../js-api/functions/$friendlyName.md | 2 +- .../js-api/functions/$inspectType.md | 2 +- .../js-api/functions/$inspectTypeName.md | 2 +- .../reference/js-api/functions/$key.md | 2 +- .../js-api/functions/$knownValues.md | 4 +- .../reference/js-api/functions/$list.md | 2 +- .../reference/js-api/functions/$maxItems.md | 4 +- .../reference/js-api/functions/$maxLength.md | 6 +- .../reference/js-api/functions/$maxValue.md | 6 +- .../js-api/functions/$maxValueExclusive.md | 6 +- .../reference/js-api/functions/$minItems.md | 4 +- .../reference/js-api/functions/$minLength.md | 6 +- .../reference/js-api/functions/$minValue.md | 6 +- .../js-api/functions/$minValueExclusive.md | 6 +- .../reference/js-api/functions/$overload.md | 2 +- .../js-api/functions/$parameterVisibility.md | 2 +- .../reference/js-api/functions/$pattern.md | 4 +- .../js-api/functions/$projectedName.md | 2 +- .../js-api/functions/$returnTypeVisibility.md | 2 +- .../reference/js-api/functions/$returnsDoc.md | 2 +- .../reference/js-api/functions/$secret.md | 4 +- .../reference/js-api/functions/$service.md | 2 +- .../reference/js-api/functions/$summary.md | 2 +- .../reference/js-api/functions/$tag.md | 2 +- .../reference/js-api/functions/$visibility.md | 2 +- .../functions/$withDefaultKeyVisibility.md | 2 +- .../functions/$withOptionalProperties.md | 2 +- .../js-api/functions/$withPickedProperties.md | 23 ++ .../functions/$withUpdateableProperties.md | 2 +- .../js-api/functions/$withVisibility.md | 2 +- .../js-api/functions/$withoutDefaultValues.md | 2 +- .../functions/$withoutOmittedProperties.md | 2 +- .../reference/js-api/functions/Numeric.md | 20 ++ .../reference/js-api/functions/addService.md | 2 +- .../reference/js-api/functions/assertType.md | 33 +-- .../js-api/functions/cadlTypeToJson.md | 2 +- .../js-api/functions/checkFormatCadl.md | 2 +- .../js-api/functions/checkFormatTypeSpec.md | 2 +- .../reference/js-api/functions/compile.md | 2 +- .../js-api/functions/compilerAssert.md | 4 +- .../js-api/functions/createCadlLibrary.md | 8 +- .../js-api/functions/createChecker.md | 2 +- .../functions/createDecoratorDefinition.md | 8 +- .../functions/createDiagnosticCollector.md | 2 +- .../functions/createProjectedNameProgram.md | 2 +- .../js-api/functions/createRekeyableMap.md | 2 +- .../reference/js-api/functions/createRule.md | 6 +- .../js-api/functions/createScanner.md | 2 +- .../js-api/functions/createServer.md | 2 +- .../js-api/functions/createSourceFile.md | 2 +- .../js-api/functions/createStateAccessors.md | 28 -- .../js-api/functions/createTypeSpecLibrary.md | 8 +- .../js-api/functions/defineCodeFix.md | 2 +- .../js-api/functions/defineLinter.md | 2 +- .../js-api/functions/definePackageFlags.md | 18 ++ .../reference/js-api/functions/emitFile.md | 2 +- .../ensureTrailingDirectorySeparator.md | 2 +- .../explainStringTemplateNotSerializable.md | 20 ++ .../js-api/functions/exprIsBareIdentifier.md | 2 +- .../js-api/functions/filterModelProperties.md | 2 +- .../js-api/functions/finishTypeForProgram.md | 4 +- .../js-api/functions/formatDiagnostic.md | 2 +- .../js-api/functions/formatIdentifier.md | 2 +- .../js-api/functions/formatTypeSpec.md | 2 +- .../reference/js-api/functions/getAllTags.md | 2 +- .../functions/getAnyExtensionFromPath.md | 2 +- .../js-api/functions/getBaseFileName.md | 2 +- .../js-api/functions/getDeprecated.md | 2 +- .../js-api/functions/getDeprecationDetails.md | 2 +- .../js-api/functions/getDirectoryPath.md | 2 +- .../js-api/functions/getDiscriminatedTypes.md | 2 +- .../js-api/functions/getDiscriminatedUnion.md | 2 +- .../js-api/functions/getDiscriminator.md | 2 +- .../reference/js-api/functions/getDoc.md | 2 +- .../reference/js-api/functions/getDocData.md | 4 +- .../js-api/functions/getDocDataInternal.md | 27 -- .../js-api/functions/getEffectiveModelType.md | 4 +- .../reference/js-api/functions/getEncode.md | 4 +- .../js-api/functions/getEntityName.md | 19 ++ .../js-api/functions/getErrorsDoc.md | 2 +- .../js-api/functions/getErrorsDocData.md | 4 +- .../js-api/functions/getFirstAncestor.md | 14 +- .../reference/js-api/functions/getFormat.md | 2 +- .../js-api/functions/getFriendlyName.md | 2 +- .../functions/getFullyQualifiedSymbolName.md | 4 +- .../js-api/functions/getIdentifierContext.md | 2 +- .../reference/js-api/functions/getKeyName.md | 2 +- .../js-api/functions/getKnownValues.md | 4 +- .../js-api/functions/getListOperationType.md | 2 +- .../js-api/functions/getLocationContext.md | 2 +- .../reference/js-api/functions/getMaxItems.md | 2 +- .../js-api/functions/getMaxItemsAsNumeric.md | 19 ++ .../js-api/functions/getMaxLength.md | 2 +- .../js-api/functions/getMaxLengthAsNumeric.md | 21 ++ .../reference/js-api/functions/getMaxValue.md | 2 +- .../js-api/functions/getMaxValueAsNumeric.md | 19 ++ .../js-api/functions/getMaxValueExclusive.md | 2 +- .../getMaxValueExclusiveAsNumeric.md | 19 ++ .../reference/js-api/functions/getMinItems.md | 2 +- .../js-api/functions/getMinItemsAsNumeric.md | 19 ++ .../js-api/functions/getMinLength.md | 2 +- .../js-api/functions/getMinLengthAsNumeric.md | 21 ++ .../reference/js-api/functions/getMinValue.md | 2 +- .../js-api/functions/getMinValueAsNumeric.md | 19 ++ .../js-api/functions/getMinValueExclusive.md | 2 +- .../getMinValueExclusiveAsNumeric.md | 19 ++ .../js-api/functions/getNamespaceFullName.md | 2 +- .../js-api/functions/getNodeAtPosition.md | 6 +- .../functions/getNodeAtPositionDetail.md | 23 ++ .../functions/getNormalizedAbsolutePath.md | 2 +- .../getNormalizedAbsolutePathWithoutRoot.md | 2 +- .../functions/getNormalizedPathComponents.md | 2 +- .../functions/getOverloadedOperation.md | 2 +- .../js-api/functions/getOverloads.md | 2 +- .../js-api/functions/getOverriddenProperty.md | 2 +- .../functions/getParameterVisibility.md | 2 +- .../js-api/functions/getParentTemplateNode.md | 2 +- .../js-api/functions/getPathComponents.md | 2 +- .../functions/getPathFromPathComponents.md | 2 +- .../reference/js-api/functions/getPattern.md | 2 +- .../js-api/functions/getPatternData.md | 2 +- .../functions/getPositionBeforeTrivia.md | 2 +- .../js-api/functions/getProjectedName.md | 2 +- .../js-api/functions/getProjectedNames.md | 2 +- .../reference/js-api/functions/getProperty.md | 2 +- .../js-api/functions/getPropertyType.md | 4 +- .../functions/getRelativePathFromDirectory.md | 4 +- .../functions/getReturnTypeVisibility.md | 2 +- .../js-api/functions/getReturnsDoc.md | 2 +- .../js-api/functions/getReturnsDocData.md | 4 +- .../js-api/functions/getRootLength.md | 2 +- .../reference/js-api/functions/getService.md | 2 +- .../functions/getSourceFileKindFromExt.md | 2 +- .../js-api/functions/getSourceLocation.md | 6 +- .../reference/js-api/functions/getSummary.md | 2 +- .../reference/js-api/functions/getTags.md | 2 +- .../reference/js-api/functions/getTypeName.md | 4 +- .../js-api/functions/getVisibility.md | 2 +- .../js-api/functions/hasParseError.md | 2 +- .../js-api/functions/hasProjectedName.md | 2 +- .../hasTrailingDirectorySeparator.md | 2 +- .../js-api/functions/ignoreDiagnostics.md | 2 +- .../js-api/functions/interpolatePath.md | 2 +- .../functions/isAnyDirectorySeparator.md | 2 +- .../js-api/functions/isArrayModelType.md | 2 +- .../js-api/functions/isCadlValueTypeOf.md | 4 +- .../reference/js-api/functions/isComment.md | 2 +- .../js-api/functions/isDeclaredInNamespace.md | 6 +- .../js-api/functions/isDeclaredType.md | 2 +- .../js-api/functions/isDeprecated.md | 2 +- .../js-api/functions/isErrorModel.md | 2 +- .../reference/js-api/functions/isErrorType.md | 4 +- .../js-api/functions/isGlobalNamespace.md | 2 +- .../js-api/functions/isImportStatement.md | 2 +- .../js-api/functions/isIntrinsicType.md | 2 +- .../reference/js-api/functions/isKey.md | 2 +- .../reference/js-api/functions/isKeyword.md | 2 +- .../js-api/functions/isListOperation.md | 2 +- .../reference/js-api/functions/isModifier.md | 2 +- .../reference/js-api/functions/isNeverType.md | 4 +- .../reference/js-api/functions/isNullType.md | 4 +- .../reference/js-api/functions/isNumeric.md | 20 ++ .../js-api/functions/isNumericType.md | 2 +- .../js-api/functions/isPathAbsolute.md | 2 +- .../js-api/functions/isProjectedProgram.md | 2 +- .../js-api/functions/isPunctuation.md | 2 +- .../js-api/functions/isRecordModelType.md | 2 +- .../reference/js-api/functions/isSecret.md | 2 +- .../reference/js-api/functions/isService.md | 2 +- .../js-api/functions/isStatementKeyword.md | 2 +- .../js-api/functions/isStdNamespace.md | 2 +- .../js-api/functions/isStringType.md | 2 +- .../js-api/functions/isTemplateDeclaration.md | 2 +- .../isTemplateDeclarationOrInstance.md | 2 +- .../js-api/functions/isTemplateInstance.md | 2 +- .../reference/js-api/functions/isTrivia.md | 2 +- .../reference/js-api/functions/isType.md | 18 ++ .../js-api/functions/isTypeSpecValueTypeOf.md | 4 +- .../js-api/functions/isUnknownType.md | 4 +- .../reference/js-api/functions/isUrl.md | 2 +- .../reference/js-api/functions/isValue.md | 18 ++ .../reference/js-api/functions/isVisible.md | 2 +- .../reference/js-api/functions/isVoidType.md | 4 +- .../reference/js-api/functions/joinPaths.md | 2 +- .../js-api/functions/listOperationsIn.md | 2 +- .../js-api/functions/listServices.md | 2 +- .../js-api/functions/logDiagnostics.md | 2 +- .../js-api/functions/logVerboseTestOutput.md | 2 +- .../mapEventEmitterToNodeListener.md | 2 +- .../js-api/functions/markDeprecated.md | 2 +- .../js-api/functions/navigateProgram.md | 2 +- .../js-api/functions/navigateType.md | 2 +- .../functions/navigateTypesInNamespace.md | 4 +- .../js-api/functions/normalizePath.md | 2 +- .../js-api/functions/normalizeSlashes.md | 2 +- .../js-api/functions/paramMessage.md | 4 +- .../reference/js-api/functions/parse.md | 2 +- .../functions/parseStandaloneTypeReference.md | 2 +- .../js-api/functions/positionInRange.md | 25 ++ .../js-api/functions/projectProgram.md | 2 +- .../js-api/functions/reducePathComponents.md | 2 +- .../removeTrailingDirectorySeparator.md | 2 +- .../js-api/functions/reportDeprecated.md | 2 +- .../functions/resolveCompilerOptions.md | 2 +- .../js-api/functions/resolveEncodedName.md | 4 +- .../functions/resolveLinterDefinition.md | 21 ++ .../js-api/functions/resolveModule.md | 2 +- .../reference/js-api/functions/resolvePath.md | 2 +- .../js-api/functions/resolveUsages.md | 2 +- .../functions/scopeNavigationToNamespace.md | 4 +- .../js-api/functions/setCadlNamespace.md | 2 +- .../js-api/functions/setTypeSpecNamespace.md | 2 +- .../functions/skipContinuousIdentifier.md | 23 ++ .../reference/js-api/functions/skipTrivia.md | 14 +- .../js-api/functions/skipTriviaBackward.md | 25 ++ .../js-api/functions/skipWhiteSpace.md | 2 +- .../functions/stringTemplateToString.md | 16 +- .../js-api/functions/typespecTypeToJson.md | 2 +- .../functions/validateDecoratorNotOnType.md | 2 +- .../functions/validateDecoratorParamCount.md | 2 +- .../functions/validateDecoratorParamType.md | 33 +-- .../functions/validateDecoratorTarget.md | 4 +- .../validateDecoratorTargetIntrinsic.md | 4 +- .../validateDecoratorUniqueOnNode.md | 2 +- .../js-api/functions/visitChildren.md | 2 +- .../functions/walkPropertiesInherited.md | 2 +- .../reference/js-api/index.md | 59 +++- .../js-api/interfaces/AliasStatementNode.md | 7 +- .../js-api/interfaces/AnyKeywordNode.md | 6 +- .../js-api/interfaces/ArrayExpressionNode.md | 6 +- .../js-api/interfaces/ArrayLiteralNode.md | 22 ++ .../js-api/interfaces/ArrayModelType.md | 47 ++-- .../reference/js-api/interfaces/ArrayValue.md | 18 ++ .../AugmentDecoratorStatementNode.md | 6 +- .../reference/js-api/interfaces/BaseNode.md | 100 ++++++- .../reference/js-api/interfaces/BaseType.md | 22 +- .../js-api/interfaces/BlockComment.md | 4 +- .../js-api/interfaces/BooleanLiteral.md | 21 +- .../js-api/interfaces/BooleanLiteralNode.md | 6 +- .../js-api/interfaces/BooleanValue.md | 18 ++ .../js-api/interfaces/CallExpressionNode.md | 23 ++ .../js-api/interfaces/CallableMessage.md | 2 +- .../reference/js-api/interfaces/Checker.md | 45 +-- .../js-api/interfaces/CompilerHost.md | 13 +- .../interfaces/CompilerLocationContext.md | 6 +- .../js-api/interfaces/CompilerOptions.md | 10 +- .../js-api/interfaces/ConstStatementNode.md | 24 ++ .../js-api/interfaces/DeclarationNode.md | 1 + .../reference/js-api/interfaces/Decorator.md | 29 +- .../js-api/interfaces/DecoratorArgument.md | 4 +- .../js-api/interfaces/DecoratorContext.md | 4 +- .../DecoratorDeclarationStatementNode.md | 6 +- .../js-api/interfaces/DecoratorDefinition.md | 8 +- .../interfaces/DecoratorExpressionNode.md | 6 +- .../interfaces/DecoratorParamDefinition.md | 2 +- .../js-api/interfaces/DecoratorValidator.md | 6 +- .../js-api/interfaces/DiagnosticCreator.md | 10 +- .../js-api/interfaces/DiagnosticDefinition.md | 2 +- .../interfaces/DirectiveExpressionNode.md | 6 +- .../js-api/interfaces/Discriminator.md | 6 +- .../reference/js-api/interfaces/DocData.md | 11 - .../js-api/interfaces/DocErrorsTagNode.md | 6 +- .../reference/js-api/interfaces/DocNode.md | 6 +- .../js-api/interfaces/DocParamTagNode.md | 6 +- .../js-api/interfaces/DocPropTagNode.md | 24 ++ .../js-api/interfaces/DocReturnsTagNode.md | 6 +- .../js-api/interfaces/DocTagBaseNode.md | 15 +- .../js-api/interfaces/DocTemplateTagNode.md | 6 +- .../js-api/interfaces/DocTextNode.md | 6 +- .../js-api/interfaces/DocUnknownTagNode.md | 6 +- .../js-api/interfaces/EmitContext.md | 2 +- .../js-api/interfaces/EmptyStatementNode.md | 6 +- .../reference/js-api/interfaces/Enum.md | 27 +- .../reference/js-api/interfaces/EnumMember.md | 29 +- .../js-api/interfaces/EnumMemberNode.md | 6 +- .../js-api/interfaces/EnumSpreadMemberNode.md | 6 +- .../js-api/interfaces/EnumStatementNode.md | 6 +- .../reference/js-api/interfaces/EnumValue.md | 17 ++ .../reference/js-api/interfaces/ErrorType.md | 21 +- .../js-api/interfaces/ExternKeywordNode.md | 6 +- .../js-api/interfaces/FileLibraryMetadata.md | 2 +- .../FunctionDeclarationStatementNode.md | 6 +- .../js-api/interfaces/FunctionParameter.md | 58 ---- .../interfaces/FunctionParameterBase.md | 63 +++++ .../interfaces/FunctionParameterNode.md | 6 +- .../js-api/interfaces/FunctionType.md | 29 +- .../js-api/interfaces/IdentifierNode.md | 6 +- .../js-api/interfaces/ImportStatementNode.md | 6 +- .../js-api/interfaces/IndeterminateEntity.md | 13 + .../reference/js-api/interfaces/Interface.md | 35 +-- .../interfaces/InterfaceStatementNode.md | 8 +- .../interfaces/IntersectionExpressionNode.md | 6 +- .../js-api/interfaces/IntrinsicType.md | 29 +- .../js-api/interfaces/InvalidStatementNode.md | 6 +- .../interfaces/JsNamespaceDeclarationNode.md | 6 +- .../js-api/interfaces/JsSourceFileNode.md | 6 +- .../js-api/interfaces/LibraryInstance.md | 2 +- .../interfaces/LibraryLocationContext.md | 9 +- .../js-api/interfaces/LineAndCharacter.md | 2 +- .../js-api/interfaces/LineComment.md | 4 +- .../interfaces/LinterResolvedDefinition.md | 11 + .../reference/js-api/interfaces/LinterRule.md | 4 +- .../js-api/interfaces/LinterRuleContext.md | 4 +- .../js-api/interfaces/LinterRuleDefinition.md | 4 +- .../js-api/interfaces/LinterRuleSet.md | 6 +- .../js-api/interfaces/ListOperationOptions.md | 2 +- .../js-api/interfaces/MemberExpressionNode.md | 6 +- .../interfaces/MixedFunctionParameter.md | 62 +++++ .../interfaces/MixedParameterConstraint.md | 13 + .../reference/js-api/interfaces/Model.md | 48 ++-- .../js-api/interfaces/ModelExpressionNode.md | 7 +- .../js-api/interfaces/ModelProperty.md | 34 +-- .../js-api/interfaces/ModelPropertyNode.md | 6 +- .../interfaces/ModelSpreadPropertyNode.md | 6 +- .../js-api/interfaces/ModelStatementNode.md | 8 +- .../interfaces/ModuleLibraryMetadata.md | 16 +- .../reference/js-api/interfaces/Namespace.md | 43 +-- .../interfaces/NamespaceNavigationOptions.md | 2 +- .../interfaces/NamespaceStatementNode.md | 6 +- .../js-api/interfaces/NeverKeywordNode.md | 6 +- .../reference/js-api/interfaces/NeverType.md | 21 +- .../js-api/interfaces/NodePackage.md | 2 +- .../reference/js-api/interfaces/NullType.md | 21 +- .../reference/js-api/interfaces/NullValue.md | 17 ++ .../reference/js-api/interfaces/Numeric.md | 140 ++++++++++ .../js-api/interfaces/NumericLiteral.md | 24 +- .../js-api/interfaces/NumericLiteralNode.md | 6 +- .../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 | 21 +- .../js-api/interfaces/ObjectValue.md | 18 ++ .../ObjectValuePropertyDescriptor.md | 12 + .../reference/js-api/interfaces/Operation.md | 39 +-- .../OperationSignatureDeclarationNode.md | 6 +- .../OperationSignatureReferenceNode.md | 6 +- .../interfaces/OperationStatementNode.md | 7 +- .../js-api/interfaces/PackageFlags.md | 10 + .../js-api/interfaces/PositionDetail.md | 21 ++ .../interfaces/ProjectLocationContext.md | 7 +- .../js-api/interfaces/ProjectedNameView.md | 2 +- .../reference/js-api/interfaces/Projection.md | 23 +- .../ProjectionArithmeticExpressionNode.md | 8 +- .../ProjectionBlockExpressionNode.md | 6 +- .../ProjectionCallExpressionNode.md | 6 +- ...jectionDecoratorReferenceExpressionNode.md | 6 +- .../ProjectionEnumMemberSelectorNode.md | 6 +- .../interfaces/ProjectionEnumSelectorNode.md | 6 +- .../ProjectionEqualityExpressionNode.md | 6 +- .../ProjectionExpressionStatementNode.md | 6 +- .../interfaces/ProjectionIfExpressionNode.md | 6 +- .../ProjectionInterfaceSelectorNode.md | 6 +- .../ProjectionLambdaExpressionNode.md | 6 +- ...rojectionLambdaParameterDeclarationNode.md | 6 +- .../ProjectionLogicalExpressionNode.md | 8 +- .../ProjectionMemberExpressionNode.md | 6 +- .../ProjectionModelExpressionNode.md | 6 +- .../interfaces/ProjectionModelPropertyNode.md | 6 +- .../ProjectionModelPropertySelectorNode.md | 6 +- .../interfaces/ProjectionModelSelectorNode.md | 6 +- .../ProjectionModelSpreadPropertyNode.md | 6 +- .../js-api/interfaces/ProjectionNode.md | 6 +- .../ProjectionOperationSelectorNode.md | 6 +- .../ProjectionParameterDeclarationNode.md | 6 +- .../interfaces/ProjectionReferenceNode.md | 6 +- .../ProjectionRelationalExpressionNode.md | 6 +- .../ProjectionScalarSelectorNode.md | 6 +- .../interfaces/ProjectionStatementNode.md | 6 +- .../ProjectionTupleExpressionNode.md | 6 +- .../ProjectionUnaryExpressionNode.md | 6 +- .../interfaces/ProjectionUnionSelectorNode.md | 6 +- .../ProjectionUnionVariantSelectorNode.md | 6 +- .../reference/js-api/interfaces/Projector.md | 6 +- .../js-api/interfaces/RecordModelType.md | 47 ++-- .../interfaces/ReplaceTextCodeFixEdit.md | 4 +- .../js-api/interfaces/ResolveModuleHost.md | 13 +- .../js-api/interfaces/ResolveModuleOptions.md | 4 +- .../js-api/interfaces/ReturnExpressionNode.md | 6 +- .../reference/js-api/interfaces/RmOptions.md | 2 +- .../reference/js-api/interfaces/Scalar.md | 36 +-- .../js-api/interfaces/ScalarConstructor.md | 58 ++++ .../interfaces/ScalarConstructorNode.md | 23 ++ .../js-api/interfaces/ScalarStatementNode.md | 9 +- .../js-api/interfaces/ScalarValue.md | 20 ++ .../reference/js-api/interfaces/Server.md | 7 +- .../reference/js-api/interfaces/ServerHost.md | 2 +- .../reference/js-api/interfaces/ServerLog.md | 12 + .../js-api/interfaces/ServerSourceFile.md | 2 +- .../interfaces/ServerWorkspaceFolder.md | 2 +- .../reference/js-api/interfaces/Service.md | 2 +- .../js-api/interfaces/ServiceDetails.md | 2 +- .../interfaces/SignatureFunctionParameter.md | 62 +++++ .../reference/js-api/interfaces/SourceFile.md | 2 +- .../js-api/interfaces/SourceLocation.md | 4 +- .../interfaces/SourceLocationOptions.md | 2 +- .../js-api/interfaces/SourceModel.md | 2 +- .../js-api/interfaces/StringLiteral.md | 21 +- .../js-api/interfaces/StringLiteralNode.md | 6 +- .../js-api/interfaces/StringTemplate.md | 22 +- .../StringTemplateExpressionNode.md | 6 +- .../interfaces/StringTemplateHeadNode.md | 6 +- .../StringTemplateLiteralLikeNode.md | 12 +- .../interfaces/StringTemplateMiddleNode.md | 6 +- .../interfaces/StringTemplateSpanLiteral.md | 23 +- .../interfaces/StringTemplateSpanNode.md | 6 +- .../interfaces/StringTemplateSpanValue.md | 23 +- .../interfaces/StringTemplateTailNode.md | 6 +- .../js-api/interfaces/StringValue.md | 18 ++ .../reference/js-api/interfaces/Sym.md | 6 +- .../js-api/interfaces/SymbolLinks.md | 11 +- .../interfaces/SyntheticLocationContext.md | 6 +- .../js-api/interfaces/TemplateArgumentNode.md | 6 +- .../interfaces/TemplateDeclarationNode.md | 1 + .../js-api/interfaces/TemplateParameter.md | 23 +- .../TemplateParameterDeclarationNode.md | 6 +- .../js-api/interfaces/TemplatedTypeBase.md | 2 +- .../reference/js-api/interfaces/TextRange.md | 4 +- .../reference/js-api/interfaces/Tuple.md | 21 +- .../js-api/interfaces/TupleExpressionNode.md | 6 +- .../js-api/interfaces/TypeInstantiationMap.md | 4 +- .../reference/js-api/interfaces/TypeMapper.md | 6 +- .../js-api/interfaces/TypeOfExpressionNode.md | 22 ++ .../js-api/interfaces/TypeReferenceNode.md | 6 +- .../js-api/interfaces/TypeSpecLibrary.md | 20 +- .../js-api/interfaces/TypeSpecLibraryDef.md | 12 +- .../js-api/interfaces/TypeSpecScriptNode.md | 6 +- .../reference/js-api/interfaces/Union.md | 9 +- .../js-api/interfaces/UnionExpressionNode.md | 6 +- .../js-api/interfaces/UnionStatementNode.md | 7 +- .../js-api/interfaces/UnionVariant.md | 27 +- .../js-api/interfaces/UnionVariantNode.md | 6 +- .../js-api/interfaces/UnknownType.md | 21 +- .../js-api/interfaces/UsingStatementNode.md | 6 +- .../interfaces/ValueOfExpressionNode.md | 6 +- .../reference/js-api/interfaces/ValueType.md | 11 - .../js-api/interfaces/VoidKeywordNode.md | 6 +- .../reference/js-api/interfaces/VoidType.md | 21 +- .../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/MemberContainerNode.md | 3 +- .../type-aliases/MemberContainerType.md | 7 +- .../js-api/type-aliases/MemberNode.md | 7 +- .../js-api/type-aliases/MemberType.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 +- 885 files changed, 4900 insertions(+), 2889 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/{libraries/http/reference/js-api/functions/$plainData.md => emitters/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 create mode 100644 packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isOneOf.md create mode 100644 packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/variables/$flags.md create mode 100644 packages/website/versioned_docs/version-latest/language-basics/values.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$multipartBody.md 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 create mode 100644 packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeRequired.md 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 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/Numeric.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createStateAccessors.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/explainStringTemplateNotSerializable.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocDataInternal.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/getMaxItemsAsNumeric.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/getMaxValueAsNumeric.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/getMinItemsAsNumeric.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/getMinValueAsNumeric.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/getNodeAtPositionDetail.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/isType.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/positionInRange.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/skipContinuousIdentifier.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/interfaces/ArrayLiteralNode.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/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/ConstStatementNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocData.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocPropTagNode.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumValue.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameter.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterBase.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/LinterResolvedDefinition.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/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/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/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/PackageFlags.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/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/ScalarValue.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/SignatureFunctionParameter.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/TypeOfExpressionNode.md delete mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueType.md create mode 100644 packages/website/versioned_docs/version-latest/standard-library/reference/js-api/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 993f754828..0000000000 --- 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 6318a4f984..0000000000 --- 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 3202e2fa00..0000000000 --- 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 adf6fea556..0000000000 --- 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 f61b9d697a..0000000000 --- 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 f6d9cd81b0..0000000000 --- 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 28b7152d03..0000000000 --- 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 a5d6e21a81..0000000000 --- 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 836c4235ec..0000000000 --- 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 cfd31b34e2..0000000000 --- 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 0ef637f7db..0000000000 --- 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 e84b41362f..0000000000 --- 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 cc0ab5bb76..0000000000 --- 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 de3f507c16..0000000000 --- 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 46b8e211dd..0000000000 --- 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 966b10a2b4..0000000000 --- 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 60dd5fe793..0000000000 --- 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 3a6f6da209..0000000000 --- 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 83844db17a..0000000000 --- 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 9855fea9fe..0000000000 --- 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 25e9849327..0000000000 --- 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 7bf3571b2f..0000000000 --- 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 ebd01a696e..0000000000 --- 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 947d8feafe..0000000000 --- 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 fadfbea1df..0000000000 --- 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 d09e88744c..0000000000 --- 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 079e0b9a3e..0000000000 --- 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 c4463be4fc..0000000000 --- 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 f441bba5f0..0000000000 --- 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 ae822a0e92..0000000000 --- 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 a821497cbd..0000000000 --- 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 f1073d0f71..0000000000 --- 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 0fb6b39703..0000000000 --- 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 4dbc7ded84..0000000000 --- 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 1a0bbbba55..0000000000 --- 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 0eca1a03ff..0000000000 --- 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 b762765d84..0000000000 --- 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 91eaf6abf3..0000000000 --- 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 6b38355bc0..0000000000 --- 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 e3c10d8967..0000000000 --- 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 878d132894..0000000000 --- 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 d9fcbef162..0000000000 --- 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 ef96db35ae..0000000000 --- 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 caeaa4c2d7..0000000000 --- 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 5448e32ca5..0000000000 --- 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 ceea70622e..0000000000 --- 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 e5fa0ec174..0000000000 --- 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 4098e34757..0000000000 --- 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 35f044cca0..0000000000 --- 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 a98460705d..0000000000 --- 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 ee722d7e95..0000000000 --- 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 31f06a636a..0000000000 --- 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 f03da4dbcc..0000000000 --- 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 9db9dd493e..0000000000 --- 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 9677616fb0..0000000000 --- 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 0d90d57b86..0000000000 --- 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 1b66d63ed6..0000000000 --- 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 bad367a8f9..0000000000 --- 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 447dd7970a..0000000000 --- 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 bd60b19089..0000000000 --- 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 1ada4809f3..0000000000 --- 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 a5d7a26cec..0000000000 --- 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 224a3e5499..d98cc3df62 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 585feaa932..2882199a11 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 4c6cd01c3a..ae3b417513 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 4435723f60..06d7bf203a 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/compiler/templates/scaffolding.json b/packages/compiler/templates/scaffolding.json index 3c277e14fa..869a016ad2 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": [ { diff --git a/packages/eslint-plugin-typespec/CHANGELOG.md b/packages/eslint-plugin-typespec/CHANGELOG.md index 0724012f37..4a10be0b26 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 a8a50edc32..9c7b55a964 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 2c4209915b..a5aca219d9 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 1919de6978..6d17c44920 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 960139e7f0..0aacae8bb8 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 18a1138d12..088fcefcbe 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 61f39a556b..dc426171af 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 24e211921b..21b942d33f 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 4257dc4cbd..25c57cf69e 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 688bd2e94e..85b96e40fa 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 b7b9aa3c38..f7cd7fa796 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 c7647c34eb..32471e0fec 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 4f571b03c8..be8d63cbd9 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 05bc0035fc..1cea77790b 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 7f11a5d073..3766d08fe7 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 993f709cbb..9b30c996a4 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 954079fd49..486437fba4 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 1e983f5b91..889942f631 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 f79328c452..0df35dd7e4 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 21592fd84e..3838f808f7 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 000dd63c33..9f9254fb76 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 bd697a683f..2fba9d6d59 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 875ee27ce7..5b16c1a970 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 67eb918ee9..4e0e1cebfc 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 e7315a6736..54a484f0be 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 a72b2c3156..fa6f06dce7 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 f86f34e477..6b9c0020ad 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 dad8d1449b..6a9aee0018 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 a83e84ea3b..0bc3d1ebec 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 a41267c370..3a8239ebbb 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 7474646caf..c65654fb78 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 9592c5e1c7..383b15f48b 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 2c0d89df86..82e9bb7985 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 0000000000..6636c477a5 --- /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 a61dd90562..e8445e5ad4 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 bbc10f06d4..ce0f343fb0 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 9dd44e51bf..31162e03e6 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 119e6ad700..8f234ca491 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 d006f08dac..d5484c1860 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 899fe9e016..4d0b4ec558 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 8b0e86d5c1..75398e2f1b 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 d22ee477e1..0eda2dfb77 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 b281f98f46..81a4882c38 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 c649d21172..7703e347ba 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 7f06cffe04..a5ae169a38 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 112a0a5ac5..9a4708a79e 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 ad32709727..6c56d5a714 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 44074e3dce..169a7b9f65 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 4344763934..9be6c745af 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 11fad245a7..4270c0306e 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 34fd56356c..c46bfb3a8b 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/libraries/http/reference/js-api/functions/$plainData.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/libraries/http/reference/js-api/functions/$plainData.md rename to packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/$oneOf.md index d340a798ad..832826d15b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$plainData.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] $plainData" +title: "[F] $oneOf" --- ```ts -$plainData(context, target): void +function $oneOf(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $plainData(context, target): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` | +| `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 5242fd4c67..515d72544c 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 20481689b1..5ab84ce2aa 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 3ab8854606..5fc01f0237 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 2874a653dd..28feb6c135 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 c94f662005..f074f6cd82 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 b0da5ad87f..181cc36057 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 daaac1ade3..28386f05ae 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 a3e3c8a6c0..eb09e51319 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 52c63e3751..dc5caf3438 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 36a2585205..b3839c561a 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 c1a7a41f97..96eb2ddd19 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 d08e1edf47..c55fd50a1f 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 1d0453f616..f0e50e58ef 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 1444d48312..ebdaf96382 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 d00b87352e..ffe2b13e0e 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 84ee972bfd..655d171931 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 6c748548e2..d1503e2cd1 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 1c0a704b15..d71713148b 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 0000000000..5858be8acc --- /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 0e6407ad2f..2255917a92 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 1de081729c..7e635d44b3 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 2b0058ce04..18fdb24b31 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/json-schema/reference/js-api/functions/isOneOf.md b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isOneOf.md new file mode 100644 index 0000000000..5ddb0ed418 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/emitters/json-schema/reference/js-api/functions/isOneOf.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isOneOf" + +--- +```ts +function isOneOf(program, target): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Type` | + +## Returns + +`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 d08bd3368b..bbaab5b47d 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 ebe07c899c..394f0e2a63 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 0000000000..a26ed5d995 --- /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 9a947919d3..7e37857aab 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 1ea0af454d..4a527d7cdf 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 b87337b5f9..832826d15b 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 c68f406008..497a2e7f0e 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 3f4d727042..09cafaf08a 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 df558647f8..ce97cdc22b 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 20ad7ec648..a8d8f611d3 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 c1a2aa96e0..b0c7b783b8 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 5b54375a74..d937506ac8 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,46 @@ 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-model-property` | `object` | ... | +| `invalid-model-property.default` | `CallableMessage`<[`"type"`]\> | ... | +| `invalid-schema` | `object` | ... | +| `invalid-schema.default` | `CallableMessage`<[`"type"`]\> | ... | +| `invalid-server-variable` | `object` | ... | +| `invalid-server-variable.default` | `CallableMessage`<[`"propName"`]\> | ... | +| `oneof-union` | `object` | ... | | `oneof-union.default` | `"@oneOf decorator can only be used on a union or a model property which type is a union."` | "@oneOf decorator can only be used on a union or a model property which type is a union." | -| `path-query` | `Object` | - | -| `path-query.default` | `"OpenAPI does not allow paths containing a query string."` | - | -| `resource-namespace` | `Object` | - | +| `path-query` | `object` | ... | +| `path-query.default` | `"OpenAPI does not allow paths containing a query string."` | ... | +| `resource-namespace` | `object` | ... | | `resource-namespace.default` | `"Resource goes on namespace"` | "Resource goes on namespace" | -| `status-code-in-default-response` | `Object` | - | +| `status-code-in-default-response` | `object` | ... | | `status-code-in-default-response.default` | `"a default response should not have an explicit status code"` | "a default response should not have an explicit status code" | -| `union-null` | `Object` | - | +| `union-null` | `object` | ... | | `union-null.default` | `"Cannot have a union containing only null types."` | "Cannot have a union containing only null types." | -| `unsupported-auth` | `Object` | - | -| `unsupported-auth.default` | `CallableMessage`<[`"authType"`]\> | - | -| `unsupported-status-code-range` | `Object` | - | -| `unsupported-status-code-range.default` | `CallableMessage`<[`"start"`, `"end"`]\> | - | +| `unsupported-auth` | `object` | ... | +| `unsupported-auth.default` | `CallableMessage`<[`"authType"`]\> | ... | +| `unsupported-status-code-range` | `object` | ... | +| `unsupported-status-code-range.default` | `CallableMessage`<[`"start"`, `"end"`]\> | ... | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md index ec81e55e26..1f986a6d7b 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$externRef.md @@ -4,7 +4,7 @@ title: "[F] $externRef" --- ```ts -$externRef( +function $externRef( ctx, target, path, diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md index c12164c1c3..126640d9cd 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$field.md @@ -4,7 +4,7 @@ title: "[F] $field" --- ```ts -$field( +function $field( context, target, index): 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 index bdd2d0b130..ec6b2c1dc4 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$message.md @@ -4,7 +4,7 @@ title: "[F] $message" --- ```ts -$message(context, target): void +function $message(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md index e8aecc7c09..fe68dd6fb3 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onEmit.md @@ -4,7 +4,7 @@ title: "[F] $onEmit" --- ```ts -$onEmit(ctx): Promise +function $onEmit(ctx): Promise ``` Emitter main function. diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md index 54dfb22502..dcb2887474 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$onValidate.md @@ -4,7 +4,7 @@ title: "[F] $onValidate" --- ```ts -$onValidate(program): Promise +function $onValidate(program): Promise ``` Validation function diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md index e5106863b5..58b621f3ab 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$package.md @@ -4,7 +4,7 @@ title: "[F] $package" --- ```ts -$package( +function $package( context, target, details?): 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 index c16acc6e4c..7f2f638014 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$reserve.md @@ -4,7 +4,7 @@ title: "[F] $reserve" --- ```ts -$reserve( +function $reserve( context, target, ... reservations): 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 index 3f35f2324f..1cf0977d94 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$service.md @@ -4,7 +4,7 @@ title: "[F] $service" --- ```ts -$service(ctx, target): void +function $service(ctx, target): void ``` Decorate an interface as a service, indicating that it represents a Protobuf `service` declaration. diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md index 4f82a6343b..c5f5b6d0e1 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/$stream.md @@ -4,7 +4,7 @@ title: "[F] $stream" --- ```ts -$stream( +function $stream( context, target, mode): 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 index 6708926d07..0cc9368604 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/functions/isMap.md @@ -4,7 +4,7 @@ title: "[F] isMap" --- ```ts -isMap(program, m): boolean +function isMap(program, m): boolean ``` Determines whether a type represents a Protobuf map. 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 6fafc3e0f6..22298fc322 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 5728b943f6..b94a11578d 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 43dd276bb5..99c17b6e90 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 6928722ab7..af1c749488 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 717c917f1e..c4d5275e01 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 d5dd81272a..c546c7933d 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 dc8a64dda4..aa57714ad5 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 78a5009c8e..13b295ece8 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 5868f8b554..857b93de8d 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 0000000000..4bed4774f0 --- /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 109a8f8373..dc8106701e 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 2996c91707..26c688c55b 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 ec9a88f52e..d85da81df6 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 09a0ca4236..e5182c6965 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 85ed387308..5cc14bfaf2 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 2260d9400e..9f293d4439 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 4910da0e7b..5529cd6c70 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 b498c22bd3..b00afa63ef 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 480aa9ffb0..5f3bb18308 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 84b422f952..5fd1aad519 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 61cbd7196e..dffade5123 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 312198ac00..b84ebd405d 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/$multipartBody.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$multipartBody.md new file mode 100644 index 0000000000..88463e2fb4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$multipartBody.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] $multipartBody" + +--- +```ts +function $multipartBody(context, target): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `ModelProperty` | + +## Returns + +`void` 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 212e92eb72..3b2236c14a 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 f975792dfc..ef801972ff 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 9574f3a3b8..49c40f1c84 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 b0fc15a8a9..9e697c030e 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 445052ac48..066c404e69 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 89857025ac..17707f346a 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 283b04bedb..b0070ad783 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 d2987164ab..c20e7d244e 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 5543b78ade..01bdd2f12a 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 3b421164c6..5dd150fc08 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 faee9533ac..1a26fa6941 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 32fcf1d6bc..7a57cd6864 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 1bb3fd0352..f9336794a9 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 65c998621c..0000000000 --- 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 4a76f1e34e..63be58d9bf 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 e575a001ab..813c4cf387 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 eea872b4c7..252ed715bc 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 f6d9df27b2..23a521e01d 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 8926f02618..7899a7315f 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 5096ca42e6..a6b583974d 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 f9674d89d4..9e85658f16 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 0000000000..7749f79421 --- /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 952150aa66..d54ac7b376 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 30d4dc0bed..7e4e9d2305 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 1106400bcb..67dafeed64 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 c1232d91b1..5b85538de6 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 947c88dedf..f39230064e 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 4b7fb1bf4a..872a2f4a5e 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 da9c1758b2..4dfd6c0c60 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 ad13ac707b..4015e2f4e7 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 2854af3100..6ac6925876 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 a2b10e35ae..ba6bc612f2 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 f1beff5fdd..33550417e5 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 d883ef3f0d..5f4acf70fb 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 8c122a8a2b..bddacdbe60 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 4db6a74299..3cf3691556 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 87683cddad..674d4f91d5 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 58bcbc0ce3..79d891474b 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 945bb11a4f..0a617dac42 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 dd86ca4815..45f9c8f235 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 293ee6ea1e..81697379ba 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 a560921e4a..034fd5c2b9 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 76e954e79d..a870973c55 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 59755082c6..6f0fe6f87a 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 5507e46ac0..59284ca313 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 b0b5551c10..8a9963d8ac 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 66394bdd05..5497d28d66 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 9eb585e9b3..04f2847e93 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 12866ccaca..6d083e7449 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 180463b276..5fb912b515 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 ee8b7f7952..81e82a2bc3 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 0000000000..f148eda70f --- /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 0000000000..9151de70f2 --- /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 0381f238e8..d02d3a1935 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 234c9d49c1..92a47e6471 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 ce13bfe40f..5bee8b6339 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 20dcc9fea4..1865ac3f83 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 8242346511..edb677d4d6 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 17710f5cd9..aa384d141d 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 39c7e922c4..63199fd046 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 701efb6b9d..eb6cde3d87 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 e465100e08..a7954f0b5e 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 03aaccd285..a7b88a653b 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 c563153d8f..85e91784b8 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 9dea86ba50..23ee0309da 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 3575f13220..389bd1023b 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 ef381fba55..5bfef1b037 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 44395324db..7373fc77a0 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 5a17f9bf5e..2ac77c5c57 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 47ddd91520..71f2022f01 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 8cd61c1c45..fb476a5724 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 f543db785e..71a5e1c5ff 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 b77cc1e039..a96c2194b9 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 eeec02b3a3..a23c30934c 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 91f717d48e..707dea0e82 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 0000000000..3df97b4d79 --- /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 8af6a3298d..6939ee16fe 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 0000000000..4152b3a2bd --- /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 0000000000..ff2b285172 --- /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 8c37fd9ae1..0657abe957 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 0000000000..60d123b088 --- /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 6523a4bafa..0000000000 --- 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 45424a8bdf..6faa833617 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 a72c350b0c..0000000000 --- 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 f995cae603..6dca384fae 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 8b67cbc04a..f18e068ff2 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 3411254954..4d1a9ccff5 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 af9e8e1847..e04f59ad4b 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 465ee8eaa9..a6ddd6a50b 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 7011486bd8..c930504ce9 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 0000000000..d925600b8d --- /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 0000000000..1038db998b --- /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 a51f7c07c0..e0c54e2dd8 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 58ef9ddd5a..4df8cc4309 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 25ab4a45bf..607f358e23 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 b281f98f46..81a4882c38 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 9a4485710d..18aa614f9c 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 9dc9803a1a..277f3a2840 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 9528a9facf..119a1bad84 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 596a03e178..2561829ddc 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 dbf5babdaf..426578b922 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 855a1c9e64..5d139f3641 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 866f66b07f..c27c2a6fef 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 f1b32896d4..b96e2f6566 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 f6150de6c4..8bce13c2c1 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 5faa50ede4..980d31ecbf 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 0e1a024b76..07b1d1dfd9 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 6594fe9490..87c5bb38a9 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 6157a66c9f..cbb22b903a 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 7c61cc8101..9c5448c758 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 09c73e9128..5f7555006c 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 539e51977b..5de3331ed2 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 e5249ff81c..7f133f3b1c 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 7c45e08a5c..e48f794084 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 7b2a7c302e..26e065cabc 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 595b0ae5a7..62f3ac76ce 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 7c97e67eee..b25c7c9cf3 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 59d491664f..6630aed584 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 44fbf81ad7..0261fa666e 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 fe8d8b459f..be060b775b 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 a8403a7f8c..404cf69e4e 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 10f11b1015..00fe8180a2 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 2fe790c329..841aecd33c 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 ebf860a285..7500bf938f 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 212e92eb72..3b2236c14a 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 b8990d5102..720a810623 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 3c1424f9c0..406230d993 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 4f2bb0e812..71d5fe42d4 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 350044c631..27357d8c45 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 2c47b2f263..6d1138c2e4 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 1dcc213df9..3bd75f9820 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 b90d9f5803..734909cfb7 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 22655150ed..c9fcee81de 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 ff9533a06f..cadb42849c 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 2061cae006..f721124e4f 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 4a67666f95..11193928be 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 ad10e29315..c86a7e6eed 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 d1641f55e9..e8187b8be8 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 d0d4616f7e..c1e40bbdb9 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 035bf89e60..d930349aa2 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 ef5607dd0c..0b26ef5e89 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 38e8f197c3..18415e1534 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 916fa74d2a..f5cca459f3 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 6b3ac20de6..be6bf69f79 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 4b391cbea4..eef7dc41e9 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 a2e3f25b11..7fbc1ab5f9 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 0ace542980..c2e263c495 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 74831209bc..1f46905c31 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 511fa16af9..ef9ae9dc67 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 449ba33cf4..906b7fb444 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 08da695b58..42a25fac7c 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 c5bc25693d..1a9826b034 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 9285f4264a..bcc25aab45 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 07fd15966f..bcd6aaa86b 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 2513a9314e..52adced9d8 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/libraries/versioning/reference/js-api/functions/$madeRequired.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeRequired.md new file mode 100644 index 0000000000..5e8a23f056 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeRequired.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $madeRequired" + +--- +```ts +function $madeRequired( + context, + target, + version): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `ModelProperty` | +| `version` | `EnumMember` | + +## Returns + +`void` 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 212e92eb72..3b2236c14a 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 29716f7d5c..eb79ad607a 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 b5f13c5052..2556f27490 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 4be50ea782..714fd6f192 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 961a253b18..6683edc991 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 b49fdc61e5..be43d9ae5b 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 e3bab32690..5d20fc5c54 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 0cebfc653c..5e9f8ca7d3 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 0859befce5..0000000000 --- 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 5e282acbda..d59bc47cb7 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 1850c0e9b1..c22f7e763c 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 f39c2e9e39..9152ffc346 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 dfd9932bcc..21b0922179 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 f2f1758a10..4155da45d7 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 7152651a3c..0000000000 --- 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 2710d05daf..48b0d50564 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 281d453204..35c1f947ac 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 7271627b65..648245770e 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 4dd8f4ac80..0000000000 --- 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 fcfe8651a2..0b61ca1cf1 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 9577e38be6..0000000000 --- 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 cfc7770ff3..fd20cc21af 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 91e38014de..6a7748063c 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 5e41facaf2..19c4115fe8 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 d634787c13..13c387f598 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 5766333d94..34759d0bed 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 16ff101189..ab2ccab6ca 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 75d0c4198a..159ee0442c 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 f10a2a5940..0000000000 --- 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 9f3c307f8b..0000000000 --- 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 56b9d0e896..0000000000 --- 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 517dd64bf3..1f3d2eafb1 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 411294a3cb..df1952959e 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 9c54508ab3..0000000000 --- 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 0f384c07cb..d1917fce4d 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 eec07dbbbf..af08cdeb19 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 1004aa3aec..43b53c8907 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 8fdcdd8e77..bc571ef2a1 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 cfae36e7ce..cf1811e6fd 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 f905329db2..5fcbb72e68 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 a06ac7f745..2c9a6fc088 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 bdc160dc16..8a3917b0f0 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 8bd7968a00..38f4bf62db 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 38981cfabd..068043f60b 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 6e1d98b877..0ff2d18616 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 0000000000..5e37300aee --- /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 719158cd91..d058b9dbe9 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 fe3cf11a22..86336bf0c3 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 index 6ab8c2f50e..1307f1548f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md @@ -26,9 +26,9 @@ new DuplicateTracker(): DuplicateTracker ## Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `#entries` | `private` | `Map`<`K`, `V`[]\> | +| Property | Modifier | Type | Default value | +| :------ | :------ | :------ | :------ | +| `#entries` | `private` | `Map`<`K`, `V`[]\> | `...` | ## Methods diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md index b98d920c44..3880063082 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/EventEmitter.md @@ -7,7 +7,7 @@ title: "[C] EventEmitter" | Type parameter | | :------ | -| `T` extends `Object` | +| `T` *extends* `object` | ## Constructors @@ -23,9 +23,9 @@ new EventEmitter(): EventEmitter ## Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `listeners` | `private` | `Map` `any`[]\> | +| Property | Modifier | Type | Default value | +| :------ | :------ | :------ | :------ | +| `listeners` | `private` | `Map` `any`[]\> | `...` | ## Methods @@ -39,7 +39,7 @@ emit(name, ...args): void | Type parameter | | :------ | -| `K` extends `string` \| `number` \| `symbol` | +| `K` *extends* `string` \| `number` \| `symbol` | #### Parameters @@ -64,7 +64,7 @@ on(name, listener): void | Type parameter | | :------ | -| `K` extends `string` \| `number` \| `symbol` | +| `K` *extends* `string` \| `number` \| `symbol` | #### Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md index d4ff2cb67d..a90ce7a8bd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ProjectionError.md @@ -11,7 +11,7 @@ Represents a failure while interpreting a projection. ## Constructors -### new ProjectionError(message) +### new ProjectionError() ```ts new ProjectionError(message): ProjectionError @@ -39,7 +39,7 @@ new ProjectionError(message): ProjectionError | `message` | `public` | `string` | - | `Error.message` | | `name` | `public` | `string` | - | `Error.name` | | `stack?` | `public` | `string` | - | `Error.stack` | -| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces

**See**
https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` |

Optional override for formatting stack traces

**See**

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

| `Error.prepareStackTrace` | | `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | ## Methods diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md index f308902603..4f22f2b0e9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/Queue.md @@ -11,7 +11,7 @@ title: "[C] Queue" ## Constructors -### new Queue(elements) +### new Queue() ```ts new Queue(elements?): Queue @@ -29,10 +29,10 @@ new Queue(elements?): Queue ## Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `#elements` | `private` | `T`[] | -| `#headIndex` | `private` | `number` | +| Property | Modifier | Type | Default value | +| :------ | :------ | :------ | :------ | +| `#elements` | `private` | `T`[] | `undefined` | +| `#headIndex` | `private` | `number` | `0` | ## Methods diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md index 8e4583342d..535e5d430e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/ResolveModuleError.md @@ -9,7 +9,7 @@ title: "[C] ResolveModuleError" ## Constructors -### new ResolveModuleError(code, message) +### new ResolveModuleError() ```ts new ResolveModuleError(code, message): ResolveModuleError @@ -39,7 +39,7 @@ new ResolveModuleError(code, message): ResolveModuleError | `message` | `public` | `string` | - | `Error.message` | | `name` | `public` | `string` | - | `Error.name` | | `stack?` | `public` | `string` | - | `Error.stack` | -| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces

**See**
https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | +| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` |

Optional override for formatting stack traces

**See**

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

| `Error.prepareStackTrace` | | `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | ## Methods diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md index 535514e33c..f3d2b91ff1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/IdentifierKind.md @@ -10,7 +10,10 @@ title: "[E] IdentifierKind" | `Declaration` | `5` | | `Decorator` | `2` | | `Function` | `3` | -| `Other` | `6` | +| `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/NodeFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md index 5200f7e519..f691f8e9eb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/NodeFlags.md @@ -7,8 +7,8 @@ title: "[E] NodeFlags" | Enumeration Member | Value | Description | | :------ | :------ | :------ | -| `DescendantErrorsExamined` | `1` | If this is set, the DescendantHasError bit can be trusted. If this not set,
children need to be visited still to see if DescendantHasError should be
set.

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

Use the parser's `hasParseError` API instead of using this flag directly. | +| `DescendantErrorsExamined` | `1` |

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

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

| +| `DescendantHasError` | `4` |

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

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

| | `None` | `0` | - | | `Synthetic` | `8` | Indicates that a node was created synthetically and therefore may not be parented. | -| `ThisNodeHasError` | `2` | Indicates that a parse error was associated with this specific node.

Use the parser's `hasParseError` API instead of using this flag directly. | +| `ThisNodeHasError` | `2` |

Indicates that a parse error was associated with this specific node.

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

| diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SymbolFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SymbolFlags.md index a121378229..95a9e3e310 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SymbolFlags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SymbolFlags.md @@ -8,6 +8,7 @@ title: "[E] SymbolFlags" | Enumeration Member | Value | Description | | :------ | :------ | :------ | | `Alias` | `2048` | - | +| `Const` | `16777216` | - | | `Declaration` | `4194304` | - | | `Decorator` | `16384` | - | | `DuplicateUsing` | `1048576` | - | @@ -19,9 +20,9 @@ title: "[E] SymbolFlags" | `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) | +| `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` | - | @@ -30,6 +31,7 @@ title: "[E] SymbolFlags" | `Projection` | `8192` | - | | `ProjectionParameter` | `65536` | - | | `Scalar` | `8` | - | +| `ScalarMember` | `33554432` | - | | `SourceFile` | `2097152` | - | | `TemplateParameter` | `32768` | - | | `Union` | `512` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md index 5c660c344f..716e2841e8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md @@ -11,20 +11,24 @@ AST types | :------ | :------ | :------ | | `AliasStatement` | `24` | - | | `ArrayExpression` | `31` | - | +| `ArrayLiteral` | `97` | - | | `AugmentDecoratorStatement` | `4` | - | | `BlockComment` | `51` | - | | `BooleanLiteral` | `34` | - | -| `CadlScript` | `0` | **Deprecated**
Use TypeSpecScript | +| `CadlScript` | `0` |

**Deprecated**

Use TypeSpecScript

| +| `CallExpression` | `99` | - | +| `ConstStatement` | `98` | - | | `DecoratorDeclarationStatement` | `25` | - | | `DecoratorExpression` | `5` | - | | `DirectiveExpression` | `6` | - | | `Doc` | `52` | - | -| `DocErrorsTag` | `56` | - | +| `DocErrorsTag` | `57` | - | | `DocParamTag` | `54` | - | -| `DocReturnsTag` | `55` | - | -| `DocTemplateTag` | `57` | - | +| `DocPropTag` | `55` | - | +| `DocReturnsTag` | `56` | - | +| `DocTemplateTag` | `58` | - | | `DocText` | `53` | - | -| `DocUnknownTag` | `58` | - | +| `DocUnknownTag` | `59` | - | | `EmptyStatement` | `48` | - | | `EnumMember` | `22` | - | | `EnumSpreadMember` | `23` | - | @@ -37,7 +41,7 @@ AST types | `InterfaceStatement` | `18` | - | | `IntersectionExpression` | `29` | - | | `InvalidStatement` | `49` | - | -| `JsNamespaceDeclaration` | `90` | - | +| `JsNamespaceDeclaration` | `91` | - | | `JsSourceFile` | `1` | - | | `LineComment` | `50` | - | | `MemberExpression` | `7` | - | @@ -48,41 +52,45 @@ AST types | `NamespaceStatement` | `8` | - | | `NeverKeyword` | `42` | - | | `NumericLiteral` | `33` | - | +| `ObjectLiteral` | `94` | - | +| `ObjectLiteralProperty` | `95` | - | +| `ObjectLiteralSpreadProperty` | `96` | - | | `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` | - | +| `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` | `77` | - | -| `ProjectionScalarSelector` | `63` | - | -| `ProjectionSpreadProperty` | `85` | - | -| `ProjectionStatement` | `87` | - | -| `ProjectionTupleExpression` | `86` | - | -| `ProjectionUnaryExpression` | `76` | - | -| `ProjectionUnionSelector` | `65` | - | -| `ProjectionUnionVariantSelector` | `66` | - | -| `Return` | `89` | - | +| `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` | - | @@ -90,9 +98,10 @@ AST types | `StringTemplateMiddle` | `37` | - | | `StringTemplateSpan` | `39` | - | | `StringTemplateTail` | `38` | - | -| `TemplateArgument` | `91` | - | +| `TemplateArgument` | `92` | - | | `TemplateParameterDeclaration` | `47` | - | | `TupleExpression` | `30` | - | +| `TypeOfExpression` | `93` | - | | `TypeReference` | `45` | - | | `TypeSpecScript` | `0` | - | | `UnionExpression` | `28` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md index 3aac199292..e57e8cd108 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md @@ -7,13 +7,13 @@ title: "[E] Token" | Enumeration Member | Value | | :------ | :------ | -| `AliasKeyword` | `57` | +| `AliasKeyword` | `59` | | `Ampersand` | `30` | -| `AmpsersandAmpersand` | `45` | +| `AmpsersandAmpersand` | `47` | | `At` | `35` | | `AtAt` | `36` | | `Bar` | `31` | -| `BarBar` | `46` | +| `BarBar` | `48` | | `CloseBrace` | `18` | | `CloseBracket` | `22` | | `CloseParen` | `20` | @@ -21,64 +21,69 @@ title: "[E] Token" | `ColonColon` | `34` | | `Comma` | `26` | | `ConflictMarker` | `13` | -| `DecKeyword` | `64` | +| `ConstKeyword` | `68` | +| `DecKeyword` | `66` | | `DocCodeFenceDelimiter` | `16` | | `DocCodeSpan` | `15` | | `DocText` | `14` | | `Dot` | `23` | | `Ellipsis` | `24` | -| `ElseKeyword` | `62` | +| `ElseKeyword` | `64` | | `EndOfFile` | `2` | -| `EnumKeyword` | `56` | +| `EnumKeyword` | `58` | | `Equals` | `29` | -| `EqualsEquals` | `47` | -| `EqualsGreaterThan` | `49` | -| `Exclamation` | `42` | -| `ExclamationEquals` | `48` | -| `ExtendsKeyword` | `68` | -| `ExternKeyword` | `67` | -| `FalseKeyword` | `70` | -| `FnKeyword` | `65` | -| `ForwardSlash` | `39` | +| `EqualsEquals` | `49` | +| `EqualsGreaterThan` | `51` | +| `Exclamation` | `44` | +| `ExclamationEquals` | `50` | +| `ExtendsKeyword` | `71` | +| `ExternKeyword` | `70` | +| `FalseKeyword` | `73` | +| `FnKeyword` | `67` | +| `ForwardSlash` | `41` | | `GreaterThan` | `28` | -| `GreaterThanEquals` | `44` | +| `GreaterThanEquals` | `46` | | `Hash` | `37` | -| `Hyphen` | `41` | +| `HashBrace` | `38` | +| `HashBracket` | `39` | +| `Hyphen` | `43` | | `Identifier` | `3` | -| `IfKeyword` | `63` | -| `ImportKeyword` | `50` | -| `InterfaceKeyword` | `59` | +| `IfKeyword` | `65` | +| `ImportKeyword` | `52` | +| `InitKeyword` | `69` | +| `InterfaceKeyword` | `61` | | `Invalid` | `1` | -| `IsKeyword` | `58` | +| `IsKeyword` | `60` | | `LessThan` | `27` | -| `LessThanEquals` | `43` | -| `ModelKeyword` | `51` | +| `LessThanEquals` | `45` | +| `ModelKeyword` | `53` | | `MultiLineComment` | `10` | -| `NamespaceKeyword` | `53` | -| `NeverKeyword` | `73` | +| `NamespaceKeyword` | `55` | +| `NeverKeyword` | `76` | | `NewLine` | `11` | | `None` | `0` | | `NumericLiteral` | `4` | -| `OpKeyword` | `55` | +| `OpKeyword` | `57` | | `OpenBrace` | `17` | | `OpenBracket` | `21` | | `OpenParen` | `19` | -| `Plus` | `40` | -| `ProjectionKeyword` | `61` | +| `Plus` | `42` | +| `ProjectionKeyword` | `63` | | `Question` | `32` | -| `ReturnKeyword` | `71` | -| `ScalarKeyword` | `52` | +| `ReturnKeyword` | `74` | +| `ScalarKeyword` | `54` | | `Semicolon` | `25` | | `SingleLineComment` | `9` | -| `Star` | `38` | +| `Star` | `40` | | `StringLiteral` | `5` | | `StringTemplateHead` | `6` | | `StringTemplateMiddle` | `7` | | `StringTemplateTail` | `8` | -| `TrueKeyword` | `69` | -| `UnionKeyword` | `60` | -| `UnknownKeyword` | `74` | -| `UsingKeyword` | `54` | -| `ValueOfKeyword` | `66` | -| `VoidKeyword` | `72` | +| `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/functions/$deprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md index 142a19dead..a725191bfb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$deprecated.md @@ -4,7 +4,7 @@ title: "[F] $deprecated" --- ```ts -$deprecated( +function $deprecated( context, target, message): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md index 730a4d2076..aaab522897 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md @@ -4,7 +4,7 @@ title: "[F] $discriminator" --- ```ts -$discriminator( +function $discriminator( context, target, propertyName): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md index 874967f9e0..0f11022108 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md @@ -4,7 +4,7 @@ title: "[F] $doc" --- ```ts -$doc( +function $doc( context, target, doc, diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md index 733e8d82b0..8756de5726 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md @@ -4,7 +4,7 @@ title: "[F] $encode" --- ```ts -$encode( +function $encode( context, target, encoding, @@ -16,7 +16,7 @@ $encode( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `encoding` | [`Type`](../type-aliases/Type.md) | | `encodedAs`? | [`Scalar`](../interfaces/Scalar.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md index bb851bfdf3..b3fb8d6970 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encodedName.md @@ -4,7 +4,7 @@ title: "[F] $encodedName" --- ```ts -$encodedName( +function $encodedName( context, target, mimeType, diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md index 8a19de4299..a1ebf827de 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md @@ -4,7 +4,7 @@ title: "[F] $error" --- ```ts -$error(context, target): void +function $error(context, target): void ``` `@error` decorator marks a model as an error type. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md index 20301ec58d..1127000903 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md @@ -4,7 +4,7 @@ title: "[F] $errorsDoc" --- ```ts -$errorsDoc( +function $errorsDoc( context, target, doc): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md index a8af2e6751..c08e80927d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md @@ -4,7 +4,7 @@ title: "[F] $format" --- ```ts -$format( +function $format( context, target, format): void @@ -27,7 +27,7 @@ https://github.com/OAI/OpenAPI-Specification/blob/3.0.3/versions/3.0.3.md#dataTy | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `format` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md index 3b8bf8bbb3..76c89ed3a2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md @@ -4,7 +4,7 @@ title: "[F] $friendlyName" --- ```ts -$friendlyName( +function $friendlyName( context, target, name, diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md index 170d63cccd..2b3348e165 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md @@ -4,7 +4,7 @@ title: "[F] $inspectType" --- ```ts -$inspectType( +function $inspectType( context, target, text): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md index 693ab993e3..9065d9e969 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md @@ -4,7 +4,7 @@ title: "[F] $inspectTypeName" --- ```ts -$inspectTypeName( +function $inspectTypeName( context, target, text): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md index 0b1d41e0a6..62aaff926c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md @@ -4,7 +4,7 @@ title: "[F] $key" --- ```ts -$key( +function $key( context, target, altName?): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md index 0e0b47ddaa..ee7f754fc1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md @@ -4,7 +4,7 @@ title: "[F] $knownValues" --- ```ts -$knownValues( +function $knownValues( context, target, knownValues): void @@ -22,7 +22,7 @@ type accepts. | 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) | +| `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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md index 54543b658b..d71be9ead3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md @@ -4,7 +4,7 @@ title: "[F] $list" --- ```ts -$list( +function $list( context, target, listedType?): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md index 72526d8170..266e539dfd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md @@ -4,7 +4,7 @@ title: "[F] $maxItems" --- ```ts -$maxItems( +function $maxItems( context, target, value): void @@ -16,7 +16,7 @@ $maxItems( | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | -| `value` | `number` | +| `value` | [`Numeric`](../interfaces/Numeric.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md index 470d7b8d6c..9b237d7e3d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md @@ -4,7 +4,7 @@ title: "[F] $maxLength" --- ```ts -$maxLength( +function $maxLength( context, target, value): void @@ -15,8 +15,8 @@ $maxLength( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `value` | `number` | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md index a730209897..9d001e6f54 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md @@ -4,7 +4,7 @@ title: "[F] $maxValue" --- ```ts -$maxValue( +function $maxValue( context, target, value): void @@ -15,8 +15,8 @@ $maxValue( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `value` | `number` | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md index c5c6c08499..840786780c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md @@ -4,7 +4,7 @@ title: "[F] $maxValueExclusive" --- ```ts -$maxValueExclusive( +function $maxValueExclusive( context, target, value): void @@ -15,8 +15,8 @@ $maxValueExclusive( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `value` | `number` | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md index 44a0f2e999..ea4a0f8414 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md @@ -4,7 +4,7 @@ title: "[F] $minItems" --- ```ts -$minItems( +function $minItems( context, target, value): void @@ -16,7 +16,7 @@ $minItems( | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | -| `value` | `number` | +| `value` | [`Numeric`](../interfaces/Numeric.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md index 3f2c0e8e95..19353213d3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md @@ -4,7 +4,7 @@ title: "[F] $minLength" --- ```ts -$minLength( +function $minLength( context, target, value): void @@ -15,8 +15,8 @@ $minLength( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `value` | `number` | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md index a02f3cf0cf..c860e955eb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md @@ -4,7 +4,7 @@ title: "[F] $minValue" --- ```ts -$minValue( +function $minValue( context, target, value): void @@ -15,8 +15,8 @@ $minValue( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `value` | `number` | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md index 92b95141ca..6a0945c077 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md @@ -4,7 +4,7 @@ title: "[F] $minValueExclusive" --- ```ts -$minValueExclusive( +function $minValueExclusive( context, target, value): void @@ -15,8 +15,8 @@ $minValueExclusive( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `value` | `number` | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `value` | [`Numeric`](../interfaces/Numeric.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md index 3f936ba8ea..91956d7f73 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md @@ -4,7 +4,7 @@ title: "[F] $overload" --- ```ts -$overload( +function $overload( context, target, overloadbase): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md index d5e50e80be..cd4457272a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md @@ -4,7 +4,7 @@ title: "[F] $parameterVisibility" --- ```ts -$parameterVisibility( +function $parameterVisibility( context, target, ... visibilities): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md index b80b5ac720..fc989abe46 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md @@ -4,7 +4,7 @@ title: "[F] $pattern" --- ```ts -$pattern( +function $pattern( context, target, pattern, @@ -16,7 +16,7 @@ $pattern( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `pattern` | `string` | | `validationMessage`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md index d24686d40e..6cf7d2484c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md @@ -4,7 +4,7 @@ title: "[F] $projectedName" --- ```ts -$projectedName( +function $projectedName( context, target, targetName, diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md index 87ceeaa964..64a2afca0c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md @@ -4,7 +4,7 @@ title: "[F] $returnTypeVisibility" --- ```ts -$returnTypeVisibility( +function $returnTypeVisibility( context, target, ... visibilities): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md index d1300a9a84..b9412fcf6c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md @@ -4,7 +4,7 @@ title: "[F] $returnsDoc" --- ```ts -$returnsDoc( +function $returnsDoc( context, target, doc): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md index 5e78d478b8..1f9d26907e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md @@ -4,7 +4,7 @@ title: "[F] $secret" --- ```ts -$secret(context, target): void +function $secret(context, target): void ``` Mark a string as a secret value that should be treated carefully to avoid exposure @@ -14,7 +14,7 @@ Mark a string as a secret value that should be treated carefully to avoid exposu | 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. | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | Decorator target, either a string model or a property with type string. | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md index f3fcadb833..5308f57e9f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md @@ -4,7 +4,7 @@ title: "[F] $service" --- ```ts -$service( +function $service( context, target, options?): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md index 7df5e12451..73d18a0058 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md @@ -4,7 +4,7 @@ title: "[F] $summary" --- ```ts -$summary( +function $summary( context, target, summary): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md index 16988bc2d4..681fed8570 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$tag.md @@ -4,7 +4,7 @@ title: "[F] $tag" --- ```ts -$tag( +function $tag( context, target, tag): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md index 6a04edc559..0b8e757671 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$visibility.md @@ -4,7 +4,7 @@ title: "[F] $visibility" --- ```ts -$visibility( +function $visibility( context, target, ... visibilities): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md index b9ce0e80fe..2b4e6c816d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md @@ -4,7 +4,7 @@ title: "[F] $withDefaultKeyVisibility" --- ```ts -$withDefaultKeyVisibility( +function $withDefaultKeyVisibility( context, target, visibility): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md index 9182ad39ab..59f56917d9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withOptionalProperties.md @@ -4,7 +4,7 @@ title: "[F] $withOptionalProperties" --- ```ts -$withOptionalProperties(context, target): void +function $withOptionalProperties(context, target): void ``` ## Parameters 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 0000000000..616e7b834d --- /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 index bad13c7465..ce061b22b2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md @@ -4,7 +4,7 @@ title: "[F] $withUpdateableProperties" --- ```ts -$withUpdateableProperties(context, target): void +function $withUpdateableProperties(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md index 03960bef8d..48b2b8f4f7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withVisibility.md @@ -4,7 +4,7 @@ title: "[F] $withVisibility" --- ```ts -$withVisibility( +function $withVisibility( context, target, ... visibilities): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md index 7a3db2917c..d9a8d639e1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutDefaultValues.md @@ -4,7 +4,7 @@ title: "[F] $withoutDefaultValues" --- ```ts -$withoutDefaultValues(context, target): void +function $withoutDefaultValues(context, target): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md index 5a5c1316e6..6a3f1ec336 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md @@ -4,7 +4,7 @@ title: "[F] $withoutOmittedProperties" --- ```ts -$withoutOmittedProperties( +function $withoutOmittedProperties( context, target, omit): 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 0000000000..038d5dd13c --- /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 index 2b5ba67bd5..415c603e49 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/addService.md @@ -4,7 +4,7 @@ title: "[F] addService" --- ```ts -addService( +function addService( program, namespace, details): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md index e38d3a60d9..4a93d6ae21 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md @@ -4,7 +4,7 @@ title: "[F] assertType" --- ```ts -assertType( +function assertType( typeDescription, t, ... kinds): asserts t is Type & Object @@ -16,30 +16,31 @@ Assert that the input type has one of the kinds provided | Type parameter | | :------ | -| `TKind` extends ( - \| `"Scalar"` - \| `"ModelProperty"` - \| `"Model"` - \| `"Interface"` +| `TKind` *extends* ( + \| `"Boolean"` + \| `"Decorator"` \| `"Enum"` \| `"EnumMember"` - \| `"TemplateParameter"` + \| `"FunctionParameter"` + \| `"Function"` + \| `"Interface"` + \| `"Intrinsic"` + \| `"Model"` + \| `"ModelProperty"` \| `"Namespace"` + \| `"Number"` + \| `"Object"` \| `"Operation"` + \| `"Projection"` + \| `"Scalar"` + \| `"ScalarConstructor"` \| `"String"` - \| `"Number"` - \| `"Boolean"` \| `"StringTemplate"` \| `"StringTemplateSpan"` + \| `"TemplateParameter"` \| `"Tuple"` \| `"Union"` - \| `"UnionVariant"` - \| `"Intrinsic"` - \| `"Function"` - \| `"Decorator"` - \| `"FunctionParameter"` - \| `"Object"` - \| `"Projection"`)[] | + \| `"UnionVariant"`)[] | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md index 4a2a01cab4..7a1ccff9da 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/cadlTypeToJson.md @@ -4,7 +4,7 @@ title: "[F] cadlTypeToJson" --- ```ts -cadlTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] +function cadlTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] ``` ## Type parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md index fb948326d1..90395ee275 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md @@ -4,7 +4,7 @@ title: "[F] checkFormatCadl" --- ```ts -checkFormatCadl(code, prettierConfig?): Promise +function checkFormatCadl(code, prettierConfig?): Promise ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md index 3b0a69b84b..cc13d8aa94 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatTypeSpec.md @@ -4,7 +4,7 @@ title: "[F] checkFormatTypeSpec" --- ```ts -checkFormatTypeSpec(code, prettierConfig?): Promise +function checkFormatTypeSpec(code, prettierConfig?): Promise ``` Check the given is correctly formatted. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md index bb7aff09c8..92ee6a7bd4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compile.md @@ -4,7 +4,7 @@ title: "[F] compile" --- ```ts -compile( +function compile( host, mainFile, options, diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md index 397746cf85..3cc1923e27 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/compilerAssert.md @@ -4,7 +4,7 @@ title: "[F] compilerAssert" --- ```ts -compilerAssert( +function compilerAssert( condition, message, target?): asserts condition @@ -19,7 +19,7 @@ being compiled. | :------ | :------ | :------ | | `condition` | `any` | Throw if this is not true. | | `message` | `string` | Error message. | -| `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) | Optional location in source code that might give a clue about
what got the compiler off track. | +| `target`? | [`DiagnosticTarget`](../type-aliases/DiagnosticTarget.md) |

Optional location in source code that might give a clue about

what got the compiler off track.

| ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md index a0f630643e..2c78196520 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md @@ -4,16 +4,16 @@ title: "[F] createCadlLibrary" --- ```ts -createCadlLibrary(lib): TypeSpecLibrary +function createCadlLibrary(lib): TypeSpecLibrary ``` ## Type parameters | Type parameter | Value | | :------ | :------ | -| `T` extends `Object` | - | -| `E` extends `Record`<`string`, `any`\> | - | -| `State` extends `string` | `never` | +| `T` *extends* `object` | - | +| `E` *extends* `Record`<`string`, `any`\> | - | +| `State` *extends* `string` | `never` | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md index de80530f72..2f0f083172 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createChecker.md @@ -4,7 +4,7 @@ title: "[F] createChecker" --- ```ts -createChecker(program): Checker +function createChecker(program): Checker ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md index df1f1ebf3e..a16bc33c8a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDecoratorDefinition.md @@ -4,16 +4,16 @@ title: "[F] createDecoratorDefinition" --- ```ts -createDecoratorDefinition(definition): DecoratorValidator +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)\> | +| `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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md index fd912a73d0..7970bff198 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createDiagnosticCollector.md @@ -4,7 +4,7 @@ title: "[F] createDiagnosticCollector" --- ```ts -createDiagnosticCollector(): DiagnosticCollector +function createDiagnosticCollector(): DiagnosticCollector ``` Create a new instance of the diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md index 0f5b83f52c..cd030131a3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createProjectedNameProgram.md @@ -4,7 +4,7 @@ title: "[F] createProjectedNameProgram" --- ```ts -createProjectedNameProgram(program, target): ProjectedNameView +function createProjectedNameProgram(program, target): ProjectedNameView ``` Create an helper to manager project names. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md index 3b6c23ac32..4be68f01f8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRekeyableMap.md @@ -4,7 +4,7 @@ title: "[F] createRekeyableMap" --- ```ts -createRekeyableMap(entries?): RekeyableMap +function createRekeyableMap(entries?): RekeyableMap ``` ## Type parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md index 153cf8b90d..cbc62e7091 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createRule.md @@ -4,7 +4,7 @@ title: "[F] createRule" --- ```ts -createRule(definition): LinterRuleDefinition +function createRule(definition): LinterRuleDefinition ``` Create a new linter rule. @@ -13,8 +13,8 @@ Create a new linter rule. | Type parameter | | :------ | -| `N` extends `string` | -| `T` extends [`DiagnosticMessages`](../interfaces/DiagnosticMessages.md) | +| `N` *extends* `string` | +| `T` *extends* [`DiagnosticMessages`](../interfaces/DiagnosticMessages.md) | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md index 2f97135c1c..32df624cbf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createScanner.md @@ -4,7 +4,7 @@ title: "[F] createScanner" --- ```ts -createScanner(source, diagnosticHandler): Scanner +function createScanner(source, diagnosticHandler): Scanner ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md index da2a6edfc0..4ee7171401 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createServer.md @@ -4,7 +4,7 @@ title: "[F] createServer" --- ```ts -createServer(host): Server +function createServer(host): Server ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md index ba61bbf773..3510e5c258 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createSourceFile.md @@ -4,7 +4,7 @@ title: "[F] createSourceFile" --- ```ts -createSourceFile(text, path): SourceFile +function createSourceFile(text, path): SourceFile ``` ## Parameters 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 3580062c7c..0000000000 --- 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 index b245ca6de1..1eb7d5aa1d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createTypeSpecLibrary.md @@ -4,7 +4,7 @@ title: "[F] createTypeSpecLibrary" --- ```ts -createTypeSpecLibrary(lib): TypeSpecLibrary +function createTypeSpecLibrary(lib): TypeSpecLibrary ``` Create a new TypeSpec library definition. @@ -13,9 +13,9 @@ Create a new TypeSpec library definition. | Type parameter | Value | | :------ | :------ | -| `T` extends `Object` | - | -| `E` extends `Record`<`string`, `any`\> | - | -| `State` extends `string` | `never` | +| `T` *extends* `object` | - | +| `E` *extends* `Record`<`string`, `any`\> | - | +| `State` *extends* `string` | `never` | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md index 802753dbe3..eaede79a3b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineCodeFix.md @@ -4,7 +4,7 @@ title: "[F] defineCodeFix" --- ```ts -defineCodeFix(fix): CodeFix +function defineCodeFix(fix): CodeFix ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md index ec398eb87b..ae1aa53c4d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/defineLinter.md @@ -4,7 +4,7 @@ title: "[F] defineLinter" --- ```ts -defineLinter(def): LinterDefinition +function defineLinter(def): LinterDefinition ``` ## Parameters 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 0000000000..1d7b0e70f0 --- /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 index c0e94345a8..c756a997a3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/emitFile.md @@ -4,7 +4,7 @@ title: "[F] emitFile" --- ```ts -emitFile(program, options): Promise +function emitFile(program, options): Promise ``` Helper to emit a file. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md index 12e9afcd7c..f5686ff142 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ensureTrailingDirectorySeparator.md @@ -4,7 +4,7 @@ title: "[F] ensureTrailingDirectorySeparator" --- ```ts -ensureTrailingDirectorySeparator(path): string +function ensureTrailingDirectorySeparator(path): string ``` ## Parameters 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 0000000000..41ff0e766e --- /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 index e40bafddc8..e10b9cd962 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/exprIsBareIdentifier.md @@ -4,7 +4,7 @@ title: "[F] exprIsBareIdentifier" --- ```ts -exprIsBareIdentifier(expr): expr is TypeReferenceNode & Object +function exprIsBareIdentifier(expr): expr is TypeReferenceNode & Object ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md index 849ef16828..6a5edd01f4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/filterModelProperties.md @@ -4,7 +4,7 @@ title: "[F] filterModelProperties" --- ```ts -filterModelProperties( +function filterModelProperties( program, model, filter): Model diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md index 3c50c8e1f4..da2fbd9f0e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/finishTypeForProgram.md @@ -4,14 +4,14 @@ title: "[F] finishTypeForProgram" --- ```ts -finishTypeForProgram(program, typeDef): T +function finishTypeForProgram(program, typeDef): T ``` ## Type parameters | Type parameter | | :------ | -| `T` extends [`Type`](../type-aliases/Type.md) | +| `T` *extends* [`Type`](../type-aliases/Type.md) | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md index 3b9605deef..87f5dc4a95 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatDiagnostic.md @@ -4,7 +4,7 @@ title: "[F] formatDiagnostic" --- ```ts -formatDiagnostic(diagnostic): string +function formatDiagnostic(diagnostic): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md index 484f24d9be..c4a9549ae4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatIdentifier.md @@ -4,7 +4,7 @@ title: "[F] formatIdentifier" --- ```ts -formatIdentifier(sv): string +function formatIdentifier(sv): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md index 753468c7b3..0faafa3f2e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/formatTypeSpec.md @@ -4,7 +4,7 @@ title: "[F] formatTypeSpec" --- ```ts -formatTypeSpec(code, prettierConfig?): Promise +function formatTypeSpec(code, prettierConfig?): Promise ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md index 3d95451fee..696e70645d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAllTags.md @@ -4,7 +4,7 @@ title: "[F] getAllTags" --- ```ts -getAllTags(program, target): string[] | undefined +function getAllTags(program, target): string[] | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md index 47d49049a0..db729975b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getAnyExtensionFromPath.md @@ -4,7 +4,7 @@ title: "[F] getAnyExtensionFromPath" --- ```ts -getAnyExtensionFromPath(path): string +function getAnyExtensionFromPath(path): string ``` Gets the file extension for a path. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md index aa73d5729e..7a5f5fc434 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getBaseFileName.md @@ -4,7 +4,7 @@ title: "[F] getBaseFileName" --- ```ts -getBaseFileName(path): string +function getBaseFileName(path): string ``` Returns the path except for its containing directory name. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md index 95200328e1..e6dd42af2e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecated.md @@ -4,7 +4,7 @@ title: "[F] getDeprecated" --- ```ts -getDeprecated(program, type): string | undefined +function getDeprecated(program, type): string | undefined ``` Return the deprecated message or undefined if not deprecated diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md index f654277555..dfe3afbb12 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md @@ -4,7 +4,7 @@ title: "[F] getDeprecationDetails" --- ```ts -getDeprecationDetails(program, typeOrNode): DeprecationDetails | undefined +function getDeprecationDetails(program, typeOrNode): DeprecationDetails | undefined ``` Returns complete deprecation details for the given type or node diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md index 07d5e1a5a9..c1bdae3524 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDirectoryPath.md @@ -4,7 +4,7 @@ title: "[F] getDirectoryPath" --- ```ts -getDirectoryPath(path): string +function getDirectoryPath(path): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md index 803e1a402c..931bfb788f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedTypes.md @@ -4,7 +4,7 @@ title: "[F] getDiscriminatedTypes" --- ```ts -getDiscriminatedTypes(program): [Model | Union, Discriminator][] +function getDiscriminatedTypes(program): [Model | Union, Discriminator][] ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md index 07f3096e55..f8fa1bedef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminatedUnion.md @@ -4,7 +4,7 @@ title: "[F] getDiscriminatedUnion" --- ```ts -getDiscriminatedUnion(type, discriminator): [DiscriminatedUnion, readonly Diagnostic[]] +function getDiscriminatedUnion(type, discriminator): [DiscriminatedUnion, readonly Diagnostic[]] ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md index 645c49827b..7630d2496d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDiscriminator.md @@ -4,7 +4,7 @@ title: "[F] getDiscriminator" --- ```ts -getDiscriminator(program, entity): Discriminator | undefined +function getDiscriminator(program, entity): Discriminator | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md index 7aff9c47e6..a6790e8eb2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDoc.md @@ -4,7 +4,7 @@ title: "[F] getDoc" --- ```ts -getDoc(program, target): string | undefined +function getDoc(program, target): string | undefined ``` Get the documentation string for the given type. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md index 9fb51757b1..e46fc2a953 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDocData.md @@ -4,7 +4,7 @@ title: "[F] getDocData" --- ```ts -getDocData(program, target): DocData | undefined +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) @@ -18,6 +18,6 @@ Get the documentation information for the given type. In most cases you probably ## Returns -[`DocData`](../interfaces/DocData.md) \| `undefined` +`DocData` \| `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 af7fc9576e..0000000000 --- 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 index 4315c21417..83eed92167 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEffectiveModelType.md @@ -4,7 +4,7 @@ title: "[F] getEffectiveModelType" --- ```ts -getEffectiveModelType( +function getEffectiveModelType( program, model, filter?): Model @@ -27,7 +27,7 @@ best name for the remaining properties is `SomeName`. | :------ | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | - | | `model` | [`Model`](../interfaces/Model.md) | The input model | -| `filter`? | (`property`) => `boolean` | An optional filter to apply to the input model's
properties. | +| `filter`? | (`property`) => `boolean` | An optional filter to apply to the input model's properties. | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md index 984c786f8c..efd937febc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md @@ -4,7 +4,7 @@ title: "[F] getEncode" --- ```ts -getEncode(program, target): EncodeData | undefined +function getEncode(program, target): EncodeData | undefined ``` ## Parameters @@ -12,7 +12,7 @@ getEncode(program, target): EncodeData | undefined | Parameter | Type | | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEntityName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEntityName.md new file mode 100644 index 0000000000..02cf184174 --- /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 index 7b7d94b08e..2f92813112 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDoc.md @@ -4,7 +4,7 @@ title: "[F] getErrorsDoc" --- ```ts -getErrorsDoc(program, target): string | undefined +function getErrorsDoc(program, target): string | undefined ``` Get the documentation string for the return errors types of an operation. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md index 437425e108..58a2cf81d5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getErrorsDocData.md @@ -4,7 +4,7 @@ title: "[F] getErrorsDocData" --- ```ts -getErrorsDocData(program, target): DocData | undefined +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) @@ -18,6 +18,6 @@ Get the documentation information for the return errors types of an operation. I ## Returns -[`DocData`](../interfaces/DocData.md) \| `undefined` +`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 index 41898c72a0..45ebc57967 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFirstAncestor.md @@ -4,15 +4,19 @@ title: "[F] getFirstAncestor" --- ```ts -getFirstAncestor(node, test): Node | undefined +function getFirstAncestor( + node, + test, + includeSelf): Node | undefined ``` ## Parameters -| Parameter | Type | -| :------ | :------ | -| `node` | [`Node`](../type-aliases/Node.md) | -| `test` | [`NodeCallback`](../type-aliases/NodeCallback.md)<`boolean`\> | +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `node` | [`Node`](../type-aliases/Node.md) | `undefined` | +| `test` | [`NodeCallback`](../type-aliases/NodeCallback.md)<`boolean`\> | `undefined` | +| `includeSelf` | `boolean` | `false` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md index edc2b18276..e44f592195 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md @@ -4,7 +4,7 @@ title: "[F] getFormat" --- ```ts -getFormat(program, target): string | undefined +function getFormat(program, target): string | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md index 1f8e4c78f8..80f41cb705 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md @@ -4,7 +4,7 @@ title: "[F] getFriendlyName" --- ```ts -getFriendlyName(program, target): string +function getFriendlyName(program, target): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md index ba12d4d11e..aa26f4ed28 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFullyQualifiedSymbolName.md @@ -4,7 +4,7 @@ title: "[F] getFullyQualifiedSymbolName" --- ```ts -getFullyQualifiedSymbolName(sym, options?): string +function getFullyQualifiedSymbolName(sym, options?): string ``` ## Parameters @@ -12,7 +12,7 @@ getFullyQualifiedSymbolName(sym, options?): string | Parameter | Type | | :------ | :------ | | `sym` | `undefined` \| [`Sym`](../interfaces/Sym.md) | -| `options`? | `Object` | +| `options`? | `object` | | `options.useGlobalPrefixAtTopLevel`? | `boolean` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md index 237920b3b8..703d580a53 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getIdentifierContext.md @@ -4,7 +4,7 @@ title: "[F] getIdentifierContext" --- ```ts -getIdentifierContext(id): IdentifierContext +function getIdentifierContext(id): IdentifierContext ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md index ad759b4110..25269d87b2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md @@ -4,7 +4,7 @@ title: "[F] getKeyName" --- ```ts -getKeyName(program, property): string +function getKeyName(program, property): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md index 4580f1e7d5..5b68d4b8b6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md @@ -4,7 +4,7 @@ title: "[F] getKnownValues" --- ```ts -getKnownValues(program, target): Enum | undefined +function getKnownValues(program, target): Enum | undefined ``` ## Parameters @@ -12,7 +12,7 @@ getKnownValues(program, target): Enum | undefined | Parameter | Type | | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md index d77ea57cad..3619f11c95 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getListOperationType.md @@ -4,7 +4,7 @@ title: "[F] getListOperationType" --- ```ts -getListOperationType(program, target): Model | undefined +function getListOperationType(program, target): Model | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md index 7c4b713a46..a42790b242 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getLocationContext.md @@ -4,7 +4,7 @@ title: "[F] getLocationContext" --- ```ts -getLocationContext(program, type): LocationContext +function getLocationContext(program, type): LocationContext ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md index bef35c87af..92658b17d4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxItems.md @@ -4,7 +4,7 @@ title: "[F] getMaxItems" --- ```ts -getMaxItems(program, target): number | undefined +function getMaxItems(program, target): number | undefined ``` ## Parameters 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 0000000000..ab5c7ede0a --- /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 index a10e2bcc68..f61a5c4048 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxLength.md @@ -4,7 +4,7 @@ title: "[F] getMaxLength" --- ```ts -getMaxLength(program, target): number | undefined +function getMaxLength(program, target): number | undefined ``` ## Parameters 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 0000000000..5f46692eb1 --- /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 index d3e75be269..fd5bb3dacb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValue.md @@ -4,7 +4,7 @@ title: "[F] getMaxValue" --- ```ts -getMaxValue(program, target): number | undefined +function getMaxValue(program, target): number | undefined ``` ## Parameters 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 0000000000..e6341ea1af --- /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 index cc245fdb02..7db657f8f9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMaxValueExclusive.md @@ -4,7 +4,7 @@ title: "[F] getMaxValueExclusive" --- ```ts -getMaxValueExclusive(program, target): number | undefined +function getMaxValueExclusive(program, target): number | undefined ``` ## Parameters 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 0000000000..7a4623d757 --- /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 index 53e57a38c0..4d6eafafb3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinItems.md @@ -4,7 +4,7 @@ title: "[F] getMinItems" --- ```ts -getMinItems(program, target): number | undefined +function getMinItems(program, target): number | undefined ``` ## Parameters 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 0000000000..ca98f81066 --- /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 index d47c83e38f..b0e1ff6e05 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinLength.md @@ -4,7 +4,7 @@ title: "[F] getMinLength" --- ```ts -getMinLength(program, target): number | undefined +function getMinLength(program, target): number | undefined ``` ## Parameters 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 0000000000..058bf71020 --- /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 index e9571d102e..094b9ae81b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValue.md @@ -4,7 +4,7 @@ title: "[F] getMinValue" --- ```ts -getMinValue(program, target): number | undefined +function getMinValue(program, target): number | undefined ``` ## Parameters 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 0000000000..250f06b4a0 --- /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 index d4ea937bff..586108ed9e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getMinValueExclusive.md @@ -4,7 +4,7 @@ title: "[F] getMinValueExclusive" --- ```ts -getMinValueExclusive(program, target): number | undefined +function getMinValueExclusive(program, target): number | undefined ``` ## Parameters 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 0000000000..a95985cbf0 --- /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 index 74dbc56f63..bd73f8e815 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNamespaceFullName.md @@ -4,7 +4,7 @@ title: "[F] getNamespaceFullName" --- ```ts -getNamespaceFullName(type, options?): string +function getNamespaceFullName(type, options?): string ``` Return the full name of the namespace(e.g. "Foo.Bar") diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md index 736a81a4a8..eda4e5f6a5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNodeAtPosition.md @@ -6,7 +6,7 @@ title: "[F] getNodeAtPosition" ## getNodeAtPosition(script, position, filter) ```ts -getNodeAtPosition( +function getNodeAtPosition( script, position, filter?): Node | undefined @@ -29,7 +29,7 @@ Resolve the node in the syntax tree that that is at the given position. ## getNodeAtPosition(script, position, filter) ```ts -getNodeAtPosition( +function getNodeAtPosition( script, position, filter): T | undefined @@ -39,7 +39,7 @@ getNodeAtPosition( | Type parameter | | :------ | -| `T` extends [`Node`](../type-aliases/Node.md) | +| `T` *extends* [`Node`](../type-aliases/Node.md) | ### Parameters 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 0000000000..af0b420360 --- /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 index d3bc953a88..2a5da51780 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePath.md @@ -4,7 +4,7 @@ title: "[F] getNormalizedAbsolutePath" --- ```ts -getNormalizedAbsolutePath(fileName, currentDirectory): string +function getNormalizedAbsolutePath(fileName, currentDirectory): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md index 7c149fe73e..fec2043371 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedAbsolutePathWithoutRoot.md @@ -4,7 +4,7 @@ title: "[F] getNormalizedAbsolutePathWithoutRoot" --- ```ts -getNormalizedAbsolutePathWithoutRoot(fileName, currentDirectory): string +function getNormalizedAbsolutePathWithoutRoot(fileName, currentDirectory): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md index 24d43d93f9..827f54bb9d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getNormalizedPathComponents.md @@ -4,7 +4,7 @@ title: "[F] getNormalizedPathComponents" --- ```ts -getNormalizedPathComponents(path, currentDirectory): string[] +function getNormalizedPathComponents(path, currentDirectory): string[] ``` Parse a path into an array containing a root component (at index 0) and zero or more path diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md index 72e5c14d99..f2e3245300 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md @@ -4,7 +4,7 @@ title: "[F] getOverloadedOperation" --- ```ts -getOverloadedOperation(program, operation): Operation | undefined +function getOverloadedOperation(program, operation): Operation | undefined ``` If the given operation overloads another operation, return that operation. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md index ab8f3d9870..ae1267531b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md @@ -4,7 +4,7 @@ title: "[F] getOverloads" --- ```ts -getOverloads(program, operation): Operation[] | undefined +function getOverloads(program, operation): Operation[] | undefined ``` Get all operations that are marked as overloads of the given operation diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md index 0ab77e503a..2d5344c5f6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverriddenProperty.md @@ -4,7 +4,7 @@ title: "[F] getOverriddenProperty" --- ```ts -getOverriddenProperty(property): ModelProperty | undefined +function getOverriddenProperty(property): ModelProperty | undefined ``` Gets the property from the nearest base type that is overridden by the diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md index e4f504e655..7d21e463c9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md @@ -4,7 +4,7 @@ title: "[F] getParameterVisibility" --- ```ts -getParameterVisibility(program, entity): string[] | undefined +function getParameterVisibility(program, entity): string[] | undefined ``` Returns the visibilities of the parameters of the given operation, if provided with `@parameterVisibility`. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md index cd9695af51..4ac4e27aaf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParentTemplateNode.md @@ -4,7 +4,7 @@ title: "[F] getParentTemplateNode" --- ```ts -getParentTemplateNode(node): Node & TemplateDeclarationNode | undefined +function getParentTemplateNode(node): Node & TemplateDeclarationNode | undefined ``` Lookup and find the node diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md index 0abf6ab72d..29a3dfdc3e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathComponents.md @@ -4,7 +4,7 @@ title: "[F] getPathComponents" --- ```ts -getPathComponents(path, currentDirectory): string[] +function getPathComponents(path, currentDirectory): string[] ``` Parse a path into an array containing a root component (at index 0) and zero or more path diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md index 9f5ec22613..d9b96b6885 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPathFromPathComponents.md @@ -4,7 +4,7 @@ title: "[F] getPathFromPathComponents" --- ```ts -getPathFromPathComponents(pathComponents): string +function getPathFromPathComponents(pathComponents): string ``` Formats a parsed path consisting of a root component (at index 0) and zero or more path diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md index 4389373300..16b6c9b142 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPattern.md @@ -4,7 +4,7 @@ title: "[F] getPattern" --- ```ts -getPattern(program, target): string | undefined +function getPattern(program, target): string | undefined ``` Gets the pattern regular expression associated with a given type, if one has been set. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md index 577ffe621d..bc7de4ca2f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md @@ -4,7 +4,7 @@ title: "[F] getPatternData" --- ```ts -getPatternData(program, target): PatternData | undefined +function getPatternData(program, target): PatternData | undefined ``` Gets the associated pattern data, including the pattern regular expression and optional validation message, if any diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md index 09ac2efec1..46de18bdbd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPositionBeforeTrivia.md @@ -4,7 +4,7 @@ title: "[F] getPositionBeforeTrivia" --- ```ts -getPositionBeforeTrivia(script, pos): number +function getPositionBeforeTrivia(script, pos): number ``` Adjust the given postion backwards before any trivia. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md index 6895accf1e..471dd9632a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedName.md @@ -4,7 +4,7 @@ title: "[F] getProjectedName" --- ```ts -getProjectedName( +function getProjectedName( program, target, projectionName): string | undefined diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md index b8c3f85a20..a975852e6f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProjectedNames.md @@ -4,7 +4,7 @@ title: "[F] getProjectedNames" --- ```ts -getProjectedNames(program, target): ReadonlyMap | undefined +function getProjectedNames(program, target): ReadonlyMap | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md index e374afa6c2..3da14e7741 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getProperty.md @@ -4,7 +4,7 @@ title: "[F] getProperty" --- ```ts -getProperty(type, propertyName): ModelProperty | undefined +function getProperty(type, propertyName): ModelProperty | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md index 87fdd3f58e..b72a0dcaf7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md @@ -4,7 +4,7 @@ title: "[F] getPropertyType" --- ```ts -getPropertyType(target): Type +function getPropertyType(target): Type ``` Return the type of the property or the model itself. @@ -13,7 +13,7 @@ Return the type of the property or the model itself. | Parameter | Type | | :------ | :------ | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md index eb43f017d8..1f1210381b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRelativePathFromDirectory.md @@ -6,7 +6,7 @@ title: "[F] getRelativePathFromDirectory" ## getRelativePathFromDirectory(from, to, ignoreCase) ```ts -getRelativePathFromDirectory( +function getRelativePathFromDirectory( from, to, ignoreCase): string @@ -29,7 +29,7 @@ Gets a relative path that can be used to traverse between `from` and `to`. ## getRelativePathFromDirectory(fromDirectory, to, getCanonicalFileName) ```ts -getRelativePathFromDirectory( +function getRelativePathFromDirectory( fromDirectory, to, getCanonicalFileName): string diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md index 05210db4d2..ca43fb6905 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md @@ -4,7 +4,7 @@ title: "[F] getReturnTypeVisibility" --- ```ts -getReturnTypeVisibility(program, entity): string[] | undefined +function getReturnTypeVisibility(program, entity): string[] | undefined ``` Returns the visibilities of the return type of the given operation, if provided with `@returnTypeVisibility`. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md index a28ad129ab..83dace9fb6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDoc.md @@ -4,7 +4,7 @@ title: "[F] getReturnsDoc" --- ```ts -getReturnsDoc(program, target): string | undefined +function getReturnsDoc(program, target): string | undefined ``` Get the documentation string for the return success types of an operation. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md index 225e0faaba..5990ac691b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnsDocData.md @@ -4,7 +4,7 @@ title: "[F] getReturnsDocData" --- ```ts -getReturnsDocData(program, target): DocData | undefined +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) @@ -18,6 +18,6 @@ Get the documentation information for the return success types of an operation. ## Returns -[`DocData`](../interfaces/DocData.md) \| `undefined` +`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 index de62b4b5ab..572edfd5f0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getRootLength.md @@ -4,7 +4,7 @@ title: "[F] getRootLength" --- ```ts -getRootLength(path): number +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"). diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md index d66035656c..35d9003f72 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md @@ -4,7 +4,7 @@ title: "[F] getService" --- ```ts -getService(program, namespace): Service | undefined +function getService(program, namespace): Service | undefined ``` Get the service information for the given namespace. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md index f2b2e15e72..c5ee3bd523 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceFileKindFromExt.md @@ -4,7 +4,7 @@ title: "[F] getSourceFileKindFromExt" --- ```ts -getSourceFileKindFromExt(path): SourceFileKind | undefined +function getSourceFileKindFromExt(path): SourceFileKind | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md index c77c0cc575..30cb67334e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSourceLocation.md @@ -6,7 +6,7 @@ title: "[F] getSourceLocation" ## getSourceLocation(target, options) ```ts -getSourceLocation(target, options?): SourceLocation +function getSourceLocation(target, options?): SourceLocation ``` ### Parameters @@ -23,7 +23,7 @@ getSourceLocation(target, options?): SourceLocation ## getSourceLocation(target, options) ```ts -getSourceLocation(target, options?): undefined +function getSourceLocation(target, options?): undefined ``` ### Parameters @@ -40,7 +40,7 @@ getSourceLocation(target, options?): undefined ## getSourceLocation(target, options) ```ts -getSourceLocation(target, options?): SourceLocation | undefined +function getSourceLocation(target, options?): SourceLocation | undefined ``` ### Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md index 8effbe4d00..c6796052df 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md @@ -4,7 +4,7 @@ title: "[F] getSummary" --- ```ts -getSummary(program, type): string | undefined +function getSummary(program, type): string | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md index 5f0bbfc5c7..1c6f1a632c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTags.md @@ -4,7 +4,7 @@ title: "[F] getTags" --- ```ts -getTags(program, target): string[] +function getTags(program, target): string[] ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md index c511f31f97..8378f0431e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getTypeName.md @@ -4,14 +4,14 @@ title: "[F] getTypeName" --- ```ts -getTypeName(type, options?): string +function getTypeName(type, options?): string ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) \| [`ValueType`](../interfaces/ValueType.md) | +| `type` | [`Type`](../type-aliases/Type.md) | | `options`? | [`TypeNameOptions`](../interfaces/TypeNameOptions.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md index 8231800984..cc0a0d3787 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md @@ -4,7 +4,7 @@ title: "[F] getVisibility" --- ```ts -getVisibility(program, target): string[] | undefined +function getVisibility(program, target): string[] | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md index 8d726b2263..6f8d34e8d3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasParseError.md @@ -4,7 +4,7 @@ title: "[F] hasParseError" --- ```ts -hasParseError(node): number | true +function hasParseError(node): number | true ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md index ab7251c8a7..e02f225202 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasProjectedName.md @@ -4,7 +4,7 @@ title: "[F] hasProjectedName" --- ```ts -hasProjectedName( +function hasProjectedName( program, target, projectionName): boolean diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md index 58c9568e47..c61f1cb264 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/hasTrailingDirectorySeparator.md @@ -4,7 +4,7 @@ title: "[F] hasTrailingDirectorySeparator" --- ```ts -hasTrailingDirectorySeparator(path): boolean +function hasTrailingDirectorySeparator(path): boolean ``` Determines whether a path has a trailing separator (`/` or `\\`). diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md index 81fdef065d..400c613824 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/ignoreDiagnostics.md @@ -4,7 +4,7 @@ title: "[F] ignoreDiagnostics" --- ```ts -ignoreDiagnostics(result): T +function ignoreDiagnostics(result): T ``` Ignore the diagnostics emitted by the diagnostic accessor pattern and just return the actual result. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md index 17c40de8e7..8df4f5a1f8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/interpolatePath.md @@ -4,7 +4,7 @@ title: "[F] interpolatePath" --- ```ts -interpolatePath(pathTemplate, predefinedVariables): string +function interpolatePath(pathTemplate, predefinedVariables): string ``` Interpolate a path template diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md index abee4537eb..d58bd82f36 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isAnyDirectorySeparator.md @@ -4,7 +4,7 @@ title: "[F] isAnyDirectorySeparator" --- ```ts -isAnyDirectorySeparator(charCode): boolean +function isAnyDirectorySeparator(charCode): boolean ``` Determines whether a charCode corresponds to `/` or ``. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md index 41d0e12807..901d4caf4d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isArrayModelType.md @@ -4,7 +4,7 @@ title: "[F] isArrayModelType" --- ```ts -isArrayModelType(program, type): type is ArrayModelType +function isArrayModelType(program, type): type is ArrayModelType ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md index 5f27dd12aa..82669edb1c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md @@ -4,14 +4,14 @@ title: "[F] isCadlValueTypeOf" --- ```ts -isCadlValueTypeOf(target, expectedType): target is InferredTypeSpecValue +function isCadlValueTypeOf(target, expectedType): target is InferredTypeSpecValue ``` ## Type parameters | Type parameter | | :------ | -| `K` extends [`TypeKind`](../type-aliases/TypeKind.md) | +| `K` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md index b30083bb6e..8f644f595f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isComment.md @@ -4,7 +4,7 @@ title: "[F] isComment" --- ```ts -isComment(token): boolean +function isComment(token): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md index b75b5969d5..d1223a8515 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredInNamespace.md @@ -4,7 +4,7 @@ title: "[F] isDeclaredInNamespace" --- ```ts -isDeclaredInNamespace( +function isDeclaredInNamespace( type, namespace, options): boolean @@ -16,9 +16,9 @@ Check if the given type is declared in the specified namespace or, optionally, i | 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 | +| `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` | `object` | - | | `options.recursive`? | `boolean` | - | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md index 8916b6e7b8..f457a276f1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeclaredType.md @@ -4,7 +4,7 @@ title: "[F] isDeclaredType" --- ```ts -isDeclaredType(type): boolean +function isDeclaredType(type): boolean ``` Check if the type is a declared type. This include: diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md index f52fe8b53f..0409f08b21 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isDeprecated.md @@ -4,7 +4,7 @@ title: "[F] isDeprecated" --- ```ts -isDeprecated(program, type): boolean +function isDeprecated(program, type): boolean ``` Check if the given type is deprecated diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md index 743b7f23c1..e4acdd8302 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorModel.md @@ -4,7 +4,7 @@ title: "[F] isErrorModel" --- ```ts -isErrorModel(program, target): boolean +function isErrorModel(program, target): boolean ``` Check if the type is an error model or a descendant of an error model. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md index 27f4941c22..08ee7caea3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isErrorType.md @@ -4,14 +4,14 @@ title: "[F] isErrorType" --- ```ts -isErrorType(type): type is ErrorType +function isErrorType(type): type is ErrorType ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | +| `type` | [`Entity`](../type-aliases/Entity.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md index bf482ade01..051f4d4c75 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isGlobalNamespace.md @@ -4,7 +4,7 @@ title: "[F] isGlobalNamespace" --- ```ts -isGlobalNamespace(program, namespace): namespace is Namespace & Object +function isGlobalNamespace(program, namespace): namespace is Namespace & Object ``` Check if the given namespace is the global namespace diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md index b92767ae14..bbff894c87 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isImportStatement.md @@ -4,7 +4,7 @@ title: "[F] isImportStatement" --- ```ts -isImportStatement(node): node is ImportStatementNode +function isImportStatement(node): node is ImportStatementNode ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md index 22175e71ab..c21ea5549f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isIntrinsicType.md @@ -4,7 +4,7 @@ title: "[F] isIntrinsicType" --- ```ts -isIntrinsicType( +function isIntrinsicType( program, type, kind): boolean diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md index de827d3e63..c93c8edaaf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKey.md @@ -4,7 +4,7 @@ title: "[F] isKey" --- ```ts -isKey(program, property): boolean +function isKey(program, property): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md index 44e74a7682..6799df9a3c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isKeyword.md @@ -4,7 +4,7 @@ title: "[F] isKeyword" --- ```ts -isKeyword(token): boolean +function isKeyword(token): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md index 2a766fa593..e2da253476 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isListOperation.md @@ -4,7 +4,7 @@ title: "[F] isListOperation" --- ```ts -isListOperation(program, target): boolean +function isListOperation(program, target): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md index 4d0548170c..cb3765325b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isModifier.md @@ -4,7 +4,7 @@ title: "[F] isModifier" --- ```ts -isModifier(token): boolean +function isModifier(token): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md index f054d8aebf..d6a600458c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNeverType.md @@ -4,14 +4,14 @@ title: "[F] isNeverType" --- ```ts -isNeverType(type): type is NeverType +function isNeverType(type): type is NeverType ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | +| `type` | [`Entity`](../type-aliases/Entity.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md index 41e1ce2ce3..6eb63cc842 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNullType.md @@ -4,14 +4,14 @@ title: "[F] isNullType" --- ```ts -isNullType(type): type is NullType +function isNullType(type): type is NullType ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | +| `type` | [`Entity`](../type-aliases/Entity.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumeric.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumeric.md new file mode 100644 index 0000000000..b82cdcc2b6 --- /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 index 5c8fa2ab12..20586a42ae 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isNumericType.md @@ -4,7 +4,7 @@ title: "[F] isNumericType" --- ```ts -isNumericType(program, target): target is Scalar +function isNumericType(program, target): target is Scalar ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md index 21e4b9b286..ced9f65115 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPathAbsolute.md @@ -4,7 +4,7 @@ title: "[F] isPathAbsolute" --- ```ts -isPathAbsolute(path): boolean +function isPathAbsolute(path): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md index 61e16dc5bc..50f8fbc75e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isProjectedProgram.md @@ -4,7 +4,7 @@ title: "[F] isProjectedProgram" --- ```ts -isProjectedProgram(program): program is ProjectedProgram +function isProjectedProgram(program): program is ProjectedProgram ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md index 2219b79829..b22d681c92 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isPunctuation.md @@ -4,7 +4,7 @@ title: "[F] isPunctuation" --- ```ts -isPunctuation(token): boolean +function isPunctuation(token): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md index 70514fcac7..f778bb369e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isRecordModelType.md @@ -4,7 +4,7 @@ title: "[F] isRecordModelType" --- ```ts -isRecordModelType(program, type): type is ArrayModelType +function isRecordModelType(program, type): type is ArrayModelType ``` Check if a model is an array type. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md index 54b813cccb..54d2b1d436 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md @@ -4,7 +4,7 @@ title: "[F] isSecret" --- ```ts -isSecret(program, target): boolean | undefined +function isSecret(program, target): boolean | undefined ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md index 2a278b6e62..e21fa69164 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isService.md @@ -4,7 +4,7 @@ title: "[F] isService" --- ```ts -isService(program, namespace): boolean +function isService(program, namespace): boolean ``` Check if the namespace is defined as a service. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md index da379ee03e..9de4e0b44b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStatementKeyword.md @@ -4,7 +4,7 @@ title: "[F] isStatementKeyword" --- ```ts -isStatementKeyword(token): boolean +function isStatementKeyword(token): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md index fc21666a88..a051e6e8be 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStdNamespace.md @@ -4,7 +4,7 @@ title: "[F] isStdNamespace" --- ```ts -isStdNamespace(namespace): boolean +function isStdNamespace(namespace): boolean ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md index 5b71a07254..2886e1194e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isStringType.md @@ -4,7 +4,7 @@ title: "[F] isStringType" --- ```ts -isStringType(program, target): target is Scalar +function isStringType(program, target): target is Scalar ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md index 1d3ab132c9..493e3c5c2e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclaration.md @@ -4,7 +4,7 @@ title: "[F] isTemplateDeclaration" --- ```ts -isTemplateDeclaration(type): type is TemplatedType & Object +function isTemplateDeclaration(type): type is TemplatedType & Object ``` Resolve if the type is a template type declaration(Non initialized template type). diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md index 1f5ffe2aca..2db06f844b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateDeclarationOrInstance.md @@ -4,7 +4,7 @@ title: "[F] isTemplateDeclarationOrInstance" --- ```ts -isTemplateDeclarationOrInstance(type): boolean +function isTemplateDeclarationOrInstance(type): boolean ``` Resolve if the type was created from a template type or is a template type declaration. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md index 55add5ec1a..3525c3149c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTemplateInstance.md @@ -4,7 +4,7 @@ title: "[F] isTemplateInstance" --- ```ts -isTemplateInstance(type): type is TemplatedType & Object +function isTemplateInstance(type): type is TemplatedType & Object ``` Check the given type is a finished template instance. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md index 4a7db7572a..4875a8e524 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTrivia.md @@ -4,7 +4,7 @@ title: "[F] isTrivia" --- ```ts -isTrivia(token): boolean +function isTrivia(token): boolean ``` ## Parameters 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 0000000000..3a896924d6 --- /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 index bfb89ac31e..d07d87a182 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isTypeSpecValueTypeOf.md @@ -4,7 +4,7 @@ title: "[F] isTypeSpecValueTypeOf" --- ```ts -isTypeSpecValueTypeOf(target, expectedType): target is InferredTypeSpecValue +function isTypeSpecValueTypeOf(target, expectedType): target is InferredTypeSpecValue ``` Check if the given target is of any of the TypeSpec types. @@ -13,7 +13,7 @@ Check if the given target is of any of the TypeSpec types. | Type parameter | | :------ | -| `K` extends [`TypeKind`](../type-aliases/TypeKind.md) | +| `K` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md index d96a20b145..3810561584 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUnknownType.md @@ -4,14 +4,14 @@ title: "[F] isUnknownType" --- ```ts -isUnknownType(type): type is UnknownType +function isUnknownType(type): type is UnknownType ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | +| `type` | [`Entity`](../type-aliases/Entity.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md index fac8b27849..d880610ea5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isUrl.md @@ -4,7 +4,7 @@ title: "[F] isUrl" --- ```ts -isUrl(path): boolean +function isUrl(path): boolean ``` Determines whether a path starts with a URL scheme (e.g. starts with `http://`, `ftp://`, `file://`, etc.). 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 0000000000..efb9515f79 --- /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 index 5b89aa6098..5a5bb4aada 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVisible.md @@ -4,7 +4,7 @@ title: "[F] isVisible" --- ```ts -isVisible( +function isVisible( program, property, visibilities): boolean diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md index 0556ff90e5..3f101edaaa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isVoidType.md @@ -4,14 +4,14 @@ title: "[F] isVoidType" --- ```ts -isVoidType(type): type is VoidType +function isVoidType(type): type is VoidType ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | +| `type` | [`Entity`](../type-aliases/Entity.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md index e78d9eea75..4ecc31a2ec 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/joinPaths.md @@ -4,7 +4,7 @@ title: "[F] joinPaths" --- ```ts -joinPaths(path, ...paths): string +function joinPaths(path, ...paths): string ``` Combines paths. If a path is absolute, it replaces any previous path. Relative paths are not simplified. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md index ac93da4059..428f568804 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listOperationsIn.md @@ -4,7 +4,7 @@ title: "[F] listOperationsIn" --- ```ts -listOperationsIn(container, options): Operation[] +function listOperationsIn(container, options): Operation[] ``` List operations in the given container. Will list operation recursively by default(Check subnamespaces.) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md index 0d54482b40..16bbbb28d5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/listServices.md @@ -4,7 +4,7 @@ title: "[F] listServices" --- ```ts -listServices(program): Service[] +function listServices(program): Service[] ``` List all the services defined in the TypeSpec program diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md index 9cb0323501..b72c0e88de 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logDiagnostics.md @@ -4,7 +4,7 @@ title: "[F] logDiagnostics" --- ```ts -logDiagnostics(diagnostics, logger): void +function logDiagnostics(diagnostics, logger): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md index cd6d715306..dc3b7a12f1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/logVerboseTestOutput.md @@ -4,7 +4,7 @@ title: "[F] logVerboseTestOutput" --- ```ts -logVerboseTestOutput(messageOrCallback): void +function logVerboseTestOutput(messageOrCallback): void ``` Verbose output is enabled by default for runs in mocha explorer in VS Code, diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md index faeb12b857..dc66d211fa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/mapEventEmitterToNodeListener.md @@ -4,7 +4,7 @@ title: "[F] mapEventEmitterToNodeListener" --- ```ts -mapEventEmitterToNodeListener(eventEmitter): SemanticNodeListener +function mapEventEmitterToNodeListener(eventEmitter): SemanticNodeListener ``` Create a Semantic node listener from an event emitter. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md index 32cca70f55..a8718dc07b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/markDeprecated.md @@ -4,7 +4,7 @@ title: "[F] markDeprecated" --- ```ts -markDeprecated( +function markDeprecated( program, type, details): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md index 820142d61b..85f7944963 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateProgram.md @@ -4,7 +4,7 @@ title: "[F] navigateProgram" --- ```ts -navigateProgram( +function navigateProgram( program, listeners, options): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md index bc2bd515fd..ecc4d5f7c9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateType.md @@ -4,7 +4,7 @@ title: "[F] navigateType" --- ```ts -navigateType( +function navigateType( type, listeners, options): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md index 5f5a9abac5..86249732ec 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/navigateTypesInNamespace.md @@ -4,7 +4,7 @@ title: "[F] navigateTypesInNamespace" --- ```ts -navigateTypesInNamespace( +function navigateTypesInNamespace( namespace, listeners, options): void @@ -15,7 +15,7 @@ navigateTypesInNamespace( | 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` | +| `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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md index 5f3c85b47a..dc2ae9deb3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizePath.md @@ -4,7 +4,7 @@ title: "[F] normalizePath" --- ```ts -normalizePath(path): string +function normalizePath(path): string ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md index f57cabe09d..eae45037c4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/normalizeSlashes.md @@ -4,7 +4,7 @@ title: "[F] normalizeSlashes" --- ```ts -normalizeSlashes(path): string +function normalizeSlashes(path): string ``` Normalize path separators, converting `\` into `/`. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md index 96b7bcd0ab..ba5a2fd758 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/paramMessage.md @@ -4,14 +4,14 @@ title: "[F] paramMessage" --- ```ts -paramMessage(strings, ...keys): CallableMessage +function paramMessage(strings, ...keys): CallableMessage ``` ## Type parameters | Type parameter | | :------ | -| `T` extends `string`[] | +| `T` *extends* `string`[] | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md index 19635813f6..4be9ea71c9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parse.md @@ -4,7 +4,7 @@ title: "[F] parse" --- ```ts -parse(code, options): TypeSpecScriptNode +function parse(code, options): TypeSpecScriptNode ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md index 11aeb6b5b7..ba97e27a22 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/parseStandaloneTypeReference.md @@ -4,7 +4,7 @@ title: "[F] parseStandaloneTypeReference" --- ```ts -parseStandaloneTypeReference(code): [TypeReferenceNode, readonly Diagnostic[]] +function parseStandaloneTypeReference(code): [TypeReferenceNode, readonly Diagnostic[]] ``` ## Parameters 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 0000000000..179a20faa2 --- /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 index 370563d678..7a1c0db09a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/projectProgram.md @@ -4,7 +4,7 @@ title: "[F] projectProgram" --- ```ts -projectProgram( +function projectProgram( program, projections, startNode?): ProjectedProgram diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md index d98770badb..78e584526c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reducePathComponents.md @@ -4,7 +4,7 @@ title: "[F] reducePathComponents" --- ```ts -reducePathComponents(components): string[] +function reducePathComponents(components): string[] ``` Reduce an array of path components to a more simplified path by navigating any diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md index 277ef723b7..2c53c2cbb0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/removeTrailingDirectorySeparator.md @@ -4,7 +4,7 @@ title: "[F] removeTrailingDirectorySeparator" --- ```ts -removeTrailingDirectorySeparator(path): string +function removeTrailingDirectorySeparator(path): string ``` Removes a trailing directory separator from a path, if it does not already have one. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md index f5f7ef69ba..f7e65b5d83 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/reportDeprecated.md @@ -4,7 +4,7 @@ title: "[F] reportDeprecated" --- ```ts -reportDeprecated( +function reportDeprecated( program, message, target): void diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md index 6389f91e09..5b382390be 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveCompilerOptions.md @@ -4,7 +4,7 @@ title: "[F] resolveCompilerOptions" --- ```ts -resolveCompilerOptions(host, options): Promise<[CompilerOptions, readonly Diagnostic[]]> +function resolveCompilerOptions(host, options): Promise<[CompilerOptions, readonly Diagnostic[]]> ``` Resolve the compiler options for the given entrypoint by resolving the tspconfig.yaml. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md index 91639e59b8..f1f69a4b4d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveEncodedName.md @@ -4,7 +4,7 @@ title: "[F] resolveEncodedName" --- ```ts -resolveEncodedName( +function resolveEncodedName( program, target, mimeType): string @@ -18,7 +18,7 @@ If a specific value was provided by `@encodedName` decorator for that mime type | Parameter | Type | | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) & `Object` | +| `target` | [`Type`](../type-aliases/Type.md) & `object` | | `mimeType` | `string` | ## Returns 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 0000000000..02a10a5f9e --- /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 index aa009c703f..fd70784598 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md @@ -4,7 +4,7 @@ title: "[F] resolveModule" --- ```ts -resolveModule( +function resolveModule( host, name, options): Promise diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md index cb260f4ffd..08308fb9e1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolvePath.md @@ -4,7 +4,7 @@ title: "[F] resolvePath" --- ```ts -resolvePath(path, ...paths): string +function resolvePath(path, ...paths): string ``` Combines and resolves paths. If a path is absolute, it replaces any previous path. Any diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md index ea6924d66d..5d61589491 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveUsages.md @@ -4,7 +4,7 @@ title: "[F] resolveUsages" --- ```ts -resolveUsages(types): UsageTracker +function resolveUsages(types): UsageTracker ``` Resolve usage(input, output or both) of various types in the given namespace. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md index bdd2cd32b5..6d4449d138 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/scopeNavigationToNamespace.md @@ -4,7 +4,7 @@ title: "[F] scopeNavigationToNamespace" --- ```ts -scopeNavigationToNamespace( +function scopeNavigationToNamespace( namespace, listeners, options): T @@ -16,7 +16,7 @@ Scope the current navigation to the given namespace. | 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` | +| `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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md index db6837821f..616332b4f0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setCadlNamespace.md @@ -4,7 +4,7 @@ title: "[F] setCadlNamespace" --- ```ts -setCadlNamespace(namespace, ...functions): void +function setCadlNamespace(namespace, ...functions): void ``` ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md index 2d54e87e46..07a9edfd16 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/setTypeSpecNamespace.md @@ -4,7 +4,7 @@ title: "[F] setTypeSpecNamespace" --- ```ts -setTypeSpecNamespace(namespace, ...functions): void +function setTypeSpecNamespace(namespace, ...functions): void ``` Set the TypeSpec namespace for that function. 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 0000000000..7c00a1f1f2 --- /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 index 4a26a6f1ff..25e217faf4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipTrivia.md @@ -4,7 +4,7 @@ title: "[F] skipTrivia" --- ```ts -skipTrivia( +function skipTrivia( input, position, endPosition): number @@ -12,12 +12,14 @@ skipTrivia( ## Parameters -| Parameter | Type | Default value | -| :------ | :------ | :------ | -| `input` | `string` | `undefined` | -| `position` | `number` | `undefined` | -| `endPosition` | `number` | `input.length` | +| 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 0000000000..ad8615e09e --- /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 index 4f80fb1b19..5cef2cd6ba 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/skipWhiteSpace.md @@ -4,7 +4,7 @@ title: "[F] skipWhiteSpace" --- ```ts -skipWhiteSpace( +function skipWhiteSpace( input, position, endPosition): 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 index 02474140f6..d821c2a5de 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/stringTemplateToString.md @@ -4,19 +4,19 @@ title: "[F] stringTemplateToString" --- ```ts -stringTemplateToString(stringTemplate): [string, readonly Diagnostic[]] +function 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. | +| 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 index eaa62def3b..a9bd6a4c1a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/typespecTypeToJson.md @@ -4,7 +4,7 @@ title: "[F] typespecTypeToJson" --- ```ts -typespecTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] +function typespecTypeToJson(typespecType, target): [T | undefined, Diagnostic[]] ``` Convert a TypeSpec type to a serializable Json object. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md index 45e8845ee2..e79ce21173 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorNotOnType.md @@ -4,7 +4,7 @@ title: "[F] validateDecoratorNotOnType" --- ```ts -validateDecoratorNotOnType( +function validateDecoratorNotOnType( context, type, badDecorator, diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md index 7b3b87dcae..21d861e354 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamCount.md @@ -4,7 +4,7 @@ title: "[F] validateDecoratorParamCount" --- ```ts -validateDecoratorParamCount( +function validateDecoratorParamCount( context, min, max, diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md index 6bd5f1b10d..6d7022c3f0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md @@ -4,7 +4,7 @@ title: "[F] validateDecoratorParamType" --- ```ts -validateDecoratorParamType( +function validateDecoratorParamType( program, target, value, @@ -17,30 +17,31 @@ Validate a decorator parameter has the correct type. | Type parameter | | :------ | -| `K` extends - \| `"Scalar"` - \| `"ModelProperty"` - \| `"Model"` - \| `"Interface"` +| `K` *extends* + \| `"Boolean"` + \| `"Decorator"` \| `"Enum"` \| `"EnumMember"` - \| `"TemplateParameter"` + \| `"FunctionParameter"` + \| `"Function"` + \| `"Interface"` + \| `"Intrinsic"` + \| `"Model"` + \| `"ModelProperty"` \| `"Namespace"` + \| `"Number"` + \| `"Object"` \| `"Operation"` + \| `"Projection"` + \| `"Scalar"` + \| `"ScalarConstructor"` \| `"String"` - \| `"Number"` - \| `"Boolean"` \| `"StringTemplate"` \| `"StringTemplateSpan"` + \| `"TemplateParameter"` \| `"Tuple"` \| `"Union"` - \| `"UnionVariant"` - \| `"Intrinsic"` - \| `"Function"` - \| `"Decorator"` - \| `"FunctionParameter"` - \| `"Object"` - \| `"Projection"` | + \| `"UnionVariant"` | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md index dad723bf22..aeaeca9663 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTarget.md @@ -4,7 +4,7 @@ title: "[F] validateDecoratorTarget" --- ```ts -validateDecoratorTarget( +function validateDecoratorTarget( context, target, decoratorName, @@ -17,7 +17,7 @@ Validate the decorator target is matching the expected value. | Type parameter | | :------ | -| `K` extends [`TypeKind`](../type-aliases/TypeKind.md) | +| `K` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md index cabe8dd644..41b753da94 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md @@ -4,7 +4,7 @@ title: "[F] validateDecoratorTargetIntrinsic" --- ```ts -validateDecoratorTargetIntrinsic( +function validateDecoratorTargetIntrinsic( context, target, decoratorName, @@ -16,7 +16,7 @@ validateDecoratorTargetIntrinsic( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | | `decoratorName` | `string` | | `expectedType` | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md)[] | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md index 89c5bae023..cdb59d96b1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorUniqueOnNode.md @@ -4,7 +4,7 @@ title: "[F] validateDecoratorUniqueOnNode" --- ```ts -validateDecoratorUniqueOnNode( +function validateDecoratorUniqueOnNode( context, type, decorator): boolean diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md index d7aa8b8f9f..c40dfb2c25 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/visitChildren.md @@ -4,7 +4,7 @@ title: "[F] visitChildren" --- ```ts -visitChildren(node, cb): T | undefined +function visitChildren(node, cb): T | undefined ``` ## Type parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md index f4a0324348..c29c3214d6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/walkPropertiesInherited.md @@ -4,7 +4,7 @@ title: "[F] walkPropertiesInherited" --- ```ts -walkPropertiesInherited(model): Generator +function walkPropertiesInherited(model): Generator ``` Enumerates the properties declared by model or inherited from its base. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md index 30f9e05fdb..afb5be83ac 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md @@ -29,13 +29,17 @@ title: "[P] JS API" - [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) @@ -44,6 +48,7 @@ title: "[P] JS API" - [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) @@ -68,10 +73,10 @@ title: "[P] JS API" - [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) +- [DocPropTagNode](interfaces/DocPropTagNode.md) - [DocReturnsTagNode](interfaces/DocReturnsTagNode.md) - [DocTagBaseNode](interfaces/DocTagBaseNode.md) - [DocTemplateTagNode](interfaces/DocTemplateTagNode.md) @@ -86,17 +91,19 @@ title: "[P] JS API" - [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) -- [FunctionParameter](interfaces/FunctionParameter.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) @@ -110,6 +117,7 @@ title: "[P] JS API" - [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) @@ -119,6 +127,8 @@ title: "[P] JS API" - [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) @@ -134,15 +144,25 @@ title: "[P] JS API" - [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) @@ -192,15 +212,20 @@ title: "[P] JS API" - [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) @@ -217,6 +242,7 @@ title: "[P] JS API" - [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) @@ -234,6 +260,7 @@ title: "[P] JS API" - [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) @@ -249,7 +276,6 @@ title: "[P] JS API" - [UsageTracker](interfaces/UsageTracker.md) - [UsingStatementNode](interfaces/UsingStatementNode.md) - [ValueOfExpressionNode](interfaces/ValueOfExpressionNode.md) -- [ValueType](interfaces/ValueType.md) - [VoidKeywordNode](interfaces/VoidKeywordNode.md) - [VoidType](interfaces/VoidType.md) @@ -284,7 +310,9 @@ title: "[P] JS API" - [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) @@ -317,6 +345,7 @@ title: "[P] JS API" - [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) @@ -333,6 +362,7 @@ title: "[P] JS API" - [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 @@ -385,10 +415,12 @@ title: "[P] JS API" - [$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) @@ -406,12 +438,13 @@ title: "[P] JS API" - [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) +- [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) @@ -429,9 +462,9 @@ title: "[P] JS API" - [getDiscriminator](functions/getDiscriminator.md) - [getDoc](functions/getDoc.md) - [getDocData](functions/getDocData.md) -- [getDocDataInternal](functions/getDocDataInternal.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) @@ -444,15 +477,24 @@ title: "[P] JS API" - [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) @@ -505,6 +547,7 @@ title: "[P] JS API" - [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) @@ -519,9 +562,11 @@ title: "[P] JS API" - [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) @@ -539,19 +584,23 @@ title: "[P] JS API" - [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) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md index 86fc6406c1..330c319129 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AliasStatementNode.md @@ -13,13 +13,14 @@ title: "[I] AliasStatementNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index be314414d2..aca32333db 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AnyKeywordNode.md @@ -13,9 +13,9 @@ title: "[I] AnyKeywordNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 8fe9d88aa2..40416ef50d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayExpressionNode.md @@ -14,9 +14,9 @@ title: "[I] ArrayExpressionNode" | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 0000000000..5d640900b2 --- /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 index 46cff03c48..952505395c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ArrayModelType.md @@ -9,29 +9,30 @@ title: "[I] ArrayModelType" ## 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` | +| 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 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 0000000000..b5fe7f4137 --- /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 index 8c4fc5910e..bc54dc3a87 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/AugmentDecoratorStatementNode.md @@ -14,11 +14,11 @@ title: "[I] AugmentDecoratorStatementNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 58834d4857..f6837fc6a1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseNode.md @@ -7,15 +7,109 @@ title: "[I] BaseNode" - [`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` | +| `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. | - | +| `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 index ef593435c0..fb915a8183 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BaseType.md @@ -11,6 +11,7 @@ title: "[I] BaseType" - [`Model`](Model.md) - [`ModelProperty`](ModelProperty.md) - [`Scalar`](Scalar.md) +- [`ScalarConstructor`](ScalarConstructor.md) - [`Interface`](Interface.md) - [`Enum`](Enum.md) - [`EnumMember`](EnumMember.md) @@ -28,19 +29,20 @@ title: "[I] BaseType" - [`TemplateParameter`](TemplateParameter.md) - [`Decorator`](Decorator.md) - [`FunctionType`](FunctionType.md) -- [`FunctionParameter`](FunctionParameter.md) +- [`FunctionParameterBase`](FunctionParameterBase.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) | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md index f3d222ac8c..630a54d756 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BlockComment.md @@ -11,7 +11,7 @@ title: "[I] BlockComment" | 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` | +| `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` | +| `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 index 0187d5657b..3b01934fc9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteral.md @@ -9,16 +9,17 @@ title: "[I] BooleanLiteral" ## 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` | - | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md index 8b289407be..2f8ec848b0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/BooleanLiteralNode.md @@ -13,10 +13,10 @@ title: "[I] BooleanLiteralNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 0000000000..41784e7a5e --- /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 0000000000..3c4b4058ae --- /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 index 2f2498273c..1ed513dcd0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CallableMessage.md @@ -7,7 +7,7 @@ title: "[I] CallableMessage" | Type parameter | | :------ | -| `T` extends `string`[] | +| `T` *extends* `string`[] | ```ts interface CallableMessage(dict): string diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md index 02a67c4341..e2e74af750 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Checker.md @@ -5,13 +5,14 @@ title: "[I] Checker" --- ## Properties -| Property | Type | -| :------ | :------ | -| `anyType` | [`UnknownType`](UnknownType.md) | -| `errorType` | [`ErrorType`](ErrorType.md) | -| `neverType` | [`NeverType`](NeverType.md) | -| `typePrototype` | `TypePrototype` | -| `voidType` | [`VoidType`](VoidType.md) | +| 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 @@ -55,14 +56,14 @@ cloneType(type, additionalProps?): T | Type parameter | | :------ | -| `T` extends [`Type`](../type-aliases/Type.md) | +| `T` *extends* [`Type`](../type-aliases/Type.md) | #### Parameters | Parameter | Type | | :------ | :------ | | `type` | `T` | -| `additionalProps`? | `{ [P in string | number | symbol]?: T[P] }` | +| `additionalProps`? | \{ \[P in string \| number \| symbol\]?: T\[P\] \} | #### Returns @@ -80,7 +81,7 @@ createAndFinishType(typeDef): T & TypePrototype | Type parameter | | :------ | -| `T` extends [`CreateTypeProps`](../type-aliases/CreateTypeProps.md) | +| `T` *extends* [`CreateTypeProps`](../type-aliases/CreateTypeProps.md) | #### Parameters @@ -168,7 +169,7 @@ createLiteralType(value, node?): BooleanLiteral #### createLiteralType(value, node) ```ts -createLiteralType(value, node?): StringLiteral | NumericLiteral | BooleanLiteral +createLiteralType(value, node?): BooleanLiteral | NumericLiteral | StringLiteral ``` ##### Parameters @@ -180,12 +181,12 @@ createLiteralType(value, node?): StringLiteral | NumericLiteral | BooleanLiteral ##### Returns -[`StringLiteral`](StringLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`BooleanLiteral`](BooleanLiteral.md) +[`BooleanLiteral`](BooleanLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`StringLiteral`](StringLiteral.md) #### createLiteralType(value, node) ```ts -createLiteralType(value, node?): StringLiteral | NumericLiteral | BooleanLiteral +createLiteralType(value, node?): BooleanLiteral | NumericLiteral | StringLiteral ``` ##### Parameters @@ -197,21 +198,21 @@ createLiteralType(value, node?): StringLiteral | NumericLiteral | BooleanLiteral ##### Returns -[`StringLiteral`](StringLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`BooleanLiteral`](BooleanLiteral.md) +[`BooleanLiteral`](BooleanLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) \| [`StringLiteral`](StringLiteral.md) *** ### createType() ```ts -createType(typeDef): T & TypePrototype & Object +createType(typeDef): T & TypePrototype & object ``` #### Type parameters | Type parameter | | :------ | -| `T` extends [`CreateTypeProps`](../type-aliases/CreateTypeProps.md) | +| `T` *extends* [`CreateTypeProps`](../type-aliases/CreateTypeProps.md) | #### Parameters @@ -221,7 +222,7 @@ createType(typeDef): T & TypePrototype & Object #### Returns -`T` & `TypePrototype` & `Object` +`T` & `TypePrototype` & `object` *** @@ -258,7 +259,7 @@ finishType(typeDef): T | Type parameter | | :------ | -| `T` extends [`Type`](../type-aliases/Type.md) | +| `T` *extends* [`Type`](../type-aliases/Type.md) | #### Parameters @@ -417,7 +418,7 @@ Std type | Type parameter | | :------ | -| `T` extends [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| `"Array"` \| `"Record"` | +| `T` *extends* `"Array"` \| [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| `"Record"` | #### Parameters @@ -504,7 +505,7 @@ isStdType(type, stdType?): type is Type & Object | Parameter | Type | | :------ | :------ | | `type` | [`Type`](../type-aliases/Type.md) | -| `stdType`? | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| `"Array"` \| `"Record"` | +| `stdType`? | `"Array"` \| [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| `"Record"` | ##### Returns @@ -527,8 +528,8 @@ Check if the source type can be assigned to the target type. | 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 | +| `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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md index c2614061df..d9cbaeceb4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerHost.md @@ -232,7 +232,7 @@ Deletes a directory or file. ### stat() ```ts -stat(path): Promise +stat(path): Promise ``` #### Parameters @@ -243,13 +243,12 @@ stat(path): Promise #### Returns -`Promise`<`Object`\> +`Promise`<`object`\> -> | Member | Type | -> | :------ | :------ | -> | `isDirectory` | `boolean` | -> | `isFile` | `boolean` | -> +| Member | Type | +| :------ | :------ | +| `isDirectory` | `boolean` | +| `isFile` | `boolean` | *** diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md index 0850e9c398..de4f917014 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerLocationContext.md @@ -7,6 +7,6 @@ Built-in ## Properties -| Property | Type | -| :------ | :------ | -| `type` | `"compiler"` | +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `type` | `readonly` | `"compiler"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md index cc46a90fa1..7e4750b127 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/CompilerOptions.md @@ -9,17 +9,17 @@ title: "[I] CompilerOptions" | :------ | :------ | :------ | | `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. | +| `designTimeBuild?` | `boolean` | When true, indicates that a compilation is being performed for live analysis in the language server. | | `emit?` | `string`[] | List or path to emitters to use. | -| ~~`emitters?`~~ | `Record`<`string`, `EmitterOptions`\> | **Deprecated**
use [emit](CompilerOptions.md) and [options](CompilerOptions.md) instead.

Will be removed in March 2022 sprint. | +| ~~`emitters?`~~ | `Record`<`string`, `EmitterOptions`\> |

**Deprecated**

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

Will be removed in March 2022 sprint.

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

**Default**
` ./tsp-output ` | -| ~~`outputPath?`~~ | `string` | **Deprecated**
use outputDir. | +| `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 0000000000..42af8d2e2a --- /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 index 66e164e878..0f3773e91f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DeclarationNode.md @@ -14,6 +14,7 @@ title: "[I] DeclarationNode" - [`UnionStatementNode`](UnionStatementNode.md) - [`EnumStatementNode`](EnumStatementNode.md) - [`AliasStatementNode`](AliasStatementNode.md) +- [`ConstStatementNode`](ConstStatementNode.md) - [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md) - [`DecoratorDeclarationStatementNode`](DecoratorDeclarationStatementNode.md) - [`FunctionDeclarationStatementNode`](FunctionDeclarationStatementNode.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md index 4a77e8572e..08bcd73352 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Decorator.md @@ -9,20 +9,21 @@ title: "[I] Decorator" ## 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) | - | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md index 1b43175dc5..ad6bdb06d2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md @@ -7,6 +7,6 @@ title: "[I] DecoratorArgument" | Property | Type | Description | | :------ | :------ | :------ | -| `jsValue` | `string` \| `number` \| `boolean` \| [`Type`](../type-aliases/Type.md) | Marshalled value for use in Javascript. | +| `jsValue` | \| `null` \| `string` \| `number` \| `boolean` \| `unknown`[] \| [`Numeric`](Numeric.md) \| [`Type`](../type-aliases/Type.md) \| `Record`<`string`, `unknown`\> \| [`Value`](../type-aliases/Value.md) | Marshalled value for use in Javascript. | | `node?` | [`Node`](../type-aliases/Node.md) | - | -| `value` | [`Type`](../type-aliases/Type.md) | - | +| `value` | [`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md index 67203ee950..6e77e12bab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorContext.md @@ -27,8 +27,8 @@ Helper to call out to another decorator | Type parameter | | :------ | -| `T` extends [`Type`](../type-aliases/Type.md) | -| `A` extends `any`[] | +| `T` *extends* [`Type`](../type-aliases/Type.md) | +| `A` *extends* `any`[] | | `R` | #### Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md index aef40fd244..c02dafc1ed 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDeclarationStatementNode.md @@ -21,7 +21,7 @@ extern dec doc(target: Type, value: valueof string); | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | @@ -29,6 +29,6 @@ extern dec doc(target: Type, value: valueof string); | `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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 76a1e932f8..9a5a4aa87a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorDefinition.md @@ -7,9 +7,9 @@ title: "[I] DecoratorDefinition" | 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` | +| `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 @@ -17,5 +17,5 @@ title: "[I] DecoratorDefinition" | :------ | :------ | :------ | :------ | | `args` | `readonly` | `P` | List of positional arguments in the function. | | `name` | `readonly` | `string` | Name of the decorator. | -| `spreadArgs?` | `readonly` | `S` | **Optional**
Type of the spread args at the end of the function if applicable. | +| `spreadArgs?` | `readonly` | `S` |

**Optional**

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

| | `target` | `readonly` | `T` \| readonly `T`[] | Decorator target. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md index 8a83fe508c..4fd36fb758 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorExpressionNode.md @@ -14,10 +14,10 @@ title: "[I] DecoratorExpressionNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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/DecoratorParamDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md index b23a5acaaf..cefc0a69a8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorParamDefinition.md @@ -7,7 +7,7 @@ title: "[I] DecoratorParamDefinition" | Type parameter | | :------ | -| `K` extends [`TypeKind`](../type-aliases/TypeKind.md) | +| `K` *extends* [`TypeKind`](../type-aliases/TypeKind.md) | ## Properties diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md index 323a428f3f..2c1b7f3d14 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorValidator.md @@ -7,9 +7,9 @@ title: "[I] DecoratorValidator" | 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` | +| `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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md index 8a84c03b52..8f1d81e00e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticCreator.md @@ -7,7 +7,7 @@ title: "[I] DiagnosticCreator" | Type parameter | | :------ | -| `T` extends `Object` | +| `T` *extends* `object` | ## Properties @@ -28,8 +28,8 @@ createDiagnostic(diag): Diagnostic | Type parameter | Value | | :------ | :------ | -| `C` extends `string` \| `number` \| `symbol` | - | -| `M` extends `string` \| `number` \| `symbol` | `"default"` | +| `C` *extends* `string` \| `number` \| `symbol` | - | +| `M` *extends* `string` \| `number` \| `symbol` | `"default"` | #### Parameters @@ -53,8 +53,8 @@ reportDiagnostic(program, diag): void | Type parameter | Value | | :------ | :------ | -| `C` extends `string` \| `number` \| `symbol` | - | -| `M` extends `string` \| `number` \| `symbol` | `"default"` | +| `C` *extends* `string` \| `number` \| `symbol` | - | +| `M` *extends* `string` \| `number` \| `symbol` | `"default"` | #### Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md index add275838f..566044675e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md @@ -7,7 +7,7 @@ title: "[I] DiagnosticDefinition" | Type parameter | | :------ | -| `M` extends [`DiagnosticMessages`](DiagnosticMessages.md) | +| `M` *extends* [`DiagnosticMessages`](DiagnosticMessages.md) | ## Properties diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md index d44d2cbe35..b63abe9c8a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DirectiveExpressionNode.md @@ -14,10 +14,10 @@ title: "[I] DirectiveExpressionNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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/Discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Discriminator.md index 6aa4d020ba..a8f1b0c5e7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Discriminator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Discriminator.md @@ -5,6 +5,6 @@ title: "[I] Discriminator" --- ## Properties -| Property | Type | -| :------ | :------ | -| `propertyName` | `string` | +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `propertyName` | `readonly` | `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 f5b48178f0..0000000000 --- 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 index 057467e38a..e4bdffb828 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocErrorsTagNode.md @@ -14,10 +14,10 @@ title: "[I] DocErrorsTagNode" | `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` | +| `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` | +| `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 index 6cddb757c4..f93cf31293 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocNode.md @@ -14,10 +14,10 @@ title: "[I] DocNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 44ed673b41..07ee121f97 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocParamTagNode.md @@ -14,11 +14,11 @@ title: "[I] DocParamTagNode" | `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` | +| `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` | +| `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 0000000000..60381d7a2d --- /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 index 927f9c0d47..9e707d65db 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocReturnsTagNode.md @@ -14,10 +14,10 @@ title: "[I] DocReturnsTagNode" | `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` | +| `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` | +| `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 index abd1a9ad79..fcf7fcd34d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTagBaseNode.md @@ -7,6 +7,15 @@ title: "[I] DocTagBaseNode" - [`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 | @@ -14,10 +23,10 @@ title: "[I] DocTagBaseNode" | `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` | +| `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` | +| `pos` | `readonly` | `number` | 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 index 8b31fbd14e..dcd53f3be6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTemplateTagNode.md @@ -14,11 +14,11 @@ title: "[I] DocTemplateTagNode" | `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` | +| `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` | +| `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 index eda08bf926..a8af628fab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocTextNode.md @@ -13,10 +13,10 @@ title: "[I] DocTextNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index a6663f5d29..ac5e0bd470 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DocUnknownTagNode.md @@ -14,10 +14,10 @@ title: "[I] DocUnknownTagNode" | `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` | +| `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` | +| `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 index 4a499946d3..e7dcc0a6d3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmitContext.md @@ -7,7 +7,7 @@ title: "[I] EmitContext" | Type parameter | Value | | :------ | :------ | -| `TOptions` extends `object` | `Record`<`string`, `never`\> | +| `TOptions` *extends* `object` | `Record`<`string`, `never`\> | ## Properties diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md index c81663646a..fc9ff60ba1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EmptyStatementNode.md @@ -13,9 +13,9 @@ title: "[I] EmptyStatementNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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/Enum.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md index edc9b7c2f1..99b447442a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Enum.md @@ -9,19 +9,20 @@ title: "[I] Enum" ## 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` | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md index 981ee9fcfc..c44756b0f8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMember.md @@ -9,20 +9,21 @@ title: "[I] EnumMember" ## 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` | - | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md index cdfd58db3e..d6de42707f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumMemberNode.md @@ -14,11 +14,11 @@ title: "[I] EnumMemberNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 3b14c528cd..f10bc53762 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumSpreadMemberNode.md @@ -13,10 +13,10 @@ title: "[I] EnumSpreadMemberNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index d99638407a..e908244661 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/EnumStatementNode.md @@ -14,11 +14,11 @@ title: "[I] EnumStatementNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 0000000000..f15bc40703 --- /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 index b762058f77..8e205cd693 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ErrorType.md @@ -9,16 +9,17 @@ title: "[I] ErrorType" ## 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` | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md index 07dd80d00a..171e434524 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ExternKeywordNode.md @@ -13,9 +13,9 @@ title: "[I] ExternKeywordNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 4c6209c527..3da19853aa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FileLibraryMetadata.md @@ -11,7 +11,7 @@ title: "[I] FileLibraryMetadata" | Property | Type | Description | Inherited from | | :------ | :------ | :------ | :------ | -| `bugs?` | `Object` | - | `LibraryMetadataBase.bugs` | +| `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. | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md index 488c6f1ca2..f5845ab0d0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionDeclarationStatementNode.md @@ -21,7 +21,7 @@ extern fn camelCase(value: StringLiteral): StringLiteral; | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | @@ -29,6 +29,6 @@ extern fn camelCase(value: StringLiteral): StringLiteral; | `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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 c48b11e6d1..0000000000 --- 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/FunctionParameterBase.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterBase.md new file mode 100644 index 0000000000..2064ffc4d5 --- /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 index 516735a4f0..f776e5dcd3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionParameterNode.md @@ -13,13 +13,13 @@ title: "[I] FunctionParameterNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index 81da8d113f..6cb650d8e8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/FunctionType.md @@ -9,20 +9,21 @@ title: "[I] FunctionType" ## 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) | - | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md index 43f918aff6..fcb2775bdf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IdentifierNode.md @@ -13,10 +13,10 @@ title: "[I] IdentifierNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index 3fbeb476d4..15f2a1b662 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ImportStatementNode.md @@ -13,10 +13,10 @@ title: "[I] ImportStatementNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 0000000000..6a395ba5f7 --- /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/Interface.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md index 0c368032c9..688fafb8be 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Interface.md @@ -9,23 +9,24 @@ title: "[I] Interface" ## 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` | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md index 0fff74c389..916826896c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InterfaceStatementNode.md @@ -11,10 +11,11 @@ title: "[I] InterfaceStatementNode" | 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` | +| `end` | `readonly` | `number` | The 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` | @@ -22,6 +23,7 @@ title: "[I] InterfaceStatementNode" | `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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 48161ccbb2..8d2bec36a1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntersectionExpressionNode.md @@ -13,10 +13,10 @@ title: "[I] IntersectionExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 17820088b6..2ed0d199a8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md @@ -7,18 +7,27 @@ title: "[I] IntrinsicType" - [`BaseType`](BaseType.md) +## Extended by + +- [`ErrorType`](ErrorType.md) +- [`VoidType`](VoidType.md) +- [`NeverType`](NeverType.md) +- [`UnknownType`](UnknownType.md) +- [`NullType`](NullType.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` | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md index 02ee2b1857..370ca1e367 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/InvalidStatementNode.md @@ -14,9 +14,9 @@ title: "[I] InvalidStatementNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index ca3f1c3143..bfc30cd892 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsNamespaceDeclarationNode.md @@ -13,10 +13,10 @@ title: "[I] JsNamespaceDeclarationNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index b8f8e53b76..19a0394b9f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/JsSourceFileNode.md @@ -13,7 +13,7 @@ title: "[I] JsSourceFileNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | @@ -21,5 +21,5 @@ title: "[I] JsSourceFileNode" | `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` | +| `pos` | `readonly` | `number` | The starting position of 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 index dce6dbb783..b13e6c72c1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryInstance.md @@ -9,6 +9,6 @@ title: "[I] LibraryInstance" | :------ | :------ | | `definition?` | [`TypeSpecLibrary`](TypeSpecLibrary.md)<`any`, `Record`<`string`, `never`\>, `never`\> | | `entrypoint` | `undefined` \| [`JsSourceFileNode`](JsSourceFileNode.md) | -| `linter` | [`LinterDefinition`](LinterDefinition.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 index d5743bd0c0..2f739d4c06 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LibraryLocationContext.md @@ -7,7 +7,8 @@ Defined in a library. ## Properties -| Property | Type | -| :------ | :------ | -| `metadata` | [`ModuleLibraryMetadata`](ModuleLibraryMetadata.md) | -| `type` | `"library"` | +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `flags?` | `readonly` | [`PackageFlags`](PackageFlags.md) | Module definition | +| `metadata` | `readonly` | [`ModuleLibraryMetadata`](ModuleLibraryMetadata.md) | Library metadata | +| `type` | `readonly` | `"library"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md index 908afd3e56..ca73a889b9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineAndCharacter.md @@ -10,5 +10,5 @@ beginning of line. | Property | Type | Description | | :------ | :------ | :------ | -| `character` | `number` | The offset in UTF-16 code units to the character from the beginning of the
line. 0-based.

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

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

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

| | `line` | `number` | The line number. 0-based. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md index 2e39f3502c..2fd85e4f2f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LineComment.md @@ -11,6 +11,6 @@ title: "[I] LineComment" | 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` | +| `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` | +| `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/LinterResolvedDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterResolvedDefinition.md new file mode 100644 index 0000000000..e370e6f072 --- /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 index 6f21a3b67b..58739acdc7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRule.md @@ -13,8 +13,8 @@ Resolved instance of a linter rule that will run. | Type parameter | | :------ | -| `N` extends `string` | -| `DM` extends [`DiagnosticMessages`](DiagnosticMessages.md) | +| `N` *extends* `string` | +| `DM` *extends* [`DiagnosticMessages`](DiagnosticMessages.md) | ## Properties diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md index 9c3c5f00a9..fb55259007 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleContext.md @@ -7,7 +7,7 @@ title: "[I] LinterRuleContext" | Type parameter | | :------ | -| `DM` extends [`DiagnosticMessages`](DiagnosticMessages.md) | +| `DM` *extends* [`DiagnosticMessages`](DiagnosticMessages.md) | ## Properties @@ -27,7 +27,7 @@ reportDiagnostic(diag): void | Type parameter | | :------ | -| `M` extends `string` \| `number` \| `symbol` | +| `M` *extends* `string` \| `number` \| `symbol` | #### Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md index 609a555a9e..750591acd8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleDefinition.md @@ -11,8 +11,8 @@ title: "[I] LinterRuleDefinition" | Type parameter | | :------ | -| `N` extends `string` | -| `DM` extends [`DiagnosticMessages`](DiagnosticMessages.md) | +| `N` *extends* `string` | +| `DM` *extends* [`DiagnosticMessages`](DiagnosticMessages.md) | ## Properties diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md index 2c2e36aab3..3f2028a16e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterRuleSet.md @@ -7,6 +7,6 @@ title: "[I] LinterRuleSet" | Property | Type | Description | | :------ | :------ | :------ | -| `disable?` | `Record`<\`${string}/${string}\`, `string`\> | Rules to disable. A rule CANNOT be in enable and disable map. | -| `enable?` | `Record`<\`${string}/${string}\`, `boolean`\> | Rules to enable/configure | -| `extends?` | \`${string}/${string}\`[] | Other ruleset this ruleset extends | +| `disable?` | `Record`<\`$\{string\}/$\{string\}\`, `string`\> | Rules to disable. A rule CANNOT be in enable and disable map. | +| `enable?` | `Record`<\`$\{string\}/$\{string\}\`, `boolean`\> | Rules to enable/configure | +| `extends?` | \`$\{string\}/$\{string\}\`[] | Other ruleset this ruleset extends | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md index 4a1dc0f60b..a979bc00e3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ListOperationOptions.md @@ -7,4 +7,4 @@ title: "[I] ListOperationOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `recursive?` | `boolean` | If the container is a namespace look for operation in sub namespaces.

**Default**
` true ` | +| `recursive?` | `boolean` |

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

**Default**

true | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md index ee5c2ef11a..7c6dfca8c1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/MemberExpressionNode.md @@ -14,11 +14,11 @@ title: "[I] MemberExpressionNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 0000000000..ab70b496e7 --- /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 0000000000..fb1ef97a31 --- /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 index 694e434aec..e2014613c2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Model.md @@ -7,29 +7,35 @@ title: "[I] Model" - [`BaseType`](BaseType.md).[`DecoratedType`](DecoratedType.md).[`TemplatedTypeBase`](TemplatedTypeBase.md) +## Extended by + +- [`ArrayModelType`](ArrayModelType.md) +- [`RecordModelType`](RecordModelType.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` | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md index 2a4767340a..60f3a011cb 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelExpressionNode.md @@ -11,12 +11,13 @@ title: "[I] ModelExpressionNode" | 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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index c9f81fd7d7..ab8f5ef647 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelProperty.md @@ -9,22 +9,24 @@ title: "[I] ModelProperty" ## 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) | - | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md index 56af32b0a9..5b80206bf8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelPropertyNode.md @@ -15,12 +15,12 @@ title: "[I] ModelPropertyNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index f293f5ec28..d8dc2254d4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelSpreadPropertyNode.md @@ -13,10 +13,10 @@ title: "[I] ModelSpreadPropertyNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index d15df4d3ab..93527ecef5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModelStatementNode.md @@ -11,10 +11,11 @@ title: "[I] ModelStatementNode" | 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` | +| `end` | `readonly` | `number` | The 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` | @@ -22,7 +23,8 @@ title: "[I] ModelStatementNode" | `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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index e3b3a3a614..2f15167be4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModuleLibraryMetadata.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ModuleLibraryMetadata.md @@ -11,11 +11,11 @@ Data for a library. Either loaded via a node_modules package or a standalone js ## 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` | +| 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 index d9fb6c8af0..2a8afb25c0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Namespace.md @@ -9,27 +9,28 @@ title: "[I] Namespace" ## 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. | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md index 4f2055ad12..416c53c787 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceNavigationOptions.md @@ -7,4 +7,4 @@ title: "[I] NamespaceNavigationOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `skipSubNamespaces?` | `boolean` | Recursively navigate sub namespaces.

**Default**
` false ` | +| `skipSubNamespaces?` | `boolean` |

Recursively navigate sub namespaces.

**Default**

false | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md index 2dc40c4f31..739305e13b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NamespaceStatementNode.md @@ -14,12 +14,12 @@ title: "[I] NamespaceStatementNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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/NeverKeywordNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md index 7103f6dde0..2e77691957 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverKeywordNode.md @@ -13,9 +13,9 @@ title: "[I] NeverKeywordNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index b469ae9d44..0428294482 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NeverType.md @@ -9,16 +9,17 @@ title: "[I] NeverType" ## 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` | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md index 04a16ff7a5..89743a77d1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md @@ -9,7 +9,7 @@ Type for package.json https://docs.npmjs.com/cli/v8/configuring-npm/package-json | Property | Type | | :------ | :------ | -| `bugs?` | `Object` | +| `bugs?` | `object` | | `bugs.email?` | `string` | | `bugs.url?` | `string` | | `dependencies?` | `Record`<`string`, `string`\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md index d01ad0ad94..50b8c022fa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NullType.md @@ -9,16 +9,17 @@ title: "[I] NullType" ## 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` | +| 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 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 0000000000..c30784c068 --- /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 0000000000..0dbe9eb316 --- /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 index 285c7e35ce..7e17af5c52 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteral.md @@ -9,17 +9,19 @@ title: "[I] NumericLiteral" ## 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` | - | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md index 8106820728..802bc7bf0d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NumericLiteralNode.md @@ -13,11 +13,11 @@ title: "[I] NumericLiteralNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 0000000000..b641c2c85e --- /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 0000000000..0673dc47b1 --- /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 0000000000..44ff6c491b --- /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 0000000000..4b48f6a4dc --- /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 index 1eea717813..d39584abde 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ObjectType.md @@ -9,16 +9,17 @@ title: "[I] ObjectType" ## 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)\> | - | - | - | +| 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 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 0000000000..2516734bc9 --- /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 0000000000..8ee7f9bd10 --- /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 index 69dfe0359d..c390463345 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Operation.md @@ -9,25 +9,26 @@ title: "[I] Operation" ## 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` | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md index a54b113cbb..1dca2600e2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureDeclarationNode.md @@ -13,11 +13,11 @@ title: "[I] OperationSignatureDeclarationNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index 802b650839..e5eb7641b3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationSignatureReferenceNode.md @@ -14,9 +14,9 @@ title: "[I] OperationSignatureReferenceNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 18a9fea866..ea4fceb8ef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/OperationStatementNode.md @@ -14,13 +14,14 @@ title: "[I] OperationStatementNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 0000000000..06b88bf172 --- /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/PositionDetail.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PositionDetail.md new file mode 100644 index 0000000000..a584105f18 --- /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/ProjectLocationContext.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md index 7af9129aa4..8937430ee8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectLocationContext.md @@ -7,6 +7,7 @@ Defined in the user project. ## Properties -| Property | Type | -| :------ | :------ | -| `type` | `"project"` | +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `flags?` | `readonly` | [`PackageFlags`](PackageFlags.md) | +| `type` | `readonly` | `"project"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md index 88f746a0e7..ff84e67f18 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedNameView.md @@ -24,7 +24,7 @@ If there is a projected name it returns that one otherwise return the original n | Parameter | Type | | :------ | :------ | -| `target` | [`Type`](../type-aliases/Type.md) & `Object` | +| `target` | [`Type`](../type-aliases/Type.md) & `object` | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md index e23357c04a..1be376e9e5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projection.md @@ -9,17 +9,18 @@ title: "[I] Projection" ## 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` | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md index 9c264d6c89..761bd7f3d4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md @@ -13,12 +13,12 @@ title: "[I] ProjectionArithmeticExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | `"/"` \| `"+"` \| `"-"` \| `"*"` | - | - | - | +| `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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index 81a0a2ab9d..bbdd2f0264 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionBlockExpressionNode.md @@ -13,10 +13,10 @@ title: "[I] ProjectionBlockExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index 5f226aa151..ffd2450b6f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionCallExpressionNode.md @@ -15,10 +15,10 @@ title: "[I] ProjectionCallExpressionNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index d118fae810..e5de9f0f9c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionDecoratorReferenceExpressionNode.md @@ -13,10 +13,10 @@ title: "[I] ProjectionDecoratorReferenceExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 1b629b18cc..c81e1ae310 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumMemberSelectorNode.md @@ -13,9 +13,9 @@ title: "[I] ProjectionEnumMemberSelectorNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index b0b4984bdd..1b7f510b3d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEnumSelectorNode.md @@ -13,9 +13,9 @@ title: "[I] ProjectionEnumSelectorNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 9bd4c0bb8e..59692aa29a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionEqualityExpressionNode.md @@ -13,12 +13,12 @@ title: "[I] ProjectionEqualityExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index e5f88227c6..979a244e8f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionExpressionStatementNode.md @@ -13,10 +13,10 @@ title: "[I] ProjectionExpressionStatementNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 376b5df32f..c5a8804c0a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionIfExpressionNode.md @@ -15,10 +15,10 @@ title: "[I] ProjectionIfExpressionNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index a6b1941cda..9b6aceea93 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionInterfaceSelectorNode.md @@ -13,9 +13,9 @@ title: "[I] ProjectionInterfaceSelectorNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 02211cc71d..a37a984ae8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaExpressionNode.md @@ -14,11 +14,11 @@ title: "[I] ProjectionLambdaExpressionNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 83d687378a..bb4ef90507 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLambdaParameterDeclarationNode.md @@ -13,10 +13,10 @@ title: "[I] ProjectionLambdaParameterDeclarationNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index bf7fc4535e..d4405dda1e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionLogicalExpressionNode.md @@ -13,12 +13,12 @@ title: "[I] ProjectionLogicalExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | `"||"` \| `"&&"` | - | - | - | +| `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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index e248552f0c..5fb330f96a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionMemberExpressionNode.md @@ -14,11 +14,11 @@ title: "[I] ProjectionMemberExpressionNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index d60c95d4be..1fba7bdc11 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelExpressionNode.md @@ -13,10 +13,10 @@ title: "[I] ProjectionModelExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index 4e472b856b..7e45d475f8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertyNode.md @@ -15,12 +15,12 @@ title: "[I] ProjectionModelPropertyNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 2041065856..884f03bae5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelPropertySelectorNode.md @@ -13,9 +13,9 @@ title: "[I] ProjectionModelPropertySelectorNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 71c9a72db8..5254bb2d55 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSelectorNode.md @@ -13,9 +13,9 @@ title: "[I] ProjectionModelSelectorNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index dd7c508c89..3add21a13a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionModelSpreadPropertyNode.md @@ -13,10 +13,10 @@ title: "[I] ProjectionModelSpreadPropertyNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index a75ecb31cb..3421ce4f22 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionNode.md @@ -16,12 +16,12 @@ title: "[I] ProjectionNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 497f82f83e..74e9357218 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionOperationSelectorNode.md @@ -13,9 +13,9 @@ title: "[I] ProjectionOperationSelectorNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 97decac28e..13ca83ed9e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionParameterDeclarationNode.md @@ -13,10 +13,10 @@ title: "[I] ProjectionParameterDeclarationNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 7e33de94c9..43a3b47bfe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionReferenceNode.md @@ -14,10 +14,10 @@ title: "[I] ProjectionReferenceNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 5aad292a12..8fbb0a7a89 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionRelationalExpressionNode.md @@ -13,12 +13,12 @@ title: "[I] ProjectionRelationalExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index 9ec87e3436..b93e0b8320 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md @@ -13,9 +13,9 @@ title: "[I] ProjectionScalarSelectorNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index eae20bc8cc..2d47c39373 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md @@ -13,16 +13,16 @@ title: "[I] ProjectionStatementNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index 2e5f14d824..8b689cb99e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionTupleExpressionNode.md @@ -13,10 +13,10 @@ title: "[I] ProjectionTupleExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index e7542f01c0..4d8026e04b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnaryExpressionNode.md @@ -13,11 +13,11 @@ title: "[I] ProjectionUnaryExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 3f1d145652..29ba0e4fd7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionSelectorNode.md @@ -13,9 +13,9 @@ title: "[I] ProjectionUnionSelectorNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 90c3333529..b7569f2104 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionUnionVariantSelectorNode.md @@ -13,9 +13,9 @@ title: "[I] ProjectionUnionVariantSelectorNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 368b089f1e..814cc63b75 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Projector.md @@ -18,15 +18,15 @@ title: "[I] Projector" ### projectType() ```ts -projectType(type): Type +projectType(type): Type | Value ``` #### Parameters | Parameter | Type | | :------ | :------ | -| `type` | [`Type`](../type-aliases/Type.md) | +| `type` | [`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) | #### Returns -[`Type`](../type-aliases/Type.md) +[`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 index 00c4902600..e73fe72a14 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RecordModelType.md @@ -9,29 +9,30 @@ title: "[I] RecordModelType" ## 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` | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md index 8ddf533238..a647bd00e9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReplaceTextCodeFixEdit.md @@ -11,8 +11,8 @@ title: "[I] ReplaceTextCodeFixEdit" | 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` | +| `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` | +| `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/ResolveModuleHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md index 7add06b0d4..7bb7f4514f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleHost.md @@ -48,7 +48,7 @@ Resolve the real path for the current host. ### stat() ```ts -stat(path): Promise +stat(path): Promise ``` Get information about the given path @@ -61,10 +61,9 @@ Get information about the given path #### Returns -`Promise`<`Object`\> +`Promise`<`object`\> -> | Member | Type | -> | :------ | :------ | -> | `isDirectory` | `boolean` | -> | `isFile` | `boolean` | -> +| 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 index 319217c4a4..b8261b73c1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md @@ -8,5 +8,5 @@ title: "[I] ResolveModuleOptions" | Property | Type | Description | | :------ | :------ | :------ | | `baseDir` | `string` | - | -| `directoryIndexFiles?` | `string`[] | When resolution reach a directory without package.json look for those files to load in order.

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

**Default**
` pkg.main ` | +| `directoryIndexFiles?` | `string`[] |

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

**Default**

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

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

**Default**

pkg.main | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md index 16f4566764..e4ea2b1ec1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ReturnExpressionNode.md @@ -13,10 +13,10 @@ title: "[I] ReturnExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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/RmOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md index 24a6d3dd98..56d73f5c06 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/RmOptions.md @@ -7,4 +7,4 @@ title: "[I] RmOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `recursive?` | `boolean` | If `true`, perform a recursive directory removal. In
recursive mode, errors are not reported if `path` does not exist, and
operations are retried on failure.

**Default**
` false ` | +| `recursive?` | `boolean` |

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

**Default**

false | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md index 63b250838d..bcfbbc8745 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Scalar.md @@ -9,23 +9,25 @@ title: "[I] Scalar" ## 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` | +| 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 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 0000000000..fbeaa0e2d1 --- /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 0000000000..8702497969 --- /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 index 3b2bd32a8f..f4fd7c6a62 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ScalarStatementNode.md @@ -11,16 +11,19 @@ title: "[I] ScalarStatementNode" | 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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 0000000000..30cba84bb1 --- /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/Server.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md index c2c3d036e2..13ac805166 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Server.md @@ -7,7 +7,7 @@ title: "[I] Server" | Property | Modifier | Type | | :------ | :------ | :------ | -| `pendingMessages` | `readonly` | readonly `string`[] | +| `pendingMessages` | `readonly` | readonly [`ServerLog`](ServerLog.md)[] | | `workspaceFolders` | `readonly` | readonly [`ServerWorkspaceFolder`](ServerWorkspaceFolder.md)[] | ## Methods @@ -339,15 +339,14 @@ initialized(params): void ### log() ```ts -log(message, details?): void +log(log): void ``` #### Parameters | Parameter | Type | | :------ | :------ | -| `message` | `string` | -| `details`? | `any` | +| `log` | [`ServerLog`](ServerLog.md) | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md index 5de1b74967..0ee0da2fab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerHost.md @@ -10,6 +10,6 @@ title: "[I] ServerHost" | `applyEdit` | `readonly` | (`paramOrEdit`: `WorkspaceEdit` \| `ApplyWorkspaceEditParams`) => `Promise`<`ApplyWorkspaceEditResult`\> | | `compilerHost` | `readonly` | [`CompilerHost`](CompilerHost.md) | | `getOpenDocumentByURL` | `readonly` | (`url`: `string`) => `undefined` \| `TextDocument` | -| `log` | `readonly` | (`message`: `string`) => `void` | +| `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 0000000000..9fc1806b8f --- /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 index 2c9511b6c5..4fa14fb063 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerSourceFile.md @@ -12,7 +12,7 @@ title: "[I] ServerSourceFile" | Property | Modifier | Type | Description | Inherited from | | :------ | :------ | :------ | :------ | :------ | | `document?` | `readonly` | `TextDocument` | - | - | -| `path` | `readonly` | `string` | The source file path.

This is used only for diagnostics. The command line compiler will populate
it with the actual path from which the file was read, but it can actually
be an arbitrary name for other scenarios. | [`SourceFile`](SourceFile.md).`path` | +| `path` | `readonly` | `string` |

The source file path.

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

| [`SourceFile`](SourceFile.md).`path` | | `text` | `readonly` | `string` | The source code text. | [`SourceFile`](SourceFile.md).`text` | ## Methods diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md index 13ccbd5b1b..d68e4b2a49 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ServerWorkspaceFolder.md @@ -11,6 +11,6 @@ title: "[I] ServerWorkspaceFolder" | 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` | +| `name` | `string` | The name of the workspace folder. Used to refer to this workspace folder in the user interface. | `WorkspaceFolder.name` | | `path` | `string` | - | - | | `uri` | `string` | The associated URI for this workspace folder. | `WorkspaceFolder.uri` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md index 0fee72a901..6e164000d1 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Service.md @@ -13,4 +13,4 @@ title: "[I] Service" | :------ | :------ | :------ | :------ | | `title?` | `string` | - | [`ServiceDetails`](ServiceDetails.md).`title` | | `type` | [`Namespace`](Namespace.md) | - | - | -| ~~`version?`~~ | `string` | **Deprecated**
Service version is deprecated. If wanting to describe a service versioning you can use the `@typespec/versioning` library. If wanting to describe the project version you can use the package.json version | [`ServiceDetails`](ServiceDetails.md).`version` | +| ~~`version?`~~ | `string` |

**Deprecated**

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

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

**Deprecated**

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

| diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SignatureFunctionParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SignatureFunctionParameter.md new file mode 100644 index 0000000000..f4b8325d83 --- /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 index dcc43f6a41..8fb0d5951c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceFile.md @@ -11,7 +11,7 @@ title: "[I] SourceFile" | Property | Modifier | Type | Description | | :------ | :------ | :------ | :------ | -| `path` | `readonly` | `string` | The source file path.

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

The source file path.

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

| | `text` | `readonly` | `string` | The source code text. | ## Methods diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md index 9ca562374f..f875ee721e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocation.md @@ -11,7 +11,7 @@ title: "[I] SourceLocation" | 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` | +| `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` | +| `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 index 3cd8d892df..5360bcea7d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceLocationOptions.md @@ -7,4 +7,4 @@ title: "[I] SourceLocationOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `locateId?` | `boolean` | If trying to resolve the location of a type with an ID, show the location of the ID node instead of the entire type.
This makes sure that the location range is not too large and hard to read. | +| `locateId?` | `boolean` | If trying to resolve the location of a type with an ID, show the location of the ID node instead of the entire type. This makes sure that the location range is not too large and hard to read. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md index 0a256f9e44..ebe8d74594 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md @@ -8,4 +8,4 @@ title: "[I] SourceModel" | 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` | +| `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/StringLiteral.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md index b07deeb8f7..038f66917f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteral.md @@ -9,16 +9,17 @@ title: "[I] StringLiteral" ## 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` | - | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md index b4483793a3..7f96499611 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringLiteralNode.md @@ -13,10 +13,10 @@ title: "[I] StringLiteralNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 1f329a46bf..19e0f66a51 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplate.md @@ -9,16 +9,18 @@ title: "[I] StringTemplate" ## 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)[] | - | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md index e49b889b4d..eb9a19a7de 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateExpressionNode.md @@ -13,11 +13,11 @@ title: "[I] StringTemplateExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index c12b6f94a9..735f12f017 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateHeadNode.md @@ -13,10 +13,10 @@ title: "[I] StringTemplateHeadNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `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` | +| `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` | +| `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 index a25a8cb00a..dc7de2af72 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateLiteralLikeNode.md @@ -7,16 +7,22 @@ title: "[I] StringTemplateLiteralLikeNode" - [`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` | +| `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` | +| `pos` | `readonly` | `number` | 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 index 18342a3f16..ecdeda446e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateMiddleNode.md @@ -13,10 +13,10 @@ title: "[I] StringTemplateMiddleNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `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` | +| `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` | +| `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 index 5065678c34..afd8591588 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanLiteral.md @@ -9,17 +9,18 @@ title: "[I] StringTemplateSpanLiteral" ## 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) | - | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md index cdd53aa95c..b03f7f2749 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanNode.md @@ -13,11 +13,11 @@ title: "[I] StringTemplateSpanNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 9dfb26225f..4d7c5ddb3d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateSpanValue.md @@ -9,17 +9,18 @@ title: "[I] StringTemplateSpanValue" ## 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) | - | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md index 868a57fc1b..1baf165c8a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/StringTemplateTailNode.md @@ -13,10 +13,10 @@ title: "[I] StringTemplateTailNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `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` | +| `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` | +| `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 0000000000..7c4932bcdc --- /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/Sym.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md index 56e88536fd..956cbc24a7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Sym.md @@ -8,13 +8,13 @@ title: "[I] Sym" | 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. | +| `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). | +| `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. | +| `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 index 7b219042a7..aac93be565 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SymbolLinks.md @@ -5,8 +5,9 @@ title: "[I] SymbolLinks" --- ## Properties -| Property | Type | -| :------ | :------ | -| `declaredType?` | [`Type`](../type-aliases/Type.md) | -| `instantiations?` | [`TypeInstantiationMap`](TypeInstantiationMap.md) | -| `type?` | [`Type`](../type-aliases/Type.md) | +| 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 index 8fd539e649..a0c66d47ac 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SyntheticLocationContext.md @@ -7,6 +7,6 @@ Refer to a type that was not declared in a file ## Properties -| Property | Type | -| :------ | :------ | -| `type` | `"synthetic"` | +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `type` | `readonly` | `"synthetic"` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md index 2bfb157efb..46f339f01e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateArgumentNode.md @@ -14,10 +14,10 @@ title: "[I] TemplateArgumentNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index a39c1945b3..463e2870d3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateDeclarationNode.md @@ -18,3 +18,4 @@ title: "[I] TemplateDeclarationNode" | :------ | :------ | :------ | | `locals?` | `readonly` | `SymbolTable` | | `templateParameters` | `readonly` | readonly [`TemplateParameterDeclarationNode`](TemplateParameterDeclarationNode.md)[] | +| `templateParametersRange` | `readonly` | [`TextRange`](TextRange.md) | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md index e32a4b1d73..a64d9d5fbe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameter.md @@ -9,17 +9,18 @@ title: "[I] TemplateParameter" ## 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` | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md index 0a548e9f96..246168ebb2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplateParameterDeclarationNode.md @@ -15,10 +15,10 @@ title: "[I] TemplateParameterDeclarationNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 82e49192cc..93bfea11cf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TemplatedTypeBase.md @@ -15,6 +15,6 @@ title: "[I] TemplatedTypeBase" | Property | Type | Description | | :------ | :------ | :------ | -| ~~`templateArguments?`~~ | [`Type`](../type-aliases/Type.md)[] | **Deprecated**
use templateMapper instead. | +| ~~`templateArguments?`~~ | ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] |

**Deprecated**

use templateMapper instead.

| | `templateMapper?` | [`TypeMapper`](TypeMapper.md) | - | | `templateNode?` | [`Node`](../type-aliases/Node.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md index b10d1814d4..b4eab27efd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TextRange.md @@ -15,5 +15,5 @@ title: "[I] TextRange" | 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. | +| `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/Tuple.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md index 95b42dd170..a58713e874 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Tuple.md @@ -9,16 +9,17 @@ title: "[I] Tuple" ## 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)[] | - | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md index 8724e77270..c115a127e4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TupleExpressionNode.md @@ -13,10 +13,10 @@ title: "[I] TupleExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 1b84e154b7..8246154d2d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeInstantiationMap.md @@ -17,7 +17,7 @@ get(args): undefined | Type | Parameter | Type | | :------ | :------ | -| `args` | readonly [`Type`](../type-aliases/Type.md)[] | +| `args` | readonly ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | #### Returns @@ -35,7 +35,7 @@ set(args, type): void | Parameter | Type | | :------ | :------ | -| `args` | readonly [`Type`](../type-aliases/Type.md)[] | +| `args` | readonly ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | | `type` | [`Type`](../type-aliases/Type.md) | #### Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md index 31d586266e..1d4ce346cc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeMapper.md @@ -7,7 +7,7 @@ title: "[I] TypeMapper" | Property | Type | | :------ | :------ | -| `args` | readonly [`Type`](../type-aliases/Type.md)[] | +| `args` | readonly ([`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) \| [`IndeterminateEntity`](IndeterminateEntity.md))[] | | `partial` | `boolean` | ## Methods @@ -15,7 +15,7 @@ title: "[I] TypeMapper" ### getMappedType() ```ts -getMappedType(type): Type +getMappedType(type): Type | Value | IndeterminateEntity ``` #### Parameters @@ -26,4 +26,4 @@ getMappedType(type): Type #### Returns -[`Type`](../type-aliases/Type.md) +[`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/TypeOfExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeOfExpressionNode.md new file mode 100644 index 0000000000..5ac489c6f0 --- /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 index b6e1e7648b..1f93afb337 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeReferenceNode.md @@ -14,10 +14,10 @@ title: "[I] TypeReferenceNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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/TypeSpecLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md index 910c3a0712..cf523aa69e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibrary.md @@ -11,20 +11,20 @@ title: "[I] TypeSpecLibrary" | Type parameter | Value | | :------ | :------ | -| `T` extends `Object` | - | -| `E` extends `Record`<`string`, `any`\> | `Record`<`string`, `never`\> | -| `State` extends `string` | `never` | +| `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?` | `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` | +| ~~`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` | +| `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`\> | - | - | - | @@ -40,8 +40,8 @@ createDiagnostic(diag): Diagnostic | Type parameter | | :------ | -| `C` extends `string` \| `number` \| `symbol` | -| `M` extends `string` \| `number` \| `symbol` | +| `C` *extends* `string` \| `number` \| `symbol` | +| `M` *extends* `string` \| `number` \| `symbol` | #### Parameters @@ -106,8 +106,8 @@ reportDiagnostic(program, diag): void | Type parameter | | :------ | -| `C` extends `string` \| `number` \| `symbol` | -| `M` extends `string` \| `number` \| `symbol` | +| `C` *extends* `string` \| `number` \| `symbol` | +| `M` *extends* `string` \| `number` \| `symbol` | #### Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md index 19df935f8a..ada1776bab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecLibraryDef.md @@ -11,18 +11,18 @@ title: "[I] TypeSpecLibraryDef" | Type parameter | Value | | :------ | :------ | -| `T` extends `Object` | - | -| `E` extends `Record`<`string`, `any`\> | `Record`<`string`, `never`\> | -| `State` extends `string` | `never` | +| `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?` | `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. | +| ~~`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. | +| `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/TypeSpecScriptNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md index d739c9bb09..22c0342f1e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/TypeSpecScriptNode.md @@ -14,7 +14,7 @@ title: "[I] TypeSpecScriptNode" | `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` | +| `end` | `readonly` | `number` | The 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` | @@ -25,8 +25,8 @@ title: "[I] TypeSpecScriptNode" | `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` | +| `pos` | `readonly` | `number` | The starting position of 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` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice, 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 index 52c9ebd293..06bfddd9c2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/Union.md @@ -12,21 +12,22 @@ title: "[I] Union" | 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` | +| `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 | - | - | +| ~~`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` | +| ~~`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. | - | - | +| `variants` | `public` | `RekeyableMap`<`string` \| `symbol`, [`UnionVariant`](UnionVariant.md)\> |

The variants of the union.

Variants are ordered in order that they appear in source.

| - | - | ## Accessors diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md index 38f1514d5d..6105306b39 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionExpressionNode.md @@ -13,10 +13,10 @@ title: "[I] UnionExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index d6ae54da13..94d6c1a6fd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionStatementNode.md @@ -14,13 +14,14 @@ title: "[I] UnionStatementNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 703e6802cd..a7bb332848 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariant.md @@ -9,19 +9,20 @@ title: "[I] UnionVariant" ## 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) | - | - | - | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md index f8483c9d4f..7b56e04525 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnionVariantNode.md @@ -14,11 +14,11 @@ title: "[I] UnionVariantNode" | `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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 27130a1f72..eddee13ea4 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UnknownType.md @@ -9,16 +9,17 @@ title: "[I] UnknownType" ## 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` | +| 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 diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md index 2f4240581d..e2c2feeb80 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/UsingStatementNode.md @@ -13,10 +13,10 @@ title: "[I] UsingStatementNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index de3d6ebb76..859ca1fff8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ValueOfExpressionNode.md @@ -13,10 +13,10 @@ title: "[I] ValueOfExpressionNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 3d84eaae20..0000000000 --- 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 index ff4e2e4c09..424d1be3c5 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidKeywordNode.md @@ -13,9 +13,9 @@ title: "[I] VoidKeywordNode" | :------ | :------ | :------ | :------ | :------ | :------ | | `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](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` | +| `end` | `readonly` | `number` | The 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` | +| `pos` | `readonly` | `number` | The starting position of 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 index 4ae3e1448e..875097424e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/VoidType.md @@ -9,16 +9,17 @@ title: "[I] VoidType" ## 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` | +| 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 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 d36ff80411..8c297cb5d7 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 422de99c2f..4be661aec4 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 09077fab54..106f2e4431 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 02ab5c9b0f..e19a31b0d5 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 3192e23b8a..d3bac77296 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 0ae423a8b9..ec1bc61bea 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 4e6824334e..46c3023cdf 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 63dab4fe8f..e6d138e6d1 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 0000000000..45e517a16c --- /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 e8f24ce1df..9b135cc2da 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 0000000000..04bc405f49 --- /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 2917cfe13a..24220b3ad7 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 3dd9bc2dec..97d745c576 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 5bf25c21ed..03ff1eefd6 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 b5681839a0..357031fd1c 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 9d73b8f666..a34c5fd4aa 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/MemberContainerNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerNode.md index a2e623dab8..01967c4a28 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/MemberContainerType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberContainerType.md index f91bcc9915..835da3b2fa 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 c43ba0af08..ebf166d087 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/MemberType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/MemberType.md index 80140f981e..c4e77ab59d 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. 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 c7fa4409c3..2697efea7d 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 8129c8f7f2..7a1d39e0fa 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 1b802da3ef..bd80ee3665 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 35404a94e3..2ade74a10d 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 13354edce8..79fba3a443 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 0000000000..0d3df8bfb2 --- /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 7ced5c24fe..42f2c0c0c6 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 7ae5686e3d..75028ec6a3 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 90778a6b18..72c86396ca 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 d761b83a3f..94d83e07fd 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 d33434f295..426ac4bc91 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 0000000000..e486f06dc0 --- /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 07ee28a1cb..c6b47f75e6 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 eebcfbea73..ab8c2b3780 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 a130841955..00eaedb95e 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 a6d0996363..8f9d68c1fd 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",