Options
All
  • Public
  • Public/Protected
  • All
Menu

Module vx-hooks/useCounter

计数器

Index

Functions

useCounter

  • useCounter(initVal: number, options?: UseCounterOptions): { current: Ref<number>; dec: (delta?: number) => number; inc: (delta?: number) => number; reset: () => number; set: (value: number) => number }
  • 计数器

    example
    
    const { current, set, inc, dec, reset } = useCounter(0, { max: 10, min: 1 })
    console.log(current) // 1
    inc()
    console.log(current) // 2
    
    inc(12)
    console.log(current) // 10
    
    dec()
    console.log(current) // 9
    
    dec(12)
    console.log(current) // 1
    
    set(4)
    console.log(current) // 4
    
    reset()
    console.log(current) // 1
    
    

    Parameters

    Returns { current: Ref<number>; dec: (delta?: number) => number; inc: (delta?: number) => number; reset: () => number; set: (value: number) => number }

    • current: Ref<number>
    • dec: (delta?: number) => number
        • (delta?: number): number
        • Parameters

          • delta: number = 1

          Returns number

    • inc: (delta?: number) => number
        • (delta?: number): number
        • Parameters

          • delta: number = 1

          Returns number

    • reset: () => number
        • (): number
        • Returns number

    • set: (value: number) => number
        • (value: number): number
        • Parameters

          • value: number

          Returns number

Generated using TypeDoc