WebCola
Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

Hierarchy

  • Local

Index

Methods

get

  • get(node: Element): T | undefined
  • Retrieves a local variable stored on the node (or one of its parents).

    Parameters

    • node: Element

      A node element.

    Returns T | undefined

remove

  • remove(node: Element): boolean
  • Deletes the value associated with the given node. Values stored on ancestors are not affected, meaning that child nodes will still see inherited values.

    This function returns true if there was a value stored directly on the node, and false otherwise.

    Parameters

    • node: Element

      A node element.

    Returns boolean

set

  • set(node: Element, value: T): Element
  • Store a value for this local variable. Calling .get() on children of this node will also retrieve the variable's value.

    Parameters

    • node: Element

      A node element.

    • value: T

      Value to store locally

    Returns Element

toString

  • toString(): string
  • Obtain a string with the internally assigned property name for the local which is used to store the value on a node

    Returns string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc