Micell

# Docs

# base64

# decode

decode(input, [options])

Decoding a base64-encoded string to a utf8 string, hex string or byte array.

Since

0.3.0

Arguments

  • input (string)
  • [options = {} (Object)]
    • [encoding = 'utf8' (string)]: The encoding of output, it can be 'utf8' or 'hex' or 'binary'.

Return

  • (string | Array)

Example

const input = 'aGVsbG8g5L2g5aW9'

// Output a utf8 string
decode(input)
// => 'hello 你好'

// Output a hex string
decode(input, { encoding: 'hex' })
// => '68656c6c6f20e4bda0e5a5bd'

// Output a byte array
decode(input, { encoding: 'binary' })
// => [104, 101, 108, 108, 111, 32, 228, 189, 160, 229, 165, 189]

# decodeFile

Decoding a base64 encoded string to a Blob (opens new window) object.

decodeFile(input, options)

Since

0.12.0

Arguments

  • input (string): A base64 encoded string.
  • options (Object)
    • type (string): An MIME type, such as 'plain/text'.

Return

  • (Promise<Blob>)

Example

decodeFile('aGVsbG8gd29ybGQ=', { type: 'plain/text' })
  .then(blob => {
    console.log(blob)
    // => Blob {size: 11, type: "plain/text"}
  })

# encode

Encoding a utf8 string, byte array or Uint8Array to a base64 string.

encode(input)

Since

0.3.0

Arguments

  • input (string | Array | Uint8Array)

Return

  • (string)

Example

// Input a string
encode('hello 你好')
// => 'aGVsbG8g5L2g5aW9'

// Input a byte array
const bytes = [104, 101, 108, 108, 111, 32, 228, 189, 160, 229, 165, 189]
encode(bytes)
// => 'aGVsbG8g5L2g5aW9'

// Input a Uint8Array
const uint8 = new Uint8Array(bytes)
encode(uint8)
// => 'aGVsbG8g5L2g5aW9'

# encodeFile

Encoding a Blob (opens new window)/File (opens new window) object to a string.

encodeFile(file)

Since

0.12.0

Arguments

  • file (Blob)

Return

  • (Promise<string>)

Example

const blob = new Blob(['hello world'], { type: 'plain/text' })
encodeFile(blob)
  .then((str) => {
    console.log(str)
    // => 'aGVsbG8gd29ybGQ='
  })

# char

# isAlphabetic

isAlphabetic(ch)

Detect a character whether it is one of a-z or A-Z.

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isAlphabetic('a');
// => true

isAlphabetic('1');
// => false

# isAlphanumeric

isAlphanumeric(ch)

Detect a character whether it is one of a-z or A-Z or 0-9.

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isAlphanumeric('a');
// => true

isAlphanumeric('1');
// => true

isAlphanumeric('*');
// => false

# isASCII

isASCII(ch)

Detect a character whether it is an ASCII character.

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isASCII('a');
// => true

isASCII('1');
// => true

isASCII('你');
// => false

# isCJK

isCJK(ch)

Detect a character whether it is a CJK (Chinese, Japanese and Korean) character.

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isCJK('你');
// => true

isCJK('の');
// => true

# isControl

isControl(ch)

Detect a character whether it is a control character (opens new window).

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isControl('\t');
// => true

isControl('\r');
// => true

# isDigit

isDigit(ch)

Detect a character whether it is a decimal digit (0-9).

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isDigit('0');
// => true

isDigit('1');
// => true

# isGraph

isGraph(ch)

Detect a character whether it is a graphic character (opens new window).

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isGraph('0');
// => true

isGraph('a');
// => true

# isHexadecimal

isHexadecimal(ch)

Detect a character whether it is a hexadecimal character (0-9, a-f, A-F).

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isHexadecimal('0');
// => true

isHexadecimal('a');
// => true

isHexadecimal('A');
// => true

# isLower

isLower(ch)

Detect a character whether it is a lower-case character (a-z).

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isLower('a');
// => true

# isPrint

isPrint(ch)

Detect a character whether it is a printable character (opens new window).

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isPrint('a');
// => true

# isPunctuation

isPunctuation(ch)

Detect a character whether it is a punctuation character.

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isPunctuation(',');
// => true

# isSpace

isSpace(ch)

Detect a character whether it is a space character.

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isSpace(' ');
// => true

# isUpper

isUpper(ch)

Detect a character whether it is a upper-case character (A-Z).

Since

0.1.0

Arguments

  • ch (string): A string with length equal to 1.

Return

  • (boolean)

Example

isUpper('a');
// => true

# get

get(key)

Get the cookie's value of the specified name, with decodeURIComponent decoding.

Since

0.1.0

Arguments

  • key (string): Cookie name.

Return

  • (string)

# getAll

