Domless SDK API Reference - Revision history

NathanJia: Made minor styling changes for some "Required" and "Optional" tags

2026-01-29T14:28:49Z

Made minor styling changes for some "Required" and "Optional" tags

← Older revision		Revision as of 14:28, 29 January 2026
Line 190:		Line 190:
	e.g. SetTimeout(callback , timeout)		e.g. SetTimeout(callback , timeout)
	===== Parameters =====		===== Parameters =====
	<blockquote>callback Required		<blockquote>callback ''Required''

	● The function to execute when the timer expires		● The function to execute when the timer expires

	timeout Optional		timeout ''Optional''

	● number - The time in milliseconds that the timer should wait before the callback function is executed.		● number - The time in milliseconds that the timer should wait before the callback function is executed.
Line 209:		Line 209:
	e.g. SetInterval(callback , interval)		e.g. SetInterval(callback , interval)
	===== Parameters =====		===== Parameters =====
	<blockquote>callback Required		<blockquote>callback ''Required''

	● The function to be executed after every specified interval		● The function to be executed after every specified interval

	interval Optional		interval ''Optional''

	● number - The delay in milliseconds between each execution of the function.		● number - The delay in milliseconds between each execution of the function.
Line 228:		Line 228:
	e.g. ClearTimeout(timeout)		e.g. ClearTimeout(timeout)
	===== Parameters =====		===== Parameters =====
	<blockquote>timeout Required		<blockquote>timeout ''Required''

	● NodeJS.Timeout \| number \| string - The id of the Timeout object returned by setTimeout		● NodeJS.Timeout \| number \| string - The id of the Timeout object returned by setTimeout
Line 237:		Line 237:
	e.g. ClearInterval(timeout)		e.g. ClearInterval(timeout)
	===== Parameters =====		===== Parameters =====
	<blockquote>timeout Required		<blockquote>timeout ''Required''

	● NodeJS.Timeout \| number \| string - The id of the Timeout object returned by setInterval		● NodeJS.Timeout \| number \| string - The id of the Timeout object returned by setInterval

DhruvAgarwal: Made changes to clearInterval, setInterval, setTimeout, clearTimeout documentation part of implementationHooks.

2026-01-29T14:04:05Z

Made changes to clearInterval, setInterval, setTimeout, clearTimeout documentation part of implementationHooks.

← Older revision		Revision as of 14:04, 29 January 2026
Line 188:		Line 188:
	Function to set a timer in milliseconds to execute a block of code on expiry		Function to set a timer in milliseconds to execute a block of code on expiry

	e.g. SetTimeout(callback , ~~1000~~)		e.g. SetTimeout(callback , timeout)
	===== Parameters =====		===== Parameters =====
	<blockquote>callback Required		<blockquote>callback Required

	● A function to execute when the timer expires		● The function to execute when the timer expires

	timeout ~~Required~~		timeout Optional

	● number - The time that the timer should wait before the callback function is executed~~. This is in milliseconds~~.		● number - The time in milliseconds that the timer should wait before the callback function is executed.
	</blockquote>		</blockquote>

			===== Return value =====
			<blockquote>timeout

			● NodeJS.Timeout \| number \| string - Timeout for use with clearTimeout.</blockquote>

	==== SetInterval ====		==== SetInterval ====
	Function to repeatedly call a function with a fixed time delay in milliseconds between each call.		Function to repeatedly call a function with a fixed time delay in milliseconds between each call.

	e.g. SetInterval(callback , ~~1000~~)		e.g. SetInterval(callback , interval)
	===== Parameters =====		===== Parameters =====
	<blockquote>callback Required		<blockquote>callback Required

	● A function to be executed every interval ~~specified~~		● The function to be executed after every specified interval

	interval ~~Required~~		interval Optional

	● number - The delay in milliseconds between ~~the~~ execution of the function		● number - The delay in milliseconds between each execution of the function.
	</blockquote>		</blockquote>

			===== Return value =====
			<blockquote>timeout

			● NodeJS.Timeout \| number \| string - Timeout for use with clearInterval.</blockquote>

	==== ClearTimeout ====		==== ClearTimeout ====
	Function to cancel the timeout previously set by SetTimeout		Function to cancel the timeout previously set using SetTimeout

	e.g. ClearTimeout(~~1000~~)		e.g. ClearTimeout(timeout)
	===== Parameters =====		===== Parameters =====
	<blockquote>timeout Required		<blockquote>timeout Required

	● number - The ~~time that~~ the ~~timer should wait before the callback function is executed~~		● NodeJS.Timeout \| number \| string - The id of the Timeout object returned by setTimeout
	</blockquote>		</blockquote>
	==== ClearInterval ====		==== ClearInterval ====
	Function to cancel the timed repeating call which was previously ~~established through~~ SetInterval		Function to cancel the timed repeating call which was previously set using SetInterval

	e.g. ClearInterval(~~1000~~)		e.g. ClearInterval(timeout)
	===== Parameters =====		===== Parameters =====
	<blockquote>~~interval~~ Required		<blockquote>timeout Required

	● number - The ~~delay between the execution~~ of the ~~function~~		● NodeJS.Timeout \| number \| string - The id of the Timeout object returned by setInterval
	</blockquote>		</blockquote>
	==== Nielsen Debug Node.js Server for Event Tracking ====		==== Nielsen Debug Node.js Server for Event Tracking ====

