New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More

@lwc/template-compiler

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@lwc/template-compiler

Template compiler package

0.33.27-alpha1
Version published
Weekly downloads
95K
-1.27%
Maintainers
11
Weekly downloads
 
Created

lwc-template-compiler

Compile LWC HTML template for consumption at runtime.

Installation

npm install --save-dev lwc-template-compiler

Usage

import compile from 'lwc-template-compiler';

const { code, warnings } = compile(`
    <template>
        <h1>Hello World!</h1>
    </template>
`);

for (let warning of warnings) {
    console.log(warning.message);
}

console.log(code);

APIs

compile

Compile a LWC template to javascript source code consumable by the engine.

import compile from 'lwc-template-compiler';
const { code, warnings } = compile(`<template><h1>Hello World!</h1></template>`);

Parameters:

  • source (string, required) - the HTML template source to compile.

Return: The method returns an object with the following fields:

  • code (string) - the compiled template.
  • warnings (array) - the list of warnings produced when compiling the template. Each warning has the following fields:
    • message (string) - the warning message.
    • level (string) - the severity of the warning: info, warning, error.
    • start (number) - the start index in the source code producing the warning.
    • length (number) - the character length in the source code producing the warning.

compileToFunction

Compile a LWC template to a javascript function. This method is mainly used for testing purposes.

import { LightningElement } from 'lwc';
import { compileToFunction } from 'lwc-template-compiler';

const html = compileToFunction(`<template><h1>Hello World!</h1></template>`);

class Component extends LightningElement {
    render() {
        return html;
    }
}

Parameters:

  • source (string, required) - the HTML template source to compile.

Return: The method returns an evaluated function that can be used directly in a component render method.

FAQs

Package last updated on 26 Dec 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts