import {PropertyBuilder} from 'custom-elements-builder/lib/builder/PropertyBuilder.js'

public class | source

PropertyBuilder

Builder → PropertyBuilder

The property builder. Its goal is to provide a way to define a property.

Constructor Summary

Public Constructor
public	constructor(propName: string)

Public Methods
public	getter(fn: function(el: HTMLElement): *): PropertyBuilder To set a getter function.
public	hidden(): PropertyBuilder To hide the property name when using `Object.keys()`.
public	immutable(): PropertyBuilder To make an immutable property.
public	setter(fn: function(el: HTMLElement, value: *)): PropertyBuilder To set a setter function.
public	value(value: *): PropertyBuilder To set a default value.

From class Builder
public	build(proto: CustomElementBuilder.context.proto, on: on) To specify the logic of the builder.

Name	Type	Attribute	Description
propName	string	nullable: false	the name of the property

To set a getter function.

Name	Type	Attribute	Description
fn	function(el: HTMLElement): *		the getter function

the builder

To hide the property name when using Object.keys().

the builder

To make an immutable property.

the builder

To set a setter function.

Name	Type	Attribute	Description
fn	function(el: HTMLElement, value: *)		the setter function

the builder

To set a default value.

Name	Type	Attribute	Description
value	*		the default value

the builder