Logo for jsDocs.io

typescript-definition-tester

  • Version 0.0.6
  • Published
  • 14.8 kB
  • 3 dependencies
  • MIT license

Install

npm i typescript-definition-tester
yarn add typescript-definition-tester
pnpm add typescript-definition-tester

Overview

The purpose of this repository is to wrap the TypeScript compiler so that a consumer can easily test their ambient module declarations against example *.ts files. This module uses chai assertions so that a user can easily add this step to existing unit t

Index

Functions

Type Aliases

Namespaces

Functions

function compile

compile: (
    fileNames: string[],
    options: ts.CompilerOptions,
    done: Function
) => void;

    function compileDirectory

    compileDirectory: {
        (path: string, done: Function): void;
        (path: string, options: ts.CompilerOptions, done: Function): void;
        (path: string, filter: FilterFunction, done: Function): void;
        (
            path: string,
            filter: FilterFunction,
            options: ts.CompilerOptions,
            done: Function
        ): void;
    };

      function walk

      walk: {
          (dir: string, done: DoneFunction): void;
          (dir: string, filter: FilterFunction, done: DoneFunction): void;
      };

        Type Aliases

        type DoneFunction

        type DoneFunction = (err: any, results?: string[]) => void;

          type FilterFunction

          type FilterFunction = (fileName: string) => boolean;

            Namespaces

            namespace test

            module 'test' {}

              interface IPerson

              interface IPerson {}

                property name

                name: string;

                  namespace typescript-definition-tester

                  module 'typescript-definition-tester' {}

                    function compile

                    compile: (
                        fileNames: string[],
                        options: ts.CompilerOptions,
                        done: Function
                    ) => void;

                      function compileDirectory

                      compileDirectory: {
                          (path: string, done: Function): void;
                          (path: string, options: ts.CompilerOptions, done: Function): void;
                          (path: string, filter: FilterFunction, done: Function): void;
                          (
                              path: string,
                              filter: FilterFunction,
                              options: ts.CompilerOptions,
                              done: Function
                          ): void;
                      };

                        function walk

                        walk: {
                            (dir: string, done: DoneFunction): void;
                            (dir: string, filter: FilterFunction, done: DoneFunction): void;
                        };

                          type DoneFunction

                          type DoneFunction = (err: any, results?: string[]) => void;

                            type FilterFunction

                            type FilterFunction = (fileName: string) => boolean;

                              Package Files (3)

                              Dependencies (3)

                              Dev Dependencies (6)

                              Peer Dependencies (1)

                              Badge

                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/typescript-definition-tester.

                              • Markdown
                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/typescript-definition-tester)
                              • HTML
                                <a href="https://www.jsdocs.io/package/typescript-definition-tester"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>