@pixi/utils

What is @pixi/utils?

@pixi/utils is a utility library that provides a collection of helper functions and classes to assist with common tasks in the PixiJS ecosystem. It includes utilities for data structures, math operations, string manipulations, and more.

What are @pixi/utils's main functionalities?

EventEmitter

The EventEmitter class provides a way to handle custom events. You can create an instance, register event listeners, and emit events.

const { EventEmitter } = require('@pixi/utils');
const emitter = new EventEmitter();
emitter.on('event', () => console.log('Event triggered!'));
emitter.emit('event');

isMobile

The isMobile utility helps to detect if the user is on a mobile device. It provides properties to check for various mobile platforms.

const { isMobile } = require('@pixi/utils');
console.log(isMobile.any); // true if the user is on a mobile device

uid

The uid function generates a unique identifier, which can be useful for creating unique keys or IDs.

const { uid } = require('@pixi/utils');
console.log(uid()); // Generates a unique identifier

deprecation

The deprecation function logs a deprecation warning to the console, which is useful for informing developers about deprecated methods or features.

const { deprecation } = require('@pixi/utils');
deprecation('1.0.0', 'This method is deprecated, use newMethod instead.');

Other packages similar to @pixi/utils

lodash

Lodash is a modern JavaScript utility library delivering modularity, performance, and extras. It provides a wide range of utility functions for common programming tasks, similar to @pixi/utils but with a broader scope.

eventemitter3

EventEmitter3 is a high-performance EventEmitter for Node.js and the browser. It offers similar event handling capabilities as the EventEmitter in @pixi/utils but is more focused and optimized for performance.

uuid

UUID is a library for generating RFC-compliant UUIDs. It provides similar functionality to the uid function in @pixi/utils but is specifically focused on generating universally unique identifiers.

README

@pixi/utils

Installation

npm install @pixi/utils

Usage

import * as utils from '@pixi/utils';