getAll()

Get the all cookies' value, with decodeURIComponent decoding.

Since

0.1.0

Return

  • (Object)

# getJson

getJson(key)

Get the cookie's value of the specified name, with JSON.parse decoding.

Since

0.1.0

Arguments

  • key (string): Cookie name.

Return

  • (string)

# getRaw

getRaw(key)

Get the cookie's value of the specified name, without decoding.

Since

0.1.0

Arguments

  • key (string)

Return

  • (string)

# isEnabled

isEnabled()

Check if the cookie is enabled.

Since

0.1.0

Return

  • (boolean)

# remove

remove(key, [options])

Remove a cookie.

Since

0.1.0

Arguments

  • key (string): Cookie name.
  • [options] (Object): Cookie options.
    • [domain] (string)
    • [path = "/"] (string)

# set

set(key, value, options)

Set a cookie, and the value argument will be encoded with encodeURIComponent.

Arguments

  • key (string): Cookie name.
  • value (string): Cookie value.
  • [options] (Object): Cookie options.
    • [domain] (string): The domain belongs to.
    • [path = "/"] (string): The path belongs to.
    • [expires] (number|string|Date): It can accept a Date object, a parsable date string (parsed by Date.parse()), an integer (unit: day) or a numeric string with a suffix character which specifies the time unit.
    • [max-age] (number) The time of existence.
    • [samesite] (boolean)
    • [secure] (boolean)
Unit suffix Representation
Y One year
M One month
D One day
h One hour
m One minute
s One second

# setJson

setJson(key, value, [options])

Same as set, set a cookie, and the value argument will be encoded with JSON.stringify.

Since

0.1.0

Arguments

  • key (string): Cookie name.
  • value (Any): Cookie value.
  • [options] (Object): Cookie options.
    • [domain] (string): The domain belongs to.
    • [path = "/"] (string): The path belongs to.
    • [expires] (number|string|Date): It can accept a Date object, a parsable date string (parsed by Date.parse()), an integer (unit: day) or a numeric string with a suffix character which specifies the time unit.
    • [max-age] (number) The time of existence.
    • [samesite] (boolean)
    • [secure] (boolean)

# setRaw

setRaw(key, value, options)

Same as set, set a cookie without any encoding.

Since

0.1.0

Arguments

  • key (string): Cookie name.
  • value (Any): Cookie value.
  • [options] (Object): Cookie options.
    • [domain] (string): The domain belongs to.
    • [path = "/"] (string): The path belongs to.
    • [expires] (number|string|Date): It can accept a Date object, a parsable date string (parsed by Date.parse()), an integer (unit: day) or a numeric string with a suffix character which specifies the time unit.
    • [max-age] (number) The time of existence.
    • [samesite] (boolean)
    • [secure] (boolean)

# date

# diff

diff(date1, date2, [unit], [roundFunc])

Compute the difference of the specified period unit between two dates.

Since

0.1.0

Arguments

  • date1 (number|Date|string): A timestamp number, a Date object or a parsable date string.
  • date2 (number|Date|string): A timestamp number, a Date object or a parsable date string.
  • [unit = "ms"] (string): A string specifies the peroid unit, default is "ms". See unit table.
  • [roundFunc = Math.round] (Function): A round function, default is Math.round.

Return

  • (number)

Unit table

Unit value Representation
Y Years
M Months
D Days
h hours
m minutes
s seconds
ms milliseconds

Example

const date1 = '2019-01-01 00:00:00';
const date2 = new Date(2019, 1, 10, 0, 0, 0);
diff(date1, date2);
// => 3456000000
diff(date1, date2, 'D')
// => 40

# format

format(date, format, [isUTC])

Since

0.1.0

Arguments

  • date (number|string from 0.8.0|Date): A timestamp number (unit: ms) or a parsable date string or a Date object.
  • format (string): A string of tokens, which is subset of the moment format tokens (opens new window). see below table.
  • [isUTC = false] (boolean): Use the UTC time, default is false.

Return

  • (string)

Format tokens

Token Output
YY 70 71 ... 18 19
YYYY 1970 1971 ... 2018 2019
M 1 2 ... 11 12
MM 01 02 ... 11 12
D 1 2 ... 30 31
DD 01 02 ... 30 31
H 0 1 ... 22 23
HH 00 01 ... 22 23
h 1 2 ... 11 12
hh 01 02 ... 11 12
m 1 2 ... 58 59
mm 01 02 ... 58 59
s 1 2 ... 58 59
ss 01 02 ... 58 59

Example

const date = new Date(1970, 0, 1, 13, 1, 1);
format(date, 'YYYY-MM-DD HH:mm:ss');
// => "1970-01-01 13:01:01"
format(date, 'YYYY-M-D h:m:s');
// => "1970-1-1 1:1:1"

