@fujia/hammer

Index

Classes

Variables

Variables

emptyObject

emptyObject: Readonly<{}> = ...

isBrowser

isBrowser: boolean = ...

isDev

isDev: boolean = ...

isNavigator

isNavigator: boolean = ...

isProd

isProd: boolean = ...

scrollbarWidth

scrollbarWidth: ScrollbarWidth = ...

Functions

Const addListener

addListener<T>(obj: null | T, ...args: Parameters<T["addEventListener"]> | [string, null | VoidFunction, ...any[]]): void

- Defined in util.ts:49
Type parameters
- T: Window | EventTarget | Document | HTMLElement
Parameters
- obj: null | T
- Rest ...args: Parameters<T["addEventListener"]> | [string, null | VoidFunction, ...any[]]
Returns void

batch

batch(fn: any): (target: unknown, ...rest: any[]) => any

- Defined in batch.ts:9
Parameters
- fn: any
Returns (target: unknown, ...rest: any[]) => any
- - (target: unknown, ...rest: any[]): any
  - Parameters
    - target: unknown
    - Rest ...rest: any[]
    Returns any

Const cacheStringFunction

cacheStringFunction<T>(fn: T): T

- Defined in cacheStringFunction.ts:9
Type parameters
- T: (str: string) => string
Parameters
- fn: T
Returns T

Const capitalizeFirstLetter

capitalizeFirstLetter(str: string): string

- Defined in util.ts:31
Parameters
- str: string
Returns string

Const chain

chain(fns: VoidFunction[], errCallback: VoidFunction): undefined | Promise<unknown>

- Defined in chain.ts:11
Parameters
- fns: VoidFunction[]
- errCallback: VoidFunction
Returns undefined | Promise<unknown>

Const chunk

chunk<T>(arr: T[], size?: number): T[][]

- Defined in array/index.ts:100
Type parameters
- T
Parameters
- arr: T[]
- size: number = 1
Returns T[][]

Const clone

clone(val: Record<any, any>): Record<any, any>

- Defined in object/index.ts:9
Parameters
- val: Record<any, any>
Returns Record<any, any>

continuous

continuous<T>(fn: CallableFunction): (...args: T[]) => T

- Defined in continuous.ts:9
Type parameters
- T
Parameters
- fn: CallableFunction
Returns (...args: T[]) => T
- - (...args: T[]): T
  - Parameters
    - Rest ...args: T[]
    Returns T

debounce

debounce(fn: any, ms?: number): (...args: any[]) => void

- Defined in debounce.ts:9
Parameters
- fn: any
- ms: number = 100
Returns (...args: any[]) => void
- - (...args: any[]): void
  - Parameters
    - Rest ...args: any[]
    Returns void

Const deepClone

deepClone(val: Record<any, any>): Record<any, any>

- Defined in object/index.ts:23
Parameters
- val: Record<any, any>
Returns Record<any, any>

Const deepCloneByJson

deepCloneByJson(val: Record<any, any>): any

- Defined in object/index.ts:46
Parameters
- val: Record<any, any>
Returns any

Const def

def(obj: object, key: string | symbol, value: any): void

- Defined in util.ts:41
Parameters
- obj: object
- key: string | symbol
- value: any
Returns void

Const diff

diff<T>(arr: T[], compareArr: T[]): T[]

- Defined in array/index.ts:80
Type parameters
- T
Parameters
- arr: T[]
- compareArr: T[]
Returns T[]

Const drop

drop<T>(arr: T[], size: number): T[]

- Defined in array/index.ts:31
Type parameters
- T = any
Parameters
- arr: T[]
- size: number
Returns T[]

Const dropRight

dropRight<T>(arr: T[], size: number): T[]

- Defined in array/index.ts:40
Type parameters
- T = any
Parameters
- arr: T[]
- size: number
Returns T[]

Const errorLog

errorLog(msg: string): void

- Defined in print.ts:24
Parameters
- msg: string
Returns void

Const flatten

flatten<T>(arr: T[]): T[]

- Defined in array/index.ts:10
Type parameters
- T = any
Parameters
- arr: T[]
Returns T[]

Const forEach

forEach(val: any, fn: (...arg: any[]) => void): void

- Defined in forEach.ts:14
SYNOPSIS:

Iterate over an Array or an Object invoking a function for each item.

If obj is an Array callback will be called passing the value, index, and complete array for each item.

If 'obj' is an Object callback will be called passing the value, key, and complete object for each property.

Parameters
- val: any
- fn: (...arg: any[]) => void
  - - (...arg: any[]): void
    - Parameters
      - Rest ...arg: any[]
      Returns void
Returns void

Const infoLog

infoLog(msg: string): void

- Defined in print.ts:12
Parameters
- msg: string
Returns void

intercept

