Skip to content

⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric Count
🔧 Functions 1
📦 Imports 4
🟢 Vue Composition API 1

📚 Table of Contents

🛠️ File Location:

📂 packages/math/useFloor/index.ts

📦 Imports

Name Source
ComputedRef vue
MaybeRefOrGetter vue
computed vue
toValue vue

Vue Composition API

Name Type Reactive Variables Composables
computed computed none none

Functions

useFloor(value: MaybeRefOrGetter<number>): ComputedRef<number>

Code
export function useFloor(value: MaybeRefOrGetter<number>): ComputedRef<number> {
  return computed<number>(() => Math.floor(toValue(value)))
}
  • JSDoc:

    /**
     * Reactive `Math.floor`
     *
     * @see https://vueuse.org/useFloor
     */
    

  • Parameters:

  • value: MaybeRefOrGetter<number>
  • Return Type: ComputedRef<number>
  • Calls:
  • computed (from vue)
  • Math.floor
  • toValue (from vue)