@maropost-ui/liquidsky-ui 0.0.10 → 0.0.12

package/dist/composables/toRefs.d.ts

@@ -1,4 +1,27 @@
 import type { MaybeRef, MaybeRefOrGetter, ToRefs } from 'vue';
+/**
+ * @description
+ * toRefs - A Vue composable that extends the native `toRefs` function to handle refs of an object.
+ *
+ * @param objectRef A ref or normal object or array.
+ * @param options Options
+ *
+ * @returns A object with the same properties as the input object, but with the values wrapped in refs.
+ *
+ * @example
+ * ```typescript
+ * import { toRefs } from '@liquidsky/ui'
+ *
+ * const obj = {
+ *   name: 'John',
+ *   age: 30
+ * }
+ * const refs = toRefs(obj)
+ *
+ * console.log(refs.name.value) // 'John'
+ * console.log(refs.age.value) // 30
+ * ```
+ */
 export interface ToRefsOptions {
     /**
      * Replace the original ref with a copy on property update.

package/dist/composables/toRefs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toRefs.d.ts","sourceRoot":"","sources":["../../src/composables/toRefs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,KAAK,CAAA;AAG7D,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAA;CACvC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,CAAC,SAAS,MAAM,EAC7C,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EACtB,OAAO,GAAE,aAAkB,GAC1B,MAAM,CAAC,CAAC,CAAC,CAqCX"}
+{"version":3,"file":"toRefs.d.ts","sourceRoot":"","sources":["../../src/composables/toRefs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,KAAK,CAAA;AAG7D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAA;CACvC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,CAAC,SAAS,MAAM,EAC7C,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EACtB,OAAO,GAAE,aAAkB,GAC1B,MAAM,CAAC,CAAC,CAAC,CAqCX"}

package/dist/composables/useUnitConversion.d.ts

@@ -1,4 +1,18 @@
 import type { UnitType, Unit } from '../types';
+/**
+ * @description
+ * useUnitConversion - A Vue composable that provides unit conversion functionality. Supports weight and dimension units.
+ *
+ * @example
+ * ```typescript
+ * const { isValidUnit, getValidUnit, getUnits, convert } = useUnitConversion()
+ *
+ * console.log(isValidUnit('kg', 'weight')) // true
+ * console.log(getValidUnit('kg', 'weight')) // 'kg'
+ * console.log(getUnits('weight')) // ['kg', 'g', 'mg', 'lb', 'oz', 'ton']
+ * console.log(convert(1, 'weight', 'kg', 'g')) // 1000
+ * ```
+ */
 export default function useUnitConversion(): {
     isValidUnit: (unit: string, type: UnitType) => boolean;
     getValidUnit: (unit: string, type: UnitType) => Unit;

package/dist/composables/useUnitConversion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useUnitConversion.d.ts","sourceRoot":"","sources":["../../src/composables/useUnitConversion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAA6B,IAAI,EAAmB,MAAM,UAAU,CAAA;AAG1F,MAAM,CAAC,OAAO,UAAU,iBAAiB;wBA2BZ,MAAM,QAAQ,QAAQ,KAAG,OAAO;yBAO/B,MAAM,QAAQ,QAAQ,KAAG,IAAI;qBAWjC,QAAQ,KAAG,MAAM,EAAE;qBAOnB,MAAM,QAAQ,QAAQ,YAAY,MAAM,UAAU,MAAM,KAAG,MAAM;EAsB1F"}
+{"version":3,"file":"useUnitConversion.d.ts","sourceRoot":"","sources":["../../src/composables/useUnitConversion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAA6B,IAAI,EAAmB,MAAM,UAAU,CAAA;AAE1F;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB;wBA2BZ,MAAM,QAAQ,QAAQ,KAAG,OAAO;yBAO/B,MAAM,QAAQ,QAAQ,KAAG,IAAI;qBAWjC,QAAQ,KAAG,MAAM,EAAE;qBAOnB,MAAM,QAAQ,QAAQ,YAAY,MAAM,UAAU,MAAM,KAAG,MAAM;EAsB1F"}