includesAll — GTM Variable Template for Array

VARIABLES › ARRAY

includesAll CORE Array

Direct (.tpl) Apply (.tpl)

Checks if all specified terms are found in the source.

---

When to Use This

String & Array

Operations that work on both strings and arrays — split, join, slice.

Comparison

Test equality, containment, and ordering between values.

---

Examples

All terms found▶ Try

INPUT

Source Content: The quick brown fox jumps over the lazy dog
Search Terms: ["quick", "fox", "dog"]

OUTPUT

true

Missing term returns false▶ Try

INPUT

Source Content: The quick brown fox jumps over the lazy dog
Search Terms: ["quick", "fox", "cat"]

OUTPUT

false

---

GTM Configuration

This is what you'll see when you open this variable in Google Tag Manager. Hover the icons for details.

includesAll

Read-Only Try Live

Source Content

💾 The value to search within.

Supported formats:
  ✓ String: "hello world"
  ✓ Array: ["a", "b", "c"]
  ✓ Comma-separated string: "a,b,c"
  ✓ JSON-stringified array or object: '["a","b"]'

Search Terms

🔍 Search terms (one or more) to find within the data.

Supported formats:
  ✓ String: "hello world"
  ✓ Array: ["a", "b", "c"]
  ✓ Comma-separated string: "a,b,c"

Input Setup

Input Function (optional)

⚙️ Optional pre-processing function applied to the input before internal logic (e.g., convert object to string, normalize case). Internal transformations such as case handling will still apply afterward.

Result Handling

Output Function (optional)

⚙️ Optional function to apply to the result before returning it (e.g., str => str + ' €', val => val !== undefined for boolean conversion). Useful for chaining transformations on the output.

Source Content array

💡 Type any text to see the result update live

🎯 Using special value — click input to type instead

Test with:

Falsy undefined null "" empty 0 false NaN

Truthy true 42 "hello" {} empty [] empty {a:1} [1,2,3]

Search Terms array

🔗 Result Handling — Chain Variables

Chain apply-mode variables to the output. Each variable receives the result of the previous one.

includesAll()

+ Chain another variable

---

Related Variables

Same category: Array

→ chunk → compact → dropItems → dropItemsRight → every → filterArray → find → findIndexByCallback → findIndexByRegex → flatten → head → includesAny → includesNone → indexOf → join → last → lastIndexOf → reduce → reduceRight → reverse → selectFromArray → some → sort → tail → takeItems → takeItemsRight → uniq → wrapInArray

---

Under the Hood

📜 View Implementation Code

/**
 * Checks if the source contains **all** of the provided search terms.
 *
 * @param {*} data.src - The data to search within (string, number, object, etc.).
 * @param {Array<string>|string} data.tms - Term, array or comma-separated string of terms to search for.
 * @param {string|Function} [data.out] - Output handler: function to transform result or string with format.
 *
 * Direct-mode specific parameters:
 * @param {Function} [data.pre] - Optional function to transform `src` before searching.
 *
 * @returns {boolean} True if all of the terms are found, false otherwise.
 *
 * @framework ggLowCodeGTMKit
 */
const includesAll = function(searchData, searchTerms) {
	if (searchData == null || searchTerms == null) {
		return false;
	}
	const searchString = searchData.toString();
	const safeSplit = value => typeof value === 'string' ? value.split(',') : value;
	searchTerms = safeSplit(searchTerms);
	return searchTerms.every(term => term != null && searchString.indexOf(term) > -1);
};
const safeFunction = fn => typeof fn === 'function' ? fn : x => x;
const out = safeFunction(data.out);
// ===============================================================================
// includesAll - Direct mode
// ===============================================================================
const applyCast = (castFn, value) => safeFunction(castFn)(value);
const searchData = applyCast(data.pre, data.src);
return out(includesAll(searchData, data.tms));

// ===============================================================================
// includesAll(...) – Apply Mode
// ===============================================================================
/*
return function(searchData, searchTerms) {
  searchTerms = data.rp1 ? data.tms : searchTerms;
   return out(includesAll(searchData, searchTerms));
};
*/

🧪 View Test Scenarios (9 tests)

✅ '[example] All terms found'
✅ Using comma-separated string for terms
✅ '[example] Missing term returns false'
✅ Custom output transformation
✅ Using pre-processing function on complex source
✅ Null source data should return false
✅ Null search terms should return false
✅ Numeric data gets converted to string for search
✅ JSON stringified object search