# parse

parse(date, [isUTC])

Since

0.10.0

Arguments

  • date (number|string|Date): A timestamp number (unit: ms) or a parsable date string or a Date object.
  • [isUTC = false] (boolean): Use the UTC time, default is false.

Return

  • (object)

Example

// In UTC+0800
j
parse(0)
// => { years: 1970, months: 0, dates: 1, hours: 8, minutes: 0, seconds: 0, milliseconds: 0 }
parse(new Date(0))
// => { years: 1970, months: 0, dates: 1, hours: 8, minutes: 0, seconds: 0, milliseconds: 0 }
parse('Thu, 01 Jan 1970 00:00:00 GMT')
// => { years: 1970, months: 0, dates: 1, hours: 8, minutes: 0, seconds: 0, milliseconds: 0 }

parse(0, true)
// => { years: 1970, months: 0, dates: 1, hours: 0, minutes: 0, seconds: 0, milliseconds: 0 }
parse(new Date(0), true)
// => { years: 1970, months: 0, dates: 1, hours: 0, minutes: 0, seconds: 0, milliseconds: 0 }
parse('Thu, 01 Jan 1970 00:00:00 GMT', true)
// => { years: 1970, months: 0, dates: 1, hours: 0, minutes: 0, seconds: 0, milliseconds: 0 }

# timeAgo

timeAgo.format(date, [locale], [nowDate])

Since

0.1.0

Arguments

  • date (number|Date|string): A timestamp, a Date object or a parsable date string.
  • [locale = "en_US"] (string): the locale, "en_US" (default) and "zh_CN" are builtins supported.
  • [nowDate = new Date()](Date): The base date.

Return

  • (string)

Example

const d = new Date();
d.setMinutes(d.getMinutes() - 10);
timeAgo.format(d);
// => "10 minutes ago"

timeAgo.format(d, 'zh_CN');
// => "10 分钟前"

# dom

# clientX

clientX(elem)

Get the difference between the left edge of an element and the left edge of viewport.

Since

0.1.0

Arguments

  • elem (Element): An element.

Return

  • (number)

Example

const el = document.getElementById('el');
const x = clientX(el);
// x => 100

# clientY

clientY(elem)

Get the difference between the top edge of an element and the top edge of viewport.

Since

0.1.0

Arguments

  • elem (Element): An element.

Return

  • (number)

Example

const el = document.getElementById('el');
const y = clientY(el);
// y => 100

# createEvent

createEvent(type, [options])

Create a custom event.

Since

0.1.0

Arguments

  • type (string): The event type.
  • [options] (string): The event options.
    • [bubbles = false] (boolean):
    • [cancelable = false] (boolean):
    • [detail = null] (Object)

Return

  • (Event)

Example

const btn = document.getElementById('btn');
const event = createEvent('click');

btn.dispatchEvent(event);

# domReady

domReady(callback)

Defer the execution of the callback, which will be executed in DOMContentLoaded event. If the DOMContentLoaded has triggered, then the callback will be executed in next event loop.

Since

0.1.0

Arguments

  • callback (Function)

Example

domReady(function () {
  // ...
});

// You can use it multiple times.
domReady(function () {
  // other callback
});

# insertScript

insertScript(url, [props])

Insert a <script> to document.

Since

0.1.0

Arguments

  • url (string): The script.src string.
  • [props] (Object): The <script> element properties.

# isElement

isElement(obj)

Check if the argument is an element.

Since

0.1.0

Arguments

  • obj (Any): Any value.

Return

  • (boolean)

# isInViewport

isInViewport(el)

Check if an element is in the viewport.

Since

0.1.0

Arguments

  • el (Element): An element.

Return

  • (boolean)

# isWindow

isWindow(obj)

Check if a value is window object.

Since

0.1.0

Arguments

  • obj (Any): Any value.

Return

  • (boolean)

# pageHeight

pageHeight([el])

Return the height of an element's content, including content not visible on the screen due to overflow.

Since

0.13.0

Arguments

  • [el] (Element)

Return

  • (number)

Example

// The height of current document
pageHeight()

// The height of an element's content
pageHeight(document.getElementById('el1'))

# pageWidth

pageWidth([el])

Return the width of an element's content, including content not visible on the screen due to overflow.

Since

0.13.0

Arguments

  • [el] (Element)

Return

  • (number)

Example

// The width of current document
pageWidth()

// The width of an element's content
pageWidth(document.getElementById('el1'))

# pageX

pageX(el)

Return the horizontal distance of an element to the left edge of the page.

Since

0.1.0

Arguments

  • el (Element)

Return

  • (number)

Example

const el = document.getElementById('el')
pageX(el)

# pageY

pageY(el)

Return the vertical distance of an element to the left edge of the page.

