typescript-service

typescript-service

Language service which helps to get diagnostic messages from typescript source files.

INSTALL

npm install --save-dev typescript-service

USAGE

import { createService } from 'typescript-service';

const service = createService({ configFile, compilerOptions });
const diagnostics = service.getDiagnostics(fileName);

API

createService({ configFile: string, compilerOptions?: ts.CompilerOptions })

• configFile (required, string) Path to tsconfig.json file
• compilerOptions (optional, Object) Compiler options to overwrite defined in tsconfig.json

Returns object with properties which are functions:

getSourceFile({ fileName: string, sourceText?: string })

Update (add) information about file in typescript service.

• fileName (required, string) Path to typescript file
• sourceText (optional, string) File content of this file

getDiagnostics: (fileName: string, sourceText?: string): Array<ts.DiagnosticWithLocation>

Get diagnostic messages for fileName

• fileName (required, string) Path to typescript file
• sourceText (optional, string) If path outside of scope defined in tsconfig you need provide sourceText

getProgram(): ts.Program

Get ts.Program

CHANGELOG

See CHANGELOG.md

Changelog

<small>2.0.2 (2018-08-26)</small>

• fix: Restored getSource file fallback implementation (e29755c)