@vjscc/utils

Type aliases

AnimationFnOptions

AnimationFnOptions: { callback?: AnyFunction; duration?: number; timingFunction?: TimingFunction }

Type declaration

Optional callback?: AnyFunction
Optional duration?: number
Optional timingFunction?: TimingFunction

AnyFunction

AnyFunction: (...args: any[]) => any

Type declaration

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

FadeFnOptions

FadeFnOptions: AnimationFnOptions & { endDisplay?: string; endOpacity?: number; startDisplay?: string; startOpacity?: number }

StringOrHTMLElement

StringOrHTMLElement: string | HTMLElement

TimingFunction

TimingFunction: (x: number) => number

Type declaration

- (x: number): number
- Parameters
  - x: number
  Returns number

Functions

cancelRAF

cancelRAF(id: number): void

- Defined in raf.ts:53
Cancel raf by id.

Parameters
- id: number
  
  Raf id created by raf.
Returns void

convertNumberToMoney

convertNumberToMoney(number: string | number, fractionDigits?: number): string

- Defined in money.ts:10
Convert number to money with thousand mark.

Parameters
- number: string | number
  
  Money number.
- fractionDigits: number = 2
  
  Decimal digits.
Returns string
Money with thousand mark.

createRAF

createRAF(callback: AnyFunction, delayFrames?: number): number

- Defined in raf.ts:23
Use RAF to do somthing. When there's no left frames, exec callback function.

Parameters
- callback: AnyFunction
  
  Callback when animation is over.
- delayFrames: number = 1
  
  Frames before fn executing.
Returns number
Return id of this RAF.

createRandomInteger

createRandomInteger(range: number): number

- Defined in random.ts:7
Generator a random number in [0, range].

Parameters
- range: number
  
  Max number of random number, round down.
Returns number
Random integer.

createRandomString

createRandomString(length: number): string

- Defined in random.ts:17
Generaotr random string.

Parameters
- length: number
  
  Length of string.
Returns string
Random string.

createRandomStringWidthDivider

createRandomStringWidthDivider(format?: string, divdier?: string): string

- Defined in random.ts:33
Generaotr random string with dividers.

Parameters
- format: string = 'xxxx-xxxx-xxxx'
  
  Format of string.
- divdier: string = '-'
  
  Divider of string chunks.
Returns string
Random String with dividers.

debounce

debounce<T>(fn: T, delay: number): (this: ThisParameterType<T>, ...args: Parameters<T>) => void

- Defined in functions.ts:11
Get function with debounce.

Type parameters
- T: AnyFunction
Parameters
- fn: T
  
  Function need to be debounce.
- delay: number
  
  Delay time before excuting.
Returns (this: ThisParameterType<T>, ...args: Parameters<T>) => void
Function with debounce.
- - (this: ThisParameterType<T>, ...args: Parameters<T>): void
  - Get function with debounce.
    
    Parameters
    - this: ThisParameterType<T>
    - Rest ...args: Parameters<T>
    Returns void
    Function with debounce.

easeInBack

easeInBack(x: number): number

- Defined in useTimingFunction.ts:114
Parameters
- x: number
Returns number

easeInBounce

easeInBounce(x: number): number

- Defined in useTimingFunction.ts:125
Parameters
- x: number
Returns number

easeInCirc

easeInCirc(x: number): number

- Defined in useTimingFunction.ts:90
Parameters
- x: number
Returns number

easeInCubic

easeInCubic(x: number): number

- Defined in useTimingFunction.ts:39
Parameters
- x: number
Returns number

easeInElastic

easeInElastic(x: number): number

- Defined in useTimingFunction.ts:99
Parameters
- x: number
Returns number

easeInExpo

easeInExpo(x: number): number

- Defined in useTimingFunction.ts:75
Parameters
- x: number
Returns number

easeInOutBack

easeInOutBack(x: number): number

- Defined in useTimingFunction.ts:120
Parameters
- x: number
Returns number

easeInOutBounce

easeInOutBounce(x: number): number

- Defined in useTimingFunction.ts:129
Parameters
- x: number
Returns number

easeInOutCirc

easeInOutCirc(x: number): number

- Defined in useTimingFunction.ts:96
Parameters
- x: number
Returns number

easeInOutCubic

easeInOutCubic(x: number): number

- Defined in useTimingFunction.ts:45
Parameters
- x: number
Returns number

easeInOutElastic

easeInOutElastic(x: number): number

- Defined in useTimingFunction.ts:105
Parameters
- x: number
Returns number

