@servicenow/sdk - v4.4.1
    Preparing search index...

    Interface Compiler

    Project that holds source files.

    interface Compiler {
        get compilerOptions(): CompilerOptionsContainer;
        get manipulationSettings(): ManipulationSettingsContainer;
        addAvailableModules(): void;
        addDirectoryAtPath(
            dirPath: string,
            options?: DirectoryAddOptions,
        ): Directory;
        addDirectoryAtPathIfExists(
            dirPath: string,
            options?: DirectoryAddOptions,
        ): Directory | undefined;
        addFluentSourceFilesAtPaths(paths: string[]): SourceFile[];
        addFluentSourceFilesFromDirectory(dir: string): SourceFile[];
        addGlobalModuleExtensions(): void;
        addGlobalTableDefinitionFile(): void;
        addSourceFileAtPath(filePath: string): SourceFile;
        addSourceFileAtPathIfExists(filePath: string): SourceFile | undefined;
        addSourceFilesAtPaths(fileGlobs: string | readonly string[]): SourceFile[];
        addSourceFilesFromDirectory(
            dir: string,
            includePatterns: string[],
            excludePatterns?: string[],
        ): SourceFile[];
        addSourceFilesFromTsConfig(tsConfigFilePath: string): SourceFile[];
        addTableInterfacesToGlobalDeclaration(
            data: {
                imports: any;
                interfaces: any;
                namedImports: any;
                properties: any;
            },
        ): void;
        addTypesTableDeclaration(typesDir: string): SourceFile | undefined;
        compileModule(
            moduleFile: SourceFile,
            fs: FileSystem,
            diagnostics: Diagnostics,
            tsConfigPath?: string,
        ): string | undefined;
        createDirectory(dirPath: string): Directory;
        createSourceFile(
            filePath: string,
            sourceFileText?:
                | string
                | WriterFunction
                | OptionalKind<SourceFileStructure>,
            options?: SourceFileCreateOptions,
        ): SourceFile;
        createWriter(): CodeBlockWriter;
        emit(emitOptions?: EmitOptions): Promise<EmitResult>;
        emitSync(emitOptions?: EmitOptions): EmitResult;
        emitToMemory(emitOptions?: EmitOptions): MemoryEmitResult;
        enableLogging(enabled?: boolean): void;
        forgetNodesCreatedInBlock<T = void>(
            block: (remember: (...node: Node<tsc.Node>[]) => void) => T,
        ): T;
        forgetNodesCreatedInBlock<T = void>(
            block: (remember: (...node: Node<tsc.Node>[]) => void) => Promise<T>,
        ): Promise<T>;
        formatDiagnosticsWithColorAndContext(
            diagnostics: readonly Diagnostic<tsc.Diagnostic>[],
            opts?: { newLineChar?: "\n" | "\r\n" },
        ): string;
        getAmbientModule(moduleName: string): Symbol | undefined;
        getAmbientModuleOrThrow(
            moduleName: string,
            message?: string | (() => string),
        ): Symbol;
        getAmbientModules(): Symbol[];
        getCompilerOptions(): tsc.CompilerOptions;
        getConfigFileParsingDiagnostics(): Diagnostic<tsc.Diagnostic>[];
        getDiagnosticsForFluentFile(
            fileOrPath: string | SourceFile,
        ): TypeScriptDiagnostic[];
        getDirectories(): Directory[];
        getDirectory(dirPath: string): Directory | undefined;
        getDirectoryOrThrow(
            dirPath: string,
            message?: string | (() => string),
        ): Directory;
        getFileSystem(): FileSystemHost;
        getFluentSourceFilesFromDirectory(dir: string): SourceFile[];
        getGeneratedTableFile(): SourceFile | undefined;
        getLanguageService(): LanguageService;
        getModuleResolutionHost(): ModuleResolutionHost;
        getOrCreateSourceFile(
            path: string,
            options?: SourceFileCreateOptions,
        ): SourceFile;
        getPreEmitDiagnostics(): Diagnostic<tsc.Diagnostic>[];
        getProgram(): Program;
        getRootDirectories(): Directory[];
        getSourceFile(fileNameOrPath: string): SourceFile | undefined;
        getSourceFile(
            searchFunction: (file: SourceFile) => boolean,
        ): SourceFile | undefined;
        getSourceFileOrThrow(fileNameOrPath: string): SourceFile;
        getSourceFileOrThrow(
            searchFunction: (file: SourceFile) => boolean,
        ): SourceFile;
        getSourceFiles(): SourceFile[];
        getSourceFiles(globPattern: string): SourceFile[];
        getSourceFiles(globPatterns: readonly string[]): SourceFile[];
        getTableColumnTypes(
            tableName: string,
        ):
            | Map<string, "number" | "boolean" | "array" | "array-optional">
            | undefined;
        getTypeChecker(): TypeChecker;
        importExistsInGlobalDeclaration(
            resolvedModuleSpecifier: string,
        ): ImportDeclaration | undefined;
        interfaceExistsInGlobalDeclaration(
            tableName: string,
        ): InterfaceDeclaration | undefined;
        isGeneratedTableFile(sourceFile: string | SourceFile): boolean;
        propertyExistsInGlobalDeclaration(
            tableName: string,
        ): PropertySignature | undefined;
        removeSourceFile(sourceFile: SourceFile): boolean;
        removeTableInterfaceFromGlobalDeclaration(
            sourceFile: string | SourceFile,
        ): void;
        resetModuleProject(): void;
        resolveSourceFileDependencies(): SourceFile[];
        save(): Promise<void>;
        saveSync(): void;
        visitSupportedNodes(
            node: Node,
            visitor: (
                node:
                    | SourceFile
                    | ImportDeclaration
                    | ExportDeclaration
                    | ExportAssignment
                    | ClassDeclaration
                    | FunctionDeclaration
                    | VariableDeclaration
                    | TypeAliasDeclaration
                    | ModuleDeclaration
                    | Identifier
                    | StringLiteral
                    | NumericLiteral
                    | ComputedPropertyName
                    | NoSubstitutionTemplateLiteral
                    | ParameterDeclaration
                    | PropertySignature
                    | VariableStatement
                    | TrueLiteral
                    | FalseLiteral
                    | TaggedTemplateExpression
                    | PropertyAccessExpression<tsc.PropertyAccessExpression>
                    | PropertyAssignment
                    | TemplateExpression
                    | ArrayLiteralExpression
                    | ArrowFunction
                    | AsExpression
                    | BinaryExpression<tsc.BinaryExpression>
                    | Block
                    | CallExpression<tsc.CallExpression>
                    | ElementAccessExpression<tsc.ElementAccessExpression>
                    | ExportSpecifier
                    | ExpressionStatement
                    | FunctionExpression
                    | ImportClause
                    | ImportSpecifier
                    | ModuleBlock
                    | NamedExports
                    | NamedImports
                    | ObjectLiteralExpression
                    | PrefixUnaryExpression
                    | TemplateHead
                    | TemplateMiddle
                    | TemplateSpan
                    | TemplateTail
                    | VariableDeclarationList
                    | LiteralTypeNode
                    | NullLiteral
                    | TupleTypeNode
                    | TypeLiteralNode
                    | TypeReferenceNode
                    | Node<EndOfFileToken>
                    | Node<EqualsToken>
                    | Node<PlusToken>
                    | Node<ExportKeyword>
                    | Node<KeywordTypeNode<AnyKeyword>>
                    | Node<EqualsGreaterThanToken>,
            ) => void | Promise<void>,
            unsupportedNodeVisitor?: (node: Node) => void | Promise<void>,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Accessors

    compilerOptions manipulationSettings

    Methods

    addAvailableModules addDirectoryAtPath addDirectoryAtPathIfExists addFluentSourceFilesAtPaths addFluentSourceFilesFromDirectory addGlobalModuleExtensions addGlobalTableDefinitionFile addSourceFileAtPath addSourceFileAtPathIfExists addSourceFilesAtPaths addSourceFilesFromDirectory addSourceFilesFromTsConfig addTableInterfacesToGlobalDeclaration addTypesTableDeclaration compileModule createDirectory createSourceFile createWriter emit emitSync emitToMemory enableLogging forgetNodesCreatedInBlock formatDiagnosticsWithColorAndContext getAmbientModule getAmbientModuleOrThrow getAmbientModules getCompilerOptions getConfigFileParsingDiagnostics getDiagnosticsForFluentFile getDirectories getDirectory getDirectoryOrThrow getFileSystem getFluentSourceFilesFromDirectory getGeneratedTableFile getLanguageService getModuleResolutionHost getOrCreateSourceFile getPreEmitDiagnostics getProgram getRootDirectories getSourceFile getSourceFileOrThrow getSourceFiles getTableColumnTypes getTypeChecker importExistsInGlobalDeclaration interfaceExistsInGlobalDeclaration isGeneratedTableFile propertyExistsInGlobalDeclaration removeSourceFile removeTableInterfaceFromGlobalDeclaration resetModuleProject resolveSourceFileDependencies save saveSync visitSupportedNodes

    Accessors

    • get compilerOptions(): CompilerOptionsContainer

      Gets the compiler options for modification.

      Returns CompilerOptionsContainer

    Methods

    • Returns void

    • Adds an existing directory from the path or throws if it doesn't exist.

      Will return the directory if it was already added.

      Parameters

      Returns Directory

      DirectoryNotFoundError when the directory does not exist.

    • Adds an existing directory from the path or returns undefined if it doesn't exist.

      Will return the directory if it was already added.

      Parameters

      Returns Directory | undefined

    • Parameters

      • paths: string[]

      Returns SourceFile[]

    • Recursively adds any .now.ts files in the specified directory, and returns the added files. Glob patterns can be supplied to control which files are added. This will also resolve the dependencies of the added files. If the directory does not exist, an empty array will be returned.

      Parameters

      • dir: string

      Returns SourceFile[]

    • Returns void

    • Returns void

    • Adds an existing source file from a file path or throws if it doesn't exist.

      Will return the source file if it was already added.

      Parameters

      • filePath: string

        File path to get the file from.

      Returns SourceFile

      FileNotFoundError when the file is not found.

    • Adds a source file from a file path if it exists or returns undefined.

      Will return the source file if it was already added.

      Parameters

      • filePath: string

        File path to get the file from.

      Returns SourceFile | undefined

    • Adds source files based on file globs.

      Parameters

      • fileGlobs: string | readonly string[]

        File glob or globs to add files based on.

      Returns SourceFile[]

      The matched source files.

    • Recursively adds any source files in the specified directory, and returns the added files. Glob patterns can be supplied to control which files are added. This will also resolve the dependencies of the added files. If the directory does not exist, an empty array will be returned.

      Parameters

      • dir: string
      • includePatterns: string[]
      • OptionalexcludePatterns: string[]

      Returns SourceFile[]

    • Adds all the source files from the specified tsconfig.json.

      Note that this is done by default when specifying a tsconfig file in the constructor and not explicitly setting the skipAddingFilesFromTsConfig option to true.

      Parameters

      • tsConfigFilePath: string

        File path to the tsconfig.json file.

      Returns SourceFile[]

    • Parameters

      • data: { imports: any; interfaces: any; namedImports: any; properties: any }

      Returns void

    • Loads the project's

      Parameters

      • typesDir: string

      Returns SourceFile | undefined

      tables.d.ts into the compiler if it exists. This file contains declare global augmentation that merges downloaded dependency table types into Now.Internal.Tables.

    • Parameters

      Returns string | undefined

    • Creates a directory at the specified path.

      Parameters

      • dirPath: string

        Path to create the directory at.

      Returns Directory

    • Creates a source file at the specified file path with the specified text.

      Note: The file will not be created and saved to the file system until .save() is called on the source file.

      Parameters

      Returns SourceFile

      • InvalidOperationError if a source file already exists at the provided file path.

    • Creates a writer with the current manipulation settings.

      Returns CodeBlockWriter

      Generally it's best to use a provided writer, but this may be useful in some scenarios.

    • Asynchronously emits all the source files to the file system as JavaScript files.

      Parameters

      • OptionalemitOptions: EmitOptions

        Optional emit options.

      Returns Promise<EmitResult>

    • Synchronously emits all the source files to the file system as JavaScript files.

      Parameters

      • OptionalemitOptions: EmitOptions

        Optional emit options.

      Returns EmitResult

    • Enables logging to the console.

      Parameters

      • Optionalenabled: boolean

        Enabled.

      Returns void

    • Forgets the nodes created in the scope of the passed in block.

      This is an advanced method that can be used to easily "forget" all the nodes created within the scope of the block.

      Type Parameters

      • T = void

      Parameters

      • block: (remember: (...node: Node<tsc.Node>[]) => void) => T

        Block of code to run. Use the remember callback or return a node to remember it.

      Returns T

    • Forgets the nodes created in the scope of the passed in block asynchronously.

      This is an advanced method that can be used to easily "forget" all the nodes created within the scope of the block.

      Type Parameters

      • T = void

      Parameters

      • block: (remember: (...node: Node<tsc.Node>[]) => void) => Promise<T>

        Block of code to run. Use the remember callback or return a node to remember it.

      Returns Promise<T>

    • Formats an array of diagnostics with their color and context into a string.

      Parameters

      • diagnostics: readonly Diagnostic<tsc.Diagnostic>[]

        Diagnostics to get a string of.

      • Optionalopts: { newLineChar?: "\n" | "\r\n" }

      Returns string

    • Gets the specified ambient module symbol or returns undefined if not found.

      Parameters

      • moduleName: string

        The ambient module name with or without quotes.

      Returns Symbol | undefined

    • Gets the specified ambient module symbol or throws if not found.

      Parameters

      • moduleName: string

        The ambient module name with or without quotes.

      • Optionalmessage: string | (() => string)

      Returns Symbol

    • Gets the ambient module symbols (ex. modules in the

      Returns Symbol[]

      folder or node_modules).

    • Parameters

      Returns TypeScriptDiagnostic[]

    • Gets all the directories.

      Returns Directory[]

    • Gets a directory by the specified path or returns undefined if it doesn't exist.

      Parameters

      • dirPath: string

        Directory path.

      Returns Directory | undefined

    • Gets a directory by the specified path or throws if it doesn't exist.

      Parameters

      • dirPath: string

        Path to create the directory at.

      • Optionalmessage: string | (() => string)

      Returns Directory

    • Parameters

      • dir: string

      Returns SourceFile[]

    • Returns SourceFile | undefined

    • Gets the program.

      Returns Program

    • Gets the directories without a parent.

      Returns Directory[]

    • Gets a source file by a file name or file path. Returns undefined if none exists.

      Parameters

      • fileNameOrPath: string

        File name or path that the path could end with or equal.

      Returns SourceFile | undefined

    • Gets a source file by a search function. Returns undefined if none exists.

      Parameters

      • searchFunction: (file: SourceFile) => boolean

        Search function.

      Returns SourceFile | undefined

    • Gets a source file by a file name or file path. Throws an error if it doesn't exist.

      Parameters

      • fileNameOrPath: string

        File name or path that the path could end with or equal.

      Returns SourceFile

    • Gets a source file by a search function. Throws an error if it doesn't exist.

      Parameters

      • searchFunction: (file: SourceFile) => boolean

        Search function.

      Returns SourceFile

    • Gets all the source files added to the project.

      Returns SourceFile[]

    • Gets all the source files added to the project that match a pattern.

      Parameters

      • globPattern: string

        Glob pattern for filtering out the source files.

      Returns SourceFile[]

    • Gets all the source files added to the project that match the passed in patterns.

      Parameters

      • globPatterns: readonly string[]

        Glob patterns for filtering out the source files.

      Returns SourceFile[]

    • Parameters

      • tableName: string

      Returns Map<string, "number" | "boolean" | "array" | "array-optional"> | undefined

    • Parameters

      • resolvedModuleSpecifier: string

      Returns ImportDeclaration | undefined

    • Parameters

      • tableName: string

      Returns InterfaceDeclaration | undefined

    • Parameters

      Returns boolean

    • Parameters

      • tableName: string

      Returns PropertySignature | undefined

    • Removes a source file from the project.

      Parameters

      Returns boolean

      True if removed.

    • Parameters

      Returns void

    • Returns void

    • Adds the source files the project's source files depend on to the project.

      Returns SourceFile[]

      The added source files.

      • This should be done after source files are added to the project, preferably once to avoid doing more work than necessary.
      • This is done by default when creating a Project and providing a tsconfig.json and not specifying to not add the source files.

    • Saves all the unsaved source files to the file system and deletes all deleted files.

      Returns Promise<void>

    • Synchronously saves all the unsaved source files to the file system and deletes all deleted files.

      Remarks: This might be very slow compared to the asynchronous version if there are a lot of files.

      Returns void

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods
    addAvailableModulesaddDirectoryAtPathaddDirectoryAtPathIfExistsaddFluentSourceFilesAtPathsaddFluentSourceFilesFromDirectoryaddGlobalModuleExtensionsaddGlobalTableDefinitionFileaddSourceFileAtPathaddSourceFileAtPathIfExistsaddSourceFilesAtPathsaddSourceFilesFromDirectoryaddSourceFilesFromTsConfigaddTableInterfacesToGlobalDeclarationaddTypesTableDeclarationcompileModulecreateDirectorycreateSourceFilecreateWriteremitemitSyncemitToMemoryenableLoggingforgetNodesCreatedInBlockformatDiagnosticsWithColorAndContextgetAmbientModulegetAmbientModuleOrThrowgetAmbientModulesgetCompilerOptionsgetConfigFileParsingDiagnosticsgetDiagnosticsForFluentFilegetDirectoriesgetDirectorygetDirectoryOrThrowgetFileSystemgetFluentSourceFilesFromDirectorygetGeneratedTableFilegetLanguageServicegetModuleResolutionHostgetOrCreateSourceFilegetPreEmitDiagnosticsgetProgramgetRootDirectoriesgetSourceFilegetSourceFileOrThrowgetSourceFilesgetTableColumnTypesgetTypeCheckerimportExistsInGlobalDeclarationinterfaceExistsInGlobalDeclarationisGeneratedTableFilepropertyExistsInGlobalDeclarationremoveSourceFileremoveTableInterfaceFromGlobalDeclarationresetModuleProjectresolveSourceFileDependenciessavesaveSyncvisitSupportedNodes