Skip to main content
Home

Built and signed on GitHub Actions

A Typescript testing package for your "type tests"

This package works with Node.js, Deno, BunIt is unknown whether this package works with Cloudflare Workers, Browsers
It is unknown whether this package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
It is unknown whether this package works with Browsers
JSR Score
64%
Published
a month ago (0.13.2)
I
f
asFileDiagnostic

asFileDiagnostic(diag)

f
askForRefinedPattern

askForRefinedPattern

T
AsOption
No documentation available
f
asSymbolMeta

asSymbolMeta(sym) -> SymbolMeta

f
asSymbolReference
No documentation available
f
asTestFile

asTestFile(filePath, options) -> Promise<TestFile>

f
availableWidth

availableWidth() -> number

I
BlockType
No documentation available
f
buildDependencyGraph

buildDependencyGraph

f
buildDependencyMap

buildDependencyMap

f
buildDependencyNode

buildDependencyNode

f
calculateDependencyDepth

calculateDependencyDepth

f
classifyImportSymbols

Classify import symbols as runtime, type, or mixed

T
CliResponse
No documentation available
T
Command
No documentation available
v
commands_union
No documentation available
f
confirmAction

confirmAction

f
consumedWidth

consumedWidth(text) -> number

f
create_cli
No documentation available
f
createFullyQualifiedNameForSymbol
No documentation available
f
createSymbolDisplayName

createSymbolDisplayName

f
createSymbolHash
No documentation available
I
Dependency

Dependency (Legacy)

f
deps_command
No documentation available
f
detectCycles

detectCycles

f
detectTerminalTheme
No documentation available
T
DiagnosticCategory
No documentation available
T
DiagnosticCodeLookup

DiagnosticCodeLookup

f
diagnosticLookup

diagnosticLookup(ref)

T
DiagnosticMessageLookup

DiagnosticMessageLookup

f
extractImports

Extract all import declarations from a source file

I
FileDiagnostic
No documentation available
I
FileImportSummary

FileImportSummary

I
FileLookup

FileLookup

I
FileMeta
No documentation available
f
files_command
No documentation available
I
f
filterSymbols

Filter symbols based on provided filter options

f
filterSymbolsByGlobPatterns

filterSymbolsByGlobPatterns

f
filterTestFilesByPattern

Filter test files by patterns, supporting negation with '!' prefix. Supports basic glob patterns with * and ? wildcards.

f
findReferencingSymbols
No documentation available
f
findSymbolsByPattern

findSymbolsByPattern

T
Foo
No documentation available
T
FQN
No documentation available
f
getAllSymbolObjectsInProject

getAllSymbolObjectsInProject

f
getAllSymbolsInProject
No documentation available
f
getConfigHash
No documentation available
f
getDependencyGraph

getDependencyGraph

f
getDependents

getDependents

f
getDiagnosticsBetweenLines

Get the diagnostics for a page and then the isolates only those between a start and end line number.

f
getDiagnosticsOutsideBlocks

getErrorsOutsideBlocks(file, ...blocks)

f
getErrorDiagnostics
No documentation available
f
getErrorDiagnosticsBetweenLines
No documentation available
f
getFileDiagnostics

gets all the diagnostics for a given file.

f
getGraphStatistics

getGraphStatistics

f
getImportLocation

Determine the import location category

f
getImportsForFile

Provides a list of symbols for the provided file

f
getImportStructure

Determine the import structure

f
getLanguageService
No documentation available
f
getProject
No documentation available
f
getProjectRoot
No documentation available
f
getProjectTypeChecker
No documentation available
f
getSymbolDefinition
No documentation available
f
getSymbolDependencies

Returns an array of dependencies for a given symbol.

f
getSymbolFileDefinition
No documentation available
f
getSymbolFlags

getSymbolFlags(sym)

f
getSymbolKind

categorizes a ts-morph Symbol into a broad category defined the SymbolKind type alias.

f
getSymbolName

finds the symbol name for a given symbol or symbol metadata structure.

f
getSymbolScope

Determines the scope of the given symbol.

f
getSymbolsDefinedInFile

