Function removeDatasetEntry

  • removeDatasetEntry<TN extends TagName = "*">(
        target: null | Target<TN>,
        key: string,
    ): ElementOf<TN>

  • Removes the dataset entry with attribute/property name key from the target.

    Type Parameters

    • TN extends TagName = "*"

      Tag name of the Element representation of target.

    Parameters

    • target: null | Target<TN>

      Element, EventTarget, or CSS selector.

    • key: string

      Dataset property or attribute name for the dataset entry to remove.

    Returns ElementOf<TN>

    Element representation of the specified target.

    Throws

    elements!InvalidElementError if the specified target wasn't found.

    Example

    HTML (Before)

    <div
      id="example"
      data-is-active="false"
      data-count="30"
      data-label="Example"
    >
      ...
    </div>

    Using Attribute Name (data-*)

    const element = findElement("#example")!;

    removeDatasetEntry(element, "data-label");

    Using Property Name (camelCase)

    const element = findElement("#example")!;

    removeDatasetEntry(element, "label");

    HTML (After)

    <div
      id="example"
      data-is-active="false"
      data-count="30"
    >
      ...
    </div>

Settings

Member Visibility