easeInOutExpo

easeInOutExpo(x: number): number

- Defined in useTimingFunction.ts:81
Parameters
- x: number
Returns number

easeInOutQuad

easeInOutQuad(x: number): number

- Defined in useTimingFunction.ts:36
Parameters
- x: number
Returns number

easeInOutQuart

easeInOutQuart(x: number): number

- Defined in useTimingFunction.ts:54
Parameters
- x: number
Returns number

easeInOutQuint

easeInOutQuint(x: number): number

- Defined in useTimingFunction.ts:63
Parameters
- x: number
Returns number

easeInOutSine

easeInOutSine(x: number): number

- Defined in useTimingFunction.ts:72
Parameters
- x: number
Returns number

easeInQuad

easeInQuad(x: number): number

- Defined in useTimingFunction.ts:30
Parameters
- x: number
Returns number

easeInQuart

easeInQuart(x: number): number

- Defined in useTimingFunction.ts:48
Parameters
- x: number
Returns number

easeInQuint

easeInQuint(x: number): number

- Defined in useTimingFunction.ts:57
Parameters
- x: number
Returns number

easeInSine

easeInSine(x: number): number

- Defined in useTimingFunction.ts:66
Parameters
- x: number
Returns number

easeOutBack

easeOutBack(x: number): number

- Defined in useTimingFunction.ts:117
Parameters
- x: number
Returns number

easeOutBounce

easeOutBounce(x: number): number

- Defined in useTimingFunction.ts:128
Parameters
- x: number
Returns number

easeOutCirc

easeOutCirc(x: number): number

- Defined in useTimingFunction.ts:93
Parameters
- x: number
Returns number

easeOutCubic

easeOutCubic(x: number): number

- Defined in useTimingFunction.ts:42
Parameters
- x: number
Returns number

easeOutElastic

easeOutElastic(x: number): number

- Defined in useTimingFunction.ts:102
Parameters
- x: number
Returns number

easeOutExpo

easeOutExpo(x: number): number

- Defined in useTimingFunction.ts:78
Parameters
- x: number
Returns number

easeOutQuad

easeOutQuad(x: number): number

- Defined in useTimingFunction.ts:33
Parameters
- x: number
Returns number

easeOutQuart

easeOutQuart(x: number): number

- Defined in useTimingFunction.ts:51
Parameters
- x: number
Returns number

easeOutQuint

easeOutQuint(x: number): number

- Defined in useTimingFunction.ts:60
Parameters
- x: number
Returns number

easeOutSine

easeOutSine(x: number): number

- Defined in useTimingFunction.ts:69
Parameters
- x: number
Returns number

fadeIn

fadeIn(el: HTMLElement, options?: FadeFnOptions): void

- Defined in animations.ts:76
Let element fade in.

Parameters
- el: HTMLElement
  
  DOM element.
- options: FadeFnOptions = {}
  
  Options.
Returns void

fadeOut

fadeOut(el: HTMLElement, options?: FadeFnOptions): void

- Defined in animations.ts:27
Let dom element fade out.

Parameters
- el: HTMLElement
  
  Dom element.
- options: FadeFnOptions = {}
  
  Options.
Returns void

getBase64

getBase64(file: File): Promise<FileReader["result"] | ProgressEvent<FileReader>>

- Defined in bom.ts:9
Convert file to base64 by FileReader.

Parameters
- file: File
  
  File object.
Returns Promise<FileReader["result"] | ProgressEvent<FileReader>>
Promise of result.

getElementViaStringOrHTMLElement

getElementViaStringOrHTMLElement(stringOrHTMLElement: StringOrHTMLElement, container?: HTMLElement | Document): HTMLElement | null

- Defined in dom.ts:54
Get element via string or HTMLElement.

Parameters
- stringOrHTMLElement: StringOrHTMLElement
  
  String or HTMLElement.
- container: HTMLElement | Document = document
  
  Where to find, default is document.
Returns HTMLElement | null
HTMLElement or null if not found or fail.

isArray

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

- Defined in types.ts:121
Checks if value is an array.

Parameters
- value: unknown
  
  The value to check.
Returns value is any[]
true if the argument appears to be an array.

isBigInt

isBigInt(value: unknown): value is bigint

- Defined in types.ts:82
Checks if value is a BigInt.

Parameters
- value: unknown
  
  The value to check.
Returns value is bigint
true if the argument appears to be a BigInt.

isBoolean

isBoolean(value: unknown): value is boolean