getSymbolsDefinedInFile(file, [imports])

f
getTerminalTheme

Synchronous version that returns the cached theme or 'dark' as default Use this after calling detectTerminalTheme() at least once

f
getTestFiles

get's an array of files in the repo

f
getWarningDiagnostics
No documentation available
f
getWarningDiagnosticsBetweenLines
No documentation available
v
global_options

options which are available to all commands

I
GraphNode
No documentation available
f
handleSymbolSelection

handleSymbolSelection

f
hasDiagnostics
No documentation available
T
ImportCategory

a category for imports

f
imports_command

imports_command

f
initializeProjectTypeChecker
No documentation available
f
invalidateDependencyCache

invalidateDependencyCache

f
isCommand

type guard which checks whether the passed in value is a known command to CLI

f
isErrorDiagnostic
No documentation available
f
isExportedSymbol
No documentation available
f
isExternalSymbol

Tests whether the passed in symbol is external to the repo being evaluated.

f
isFileDiagnostic

type guard which validates passed in value is a FileDiagnostic

f
isFQN
No documentation available
f
isGenericSymbol

Distinguishes between a true symbol definition and a generic.

f
isSlowTest
No documentation available
f
isSourceFile
No documentation available
f
isSymbol

Type guard which checks whether the passed in value is a Symbol from ts-morph.

f
isSymbolExported

Determines if the given symbol is exported in the project.

f
isSymbolMeta

Type guard which checks whether the passed in value is SymbolMeta.

f
isSymbolMetaWithDependencies
No documentation available
f
isTsDiagnostic

type guard which validates passed in value is a Diagnostic from Typescript (but not ts-morph).

f
isTsMorphDiagnostic

type guard which validates passed in value is a Diagnostic from ts-morph.

f
isVerySlowTest
No documentation available
I
JsDocInfo
No documentation available
I
JsDocTag

an individual tag and tag comment

f
matchesFilter

Check if a symbol name matches a filter string

v
MAX_SYMBOLS
No documentation available
T
MicrosoftDiagnosticLookup

DiagnosticMessageLookup

f
msg

messages out to stderr (to avoid conflicts with primary output going to stdout)

f
NumericArray

used to define CLI variable as a numeric array

v
only_global_options

options which are available only when no command is expressed

f
padEndVisible

padEndVisible(text, targetWidth) -> string

f
prettyPath

prettyPath(path)

f
prettyPath2

prettyPath

f
projectUsing

Returns a ts-morph project from an array of possible tsconfig files, using the first match in the file system.

f
rel

make file reference relative from current working directory

f
relativeFile

returns a relative filepath from the project's root

f
resetProjectCache

Reset the project cache - useful for testing when you need to switch projects

f
selectMultipleSymbolsFromMatches

selectMultipleSymbolsFromMatches

f
selectSymbolFromMatches

selectSymbolFromMatches

f
shout

messages out to stderr (to avoid conflicts with primary output going to stdout)

f
source_command
No documentation available
f
stripAnsi

Removes all ANSI escape codes from a string, including:

T
SymbolFilterCallback
No documentation available
T
SymbolFlagKey

The union type which represents all the keys to the ts.SymbolFlags enumeration.

T
SymbolFlagLookup

type utility which provides the name of the SymbolFlag for a given numerical representation of it's ts.SymbolFlags property.

f
symbolHasSymbolFlags

tests whether the passed in symbol has any of the passed in ts.SymbolFlags

T
SymbolKind
No documentation available
T
SymbolMetaWithDeps

SymbolMetaWithDeps

I
SymbolReference
No documentation available
f
symbols_command

COMMAND

T
SymbolScope

specifies the scope of where the symbol is available:

T
TerminalTheme
No documentation available
f
test_command
No documentation available
I
TestFileOptions
No documentation available
f
traverseDependencies

traverseDependencies

f
truncateVisible

truncateVisible(text, maxWidth) -> string

I
TypeGeneric

Describes a generic parameter

I
T
TypescriptTvUrl
No documentation available
f
updateDependencyGraph

updateDependencyGraph

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.