@types/module-alias

What is @types/module-alias?

@types/module-alias is a TypeScript type definition package for the module-alias library, which allows you to create custom module paths and aliases in Node.js applications. This can help simplify and organize your import statements, making your codebase cleaner and more maintainable.

What are @types/module-alias's main functionalities?

Registering Aliases

This feature allows you to register custom aliases for your modules. In this example, '@root' is aliased to the root directory and '@models' is aliased to the models directory.

const moduleAlias = require('module-alias');
moduleAlias.addAlias('@root', __dirname);
moduleAlias.addAlias('@models', __dirname + '/models');

Using Aliases in Imports

Once aliases are registered, you can use them in your import statements. This makes your import paths shorter and more readable.

const myModel = require('@models/myModel');

Configuration via package.json

You can also configure your aliases directly in your package.json file. This provides a centralized place for managing your module aliases.

{
  "_moduleAliases": {
    "@root": ".",
    "@models": "models"
  }
}

Other packages similar to @types/module-alias

tsconfig-paths

tsconfig-paths is a package that helps load modules whose location is specified in the paths section of tsconfig.json. It is specifically designed for TypeScript projects and provides similar functionality to module-alias by allowing you to define custom module paths.

babel-plugin-module-resolver

babel-plugin-module-resolver is a Babel plugin that allows you to add custom module resolution paths, similar to module-alias. It is more commonly used in projects that use Babel for transpilation and offers more flexibility with Babel's ecosystem.

README

Installation

npm install --save @types/module-alias

Summary

This package contains type definitions for module-alias (https://github.com/ilearnio/module-alias/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/module-alias.

index.d.ts

// Type definitions for module-alias 2.0
// Project: https://github.com/ilearnio/module-alias/
// Definitions by: Kevin Ramharak <https://github.com/KevinRamharak>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

export = init;

/**
 * Import aliases from package.json
 */
declare function init(options?: string | init.Options): void;

/**
 * Exported functoins
 */
declare namespace init {
    function isPathMatchesAlias(path: string, alias: string): boolean;

    /**
     * Register a custom modules directory
     */
    function addPath(path: string): void;

    /**
     * Register a single alias
     */
    function addAlias(alias: string, path: string): void;

    /**
     * Register mutliple aliases
     */
    function addAliases(aliases: { [alias: string]: string }): void;

    /**
     * Reset any changes maded (resets all registered aliases
     * and custom module directories)
     * The function is undocumented and for testing purposes only
     */
    function reset(): void;

    /**
     * module intialis options type
     */
    interface Options {
        base: string;
    }
}

Additional Details

• Last updated: Fri, 09 Jul 2021 02:32:35 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Kevin Ramharak.