Since

0.1.0

Arguments

  • el (Element)

Return

  • (number)

Example

const el = document.getElementById('el')
pageY(el)

# scrollTo

scrollTo(x, y)
scrollTo(options)
scrollTo(elOrWindow, x, y)
scrollTo(elOrWindow, options)

Scroll the page or element to the target position.

Since

0.1.0

Arguments

  • [x = 0] (number)
  • [y = 0] (number)
  • [elOrWindow = window] (Element | Window)
  • [options] (ExScrollToOptions)

Example

// Scroll the page to (100, 100)
scroll(100, 100)

// Scroll the page to (100, 100) smoothly
scroll({ x: 100, y: 100, behavior: 'smooth' })

// Scroll the page to (100, 100) with an easing function
scroll({ x: 100, y: 100, easing: 'ease-out' })

// Scroll an element to (100, 100)
scroll(el, 100, 100)

// Scroll an element to (100, 100) smoothly
scroll(el, { x: 100, y: 100, behavior: 'smooth' })

// Scroll an element to (100, 100) with an easing function
scroll(el, { x: 100, y: 100, easing: 'ease-out' })

# scrollX

scrollX([elOrWindow])

Get the horizontal scroll distance of an element or a window.

Since

0.1.0

Arguments

  • [elOrWindow = window] (Element|Window): An element or a window.

Return

  • (number)

Example

// Return the window scrollX if no argument is passed
scrollX();

const el = document.getElementById('el')
scrollX(el);

# scrolY

scrollY([elOrWindow])

Get the horizontal scroll distance of an element or a window.

Since

0.1.0

Arguments

  • [elOrWindow = window] (Element|Window): An element or a window.

Return

  • (number)

Example

// Return the window scrollY if no argument is passed
scrollY();

const el = document.getElementById('el')
scrollY(el);

# viewport

viewport([elOrWindow])

Get the width and height of the viewport of an element or a window.

Since

0.1.0

Arguments

  • [elOrWindow = window] (Element|Window): An element or a window.

Return

  • (Object)

Example

viewport();
// => { width: 1920, height: 900 }

# easing

# cubicBezier

cubicBezier(x1, y1, x2, y2)

It generates an easing function, like the cubic-bezier() of CSS transition.

Since

0.2.0

Arguments

  • x1 (number)
  • y1 (number)
  • x2 (number)
  • y2 (number)

Return

  • (Function)

Example

const linear = cubicBezier(0, 0, 1, 1)
linear(0.1)
// => 0.1

# ease

ease(x)

It is a shortand to cubicBezier(0.25, 0.1, 0.25, 1).

Since

0.2.0

Arguments

  • x (number)

Return

  • (number)

# easeIn

easeIn(x)

It is a shortand to cubicBezier(0.42, 0, 1, 1).

Since

0.2.0

Arguments

  • x (number)

Return

  • (number)

# easeInOut

easeInOut(x)

It is a shortand to cubicBezier(0.42, 0, 0.58, 1).

Since

0.2.0

Arguments

  • x (number)

Return

  • (number)

# easeOut

easeOut(x)

It is a shortand to cubicBezier(0, 0, 0.58, 1).

Since

0.2.0

Arguments

  • x (number)

Return

  • (number)

# linear

linear(x)

It is a shortand to cubicBezier(0, 0, 1, 1).

Since

0.2.0

Arguments

  • x (number)

Return

  • (number)

Example

linear(0.1)
// => 0.1

# emitter

You can use micell.emitter.create() to create an Emitter instance. And, every Emitter instance has the below methods:

  • emit
  • getListeners
  • off
  • on
  • once

The micell.emitter can be used as a global Emitter instance. That is, the below functions are the methods of the global emitter.

  • micell.emitter.emit
  • micell.emitter.getListeners
  • micell.emitter.off
  • micell.emitter.on
  • micell.emitter.once

# Emitter

new Emitter()

The Emitter constructor. Recommend to use the below create() method to create an Emitter instance.

Since

0.5.0

Return

  • (Emitter)

# create

create()

Create an Emitter instance.

Since

0.5.0

Return

  • (Emitter)

Example

const emitter = create()
emitter.on('foo', () => console.log('foo'))
emitter.emit('foo')
// => 'foo'

# emit

emit(type, [arg1], [arg2], ...)

Since

0.5.0

Arguments

  • type (string)
  • [argN] (any)
micell.emitter.on('foo', (...args) => console.log(args))
micell.emitter.emit('foo', 1, 2, 3)
// => [1, 2, 3]

# getListeners

getListeners(type)

Return the given type listeners or all listeners.

Since

0.5.0

Arguments

  • [type (string)]

Return

  • (Array<Listener>)

Example

