Skip to content
TypeScript Dev Toolkit
v3.7.2
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Guides
Commands
API reference
build
Overview
buildClean
buildCompile
buildCompileSvelte
buildCompileTypeScript
buildTemplates
bundlers
esbuild-impl
change-extension-plugin
Overview
changeExtensionPlugin
rewriteImportPathExtensions
custom-esbuild-options-plugin
Overview
customEsbuildOptionsPlugin
fix-esm-plugin
Overview
fixEsmPlugin
preprocess-plugin
Overview
ensureBrowserProcess
ensureDisposeSymbols
keepName
makePreprocessBanner
MakePreprocessBannerOptions
preprocessPlugin
PreprocessPluginOptions
svelte-wrapper-plugin
Overview
isMissingSveltePackageError
svelteWrapperPlugin
check-project-types
Overview
checkProjectTypes
CheckProjectTypesParams
ParsedTsConfig
parseTsConfig
toCanonical
cli-utils
Overview
CliTaskResult
cmdEscapeCommandLine
toCommandLine
toPosixCommandLine
wrapCliTask
code-generator
Overview
generate
commitlint-config
Overview
commitlintConfig
obsidianDevUtilsConfig
commitlint-forbidden-patterns
Overview
forbiddenPatternsPlugin
NO_FORBIDDEN_PATTERNS_RULE_NAME
noForbiddenPatternsRule
commitlint-spellcheck-header
Overview
SPELLCHECK_HEADER_RULE_NAME
spellcheckHeaderPlugin
spellcheckHeaderRule
docs-site
api-doc-constants
Overview
EVENT_METHODS
GENERIC_TYPE_PARAMS
TS_GLOBAL_TYPES
TS_PRIMITIVE_TYPES
TS_UTILITY_TYPES
api-doc-documented-files
Overview
isDocumentedDirectoryName
isDocumentedFileName
isDocumentedModulePath
api-doc-jsdoc
Overview
extractClassInfo
extractConstructorInfo
extractEnumInfo
extractFileOverview
extractInterfaceInfo
extractMethodInfo
extractMethodSignatureInfo
extractPropertyInfo
extractPropertySignatureInfo
extractTypeAliasInfo
getDeclaredReturnType
getDescription
getExamples
getParameterDescriptions
getPropertyType
getRemarks
getReturnDescription
getSince
resolveTypeofAliases
api-doc-link-rendering
Overview
doesMemberPageExist
findType
linkBaseType
loadExternalTypeMaps
markdownToHtml
memberHref
registerMemberPages
registerRouteSegments
renderExampleMdx
renderMdxProse
renderTypeWithLinks
resolveExternalTypeUrl
resolveLinks
resolveTsUtilityUrl
resolveWebApiUrl
toTypeFileSegment
toTypeRouteSegment
typeHref
typeLink
api-doc-package-sites
Overview
clearPackageDeclarations
DEFAULT_PACKAGE_SITES
getPackageTypeUrl
registerPackageDeclaration
api-doc-page-generation
Overview
appendBacklinksAndWrite
buildBacklinksFromContent
buildSidebarTree
computeOverviewSignature
generateMemberPages
generateNamespaceIndexPages
generateOverviewPage
generateSidebarJson
renderConstructorMdx
renderEnumPage
renderFrontMatter
renderFunctionPage
renderMethodOverloadMdx
renderMethodTableMdx
renderPropertyTableMdx
renderTypeAliasPage
renderVariablePage
sidebarTreeToEntries
api-doc-route-segments
Overview
toRouteSegment
toRouteSegmentPreserveCase
api-doc-settings
Overview
ApiDocSettings
configureApiDocs
getApiDocSettings
api-doc-source-processing
Overview
collectFunctions
collectPackageDeclarations
collectVariables
computeCacheHash
computeNamespace
findEntryFiles
processSourceFile
registerGenericTypeParams
api-doc-text-utils
Overview
computeOverloadKey
ensureDirectory
escapeJsString
escapeJsxAttribute
escapeMarkdown
escapeMdxAngleBrackets
escapeMdxBraces
escapeMdxProse
escapeYaml
foldTsDocParagraphs
getDisplayName
getImportStatement
getNamespaceDirectory
memberRouteSegment
memberSlug
overloadRouteSegment
overloadSlug
replaceRegExpMatches
segmentMarkdown
simplifyType
stripMarkdown
truncateSignature
api-doc-type-merging
Overview
buildTypeParameterMap
parseTypeArguments
resolveInheritedMembers
substituteMemberTypes
substituteTypeParams
api-doc-types
Overview
CodeSegment
EnumMemberInfo
MarkdownSegment
MemberInfo
PageContent
PageFrontMatter
ParameterInfo
ProseSegment
ReturnTypeProvider
SidebarEntry
SidebarLink
SidebarTreeNode
TextProvider
TypeInfo
WebApiEntry
api-docs
Overview
generateApiDocs
GenerateApiDocsParams
astro-config
Overview
defineDocsSiteConfig
docs-links
Overview
assertDocsLinksResolve
AssertDocsLinksResolveParams
docs-site-assets
Overview
API_COMPONENTS_IMPORT_PREFIX
getDocsSiteAssetsDirectory
docs-site-commands
Overview
buildDocsSite
devDocsSite
previewDocsSite
docs-site-config
Overview
DocsSiteConfig
ResolvedDocsSiteConfig
resolveDocsSiteConfig
docs-snippets
Overview
assertDocsSnippetsCompile
AssertDocsSnippetsCompileParams
DocsSnippet
DocsSnippetProblem
extractDocsSnippets
findDocsSnippetProblems
FindDocsSnippetProblemsParams
formatDocsSnippetProblems
link-check
Overview
BrokenLink
collectBrokenExternalLinks
CollectBrokenExternalLinksOptions
collectBrokenLinks
collectExternalTargets
DEFAULT_EXTERNAL_LINK_PER_HOST_CONCURRENCY
DEFAULT_EXTERNAL_LINK_RETRY_INITIAL_DELAY_IN_MILLISECONDS
DEFAULT_EXTERNAL_LINK_RETRY_MAX_DELAY_IN_MILLISECONDS
DEFAULT_EXTERNAL_LINK_RETRY_TOTAL_BUDGET_IN_MILLISECONDS
DocumentationPage
ExternalLinkProbeResult
ExternalLinkRetryOptions
extractIds
extractLinks
formatBrokenLinks
getOutputRelativePath
getPageUrl
isInternalDocUrl
LinkCheckFileSystem
NETWORK_FAILURE_STATUS
parseRetryAfterInMilliseconds
resolveWithinRoot
og-image
Overview
computeOgHash
loadFonts
loadLogoDataUri
OgCardContent
renderOgImage
RenderOgImageOptions
og-image-page
Overview
getOgImagePageSlug
og-images
Overview
generateOgImages
GenerateOgImagesParams
outdated-references
Overview
assertNoOutdatedReferences
findOutdatedReferences
findOutdatedReferencesInText
formatOutdatedReferences
OUTDATED_REFERENCE_ALLOW_MARKER
OutdatedReference
repo-homepage
Overview
RepoHomepageMode
syncRepoHomepage
SyncRepoHomepageParams
route-data
Overview
onRequest
satteri-github-alerts
Overview
GITHUB_ALERT_ASIDE_VARIANTS
satteriGitHubAlerts
satteri-relative-links
Overview
satteriRelativeLinks
unrendered-alerts
Overview
collectUnrenderedAlerts
formatUnrenderedAlerts
UnrenderedAlert
env-toggle
Overview
exitIfScriptDisabled
getDisabledScriptEnvVariableName
isEnvVariableOff
loadEnvFileIfExists
exec
Overview
appendNodeOption
buildChildEnv
CommandPart
exec
ExecArgument
ExecDetailedOptions
ExecOptions
ExecResult
ExecSimpleOptions
getEffectiveCommandLineLength
getMaxBatchCommandLength
forbidden-patterns
Overview
findForbiddenPatternMatches
FORBIDDEN_PATTERNS_FILE_ENV_VARIABLE
ForbiddenPatternMatch
readForbiddenPatterns
formatters
auto
Overview
detectFormatter
format
FormatOptions
Formatter
biome
Overview
BIOME_CONFIG_FILE_NAMES
BIOME_EXPLICIT_PATHS_ARGUMENTS
ensureBiomeConfig
EnsureBiomeConfigOptions
format
FormatOptions
hasBiomeConfig
dprint
Overview
format
FormatOptions
prettier
Overview
format
FormatOptions
getPrettierConfig
hasPrettierConfig
PRETTIER_CONFIG_FILE_NAMES
fs
Overview
BufferResultOptions
DirentResultOptions
readdirPosix
StringResultOptions
gate
Overview
gate
GateOptions
parseGateArguments
git
Overview
getNonIgnoredFiles
GetNonIgnoredFilesOptions
readIndexContent
json
Overview
editJson
EditJsonOptions
EditJsonParams
editJsonSync
EditJsonSyncOptions
EditJsonSyncParams
readJson
readJsonSync
writeJson
writeJsonSync
library-build
Overview
buildCleanLibrary
buildLibrary
BuildLibraryOptions
buildLibraryTypes
generateLibraryExports
GenerateLibraryExportsOptions
generateLibraryIndex
GenerateLibraryIndexOptions
LIBRARY_BANNER
LIBRARY_BUILD_STEPS
runBuildSteps
SOURCE_CONDITION
linters
auto
Overview
detectLinter
lint
Linter
LintOptions
biome
Overview
lint
LintOptions
cspell
Overview
spellcheck
SpellcheckOptions
cspell-content
Overview
spellcheckContent
SpellcheckContentParams
eslint
Overview
classifyEslintExit
describeFailureToLint
EslintExitKind
hasEslintConfig
lint
LINT_PROBLEMS_MESSAGE
LintOptions
eslint-agnostic-core-boundary
Overview
getPackageBoundaryNoRestrictedImportPatterns
GetPackageBoundaryNoRestrictedImportPatternsParams
NoRestrictedImportPatternEntry
eslint-config
Overview
createDefaultEslintConfigContext
defineEslintConfigs
DefineEslintConfigsOptions
EslintConfigContext
getEslintCoreConfigs
getGlobalIgnoreConfigs
getTypeScriptEslintConfigs
GetTypeScriptEslintConfigsParams
eslint-no-restricted-syntax
Overview
noRestrictedSyntaxRuleEntries
NoRestrictedSyntaxRuleEntry
eslint-rules
in-house-plugin
Overview
genericInHouseEslintRules
IN_HOUSE_ESLINT_PLUGIN_NAME
inHouseEslintPlugin
no-async-callback-to-unsafe-return
Overview
MESSAGE_ID
noAsyncCallbackToUnsafeReturn
no-unresolved-jsdoc-link
Overview
MESSAGE_ID
noUnresolvedJsdocLink
no-unused-params-members
Overview
MESSAGE_ID
noUnusedParamsMembers
no-used-underscore-variables
Overview
MESSAGE_ID
noUsedUnderscoreVariables
params-options-name-match
Overview
MESSAGE_ID
paramsOptionsNameMatch
prefer-logical-operator-over-ternary
Overview
MESSAGE_ID
preferLogicalOperatorOverTernary
UNICORN_RULE_NAME
prefer-noop-async
Overview
MESSAGE_ID
preferNoopAsync
readonly-params-options-result-members
Overview
MESSAGE_ID
readonlyParamsOptionsResultMembers
require-method-template
Overview
MESSAGE_ID_MISSING_TEMPLATE
MESSAGE_ID_MISSING_TEMPLATE_DESCRIPTION
requireMethodTemplate
require-super-call
Overview
MESSAGE_ID
requireSuperCall
rule-tester-helper
Overview
toRuleTesterModule
ts-estree-node
Overview
toTSESTreeNode
lint-ignores
Overview
CLAUDE_WORKTREES_IGNORE_GLOB
markdownlint
Overview
lint
LintOptions
markdownlint-cli2-config
Overview
obsidianDevUtilsConfig
markdownlint-content
Overview
lintMarkdownContent
LintMarkdownContentParams
markdownlint-ignores
Overview
checkIsInNodeModules
NODE_MODULES_IGNORE_GLOB
markdownlint-rules
no-soft-break-in-paragraph
Overview
NO_SOFT_BREAK_IN_PARAGRAPH_RULE_NAME
noSoftBreakInParagraphRule
over-exposure
Overview
analyzeOverExposure
AnalyzeOverExposureParams
createLanguageServiceHost
CreateLanguageServiceHostParams
createProjectLanguageService
CreateProjectLanguageServiceParams
CurrentExposure
findOverExposure
FindOverExposureParams
formatOverExposureFindings
FormatOverExposureFindingsOptions
LIFECYCLE_ALLOWLIST
OverExposureFileSystem
OverExposureFinding
OverExposureProgress
OverExposureSkipReason
SuggestedExposure
nano-staged-config
Overview
getNanoStagedConfig
GetNanoStagedConfigOptions
NanoStagedConfig
NanoStagedTask
NanoStagedTaskContext
obsidianDevUtilsConfig
npm
Overview
editNpmShrinkWrapJson
EditNpmShrinkWrapJsonOptions
editPackageJson
EditPackageJsonOptions
editPackageJsonSync
EditPackageJsonSyncOptions
editPackageLockJson
EditPackageLockJsonOptions
editPackageLockJsonSync
EditPackageLockJsonSyncOptions
getNpmShrinkWrapJsonPath
getPackageJsonPath
getPackageLockJsonPath
PackageLockJson
readPackageJson
readPackageJsonSync
readPackageLockJson
readPackageLockJsonSync
writePackageJson
writePackageJsonSync
writePackageLockJson
writePackageLockJsonSync
npm-publish
Overview
publish
npm-run
Overview
npmRun
npmRunOptional
NpmRunOptionalResult
package-lock-integrity
Overview
assertPackageLockIntegrity
findPackageLockEntriesMissingIntegrity
package-manager
Overview
getPackageManager
getPackageManagerRunCommand
PackageManager
resolveToolCommand
ResolveToolCommandParams
released-issues
Overview
closeReleasedIssues
CloseReleasedIssuesParams
getIssueReferences
GetIssueReferencesParams
IssueReference
repo-paths
Overview
RepoPaths
root
Overview
execFromRoot
ExecFromRootOptions
getRootFolder
resolvePathFromRoot
ResolvePathFromRootParams
resolvePathFromRootSafe
ResolvePathFromRootSafeParams
toRelativeFromRoot
ToRelativeFromRootParams
shared-config-files
Overview
getSharedConfigFilePath
SharedConfigFile
test-runners
auto
Overview
detectTestRunner
test
testCoverage
TestCoverageOptions
TestOptions
TestRunner
testWatch
TestWatchOptions
VITEST_CONFIG_FILE_NAMES
jest
Overview
EXPERIMENTAL_VM_MODULES_FLAG
hasJestConfig
JEST_CONFIG_FILE_NAMES
test
testCoverage
TestCoverageOptions
TestOptions
testWatch
TestWatchOptions
jest-config
Overview
DEFAULT_JEST_TEST_PATH_IGNORE_PATTERNS
defineJestConfig
DefineJestConfigOptions
isEsmPackage
JEST_RELATIVE_JS_IMPORT_MAPPER
JEST_TYPESCRIPT_TRANSFORM_PATTERN
vitest
Overview
test
testCoverage
TestCoverageOptions
TestOptions
testWatch
TestWatchOptions
vitest-config
Overview
DEFAULT_VITEST_REPORTERS
DEFAULT_VITEST_TEST_EXCLUDE
defineLibraryVitestConfig
DefineLibraryVitestConfigParams
LIBRARY_VITEST_COVERAGE
VitestReporter
upstream-sync
Overview
buildPrBody
CommandResult
compareWithUpstream
GitUpstreamEntry
NpmUpstreamEntry
parseUpstreamsConfig
planSync
SyncDependencies
SyncPlan
SyncResult
syncUpstreams
SyncUpstreamsOptions
UpstreamEntry
UpstreamsConfig
UpstreamStatus
writePin
upstream-sync-cli
Overview
createNodeSyncDependencies
parseSyncUpstreamsArguments
runSyncUpstreamsCli
validate-declarations
Overview
validateDeclarations
ValidateDeclarationsOptions
validate-dependencies
Overview
DEFAULT_VALIDATE_DEPENDENCIES_FOLDERS
validateDependencies
ValidateDependenciesOptions
version
Overview
addGitTag
addUpdatedFilesToGit
AddUpdatedFilesToGitOptions
assertGitHubCliInstalled
assertGitInstalled
assertGitRepoClean
autolinkBareUrls
getNewVersion
getReleaseNotes
getVersionUpdateType
gitPush
isPreRelease
ParsedVersionArguments
parseVersionArguments
publishGitHubRelease
PublishGitHubReleaseOptions
toUpdateVersionOptions
updateChangelog
UpdateChangelogOptions
updateVersion
updateVersionInFiles
UpdateVersionOptions
validate
VERSION_ARGUMENT_OPTIONS
VersionArgumentValues
VersionUpdateType
GitHub
Select theme
Dark
Light
Auto
EslintConfigContext.sourceFiles
EslintConfigContext
› sourceFiles
Type:
string
[]
The source files.