UserUtils-Mirror/README.md

UserUtils

Various utilities for userscripts

Table of Contents:

• Installation
• Features
  • onSelector() - call a listener once a selector is found in the DOM
  • autoPlural() - automatically pluralize a string
  • clamp() - clamp a number between a min and max value
  • pauseFor() - pause the execution of a function for a given amount of time
  • debounce() - call a function only once, after a given amount of time
  • getUnsafeWindow() - get the unsafeWindow object or fall back to the regular window object
  • insertAfter() - insert an element as a sibling after another element
  • 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
  • fetchAdvanced() - wrapper around the fetch API with a timeout option
  • 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
• License

Installation:

• If you are using a bundler like webpack, you can install this package using npm:

  npm i @sv443-network/userutils
  

  Then, import it in your script as usual:

  import * as userUtils from "@sv443-network/userutils";
  // or
  import { addGlobalStyle } from "@sv443-network/userutils";
  

  Shameless plug: I also have a webpack-based template for userscripts in TypeScript that you can use to get started quickly.

• If you are not using a bundler, you can include the latest release from GreasyFork by adding this directive to the userscript header:

  // @require https://greasyfork.org/scripts/TODO
  

If you like using this library, please consider supporting development

Features:

onSelector()

autoPlural()

clamp()

pauseFor()

debounce()

getUnsafeWindow()

insertAfter()

addParent()

addGlobalStyle()

preloadImages()

fetchAdvanced()

openInNewTab()

interceptEvent()

interceptWindowEvent()

License:

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

Made with ❤️ by [Sv443](https://github.com/Sv443) If you like this library, please consider [supporting development](https://github.com/sponsors/Sv443)