❤
npm
Sign UpSign In

mazey
TypeScript icon, indicating that this package has built-in type declarations

4.0.7 • Public • Published

English | 简体中文

Mazey

npm version l

Mazey is a functional library for daily front-end work. There are already many excellent libraries for front-end development, but creating a file named utils.js or common.js is generally used to supply common functions in projects. It's boring to copy similar functions across multiple projects. That's why I've created this library and will keep updating it to serve as a reliable resource for front-end needs.

Install

Use Mazey via npm.

npm install mazey --save

Use Mazey from CDN.

<script type="text/javascript" src="//i.mazey.net/mazey/lib/mazey.min.js"></script>

Of course, you can also download and serve the file lib/mazey.min.js yourself.

Usage

Example: Use a function to verify if a value is a number suitable for standard calculations and comparisons.

Import from npm.

import { isNumber } from 'mazey';

const x = 123;
const y = Infinity;
// <=> typeof x === 'number' && !isNaN(x) && isFinite(x)
isNumber(x); // Output: true
isNumber(y); // Output: false

Import from CDN.

<script type="text/javascript" src="//i.mazey.net/mazey/lib/mazey.min.js"></script>
<script>
  const x = Infinity;
  // <=> typeof x === 'string' && !isNaN(x)
  mazey.isNumber(x, { isInfinityAsNumber: true }); // Output: true
</script>

API Examples

There are some examples maintained by hand below. For more information, please check the full documentation.

Table of Contents

Load Resource

loadScript

Load a JavaScript file from the server and execute it.

Usage:

loadScript(
    'http://example.com/static/js/plugin-2.1.1.min.js',
    {
      id: 'iamid', // (Optional) script ID, default none
      timeout: 5000, // (Optional) timeout, default `5000`
      isDefer: false, // (Optional) defer, default `false`
    }
  )
  .then(
    res => {
      console.log(`Load JavaScript script: ${res}`);
    }
  )
  .catch(
    err => {
      console.error(`Load JavaScript script: ${err.message}`)
    }
  );

Output:

Load JavaScript script: loaded

loadScriptIfUndefined

Load a script from the given URL if it (window['attribute']) has not already been loaded.

Usage:

loadScriptIfUndefined('xyz', 'https://example.com/lib/xyz.min.js')
  .then(() => {
    console.log('xyz is loaded.');
  })
  .catch(err => {
    console.log('Failed to load xyz.', err);
  });

Output:

xyz is loaded.

loadCSS

Load a CSS file from the server.

Usage:

loadCSS(
    'http://example.com/path/example.css',
    {
      id: 'iamid', // Optional, link ID, default none
    }
  )
  .then(
    res => {
      console.log(`Load CSS Success: ${res}`);
    }
  )
  .catch(
    err => {
      console.error(`Load CSS Fail: ${err.message}`)
    }
  );

Output:

Load CSS Success: loaded

loadImage

Load an image from the given URL.

The target image will be loaded in the background, and the Promise status will change after the image is loaded. If the image fails to load, the Promise status will change to reject with the error object. If the image is loaded successfully, the Promise status will change to resolve with the image object. This method can be used to preload images and cache them in the browser. It can also be used to implement lazy loading of images.

Note that this method will not add the image to the DOM.

Usage:

loadImage('https://example.com/example.png')
  .then((img) => {
    console.log(img);
  })
  .catch((err) => {
    console.log(err);
  });

windowLoaded

