コンテンツへスキップ

useBase64

カテゴリ
エクスポートサイズ
769 B
最終更新日
先週

リアクティブなbase64変換。プレーンテキスト、バッファ、ファイル、キャンバス、オブジェクト、マップ、セット、画像をサポートします。

デモ

テキスト入力
Base64
バッファ入力
new ArrayBuffer(1024)
Base64
ファイル入力
Base64
画像入力
Base64

使用法

ts
import { useBase64 } from '@vueuse/core'
import { Ref, ref } from 'vue'

const text = ref('')

const { base64 } = useBase64(text)
js
import { useBase64 } from '@vueuse/core'
import { ref } from 'vue'
const text = ref('')
const { base64 } = useBase64(text)

オブジェクト、配列、マップ、またはセットを使用する場合は、オプションでシリアライザーを提供できます。それ以外の場合、データはデフォルトのシリアライザーによってシリアライズされます。オブジェクトと配列はJSON.stringifyによって文字列に変換されます。マップとセットは、stringifyの前にそれぞれオブジェクトと配列に変換されます。

型宣言

型宣言を表示
typescript
export interface ToDataURLOptions {
  /**
   * MIME type
   */
  type?: string | undefined
  /**
   * Image quality of jpeg or webp
   */
  quality?: any
}
export interface UseBase64ObjectOptions<T> {
  serializer: (v: T) => string
}
export interface UseBase64Return {
  base64: Ref<string>
  promise: Ref<Promise<string>>
  execute: () => Promise<string>
}
export declare function useBase64(
  target: MaybeRefOrGetter<string>,
): UseBase64Return
export declare function useBase64(
  target: MaybeRefOrGetter<Blob>,
): UseBase64Return
export declare function useBase64(
  target: MaybeRefOrGetter<ArrayBuffer>,
): UseBase64Return
export declare function useBase64(
  target: MaybeRefOrGetter<HTMLCanvasElement>,
  options?: ToDataURLOptions,
): UseBase64Return
export declare function useBase64(
  target: MaybeRefOrGetter<HTMLImageElement>,
  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

ソース

ソースデモドキュメント

コントリビューター

Anthony Fu
Anthony Fu
丶远方
Mikhailov Nikita
wheat
jelf

変更履歴

v12.0.0-beta.1 2024年11月21日
0a9ed - feat!: Vue 2のサポートを削除、バンドルを最適化、クリーンアップ (#4349)
v10.0.0-beta.5 2023年4月13日
cb644 - refactor!: isFunctionisStringのユーティリティを削除
v10.0.0-beta.4 2023年4月13日
4d757 - feat(types)!: MaybeComputedRefMaybeRefOrGetterにリネーム
0a72b - feat(toValue): resolveUnreftoValueにリネーム

MITライセンスの下でリリースされています。