1. Web
  2. Web APIs
  3. CharacterData
  4. substringData()

CharacterData: substringData() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨July 2015⁩.

The substringData() method of the CharacterData interface returns a portion of the existing data, starting at the specified index and extending for a given number of characters afterwards.

Syntax

js
substringData(offset, count)

Parameters

offset

The index of the first character to include in the returned substring. 0 is the first character of the string.

count

The number of characters to return.

Return value

A string with the substring.

Exceptions

IndexSizeError DOMException

Thrown if offset + count is larger than the length of the contained data.

Specifications

Specification
DOM
# dom-characterdata-substringdata

Browser compatibility

Help improve MDN

Learn how to contribute

This page was last modified on by MDN contributors.

View this page on GitHub • Report a problem with this content