Check whether the page is loaded successfully (Keep the compatibility if the browser's load event has been triggered).

Usage:

windowLoaded(30) // second
  .then(res => {
    console.log(`Load Success: ${res}`);
  })
  .catch(err => {
    console.log(`Load Timeout or Fail: ${err.message}`);
  });

Output:

Load Success: load

Util

isNumber

Check whether it is a right number.

Usage:

const ret1 = isNumber(123);
const ret2 = isNumber('123');
// Default: NaN, Infinity is not Number
const ret3 = isNumber(Infinity);
const ret4 = isNumber(Infinity, { isInfinityAsNumber: true });
const ret5 = isNumber(NaN);
const ret6 = isNumber(NaN, { isNaNAsNumber: true, isInfinityAsNumber: true });
console.log(ret1, ret2, ret3, ret4, ret5, ret6);

Output:

true false false true false true

isJSONString

Check whether it is a valid JSON string.

Usage:

const ret1 = isJSONString(`['a', 'b', 'c']`);
const ret2 = isJSONString(`["a", "b", "c"]`);
console.log(ret1);
console.log(ret2);

Output:

false
true

isValidData

Determine the validity of the data.

Usage:

const validData = {
  a: {
    b: {
      c: 413
    }
  }
};
const isValidDataResA = isValidData(validData, ['a', 'b', 'c'], 2333);
const isValidDataResB = isValidData(validData, ['a', 'b', 'c'], 413);
const isValidDataResC = isValidData(validData, ['d', 'd'], 413);
console.log('isValidDataResA:', isValidDataResA);
console.log('isValidDataResB:', isValidDataResB);
console.log('isValidDataResC:', isValidDataResC);

Output:

isValidDataResA: false
isValidDataResB: true
isValidDataResC: false

genRndNumString

Produce a random string of number, genRndNumString(7) => '7658495'.

Usage:

const ret1 = genRndNumString(4);
const ret2 = genRndNumString(7);
console.log(ret1);
console.log(ret2);

Output:

9730
2262490

formatDate

Return the formatted date string in the given format.

Usage:

const ret1 = formatDate();
const ret2 = formatDate('Tue Jan 11 2022 14:12:26 GMT+0800 (China Standard Time)', 'yyyy-MM-dd hh:mm:ss');
const ret3 = formatDate(1641881235000, 'yyyy-MM-dd hh:mm:ss');
const ret4 = formatDate(new Date(2014, 1, 11), 'MM/dd/yyyy');
console.log('Default formatDate value:', ret1);
console.log('String formatDate value:', ret2);
console.log('Number formatDate value:', ret3);
console.log('Date formatDate value:', ret4);

Output:

Default formatDate value: 2023-01-11
String formatDate value: 2022-01-11 14:12:26
Number formatDate value: 2022-01-11 14:07:15
Date formatDate value: 02/11/2014

debounce

Debounce

Usage:

const foo = debounce(() => {
  console.log('The debounced function will only be invoked in 1000 milliseconds, the other invoking will disappear during the wait time.');
}, 1000, true);

throttle

Throttle

Usage:

const foo = throttle(() => {
  console.log('The function will be invoked at most once per every wait 1000 milliseconds.');
}, 1000, { leading: true });

Reference: Lodash

convertCamelToKebab

Transfer CamelCase to KebabCase.

Usage:

const ret1 = convertCamelToKebab('ABC');
const ret2 = convertCamelToKebab('aBC');
console.log(ret1);
console.log(ret2);

Output:

a-b-c
a-b-c

convertCamelToUnder

Transfer CamelCase to Underscore.

Usage:

const ret1 = convertCamelToUnder('ABC');
const ret2 = convertCamelToUnder('aBC');
console.log(ret1);
console.log(ret2);

Output:

a_b_c
a_b_c

deepCopy

Copy/Clone Object deeply.

Usage:

const ret1 = deepCopy(['a', 'b', 'c']);
const ret2 = deepCopy('abc');
console.log(ret1);
console.log(ret2);

Output:

['a', 'b', 'c']
abc

URL

getQueryParam

Get the query param's value of the current Web URL(location.search).

Usage:

// http://example.com/?t1=1&t2=2&t3=3&t4=4#2333
// ?t1=1&t2=2&t3=3&t4=4
const p1 = getQueryParam('t3');
const p2 = getQueryParam('t4');
console.log(p1, p2);

Output:

3 4

getUrlParam

Returns the value of the specified query parameter in the input URL.

Usage:

const p1 = getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3');
const p2 = getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4');
console.log(p1, p2);

Output:

3 4

getHashQueryParam

Get the hash query param's value of the current Web URL(location.hash).

Usage:

// http://example.com/?#2333?t1=1&t2=2&t3=3&t4=4
// #2333?t1=1&t2=2&t3=3&t4=4
const p1 = getHashQueryParam('t3');
const p2 = getHashQueryParam('t4');
console.log(p1, p2);

Output:

3 4

getDomain

Get the domain of URL, and other params.

Usage:

const ret1 = getDomain('http://example.com/?t1=1&t2=2&t3=3&t4=4');
const ret2 = getDomain('http://example.com/test/thanks?t1=1&t2=2&t3=3&t4=4', ['hostname', 'pathname']);
const ret3 = getDomain('http://example.com:7890/test/thanks', ['hostname']);
const ret4 = getDomain('http://example.com:7890/test/thanks', ['host']); // With Port
const ret5 = getDomain('http://example.com:7890/test/thanks', ['origin']);
const ret6 = getDomain('http://example.com:7890/test/thanks?id=1', ['origin', 'pathname', 'search']);
console.log(ret1);
console.log(ret2);
console.log(ret3);
console.log(ret4);
console.log(ret5);
console.log(ret6);

Output:

example.com
example.com/test/thanks
example.com
example.com:7890
http://example.com:7890
http://example.com:7890/test/thanks?id=1

updateQueryParam

Update the query param's value of the input URL.

Usage:

const ret1 = updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3', 'three');
const ret2 = updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4', 'four');
console.log(ret1);
console.log(ret2);

Output:

http://example.com/?t1=1&t2=2&t3=three&t4=4
http://example.com/?t1=1&t2=2&t3=3&t4=four

isValidUrl

Checks if the given string is a valid URL, including scheme URLs.

Usage:

const ret1 = isValidUrl('https://www.example.com');
const ret2 = isValidUrl('http://example.com/path/exx/ss');
const ret3 = isValidUrl('https://www.example.com/?q=hello&age=24#world');
const ret4 = isValidUrl('http://www.example.com/#world?id=9');
const ret5 = isValidUrl('ftp://example.com');
console.log(ret1, ret2, ret3, ret4, ret5);

Output:

true true true true true

If you are specifically checking for HTTP/HTTPS URLs, it is recommended to use the isValidHttpUrl function instead. The isValidUrl function matches all scheme URLs, including FTP and other non-HTTP schemes.

isValidHttpUrl

Check if the given string is a valid HTTP/HTTPS URL.

Usage:

const ret1 = isValidHttpUrl('https://www.example.com');
const ret2 = isValidHttpUrl('http://example.com/path/exx/ss');
const ret3 = isValidHttpUrl('https://www.example.com/?q=hello&age=24#world');
const ret4 = isValidHttpUrl('http://www.example.com/#world?id=9');
const ret5 = isValidHttpUrl('ftp://example.com');
console.log(ret1, ret2, ret3, ret4, ret5);

Output:

true true true true false

Cache Data

Cookie

Handle Cookie.

Usage:

setCookie('test', '123', 30, 'example.com'); // key value day domain
const ret = getCookie('test');
console.log(ret);

Output:

123

Storage

Handle Storage (Keep fit for JSON, it can transfer format automatically).

Usage:

setSessionStorage('test', '123');
const ret1 = getSessionStorage('test');
setLocalStorage('test', '123');
const ret2 = getLocalStorage('test');
console.log(ret1, ret2);

// or package in usage
const projectName = 'mazey';
function mSetLocalStorage (key, value) {
  return setLocalStorage(`${projectName}_${key}`, value);
}

function mGetLocalStorage (key) {
  return getLocalStorage(`${projectName}_${key}`);
}

Output:

123 123

DOM

addStyle

Add <style> in <head>.

Example 1: Add the <style> with id, and repeated invoking will update the content instead of adding a new one.

addStyle(
  `
    body {
      background-color: #333;
    }
  `,
  {
    id: 'test',
  }
);
// <style id="test">
//   body {
//     background-color: #333;
//   }
// </style>

Example 2: Add the <style> without id, and repeated invoking will add a new one.

addStyle(
  `
    body {
      background-color: #444;
    }
  `
);
// <style>
//   body {
//     background-color: #444;
//   }
// </style>

Class

Modify class.

Usage:

const dom = document.querySelector('#box');

// Determine `class`
hasClass(dom, 'test');
// Add `class`
addClass(dom, 'test');
// Remove `class`
removeClass(dom, 'test');

newLine

Make a new line of HTML.

Usage:

const ret1 = newLine('a\nb\nc');
const ret2 = newLine('a\n\nbc');
console.log(ret1);
console.log(ret2);

Output:

a<br />b<br />c
a<br /><br />bc

Calculate and Formula

inRate

Hit probability (1% ~ 100%).

Usage:

const ret = inRate(0.5); // 0.01 ~ 1 true/false
console.log(ret);

Output:

true

Example: Test the precision.

// Test
let trueCount = 0;
let falseCount = 0;
new Array(1000000).fill(0).forEach(() => {
  if (inRate(0.5)) {
    trueCount++;
  } else {
    falseCount++;
  }
});
console.log(trueCount, falseCount); // 499994 500006

longestComSubstring

Computes the longest common substring of two strings.

Usage:

const ret = longestComSubstring('fish', 'finish');
console.log(ret);

Output:

3

longestComSubsequence

Computes the longest common subsequence of two strings.

Usage:

const ret = longestComSubsequence('fish', 'finish');
console.log(ret);

Output:

4

Browser Information

getBrowserInfo

Browser Information

Usage:

const ret = getBrowserInfo();
console.log(ret);

Output:

{"engine":"webkit","engineVs":"537.36","platform":"desktop","supporter":"chrome","supporterVs":"85.0.4183.121","system":"windows","systemVs":"10"}

Results:

Attribute Description Type Values
system System string android, ios, windows, macos, linux
systemVs System version string Windows: 2000, xp, 2003, vista, 7, 8, 8.1, 10 macOS: ...
platform Platform string desktop, mobile
engine Engine string webkit, gecko, presto, trident
engineVs Engine version string -
supporter Supporter string edge, opera, chrome, safari, firefox, iexplore
supporterVs Supporter version string -
shell Shell string (Optional) wechat, qq_browser, qq_app, uc, 360, 2345, sougou, liebao, maxthon, bilibili
shellVs Shell version string (Optional) 20/...
appleType Apple device type string (Optional) ipad, iphone, ipod, iwatch

Example: Determine the environment of the mobile QQ.

const { system, shell } = getBrowserInfo();
const isMobileQQ = ['android', 'ios'].includes(system) && ['qq_browser', 'qq_app'].includes(shell);

isSafePWAEnv

Detect the margin of Safety. Determine if it is a secure PWA environment that it can run.

Usage:

const ret = isSafePWAEnv();
console.log(ret);

Output:

true

Web Performance

getPerformance

Get page load time(PerformanceNavigationTiming).

This function uses the PerformanceNavigationTiming API to get page load time data. The PerformanceNavigationTiming API provides more accurate and detailed information about page load time than the deprecated PerformanceTiming API. If you are using an older browser that does not support PerformanceNavigationTiming, you can still use the PerformanceTiming API by using the previous version of this library (v3.9.7).

Usage:

// `camelCase：false` (Default) Return underline(`a_b`) data.
// `camelCase：true` Return hump(`aB`) data.
getPerformance()
 .then(res => {
  console.log(JSON.stringify(res));
 })
 .catch(console.error);

Output:

{"source":"PerformanceNavigationTiming","os":"others","os_version":"","device_type":"pc","network":"4g","screen_direction":"","unload_time":0,"redirect_time":0,"dns_time":0,"tcp_time":0,"ssl_time":0,"response_time":2,"download_time":2,"first_paint_time":288,"first_contentful_paint_time":288,"dom_ready_time":0,"onload_time":0,"white_time":0,"render_time":0,"decoded_body_size":718,"encoded_body_size":718}

Results:

Attribute Description Type Values
dns_time DNS Lookup number domainLookupEnd - domainLookupStart
tcp_time Connection Negotiation number connectEnd - connectStart
response_time Requests and Responses number responseStart - requestStart
white_time White Screen number responseStart - navigationStart
dom_ready_time Dom Ready number domContentLoadedEventStart - navigationStart
onload_time Onload number loadEventStart - navigationStart
render_time EventEnd number loadEventEnd -navigationStart
unload_time Unload number (Optional) unloadEventEnd - unloadEventStart
redirect_time Redirect number (Optional) redirectEnd - redirectStart
ssl_time SSL number (Optional) connectEnd - secureConnectionStart
download_time Download number (Optional) responseEnd - responseStart

Debug

genCustomConsole

Custom console printing (console).

Usage:

const myConsole = genCustomConsole('MazeyLog:');
myConsole.log('I am string.');
myConsole.info('I am boolean.', true);
myConsole.info('I am number.', 123, 456);
myConsole.info('I am object.', { a: 123, b: 456});

Output:

MazeyLog: I am string.
MazeyLog: I am boolean. true
MazeyLog: I am number. 123 456
MazeyLog: I am object. {a: 123, b: 456}

Contributing

Development Environment

Node.js

  • v16.19.0

TypeScript

  • v5.1.6

Scripts

Install Dependencies:

npm i

Development:

npm run dev

Build:

npm run build

Document:

npm run docs

Test:

npm run test

Returns

Values Description Type
ok The operation was successful. string
loaded Some assets have been loaded. string
fail An error occurred. string
defined The value is defined. string
undefined The value is undefined. string
timeout The operation timed out. string
true The value is true. boolean
false The value is false. boolean

License

This software is released under the terms of the MIT license.

Readme

Keywords

Package Sidebar

Install

npm i mazey

Repository

github.com/mazeyqian/mazey

Homepage

github.com/mazeyqian/mazey#readme

Weekly Downloads

84

Version

4.0.7

License

MIT

Unpacked Size

188 kB

Total Files

17

Last publish

Collaborators

  • mazeyqian
Try on RunKit
Report malware