feat .calude

.claude/skills/vueuse-functions/references/useBase64.md

@@ -0,0 +1,88 @@
+---
+category: Utilities
+---
+
+# useBase64
+
+Reactive base64 transforming. Supports plain text, buffer, files, canvas, objects, maps, sets and images.
+
+## Usage
+
+```ts
+import { useBase64 } from '@vueuse/core'
+import { shallowRef } from 'vue'
+
+const text = shallowRef('')
+
+const { base64 } = useBase64(text)
+```
+
+If you use object, array, map or set you can provide serializer in options. Otherwise, your data will be serialized by default serializer.
+Objects and arrays will be transformed in string by JSON.stringify. Map and set will be transformed in object and array respectively before stringify.
+
+## Type Declarations
+
+```ts
+export interface UseBase64Options {
+  /**
+   * Output as Data URL format
+   *
+   * @default true
+   */
+  dataUrl?: boolean
+}
+export interface ToDataURLOptions extends UseBase64Options {
+  /**
+   * MIME type
+   */
+  type?: string | undefined
+  /**
+   * Image quality of jpeg or webp
+   */
+  quality?: any
+}
+export interface UseBase64ObjectOptions<T> extends UseBase64Options {
+  serializer?: (v: T) => string
+}
+export interface UseBase64Return {
+  base64: ShallowRef<string>
+  promise: ShallowRef<Promise<string>>
+  execute: () => Promise<string>
+}
+export declare function useBase64(
+  target: MaybeRefOrGetter<string | undefined>,
+  options?: UseBase64Options,
+): UseBase64Return
+export declare function useBase64(
+  target: MaybeRefOrGetter<Blob | undefined>,
+  options?: UseBase64Options,
+): UseBase64Return
+export declare function useBase64(
+  target: MaybeRefOrGetter<ArrayBuffer | undefined>,
+  options?: UseBase64Options,
+): UseBase64Return
+export declare function useBase64(
+  target: MaybeRefOrGetter<HTMLCanvasElement | undefined>,
+  options?: ToDataURLOptions,
+): UseBase64Return
+export declare function useBase64(
+  target: MaybeRefOrGetter<HTMLImageElement | undefined>,
+  options?: ToDataURLOptions,
+): UseBase64Return
+export declare function useBase64<T extends Record<string, unknown>>(
+  target: MaybeRefOrGetter<T>,
+  options?: UseBase64ObjectOptions<T>,
+): UseBase64Return
+export declare function useBase64<T extends Map<string, unknown>>(
+  target: MaybeRefOrGetter<T>,
+  options?: UseBase64ObjectOptions<T>,
+): UseBase64Return
+export declare function useBase64<T extends Set<unknown>>(
+  target: MaybeRefOrGetter<T>,
+  options?: UseBase64ObjectOptions<T>,
+): UseBase64Return
+export declare function useBase64<T>(
+  target: MaybeRefOrGetter<T[]>,
+  options?: UseBase64ObjectOptions<T[]>,
+): UseBase64Return
+```