AmySockanathan: /* SetInterval */

2026-01-27T21:27:38Z

SetInterval

← Older revision		Revision as of 21:27, 27 January 2026
Line 200:		Line 200:

	==== SetInterval ====		==== SetInterval ====
	Function to repeatedly call a function with a fixed time delay between each call.		Function to repeatedly call a function with a fixed time delay in milliseconds between each call.

	e.g. SetInterval(callback , 1000)		e.g. SetInterval(callback , 1000)
Line 210:		Line 210:
	interval Required		interval Required

	● number - The delay between the execution of the function		● number - The delay in milliseconds between the execution of the function
	</blockquote>		</blockquote>

	==== ClearTimeout ====		==== ClearTimeout ====
	Function to cancel the timeout previously set by SetTimeout		Function to cancel the timeout previously set by SetTimeout

AmySockanathan: /* SetTimeout */

2026-01-27T21:27:03Z

SetTimeout

← Older revision		Revision as of 21:27, 27 January 2026
Line 186:		Line 186:

	==== SetTimeout ====		==== SetTimeout ====
	Function to set a timer to execute a block of code on expiry		Function to set a timer in milliseconds to execute a block of code on expiry

	e.g. SetTimeout(callback , 1000)		e.g. SetTimeout(callback , 1000)
Line 196:		Line 196:
	timeout Required		timeout Required

	● number - The time that the timer should wait before the callback function is executed		● number - The time that the timer should wait before the callback function is executed. This is in milliseconds.
	</blockquote>		</blockquote>

	==== SetInterval ====		==== SetInterval ====
	Function to repeatedly call a function with a fixed time delay between each call.		Function to repeatedly call a function with a fixed time delay between each call.

AmySockanathan: Implementation Hooks: Added settimeout, setinterval, cleartimeout and clearinterval

2026-01-27T21:23:27Z

Implementation Hooks: Added settimeout, setinterval, cleartimeout and clearinterval

@@ Line 96: / Line 96: @@
 === Implementation Hooks ===
 This object captures the required entities for the DOM-less SDK to operate correctly. These are normally platform dependent and are expected to be passed on to the DOM-less SDK as part of its initialization. See below for the descriptions of each key.
@@ Line 183: / Line 185: @@
 ● string - a string specifying the referrer of the request</blockquote>
