Logo for jsDocs.io

typescript-transform-paths

  • Version 3.5.5
  • Published
  • 155 kB
  • 1 dependency
  • MIT license

Install

npm i typescript-transform-paths
yarn add typescript-transform-paths
pnpm add typescript-transform-paths

Overview

Transforms module resolution paths using TypeScript path mapping and/or custom paths

Index

Functions

Interfaces

Namespaces

Functions

function register

register: typeof register;

    function transformer

    transformer: (
        program?: ts.Program,
        pluginConfig?: TsTransformPathsConfig,
        transformerExtras?: TransformerExtras,
        manualTransformOptions?: {
            compilerOptions?: ts.CompilerOptions;
            fileNames?: string[];
        }
    ) => (
        transformationContext: ts.TransformationContext
    ) => (sourceFile: ts.SourceFile) => ts.SourceFile;

      Interfaces

      interface TsTransformPathsConfig

      interface TsTransformPathsConfig extends PluginConfig {}

        property exclude

        readonly exclude?: string[];

          property useRootDirs

          readonly useRootDirs?: boolean;

            Namespaces

            namespace nxTransformerPlugin

            module 'dist/plugins/nx-transformer-plugin.d.ts' {}

              variable afterDeclarations

              const afterDeclarations: NxTransformerFactory;

                variable before

                const before: NxTransformerFactory;

                  interface NxTransformerPlugin

                  interface NxTransformerPlugin {}

                    property afterDeclarations

                    afterDeclarations: NxTransformerFactory;

                      property before

                      before: NxTransformerFactory;

                        interface TsTransformPathsConfig

                        interface TsTransformPathsConfig {}

                          property afterDeclarations

                          readonly afterDeclarations?: boolean;

                            property exclude

                            readonly exclude?: string[];

                              property transform

                              readonly transform?: string;

                                property tsConfig

                                readonly tsConfig?: string;

                                  property useRootDirs

                                  readonly useRootDirs?: boolean;

                                    type NxTransformerFactory

                                    type NxTransformerFactory = (
                                        config?: Omit<TsTransformPathsConfig, 'transform'>,
                                        program?: ts.Program
                                    ) => ts.TransformerFactory<ts.SourceFile>;

                                      namespace register

                                      namespace register {}

                                        function initialize

                                        initialize: () => {
                                            tsNode: typeof TSNode;
                                            instanceSymbol: typeof REGISTER_INSTANCE;
                                            tsNodeInstance: TSNode.Service;
                                        };

                                          Package Files (5)

                                          Dependencies (1)

                                          Dev Dependencies (18)

                                          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-transform-paths.

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