micell.emitter.on('foo', () => console.log('foo 1'))
micell.emitter.on('bar', () => console.log('bar 1'))
micell.emitter.on('foo', () => console.log('foo 2'))

// All listeners for 'foo'
micell.emitter.getListeners('foo')

// All listeners
micell.emitter.getListeners()

# off

off(type, listener)
  • If nothing is passed, all listeners will be removed.
  • If only the type parameter is passed, the given type listeners will be removed.
  • If the type and listener are passed, then all the listeners of the type will be removed.

Since

0.5.0

Arguments

  • [type (string)]
  • [listener (function)]

Example

const fn1 = () => console.log(1)
const fn2 = () => console.log(2)

micell.emitter.on('foo', fn1)
micell.emitter.on('bar', fn1)
micell.emitter.on('foo', fn2)

micell.emitter.off('foo', fn1)
micell.emitter.off('foo')
micell.emitter.off()

# on

on(type, listener)

Attach a listener to the emitter.

Since

0.5.0

Arguments

  • [type (string)]
  • [listener (function)]

# once

once(type, listener)

Same as on, attach a listener to the emitter but the listener will be triggered once.

Since

0.5.0

Arguments

  • [type (string)]
  • [listener (function)]

# lang

# getType

getType(value)

Return the type of value.

Since

0.14.0

Arguments

  • value (any)

Return

  • (string)

Example

getType(undefined)
// => 'Undefined'
getType(null)
// => 'Null'
getType(1)
// => 'Number'
getType(true)
// => 'Boolean'
getType('')
// => 'String'
getType(Symbol('foo'))
// => 'Symbol'
getType(0n)
// => 'BigInt'
getType({})
// => 'Object'
getType([])
// => 'Array'
getType(/\s/)
// => 'RegExp'
getType(new Date())
// => 'Date'
getType(function () {})
// => 'Function'

# isArray

isArray(value)

Check if a value is an Array.

Since

0.1.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isArray([])
// => true

# isBigInt

isBigInt(value)

Check if a value is a BigInt value.

Since

0.8.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isBigInt(BigInt(1));
// => true

# isBoolean

isBoolean(value)

Check if a value is a Boolean.

Since

0.1.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isBoolean(true);
// => true

# isDate

isDate(value)

Check if a value is a Date object.

Since

0.1.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isDate([]);
// => true

# isError

isError(value)

Check if a value is an Error object.

Since

0.1.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isError(new Error('error message'));
// => true

# isFunction

isFunction(value)

Check if a value is a function, including generator function and async function.

Since

0.1.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isFunction(function () {});
// => true

isFunction(function* () {});
// => true

# isNil

isNil(value)

Check if a value is null or undefined.

Since

0.1.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isNil(null);
// => true
isNil(undefined);
// => true

# isNull

isNull(value)

Check if a value is null

Since

0.1.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isNull(null);
// => true

# isNumber

isNumber(value)

Check if a value is a Number.

Since

0.1.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isNumber(1);
// => true

# isObject

isObject(value)

Check if a value is an Object.

Since

0.1.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isObject({});
// => true
isObject(null);
// => false

# isRegExp

isRegExp(value)

Check if a value is a RegExp object.

Since

0.1.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isRegExp(/\s+/);
// => true

# isString

isString(value)

Check if a value is a String.

Since

0.1.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isString('hello world');
// => true

# isSymbol

isSymbol(value)

Check if a value is a Symbol value.

Since

0.8.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isSymbol(Symbol('foo'));
// => true

# isUndefined

isUndefined(value)

Check if a value is undefined.

Since

0.1.0

Arguments

  • value (any)

Return

  • (boolean)

Example

isUndefined(void 0);
// => true

# path

# basename

basename(str)

Return the last part of the path string.

Since

0.1.0

Arguments

  • str (string)

Return

  • (string)

Example

basename('/foo/bar');
// => "bar"

# dirname

dirname(str)

Since

0.1.0

Arguments

  • str (string)

Return

  • (string)

Example

dirname('/foo/bar');
// => "/foo"

# extname

extname(str)

Return the extension name of the path.

Since

0.1.0

Arguments

  • str (string)

Return

  • (string)

Example

extname('/foo/bar.txt');
// => ".txt"

# join

join(...args)

Join the path strings seperated by an slash /.

Since

0.8.0

Arguments

  • args (string[])

Return

  • (string)

Example

join()
// => ""
join('foo', 'bar')
// => "foo/bar"
join('foo/', '/bar')
// => "foo/bar"

# qs

# get

get(name)

Get the value of the specified name in the current search string.

Since

0.1.0

Arguments

  • name (string)

Return

  • (string|Array\<string\>)

Example

// location.search = '?hello=world'
getQuery('hello');
// => "world"


// location.search = '?fruits=apple&fruits=orange'
getQuery('fruits');
// => ["apple", "orange"]

