Class Template

Template.

Hierarchy

Constructors

constructor

Properties

_blocks _componentName author? cuSocket? name

Accessors

blocks first last length

Methods

add export get pop push toString

Constructors

constructor

Properties

_blocks

_blocks: DFCodeExportableBlock[] = []

Never use this unless you want to explicitly set the codeblocks array.

Readonly _componentName

_componentName: string = "serializable"

The component's name

Optional author

author?: string

Template author, defaults to "anonymous".

Optional cuSocket

cuSocket?: WebSocket

name

name: string | false

Template name, defaults to "untitled".

Accessors

blocks

first

last

length

Methods

add

export

  • Serialize the object into a readable DiamondFire format.

    Returns

    DiamondFire codeblock object.

    Returns {
        compressed: string;
        sendToCodeutils: (() => Promise<void>);
        serialized: RawDFTemplate;
    }

    • compressed: string
    • Readonly sendToCodeutils: (() => Promise<void>)
        • (): Promise<void>

        • Returns Promise<void>

    • serialized: RawDFTemplate

get

pop

push

toString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc