Home > vue-metamorph > astHelpers > createDefaultImport

astHelpers.createDefaultImport() function

Adds a default import to a script AST. If an import declaration for the module already exists, this function merges the default specifier into that declaration. It doesn't create duplicate imports.

Signature:

export declare function createDefaultImport(ast: namedTypes.Program, moduleSpecifier: string, importName: string): void;

Parameters

Parameter	Type	Description
ast	namedTypes.Program	The script AST.
moduleSpecifier	string	The module name to import from, such as 'vue'.
importName	string	The local name for the default import.

Returns:

void

Exceptions

An error if the declaration already has a default import under a different name.

Example

// import Vue from 'vue';
createDefaultImport(scriptAST, 'vue', 'Vue');