# parse

parse(search)

Parse a search string.

Since

0.1.0

Arguments

  • search (string)

Return

  • (Object)

# stringify

stringify(query)

Convert an object to a search string.

Since

0.1.0

Arguments

  • query (Object)

Return

  • (string)

# regex

# isAscii

isAscii(str)

Check if a string contains the ASCII characters only.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isAscii('hello world');
// => true

# isDecimal

isDecimal(str)

Check if a string is a decimal number.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isDecimal('1');
// => true
isDecimal('3.14');
// => true

# isDigit

isDigit(str)

Check if a string contains the digits (0-9) only.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isDigit('0123');
// => true

# isDomain

isDomain(str)

Check if a string is a domain.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isDomain('example.com');
// => true
isDomain('https://example.com');
// => false

# isEmail

isEmail(str)

Check if a string is an email address.

If you need to check if an email is valid, the best option is that sending an email with a recipient link.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isEmail('alexchao1990@gmail.com');
// => true

isEmail('alexchao1990+github@gmail.com');
// => true

# isHexColor

isHexColor(str)

Check if a string is an hex color value.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isHexColor('#f50');
// => true

isHexColor('#ff5500');
// => true

isHexColor('#FF5500');
// => true

# isHsl

isHsl(str)

Check if a string is an HSL value.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isHsl('hsl(100, 50%, 50%)');
// => true

isHsl('HSL(100, 50%, 50%)');
// => true

# isHsla

isHsla(str)

Check if a string is an HSLA value.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isHsla('hsla(100, 50%, 50%, 0.5)');
// => true

isHsla('HSLA(100, 50%, 50%, 0.5)');
// => true

# isInteger

isInteger(str)

Same as isDigit. Check if a string contains the digits only.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isInteger('0123');
// => true

# isIP

isIP(str)

Check if a string is an IP (v4 or v6) address.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isIP('192.0.0.1');
// => true

isIP('2408:8100:2514:3f70:c98:15fe:9611:acdc');
// => true

# isIPv4

isIPv4(str)

Check if a string is an IP (v4) address.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isIPv4('192.0.0.1');
// => true

# isIPv6

isIPv6(str)

Check if a string is an IP (v4) address.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isIPv6('2408:8100:2514:3f70:c98:15fe:9611:acdc');
// => true

# isQQ

isQQ(str)

Check if a string is a QQ id.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isQQ('10000');
// => true

# isRealNumber

isRealNumber(str)

Check if a string is a real number.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isRealNumber('0.12');
// => true

isRealNumber('1.2e10');
// => true

isRealNumber('1.2e-10');
// => true

# isRgb

isRgb(str)

Check if a string is a RGB value.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isRgb('rgb(255, 255, 255)');
// => true

isRgb('RGB(255, 255, 255)');
// => true

# isRgba

isRgba(str)

Check if a string is a RGBA value.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isRgb('rgba(255, 255, 255, 0.5)');
// => true

isRgb('RGBA(255, 255, 255, 0.5)');
// => true

# string

# countChars

countChars(str, [type])

Count the number of characters in a string.

Since

0.1.0

Arguments

  • str (string)
  • [type = 0] (number): If type is 0, return the length of string. If type is 1, a full width character is counted 2, an half width character is counted 1. If type is 1, a full width character is counted 1, an half width characters is counted 0.5, but the result will be round up to an integer.

Return

  • (number)

Example

countChars('hello你好')
// => 7
countChars('hello你好', 1)
// => 9
countChars('hello你好', 2)
// => 5

# countLines

countLines(str)

Count the number of lines separated by "\n".

Since

0.1.0

Arguments

  • str (string)

Return

  • (number)

Example

const str = `hello
world
1`;
countLines(str);
// => 3

# escapeRegexp

escapeRegexp(str)

Escape the special characters in regular expression.

Since

0.1.0

Arguments

  • str (string)

Return

  • (string)

Example

escapeRegexp('a-z');
// => "a\-z"

# firstChar

firstChar(str)

Return the first character of a string.

Since

0.1.0

Arguments

  • str (string)

Return

  • (string)

Example

firstChar('hello');
// => "h"

# isValidJSON

isValidJSON(str)

Check if a string is a valid JSON string.

Since

0.1.0

Arguments

  • str (string)

Return

  • (boolean)

Example

isValidJSON('{"name": "Alex Chao"}');
// => true

isValidJSON('""');
// => true

# lastChar

lastChar(str)

Return the last character of a string.

Since

0.1.0

Arguments

  • str (string)

Return

  • (string)

Example

lastChar('hello');
// => "o"

# truncate

truncate([str], [options])

Return a truncated string end with the specified omission.

Since

0.1.0

