Interface UtilsAPI

Utility functions available in Browser scripts.

interface UtilsAPI {
    getVar(name: string): string;
    iterate(obj: any): Iterable<IterateEntry>;
    safeJsonStringify(obj: any): string;
}

Index

Methods

getVar iterate safeJsonStringify

Methods

getVar

getVar(name: string): string
Returns a shared variable by name (same variable scope as the API Collection).
Parameters
- name: string
Returns string
- Defined in scripts.d.ts:14

iterate

iterate(obj: any): Iterable<IterateEntry>
Iterates over any structure (Object, Array, Map, etc.).

Example: for (const [k, v] of Utils.iterate(obj))
Parameters
- obj: any
Returns Iterable<IterateEntry>
- Defined in scripts.d.ts:28

safeJsonStringify

safeJsonStringify(obj: any): string
Safely converts any object to JSON, handling circular references.
Parameters
- obj: any
Returns string
- Defined in scripts.d.ts:20