intercept(fn: any, {{: { afterCall: any; beforeCall: any }): (...args: any[]) => any

- Defined in intercept.ts:24
description
A function intercepter

export
Parameters
- fn: any
  
  the called function
- {{: { afterCall: any; beforeCall: any }
  
  beforeCall: Function, afterCall: Function }} { beforeCall, a prepositive intercept(er), if exist and return false, the fn will not be executed. afterCall, if exit, can instead of the fn's return value }
  - afterCall: any
  - beforeCall: any
Returns (...args: any[]) => any
- - (...args: any[]): any
  - Parameters
    - Rest ...args: any[]
    Returns any

Const invokeArrayFns

invokeArrayFns(fns: CallableFunction[], arg?: any): void

- Defined in util.ts:35
Parameters
- fns: CallableFunction[]
- Optional arg: any
Returns void

Const isArray

isArray(val: unknown): val is any[]

- Defined in is.ts:54
Parameters
- val: unknown
Returns val is any[]

Const isArrayBuffer

isArrayBuffer(val: unknown): val is ArrayBuffer

- Defined in is.ts:93
Parameters
- val: unknown
Returns val is ArrayBuffer

Const isArrayBufferView

isArrayBufferView(val: any): val is ArrayBufferView

- Defined in is.ts:120
Parameters
- val: any
Returns val is ArrayBufferView

Const isBlob

isBlob(val: unknown): val is Blob

- Defined in is.ts:152
Parameters
- val: unknown
Returns val is Blob

Const isBuffer

isBuffer(val: any): val is Buffer

- Defined in is.ts:101
Parameters
- val: any
Returns val is Buffer

Const isDate

isDate(val: unknown): val is Date

- Defined in is.ts:68
Parameters
- val: unknown
Returns val is Date

Const isDef

isDef(val: unknown): boolean

- Defined in is.ts:20
Parameters
- val: unknown
Returns boolean

Const isFalse

isFalse(val: unknown): val is false

- Defined in is.ts:28
Parameters
- val: unknown
Returns val is false

Const isFile

isFile(val: unknown): val is File

- Defined in is.ts:144
Parameters
- val: unknown
Returns val is File

Const isFileList

isFileList(val: unknown): val is FileList

- Defined in is.ts:160
Parameters
- val: unknown
Returns val is FileList

Const isFormData

isFormData(val: any): val is FormData

- Defined in is.ts:177
Parameters
- val: any
Returns val is FormData

Const isFunction

isFunction(val: unknown): val is VoidFunction

- Defined in is.ts:70
Parameters
- val: unknown
Returns val is VoidFunction

Const isInteger

isInteger(val: unknown): val is number

- Defined in is.ts:76
Parameters
- val: unknown
Returns val is number

Const isIntegerKey

isIntegerKey(key: unknown): boolean

- Defined in is.ts:110
Parameters
- key: unknown
Returns boolean

Const isMap

isMap(val: unknown): val is Map<any, any>

- Defined in is.ts:56
Parameters
- val: unknown
Returns val is Map<any, any>

Const isNumber

isNumber(val: unknown): val is number

- Defined in is.ts:74
Parameters
- val: unknown
Returns val is number

Const isObject

isObject(val: unknown): val is Record<any, any>

- Defined in is.ts:79
Parameters
- val: unknown
Returns val is Record<any, any>

Const isOn

isOn(val: string): boolean

- Defined in is.ts:13
Parameters
- val: string
Returns boolean

Const isPalindrome

isPalindrome(val: string): boolean

- Defined in string/index.ts:20
Parameters
- val: string
Returns boolean

Const isPlainObject

isPlainObject(val: unknown): val is Record<any, any>

- Defined in is.ts:47
Parameters
- val: unknown
Returns val is Record<any, any>

isPrimitive

isPrimitive(val: unknown): boolean

- Defined in is.ts:32
Parameters
- val: unknown
Returns boolean

Const isPromise

isPromise<T>(val: unknown): val is Promise<T>

- Defined in is.ts:83
Type parameters
- T = any
Parameters
- val: unknown
Returns val is Promise<T>

Const isRegExp

isRegExp(val: unknown): val is RegExp

- Defined in is.ts:64
Parameters
- val: unknown
Returns val is RegExp

Const isSet

isSet(val: unknown): val is Set<any>

- Defined in is.ts:60
Parameters
- val: unknown
Returns val is Set<any>

Const isStandardBrowserEn

isStandardBrowserEn(): boolean

- Defined in is.ts:205
Check the running context is a standard browser environment

web workers: typeof window -> undefined typeof document -> undefined

react-native: navigator.product -> 'ReactNative' nativescript: navigator.product -> 'NativeScript' or 'NS'

Returns boolean

Const isString

isString(val: unknown): val is string

- Defined in is.ts:72
Parameters
- val: unknown
Returns val is string

Const isTrue

isTrue(val: unknown): val is true

- Defined in is.ts:24
Parameters
- val: unknown
Returns val is true

Const isTypedArray

isTypedArray(): (val: unknown) => boolean

- Defined in is.ts:188
Returns (val: unknown) => boolean
- - (val: unknown): boolean
  - Parameters
    - val: unknown
    Returns boolean

Const isURLSearchParams

isURLSearchParams(val: unknown): val is URLSearchParams

- Defined in is.ts:168
Parameters
- val: unknown
Returns val is URLSearchParams

Const isUndef

isUndef(val: unknown): val is UndefType

- Defined in is.ts:16
Parameters
- val: unknown
Returns val is UndefType

Const isValidArrayIndex

isValidArrayIndex(val: unknown): boolean

- Defined in is.ts:132
Parameters
- val: unknown
Returns boolean

localeCompareSupportsLocales

localeCompareSupportsLocales(): boolean

- Defined in canISee.ts:6
desc
check browser support for extended arguments.

export
Returns boolean

Const loggerTiming

loggerTiming(str: "", start: true): void

- Defined in print.ts:36
Parameters
- str: ""
- start: true
Returns void

Const merge

merge(...args: Record<any, any>[]): Record<any, any>

- Defined in object/merge.ts:27
Parameters
- Rest ...args: Record<any, any>[]
Returns Record<any, any>

Const noop

noop(): void

- Defined in util.ts:13
Returns void

Const objToString

objToString(): string

- Defined in util.ts:15
Returns string

once

once(fn: null | VoidFunction, replacer?: VoidFunction): VoidFunction

- Defined in once.ts:12
Parameters
- fn: null | VoidFunction
- Optional replacer: VoidFunction
Returns VoidFunction

pipe

pipe(...fns: any[]): (value: unknown) => any

- Defined in pipe.ts:26
Parameters
- Rest ...fns: any[]
Returns (value: unknown) => any
- - (value: unknown): any
  - Parameters
    - value: unknown
    Returns any

Const removeItemFromArray

removeItemFromArray<T>(arr: T[], item: T): void

- Defined in util.ts:23
Type parameters
- T
Parameters
- arr: T[]
- item: T
Returns void

Const removeListener

removeListener<T>(obj: null | T, ...args: [string, null | VoidFunction, ...any[]] | Parameters<T["removeEventListener"]>): void

- Defined in util.ts:58
Type parameters
- T: Window | EventTarget | Document | HTMLElement
Parameters
- obj: null | T
- Rest ...args: [string, null | VoidFunction, ...any[]] | Parameters<T["removeEventListener"]>
Returns void

Const reverse

reverse(val: string): string

- Defined in string/index.ts:7
Parameters
- val: string
Returns string

reverseFuncArgs

reverseFuncArgs(fn: any): (...args: any) => any

- Defined in reverse.ts:10
Parameters
- fn: any
Returns (...args: any) => any
- - (...args: any): any
  - Parameters
    - Rest ...args: any
    Returns any

Const shuffle

shuffle<T>(items: T[]): T[]

- Defined in shuffle.ts:10
Type parameters
- T
Parameters
- items: T[]
Returns T[]

shuffleWithGenerator

shuffleWithGenerator<T>(items: T[]): Generator<T, void, unknown>

- Defined in shuffle.ts:22
Type parameters
- T
Parameters
- items: T[]
Returns Generator<T, void, unknown>

Const spreadObjToString

spreadObjToString(val: Record<string, unknown>, prefix?: string): undefined | string

- Defined in util.ts:67
Parameters
- val: Record<string, unknown>
- Optional prefix: string
Returns undefined | string

Const successLog

successLog(msg: string): void

- Defined in print.ts:30
Parameters
- msg: string
Returns void

throttle

throttle(fn: any, ms?: number): (...args: any) => any

- Defined in throttle.ts:9
Parameters
- fn: any
- ms: number = 100
Returns (...args: any) => any
- - (...args: any): any
  - Parameters
    - Rest ...args: any
    Returns any

Const toNumber

toNumber(val: any): any

- Defined in to.ts:16
Parameters
- val: any
Returns any

Const toRawType

toRawType(val: unknown): string

- Defined in to.ts:12
Parameters
- val: unknown
Returns string

Const toTypeString

toTypeString(val: unknown): string

- Defined in to.ts:10
Parameters
- val: unknown
Returns string

Const trim

trim(str: string, greed?: boolean): string

- Defined in trim.ts:10
Parameters
- str: string
- greed: boolean = false
Returns string

Const truncate

truncate(val: string, size: number, tail?: string): string

- Defined in string/index.ts:32
Parameters
- val: string
- size: number
- Optional tail: string
Returns string

Const unique

unique<T>(arr: T[]): T[]

- Defined in array/index.ts:50
Type parameters
- T = any
Parameters
- arr: T[]
Returns T[]

Const uniqueBySet

uniqueBySet<T>(arr: T[]): T[]

- Defined in array/index.ts:70
Type parameters
- T
Parameters
- arr: T[]
Returns T[]

Const warningLog

warningLog(msg: string): void

- Defined in print.ts:18
Parameters
- msg: string
Returns void

Const wipeEmptyOfObj

wipeEmptyOfObj<T>(val: T): void | Pick<T, keyof T>

- Defined in wipeEmptyOfObj.ts:12
Type parameters
- T: object
Parameters
- val: T
Returns void | Pick<T, keyof T>

Generated using TypeDoc