Arguments

  • [str = ""] (string): The string to be truncated.
  • [options = {}] (Object): The options object.
    • [length] (number): The maxmium string length. It is the str length by default.
    • [omission = "..."] (string): The omission string.
    • [countType = 0] (number): How to count the half width and full width characters.
      • 0: Count 1 for each character.
      • 1: Count 1 for half width and count 2 for full width.
      • 2: Count 0.5 for half width and count 1 for full width.

Return

  • (string)

Example

const str = 'hello, 你好，world!世界！';
truncate(str);
truncate(str, { length: 10 });
truncate(str, { omission: '***' });
truncate(str, { length: 10, countType: 1 });

# ua

# isAlipay

isAlipay()

Check is the environment is Alipay App.

Since

0.14.0

Return

  • (boolean)

# isAndroid

isAndroid()

Check if the os is Android.

Since

0.1.0

Return

  • (boolean)

# isIOS

isIOS()

Check if the os is iOS.

Since

0.1.0

Return

  • (boolean)

# isIPad

isIPad()

Check if the environment is iPad.

Since

0.1.0

Return

  • (boolean)

# isIPhone

isIPhone()

Check if the environment is iPhone.

Since

0.1.0

Return

  • (boolean)

# isLinux

isLinux()

Check if the os is Linux.

Since

0.1.0

Return

  • (boolean)

# isMacOS

isMacOS()

Check if the os is macOS.

Since

0.1.0

Return

  • (boolean)

# isMobile

isMobile()

Check if the os is a mobile system.

Since

0.1.0

Return

  • (boolean)

# isTablet

isTablet()

Check if the os is a tablet system.

Since

0.1.0

Return

  • (boolean)

# isWechat

isWechat()

Check if the environment is Wechat.

Since

0.1.0

Return

  • (boolean)

# isWindows

isWindows()

Check if the os is Windows.

Since

0.1.0

Return

  • (boolean)

# url

# isAbsolute

isAbsolute(url)

Check if the url is an absolute URL.

Since

0.6.0

Arguments

  • url (string)

Return

  • (boolean)

Example

isAbsolute('example.com')
// => false
isAbsolute('https://example.com')
// => true

# join

join(...args)

Join and normalize the url part strings.

Since

0.8.0

Arguments

  • args (string[])

Return

  • (string)

Example

join('https://example.com', 'foo', 'bar')
// => 'https://example.com/foo/bar'
join('https://example.com', 'foo', 'bar/')
// => 'https://example.com/foo/bar/'
join('https://example.com', 'foo', 'bar', '?hello=world')
// => 'https://example.com/foo/bar?hello=world'

# parse

parse(url)

Since

0.4.0

Arguments

  • url (string): The parsed url.

Return

  • (Object)

Example

parse('http://admin:123456@example.com:8080/path-to-somewhere?foo=1&lang=js&lang=css#title')
// =>
// {
//   hash: '#title',
//   host: 'example.com:8080',
//   hostname: 'example.com',
//   href: 'http://admin:123456@example.com:8080/path-to-somewhere?foo=1&lang=js&lang=css#title',
//   origin: 'http://example.com:8080',
//   password: '123456',
//   pathname: '/path-to-somewhere',
//   port: '8080',
//   protocol: 'http',
//   query: {
//     foo: '1',
//     lang: ['js', 'css']
//   },
//   search: '?foo=1&lang=js&lang=css',
//   username: 'admin'
// }

# stringify

stringify(urlParts)

Since

0.4.0

Arguments

  • urlParts (Object): The url parts object.

Return

  • (string)

Example

stringify({
  protocol: 'http',
  host: 'example.com',
  pathname: '/path',
  query: {
    foo: '1',
    lang: ['js', 'css']
  }
})
// => 'http://example.com/path?foo=1&lang=js&lang=css'

# ajax

ajax(url, [options])

Since

0.1.0

Arguments

  • url (string): The request url.
  • [options] (Object): The ajax options.
    • [async = true] (boolean): If the request is send asynchronously.
    • [beforeSend] (Function): The callback called before the request sent. If it returns false, then the request will not be sent.
    • [data = null] (string|Object): The data sent.
    • [headers = null] (Object): The request headers.
    • [method = "get"] (string): The request method.
    • [responseType = "json"] (string): How to parse the response.
    • [timeout = 0] (number): The timeout.

Return

  • (Promise)

# classNames

classNames(...args)

Generate the className value of an element by any number of arguments. It is same as JedWatson/classnames (opens new window).

Since

0.10.0

Arguments

  • [args] (any[]): See the below example.

Return

  • (string)

Example

classNames('foo', 'bar'); // => 'foo bar'
classNames('foo', { bar: true }); // => 'foo bar'
classNames({ 'foo-bar': true }); // => 'foo-bar'
classNames({ 'foo-bar': false }); // => ''
classNames({ foo: true }, { bar: true }); // => 'foo bar'
classNames({ foo: true, bar: true }); // => 'foo bar'

