[P] JS API
Enumerations
Section titled âEnumerationsâClasses
Section titled âClassesâInterfaces
Section titled âInterfacesâ- ArrayModelType
- ArrayValue
- BaseType
- BlockComment
- BooleanLiteral
- BooleanValue
- CallableMessage
- Checker
- CodeFix
- CodeFixContext
- CompileResult
- CompilerHost
- CompilerLocationContext
- CompilerOptions
- DecoratedType
- Decorator
- DecoratorApplication
- DecoratorArgument
- DecoratorContext
- DecoratorDefinition
- DecoratorFunction
- DecoratorImplementations
- DecoratorParamDefinition
- DecoratorValidator
- DeprecatedDirective
- DeprecationDetails
- Diagnostic
- DiagnosticCollector
- DiagnosticCreator
- DiagnosticDefinition
- DiagnosticMessages
- DirectiveBase
- DiscriminatedUnion
- DiscriminatedUnionLegacy
- Discriminator
- EmitContext
- EmitFileOptions
- EncodeData
- Enum
- EnumMember
- EnumValue
- ErrorType
- Example
- ExampleOptions
- FileLibraryMetadata
- FilePos
- FunctionParameterBase
- IdentifierContext
- IndeterminateEntity
- InitProjectContext
- InsertTextCodeFixEdit
- Interface
- IntrinsicType
- LibraryInstance
- LibraryLocationContext
- LineAndCharacter
- LineComment
- LinterDefinition
- LinterResolvedDefinition
- LinterRule
- LinterRuleContext
- LinterRuleDefinition
- LinterRuleSet
- ListOperationOptions
- Logger
- LogInfo
- LogSink
- MixedFunctionParameter
- MixedParameterConstraint
- Model
- ModelProperty
- ModuleLibraryMetadata
- Namespace
- NamespaceNavigationOptions
- NavigationOptions
- NeverType
- NullType
- NullValue
- Numeric
- NumericLiteral
- NumericValue
- ObjectValue
- ObjectValuePropertyDescriptor
- Operation
- OpExample
- PackageFlags
- PackageJson
- PagingOperation
- PagingProperty
- ParseOptions
- PatternData
- PositionDetail
- ProcessedLog
- Program
- ProjectLocationContext
- RecordModelType
- ReplaceTextCodeFixEdit
- ResolveCompilerOptionsOptions
- ResolveModuleHost
- ResolveModuleOptions
- RmOptions
- Scalar
- ScalarConstructor
- ScalarValue
- SemanticToken
- Server
- ServerCustomCapacities
- ServerHost
- ServerInitializeResult
- ServerLog
- ServerSourceFile
- ServerWorkspaceFolder
- Service
- ServiceDetails
- SignatureFunctionParameter
- SourceFile
- SourceLocation
- SourceLocationOptions
- SourceModel
- StateDef
- StringLiteral
- StringTemplate
- StringTemplateSpanLiteral
- StringTemplateSpanValue
- StringValue
- SuppressDirective
- SyntheticLocationContext
- TemplatedTypeBase
- TemplateInstanceTarget
- TemplateParameter
- TextRange
- Tracer
- TracerOptions
- Tuple
- TypeInstantiationMap
- TypeMapper
- TypeNameOptions
- TypeSpecLibrary
- TypeSpecLibraryDef
- TypeSpecManifest
- Union
- UnionVariant
- UnknownType
- UsageTracker
- VisibilityFilter
- VisibilityProvider
- VoidType
Type Aliases
Section titled âType Aliasesâ- BytesKnownEncoding
- CodeFixEdit
- Comment
- CreateTypeProps
- CustomRequestName
- DateTimeKnownEncoding
- Declaration
- DecoratorArgumentValue
- DiagnosticFormat
- DiagnosticHandler
- DiagnosticMap
- DiagnosticReport
- DiagnosticReportWithoutTarget
- DiagnosticResult
- DiagnosticSeverity
- DiagnosticTarget
- Directive
- DirectiveArgument
- DocContent
- DurationKnownEncoding
- EmitOptionsFor
- EmitterFunc
- Entity
- Expression
- FunctionParameter
- InferredTypeSpecValue
- InitProjectConfig
- InitProjectTemplate
- InitProjectTemplateEmitterTemplate
- InitProjectTemplateLibrarySpec
- IntrinsicScalarName
- JSONSchemaType
- LibraryMetadata
- LinterRuleDiagnosticFormat
- LinterRuleDiagnosticReport
- LinterRuleDiagnosticReportWithoutTarget
- LiteralType
- LocationContext
- LogLevel
- MarshalledValue
- MemberContainerType
- MemberType
- ModelIndexer
- Modifier
- ModuleResolutionResult
- NeverIndexer
- NewLine
- OperationContainer
- OperationSignature
- ReferenceExpression
- RuleRef
- SemanticNodeListener
- ServerLogLevel
- SourceFileKind
- Statement
- StdTypeName
- StdTypes
- StringTemplateSpan
- TemplatedType
- TrackableType
- Type
- TypeKind
- TypeListeners
- TypeOfDiagnostics
- TypeSpecDiagnosticTarget
- TypeSpecValue
- Value
- WriteLine
Variables
Section titled âVariablesâ- $defaultVisibility
- $discriminator
- $doc
- $encode
- $error
- $errorsDoc
- $example
- $format
- $friendlyName
- $inspectType
- $inspectTypeName
- $invisible
- $key
- $maxItems
- $maxLength
- $maxValue
- $maxValueExclusive
- $minItems
- $minLength
- $minValue
- $minValueExclusive
- $opExample
- $overload
- $parameterVisibility
- $pattern
- $removeVisibility
- $returnsDoc
- $returnTypeVisibility
- $secret
- $service
- $summary
- $tag
- $visibility
- $withDefaultKeyVisibility
- $withLifecycleUpdate
- $withOptionalProperties
- $withoutDefaultValues
- $withoutOmittedProperties
- $withPickedProperties
- $withUpdateableProperties
- $withVisibility
- $withVisibilityFilter
- discriminatedDecorator
- EmptyVisibilityProvider
- getEncode
- getFormat
- getFriendlyName
- getKeyName
- getOverloadedOperation
- getOverloads
- getPatternData
- getService
- getSummary
- isList
- isSecret
- MANIFEST
- NodeHost
- NoTarget
- VisibilityFilter
Functions
Section titled âFunctionsâ- $encodedName
- addService
- addVisibilityModifiers
- assertType
- checkFormatTypeSpec
- clearVisibilityModifiersForClass
- compile
- compilerAssert
- createDiagnosticCollector
- createRule
- createServer
- createSourceFile
- createTypeSpecLibrary
- defineCodeFix
- defineLinter
- definePackageFlags
- emitFile
- ensureTrailingDirectorySeparator
- explainStringTemplateNotSerializable
- filterModelProperties
- formatDiagnostic
- formatIdentifier
- formatTypeSpec
- getAllTags
- getAnyExtensionFromPath
- getBaseFileName
- getDeprecated
- getDeprecationDetails
- getDirectoryPath
- getDiscriminatedTypes
- getDiscriminatedUnion
- getDiscriminatedUnionFromInheritance
- getDiscriminator
- getDoc
- getDocData
- getEffectiveModelType
- getEntityName
- getErrorsDoc
- getErrorsDocData
- getExamples
- getLifecycleVisibilityEnum
- getLocationContext
- getMaxItems
- getMaxItemsAsNumeric
- getMaxLength
- getMaxLengthAsNumeric
- getMaxValue
- getMaxValueAsNumeric
- getMaxValueExclusive
- getMaxValueExclusiveAsNumeric
- getMediaTypeHint
- getMinItems
- getMinItemsAsNumeric
- getMinLength
- getMinLengthAsNumeric
- getMinValue
- getMinValueAsNumeric
- getMinValueExclusive
- getMinValueExclusiveAsNumeric
- getNamespaceFullName
- getNormalizedAbsolutePath
- getNormalizedAbsolutePathWithoutRoot
- getNormalizedPathComponents
- getOpExamples
- getPagingOperation
- getParameterVisibilityFilter
- getPathComponents
- getPathFromPathComponents
- getPattern
- getPositionBeforeTrivia
- getProperty
- getPropertyType
- getRelativePathFromDirectory
- getReturnsDoc
- getReturnsDocData
- getReturnTypeVisibilityFilter
- getRootLength
- getSourceFileKindFromExt
- getSourceLocation
- getTags
- getTypeName
- getVisibilityForClass
- hasTrailingDirectorySeparator
- hasVisibility
- ignoreDiagnostics
- interpolatePath
- isAnyDirectorySeparator
- isArrayModelType
- isDeclaredInNamespace
- isDeclaredType
- isDeprecated
- isErrorModel
- isErrorType
- isGlobalNamespace
- isKey
- isNeverType
- isNullType
- isNumeric
- isNumericType
- isPathAbsolute
- isRecordModelType
- isSealed
- isService
- isStdNamespace
- isStringType
- isTemplateDeclaration
- isTemplateDeclarationOrInstance
- isTemplateInstance
- isType
- isTypeSpecValueTypeOf
- isUnknownType
- isUrl
- isValue
- isVisible
- isVoidType
- joinPaths
- listOperationsIn
- listServices
- logDiagnostics
- mapEventEmitterToNodeListener
- markDeprecated
- navigateProgram
- navigateType
- navigateTypesInNamespace
- normalizePath
- normalizeSlashes
- Numeric
- paramMessage
- reducePathComponents
- removeTrailingDirectorySeparator
- removeVisibilityModifiers
- reportDeprecated
- resetVisibilityModifiersForClass
- resolveCompilerOptions
- resolveEncodedName
- resolveLinterDefinition
- resolveModule
- resolvePath
- resolveUsages
- scopeNavigationToNamespace
- sealVisibilityModifiers
- sealVisibilityModifiersForProgram
- serializeValueAsJson
- setTypeSpecNamespace
- typespecTypeToJson
- validateDecoratorNotOnType
- validateDecoratorUniqueOnNode
- walkPropertiesInherited
References
Section titled âReferencesâprintIdentifier
Section titled âprintIdentifierâRenames and re-exports formatIdentifier