- Defined in types.ts:59
Checks if value is a boolean.

Parameters
- value: unknown
  
  The value to check.
Returns value is boolean
true if value is a boolean, otherwise false.

isFunction

isFunction(value: unknown): value is AnyFunction

- Defined in types.ts:131
Checks if value is classified as a Function object.

Parameters
- value: unknown
  
  The value to check.
Returns value is AnyFunction
true if value is a function, otherwise false.

isHTMLElement

isHTMLElement(value: unknown): value is HTMLElement

- Defined in dom.ts:9
Check if value is a HTML element.

Parameters
- value: unknown
  
  The value to check.
Returns value is HTMLElement
True if it is, false if it isn't.

isHTMLElementOrDocument

isHTMLElementOrDocument(value: unknown): value is HTMLElement | Document

- Defined in dom.ts:31
Check if value is a HTML element or document.

Parameters
- value: unknown
  
  The value to check.
Returns value is HTMLElement | Document
true if it is, otherwise false.

isNull

isNull(value: unknown): value is null

- Defined in types.ts:29
Checks if value is null.

Parameters
- value: unknown
  
  The value to check.
Returns value is null
true if the argument appears to be null.

isNumber

isNumber(value: unknown): value is number

- Defined in types.ts:49
Checks if value is a number.

Parameters
- value: unknown
  
  The value to check.
Returns value is number
true if value is a number, otherwise false.

isObject

isObject(value: unknown): value is Record<string, unknown>

- Defined in types.ts:92
Checks if value is a object.

Parameters
- value: unknown
  
  The value to check.
Returns value is Record<string, unknown>
true if the argument appears to be a object.

isPlainObject

isPlainObject(value: unknown): value is Record<string, unknown>

- Defined in types.ts:103
Checks if value is a plain object.

Parameters
- value: unknown
  
  The value to check.
Returns value is Record<string, unknown>
true if the argument appears to be a plain object.

isString

isString(value: unknown): value is string

- Defined in types.ts:39
Checks if value is a string.

Parameters
- value: unknown
  
  The value to check.
Returns value is string
true if value is a string, otherwise false.

isStringOrHTMLElement

isStringOrHTMLElement(value: unknown): value is StringOrHTMLElement

- Defined in dom.ts:41
Check if value is a string or HTMLELement.

Parameters
- value: unknown
  
  Target value to check.
Returns value is StringOrHTMLElement
True if it is string or HTMLELement, false otherwise.

isSymbol

isSymbol(value: unknown): value is symbol

- Defined in types.ts:69
Checks if value is a symbol.

Parameters
- value: unknown
  
  The value to check.
Returns value is symbol
true if the argument appears to be a symbol.

isUndefined

isUndefined(value: unknown): value is undefined

- Defined in types.ts:19
Checks if value is undefined.

Parameters
- value: unknown
  
  The value to check.
Returns value is undefined
true if the argument appears to be undefined.

isWindow

isWindow(value: unknown): boolean

- Defined in bom.ts:24
Check if value is window.

Parameters
- value: unknown
  
  The value to check.
Returns boolean
true if it's window, otherwise return false.

linear

linear(x: number): number

- Defined in useTimingFunction.ts:24
Parameters
- x: number
Returns number

swing

swing(x: number): number

- Defined in useTimingFunction.ts:27
Parameters
- x: number
Returns number

throttle

throttle<T>(fn: T, interval: number): (this: ThisParameterType<T>, ...args: Parameters<T>) => void

- Defined in functions.ts:31
Get function with throttle.

Type parameters
- T: AnyFunction
Parameters
- fn: T
  
  Function need to be throttle.
- interval: number
  
  Interval time before each excuting.
Returns (this: ThisParameterType<T>, ...args: Parameters<T>) => void
Function with throttle.
- - (this: ThisParameterType<T>, ...args: Parameters<T>): void
  - Get function with throttle.
    
    Parameters
    - this: ThisParameterType<T>
    - Rest ...args: Parameters<T>
    Returns void
    Function with throttle.

useTimingFunction

useTimingFunction(currentTime: number, duration: number, startValue: number, targetValue: number, fn?: TimingFunction): number

- Defined in useTimingFunction.ts:143
Use timing function to calculate value in progress.

Parameters
- currentTime: number
  
  Current time.
- duration: number
  
  Duration.
- startValue: number
  
  Start value.
- targetValue: number
  
  Target value.
- fn: TimingFunction = linear
  
  Timing function.
Returns number
Current value.

Generated using TypeDoc