@mountain-ui/utils
v1.0.3
Published
A set of utilities for the mountain-ui libraries
Downloads
41
Maintainers
Readme
@mountain-ui/utils
@mountain-ui/utils
Prerequisites
Before integrating the @mountain-ui/utils library into your project, ensure that you have the following prerequisites:
- Node.js: Make sure Node.js is installed on your machine. You can download it from nodejs.org.
Installation
To harness the power of the @mountain-ui/utils library, follow these straightforward steps:
Open a terminal window in your project directory.
Run the following command to install the utils library:
npm install @mountain-ui/utils
Once installed, you can import and use the utilities in your project.
Usage Example
Here's a simple example demonstrating how to use some of the utilities in your project:
import {
debounce,
deepMerge,
hasWindow,
isBareObject,
isFunction,
isString,
pipe,
sleep,
toLowerCaseFirst,
toUpperCaseFirst
} from '@mountain-ui/utils';
// Example usage of debounce
const debouncedFunction = debounce(() => {
console.log('Debounced function executed.');
}, 300);
// Example usage of deepMerge
const mergedObject = deepMerge({ a: 1 }, { b: 2, a: 3 });
// Example usage of isFunction
console.log(isFunction(() => {})); // true
console.log(isFunction('not a function')); // false
// Example usage of sleep
async function delayedFunction() {
console.log('Before sleep');
await sleep(2000);
console.log('After sleep');
}
// Example usage of toUpperCaseFirst
const uppercased = toUpperCaseFirst('hello');
// Example usage of pipe
const addOne = x => x + 1;
const double = x => x * 2;
const result = pipe(addOne, double)(3); // (3 + 1) * 2 = 8
console.log(result);
Utilities
For detailed information about each utility, refer to the sub-pages: