JSPM

[!NOTE]
In version 10.0.0, many of the platform-agnostic features were moved to the CoreUtils library.
_{Everything is re-exported by UserUtils for backwards compatibility, but you may want to consider using CoreUtils directly if you don't need any of the DOM- or GreaseMonkey-specific features or want control over the installed version of CoreUtils.}

Table of Contents:

• Installation
• License
• Preamble (info about the documentation)
• UserUtils Features
  • DOM:
    • 🟧 Dialog - class for creating custom modal dialogs with a promise-based API and a generic, default style
    • 🟧 SelectorObserver - class that manages listeners that are called when selectors are found in the DOM
    • 🟣 getUnsafeWindow() - get the unsafeWindow object or fall back to the regular window object
    • 🟣 isDomLoaded() - check if the DOM has finished loading and can be queried and modified
    • 🟣 onDomLoad() - run a function or pause async execution until the DOM has finished loading (or immediately if DOM is already loaded)
    • 🟣 addParent() - add a parent element around another element
    • 🟣 addGlobalStyle() - add a global style to the page
    • 🟣 preloadImages() - preload images into the browser cache for faster loading later on
    • 🟣 openInNewTab() - open a link in a new tab
    • 🟣 interceptEvent() - conditionally intercepts events registered by addEventListener() on any given EventTarget object
    • 🟣 interceptWindowEvent() - conditionally intercepts events registered by addEventListener() on the window object
    • 🟣 isScrollable() - check if an element has a horizontal or vertical scroll bar
    • 🟣 observeElementProp() - observe changes to an element's property that can't be observed with MutationObserver
    • 🟣 getSiblingsFrame() - returns a frame of an element's siblings, with a given alignment and size
    • 🟣 setInnerHtmlUnsafe() - set the innerHTML of an element using a Trusted Types policy without sanitizing or escaping it
    • 🟣 probeElementStyle() - probe the computed style of a temporary element (get default font size, resolve CSS variables, etc.)
  • Misc:
    • 🟧 GMStorageEngine - storage engine class for DataStores using the GreaseMonkey API
    • 🟧 Mixins - class for creating mixin functions that allow multiple sources to modify a target value in a highly flexible way
  • Translation:
    • 🟣 tr.for() - translates a key for the specified language
    • 🟣 tr.use() - creates a translation function for the specified language
    • 🟣 tr.hasKey() - checks if a key exists in the given language
    • 🟣 tr.addTranslations() - add a flat or recursive translation object for a language
    • 🟣 tr.getTranslations() - returns the translation object for a language
    • 🟣 tr.deleteTranslations() - delete the translation object for a language
    • 🟣 tr.setFallbackLanguage() - set the fallback language used when a key is not found in the given language
    • 🟣 tr.getFallbackLanguage() - returns the fallback language
    • 🟣 tr.addTransform() - adds a transform function to the translation system for custom argument insertion and much more
    • 🟣 tr.deleteTransform() - removes a transform function
    • 🟩 tr.transforms - predefined transform functions for quickly adding custom argument insertion
    • 🔷 TrKeys - generic type that extracts all keys from a flat or recursive translation object into a union
  • Errors
    • 🟧 PlatformError - thrown when the current platform doesn't support a certain feature, like calling a DOM function in a non-DOM environment
• CoreUtils Features (re-exported for backwards compatibility)
  • Array:
    • 🟣 function randomItem() - Returns a random item from the given array
    • 🟣 function randomItemIndex() - Returns a random array item and index as a tuple
    • 🟣 function randomizeArray() - Returns a new array with the items in random order
    • 🟣 function takeRandomItem() - Returns a random array item and mutates the array to remove it
    • 🟣 function takeRandomItemIndex() - Returns a random array item and index as a tuple and mutates the array to remove it
    • 🔷 type NonEmptyArray - Non-empty array type
  • Colors:
    • 🟣 function darkenColor() - Darkens the given color by the given percentage
    • 🟣 function hexToRgb() - Converts a hex color string to an RGB object
    • 🟣 function lightenColor() - Lightens the given color by the given percentage
    • 🟣 function rgbToHex() - Converts an RGB object to a hex color string
  • Crypto:
    • 🟣 function abtoa() - Converts an ArrayBuffer to a string
    • 🟣 function atoab() - Converts a string to an ArrayBuffer
    • 🟣 function compress() - Compresses the given string using the given algorithm and encoding
    • 🟣 function decompress() - Decompresses the given string using the given algorithm and encoding
    • 🟣 function computeHash() - Computes a string's hash using the given algorithm
    • 🟣 function randomId() - Generates a random ID of the given length
  • DataStore: - Cross-platform, general-purpose, sync/async hybrid, JSON-serializable database infrastructure:
    • 🟧 class DataStore - The main class for the data store
      • 🔷 type DataStoreOptions - Options for the data store
      • 🔷 type DataMigrationsDict - Dictionary of data migration functions
      • 🔷 type DataStoreData - The type of the serializable data
    • 🟧 class DataStoreSerializer - Serializes and deserializes data for multiple DataStore instances
      • 🔷 type DataStoreSerializerOptions - Options for the DataStoreSerializer
      • 🔷 type LoadStoresDataResult - Result of calling loadStoresData()
      • 🔷 type SerializedDataStore - Meta object and serialized data of a DataStore instance
      • 🔷 type StoreFilter - Filter for selecting data stores
    • 🟧 class DataStoreEngine - Base class for DataStore storage engines, which handle the data storage
      • 🔷 type DataStoreEngineDSOptions - Reduced version of DataStoreOptions
    • Storage Engines:
      • 🟧 class BrowserStorageEngine - Storage engine for browser environments (localStorage, sessionStorage)
        • 🔷 type BrowserStorageEngineOptions - Options for the browser storage engine
      • 🟧 class FileStorageEngine - File-based storage engine for Node.js and Deno
        • 🔷 type FileStorageEngineOptions - Options for the file storage engine
  • Debouncer:
    • 🟣 function debounce() - Function wrapper for the Debouncer class
    • 🟧 class Debouncer - Class that manages listeners whose calls are rate-limited
      • 🔷 type DebouncerType - The triggering type for the debouncer
      • 🔷 type DebouncedFunction - Function type that is returned by the debounce() function
      • 🔷 type DebouncerEventMap - Event map type for the Debouncer class
  • Errors:
    • 🟧 class DatedError - Base error class with a date property
      • 🟧 class ChecksumMismatchError - Error thrown when two checksums don't match
      • 🟧 class CustomError - Custom error with a configurable name for one-off situations
      • 🟧 class MigrationError - Error thrown in a failed data migration
      • 🟧 class ValidationError - Error while validating data
  • Math:
    • 🟣 function bitSetHas() - Checks if a bit is set in a bitset
    • 🟣 function clamp() - Clamps a number between a given range
    • 🟣 function digitCount() - Returns the number of digits in a number
    • 🟣 function formatNumber() - Formats a number to a string using the given locale and format identifier
      • 🔷 type NumberFormat - Number format identifier
    • 🟣 function mapRange() - Maps a number from one range to another
    • 🟣 function overflowVal() - Makes sure a number is in a range by over- & underflowing it
    • 🟣 function randRange() - Returns a random number in the given range
    • 🟣 function roundFixed() - Rounds the given number to the given number of decimal places
    • 🟣 function valsWithin() - Checks if the given numbers are within a certain range of each other
  • Misc:
    • 🟣 function consumeGen() - Consumes a ValueGen object
      • 🔷 type ValueGen - A value that can be either type T, or a sync or async function that returns T
    • 🟣 function consumeStringGen() - Consumes a StringGen object
      • 🔷 type StringGen - A value that can be either of type string, or a sync or async function that returns a string
    • 🟣 function fetchAdvanced() - Wrapper around fetch() with options like a timeout
      • 🔷 type FetchAdvancedOpts - Options for the fetchAdvanced() function
    • 🟣 function getListLength() - Returns the length of a ListLike object
    • 🟣 function pauseFor() - Pauses async execution for the given amount of time
    • 🟣 function pureObj() - Applies an object's props to a null object (object without prototype chain) or just returns a new null object
    • 🟣 function setImmediateInterval() - Like setInterval(), but instantly calls the callback and supports passing an AbortSignal
    • 🟣 function setImmediateTimeoutLoop() - Like a recursive setTimeout() loop, but instantly calls the callback and supports passing an AbortSignal
    • 🟣 function scheduleExit() - Schedules a process exit after the next event loop tick, to allow operations like IO writes to finish.
    • 🟣 function getCallStack() - Returns the current call stack, starting at the caller of this function.
  • NanoEmitter:
    • 🟧 class NanoEmitter - Simple, lightweight event emitter class that can be used in both FP and OOP, inspired by EventEmitter from node:events, based on nanoevents
      • 🔷 type NanoEmitterOptions - Options for the NanoEmitter class
  • Text:
    • 🟣 function autoPlural() - Turns the given term into its plural form, depending on the given number or list length
    • 🟣 function capitalize() - Capitalizes the first letter of the given string
    • 🟣 function createProgressBar() - Creates a progress bar string with the given percentage and length
      • 🟩 const defaultPbChars - Default characters for the progress bar
      • 🔷 type ProgressBarChars - Type for the progress bar characters object
    • 🟣 function joinArrayReadable() - Joins the given array into a string, using the given separators and last separator
    • 🟣 function secsToTimeStr() - Turns the given number of seconds into a string in the format (hh:)mm:ss with intelligent zero-padding
    • 🟣 function truncStr() - Truncates the given string to the given length

      Installation:

      Shameless plug: I made a template for userscripts in TypeScript that you can use to get started quickly. It also includes this library by default.

      • If you are using a bundler (like webpack, rollup, vite, etc.), you can install this package in one of the following ways:

        npm i @sv443-network/userutils
        pnpm i @sv443-network/userutils
        yarn add @sv443-network/userutils
        npx jsr install @sv443-network/userutils
        deno add jsr:@sv443-network/userutils

        Then import it in your script as usual:

        // on Node:
        import { addGlobalStyle } from "@sv443-network/userutils";
        
        // on Deno:
        import { addGlobalStyle } from "jsr:@sv443-network/userutils";
        
        // you can also import the entire library as an object (not recommended because of worse treeshaking support):
        import * as UserUtils from "@sv443-network/userutils";

      
      

      • If you are not using a bundler, want to reduce the size of your script, or declared the package as external in your bundler, you can include the latest release by adding one of these directives to the userscript header, depending on your preferred CDN:

        Versioned (recommended):

        // @require https://cdn.jsdelivr.net/npm/@sv443-network/userutils@INSERT_VERSION/dist/index.global.js
        // @require https://unpkg.com/@sv443-network/userutils@INSERT_VERSION/dist/index.global.js

        Non-versioned (not recommended because it auto-updates):

        // @require https://update.greasyfork.org/scripts/472956/UserUtils.js
        // @require https://openuserjs.org/src/libs/Sv443/UserUtils.js

      • If you are using this library in a generic DOM environment without access to the GreaseMonkey API, either download the latest release from the releases page to include in your project or add one of the following tags to the <head>:

        <script src="https://cdn.jsdelivr.net/npm/@sv443-network/userutils@INSERT_VERSION/dist/index.global.js"></script>
        <script src="https://unpkg.com/@sv443-network/userutils@INSERT_VERSION/dist/index.global.js"></script>

      [!NOTE]
      In order for your script not to break on a major library update, use one the versioned URLs above after replacing INSERT_VERSION with the desired version (e.g. 8.3.2) or the versioned URL that's shown at the top of the GreasyFork page.

      
      

      • Then, access the functions on the global variable UserUtils:

        UserUtils.addGlobalStyle("body { background-color: red; }");
        
        // or using object destructuring:
        
        const { clamp } = UserUtils;
        console.log(clamp(1, 5, 10)); // 5

      
      

      • If you're using TypeScript and it complains about the missing global variable UserUtils, install the library using the package manager of your choice and add the following inside any .ts file that is included in the final build:

        declare const UserUtils: typeof import("@sv443-network/userutils");
        
        declare global {
          interface Window {
            UserUtils: typeof UserUtils;
          }
        }

      
      

      • If you're using a linter like ESLint, it might complain about the global variable UserUtils not being defined. To fix this, add the following to your ESLint configuration file:

        "globals": {
            "UserUtils": "readonly"
        }

      
      
      

      License:

      This library is licensed under the MIT License.
      See the license file for details.

      
      
      
      
      

      Made with ❤️ by Sv443
      If you like this library, please consider supporting the development