跳到主要内容

useBase64

分类
导出大小
794 B
上次更改
8 个月前

响应式 Base64 转换。支持纯文本、缓冲区、文件、画布、对象、映射、集合和图片。

演示

文本输入
Base64
缓冲区输入
new ArrayBuffer(1024)
Base64
文件输入
Base64
图片输入
Base64

用法

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

如果使用对象、数组、映射或集合,可以在选项中提供序列化器。否则,您的数据将由默认序列化器序列化。对象和数组将通过 JSON.stringify 转换为字符串。映射和集合将在字符串化之前分别转换为对象和数组。

类型声明

显示类型声明
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

来源

源代码演示文档

贡献者

Anthony Fu
IlyaL
Anthony Fu
Robin
丶远方
Mikhailov Nikita
wheat
jelf

更新日志

v12.8.0
7432f - feat(types): 废弃 MaybeRefMaybeRefOrGetter,转而使用 Vue 的原生类型 (#4636)
v12.3.0
59f75 - feat(toValue): 废弃 @vueuse/shared 中的 toValue,转而使用 Vue 的原生函数
v12.1.0
4b4bd - feat: 添加 Data URL 输出控制选项 (#4316)
0a9ed - feat!: 放弃对 Vue 2 的支持,优化打包并清理 (#4349)

根据 MIT 许可证发布。