Nearly Perfect Mediocracy

    @lwc/compiler
    TypeScript icon, indicating that this package has built-in type declarations

    2.23.0 • Public • Published

    LWC Compiler

    @lwc/compiler is an open source project that enables developers to take full control of processing a single Lightning Web Components module for runtime consumption.

    Installation

    yarn add --dev @lwc/compiler

    APIs

    transform

    Transform the content of individual file.

    import { transform } from '@lwc/compiler';
    
    const source = `
        import { LightningElement } from 'lwc';
        export default class App extends LightningElement {}
    `;
    
    const filename = 'app.js';
    
    const options = {
        namespace: 'c',
        name: 'app',
    };
    
    const { code } = await transform(source, filename, options);

    Parameters:

    • source (string, required) - the source to be transformed can be the content of javascript, HTML, CSS.
    • filename (string, required) - the source filename with extension.
    • options (object, required) - the transformation options. The name and the namespace of the component is a minimum required for transformation.

    Return

    • code (string) - the compiled source code.
    • map (object) - the generated source map.
    • warnings (array, optional) - the array of diagnostic warnings, if any.

    version

    import { version } from '@lwc/compiler';
    
    console.log(version);

    Return

    • version (string) - the current version of the compiler ex: 0.25.1.

    Keywords

    none

    Install

    npm i @lwc/compiler

    Homepage

    lwc.dev/

    DownloadsWeekly Downloads

    38,265

    Version

    2.23.0

    License

    MIT

    Unpacked Size

    32.7 kB

    Total Files

    20

    Last publish

    Collaborators

    • divmain
    • lwc-admin
    • caridy
    • tbliss
    • pmdartus
    • ekashida
    • kevinv11n
    • jye-sf
    • rui.qiu
    • ravi.jayaramappa
    • jodarove
    • abdulsattar
    • nolanlawson
    • jmsjtu