// lots of arguments of various types
classNames('foo', { bar: true, duck: false }, 'baz', { quux: true }); // => 'foo bar baz quux'

// other falsy values and none of string, object and array are just ignored
classNames(null, false, 'bar', undefined, 0, 1, true, { baz: null }, ''); // => 'bar'

// Arrays will be recursively flattened as per the rules above
const arr = ['b', { c: true, d: false }];
classNames('a', arr); // => 'a b c'

# css

css(el, [prop])

Get the value of the specified or all CSS properties.

Since

0.1.0

Arguments

  • el (Element|string): an element or a CSS selector string.
  • [prop] (string): CSS property name.

Return

  • (string|Object)

Example

const el = document.getElementById('el');

// Get all properties
css(el);
// => CSSStyleDeclaration { ... }

// Passing a selector string
css('#el');
// => CSSStyleDeclaration { ... }

// Get the specified properties' value
css('#el', 'width');
// => '100px'

# delay

delay(duration)

Return a promise, it will be resolved after the duration time.

Since

0.1.0

Arguments

  • duration (number): The duration.

Return

  • (Promise)

# download

download(file, [fileName])

Download a url or a Blob (opens new window) object or a File (opens new window) object. This function originates from eligrey/FileSaver.js (opens new window).

Arguments

  • file (string | Blob | File): a url string or a Blob object or a File object.
  • [fileName] (string): Prefer use this argument as file name, then the name of file if file is type of File, and finally the 'download' string.

Example

// Download the file located by a url string
download('https://micell.org/logo.svg', 'micell-logo.svg')

// Download the Blob
const blob = new Blob(['Hello, world!'], { type: 'text/plain;charset=utf-8' })
download(blob, 'hello-world.txt')

# jsonp

jsonp(url, [options])

Since

0.1.0

Arguments

  • url (string): The request url
  • [options] (Object): The options.
    • [callback] (string): The callback called after the request success or failed.
    • [responseType = "json"] (string): How to parse the response.
    • [timeout = 0] (number): The request timeout.

Return

  • (Promise)

# md5

md5(input)

Since

0.4.0

Arguments

  • input (string | number[] | Uint8Array)

Return

  • (string)

Example

md5('hello 你好')
// => '429f2c0b03ebc9911455cbec2a09bc6f'

# noop

This is an empty function, accepting no argument, returning no value.

Since

0.1.0

# numberFormat

numberFormat(number, [digits], [dot], [sep])

Format a number.

Since

0.1.0

Arguments

  • number (number): The number to be formatted.
  • [digits = -1] (number): The length of decimal part. If it's -1, then the original decimal part will be preserved. It it's greater than -1, the the last of the preserved digits will be obtained with Math.round.
  • [dot = "."] (string): The delimiter of the integer and decimal part.
  • [sep = ","] (string): The thousand separator.

Return

  • (string)

Example

numberFormat(3.1415);
// => '3.1415'
numberFormat(3.1415, 3);
// => '3.142'

# raf

raf(callback)

It is same as requestAnimationFrame (opens new window) when supported. Or, use setTimeout to simulate.

Since

0.2.0

Arguments

  • callback (Function): The function to be invoked before the next repaint. A DOMHighResTimeStamp (opens new window) similar to be returned by performance.now() is passed to be as the first argument.

Return

  • (number): The timer id to be used to cancel the next callback.

Example

raf(time => console.log(time))
// => 120.123

const timerId = raf(() => console.log('never happen'))
raf.cancel(timerId)

# randomNumbers

randomNumbers(start, end, length)

Return an array of random integer which is greater than or equal to start and less than or equal to end. In array, each other is not equal.

Since

0.8.0

Arguments

  • start (number): The minimum integer.
  • end (number): The maximum integer.
  • length (number): The number of integers.

Return

  • (numbers[])

Example

randomNumbers(1, 10, 5)
// => [9, 4, 1, 5, 7]

# randomString

randomString([len], [chars])

Return a random string which consists of the characters specified by chars.

Since

0.1.0

Arguments

  • [len = 32] (number): The length of random string, default is 32.
  • [chars] (string): The character set, default is lower letters, upper letters and digits.

Return

  • (string)

Example

randomString();

// Generate an 8 length string.
randomString(8);

// Generate a random digit string.
randomString(undefined, '0123456789');

# uuid

uuid()

Generate a UUID based on random numbers, see algorithm in rfc4122 (opens new window).

Since

0.1.0

Return

  • (string)

Example

uuid();
// => 'fedb3747-4208-475d-b473-e51b583cddaf'
Last Updated: 4/8/2022, 12:31:18 PM