-====='''''<pre style="color: green; font-weight: bold; font-size: 20px">Note: Implementation Hooks are mandatory for the DOM-less SDK to function as expected.</pre>'''''=====
+==== SetTimeout ====
 ==== Nielsen Debug Node.js Server for Event Tracking ====
 We are excited to announce the beta version of our Debug Node.js server, designed to track requests and events sent from our Dom-less SDK using WebSocket connections. While this feature is not officially released, we are currently looking for users interested in beta testing.

AmySockanathan: /* storage */

2025-11-25T13:45:34Z

storage

← Older revision		Revision as of 13:45, 25 November 2025
Line 132:		Line 132:
	Persistent storage of key/values, similar in behavior to browser localStorage.		Persistent storage of key/values, similar in behavior to browser localStorage.

	e.g. storage.~~set~~('nol_lsid', 'umy3w4ik9usw2ppqmw2vkecckxfob1697308388')		e.g. storage.setItem('nol_lsid', 'umy3w4ik9usw2ppqmw2vkecckxfob1697308388')

	===== Methods =====		===== Methods =====

AmySockanathan: /* Methods */

2025-11-25T13:17:19Z

Methods

← Older revision		Revision as of 13:17, 25 November 2025
Line 137:		Line 137:
	<blockquote>setItem()		<blockquote>setItem()

	storage.~~set~~(key: string, value: string)		storage.setItem(key: string, value: string)

	getItem()		getItem()

	storage.~~get~~(key: string)		storage.getItem(key: string)

	removeItem()		removeItem()

	storage.~~remove~~(key: string)		storage.removeItem(key: string)

	clear()		clear()

AmySockanathan: Replace Storage set, get and remove function names with setItem, getItem and removeItem.

2025-11-25T00:55:22Z

Replace Storage set, get and remove function names with setItem, getItem and removeItem.

← Older revision		Revision as of 00:55, 25 November 2025
Line 135:		Line 135:

	===== Methods =====		===== Methods =====
	<blockquote>~~set~~()		<blockquote>setItem()

	storage.set(key: string, value: string)		storage.set(key: string, value: string)

	~~get~~()		getItem()

	storage.get(key: string)		storage.get(key: string)

	~~remove~~()		removeItem()

	storage.remove(key: string)		storage.remove(key: string)

AmySockanathan: /* Note: Implementation Hooks are mandatory for the DOM-less SDK to function as expected. */

2025-06-09T19:28:52Z

Note: Implementation Hooks are mandatory for the DOM-less SDK to function as expected.

← Older revision		Revision as of 19:28, 9 June 2025
Line 183:		Line 183:
	● string - a string specifying the referrer of the request</blockquote>		● string - a string specifying the referrer of the request</blockquote>

	====='''''<pre style="color: ~~purple~~; font-weight: bold; font-size: 20px">Note: Implementation Hooks are mandatory for the DOM-less SDK to function as expected.</pre>'''''=====		====='''''<pre style="color: green; font-weight: bold; font-size: 20px">Note: Implementation Hooks are mandatory for the DOM-less SDK to function as expected.</pre>'''''=====

	==== Nielsen Debug Node.js Server for Event Tracking ====		==== Nielsen Debug Node.js Server for Event Tracking ====

AmySockanathan: Add color

2025-06-09T19:28:24Z

Add color

← Older revision		Revision as of 19:28, 9 June 2025
Line 183:		Line 183:
	● string - a string specifying the referrer of the request</blockquote>		● string - a string specifying the referrer of the request</blockquote>

	===== '''''Note: ~~ImplementationHooks~~ are mandatory for the DOM-less SDK to function as expected.''''' =====		====='''''<pre style="color: purple; font-weight: bold; font-size: 20px">Note: Implementation Hooks are mandatory for the DOM-less SDK to function as expected.</pre>'''''=====

	==== Nielsen Debug Node.js Server for Event Tracking ====		==== Nielsen Debug Node.js Server for Event Tracking ====