@vtj / Modules / utils

Module: utils

Table of contents

Namespaces

• cookie
• url

Classes

• Logger
• Request
• Storage

Interfaces

• FetchJsonpOptions
• IApiMap
• IRequestConfig
• IRequestOptions
• IRequestRecord
• IRequestSettings
• IRequestSkipWarn
• IRequestSkipWarnResponse
• IResultWrapper
• IStaticRequest
• LoadScriptOptions
• StorageOptions
• StorageTypes

Type Aliases

• Jsonp
• LoggerLevel
• RequestOriginResponse

Variables

• LOCAL_REQUEST_ID
• VTJ_UTILS_VERSION
• isClient
• logger
• storage

Functions

• cAF
• createApi
• createApis
• createRequest
• downloadBlob
• downloadRemoteFile
• downloadUrl
• fileToBase64
• formDataToJson
• getLogger
• jsonp
• loadScript
• rAF
• request
• useApi

Type Aliases

Jsonp

Ƭ Jsonp: typeof jsonp

Defined in

packages/utils/src/jsonp.ts:35

---

LoggerLevel

Ƭ LoggerLevel: "debug" | "log" | "info" | "warn" | "error"

Defined in

packages/utils/src/logger.ts:1

---

RequestOriginResponse

Ƭ RequestOriginResponse<R, D>: AxiosResponse<IResultWrapper<R>, D>

Type parameters

Name	Type
R	any
D	any

Defined in

packages/utils/src/request.ts:59

Variables

LOCAL_REQUEST_ID

• Const LOCAL_REQUEST_ID: "Local-Request-Id"

Defined in

packages/utils/src/request.ts:28

---

VTJ_UTILS_VERSION

• Const VTJ_UTILS_VERSION: "0.8.8"

! Copyright (c) 2024, VTJ.PRO All rights reserved.

Name

@vtj/utils

Author

CHC chenhuachun1549@dingtalk.com

Version

0.8.8

License

MIT License

Defined in

packages/utils/src/version.ts:8

---

isClient

• Const isClient: boolean

是否浏览器环境

Defined in

packages/utils/src/util.ts:4

---

logger

• Const logger: Logger

Defined in

packages/utils/src/logger.ts:112

---

storage

• Const storage: Storage

Defined in

packages/utils/src/storage.ts:106

Functions

cAF

▸ cAF(handle): void

Parameters

Name	Type
handle	number

Returns

void

Defined in

packages/utils/src/raf.ts:8

---

createApi

▸ createApi<R, D>(config): (data?: D, opts?: IRequestConfig<any>) => Promise<R>

Type parameters

Name	Type
R	any
D	any

Parameters

Name	Type
config	string | IRequestConfig<any>

Returns

fn

▸ (data?, opts?): Promise<R>

Parameters

Name	Type
data?	D
opts?	IRequestConfig<any>

Returns

Promise<R>

Defined in

packages/utils/src/request.ts:487

---

createApis

▸ createApis(map): Record<string, (data?: unknown, opts?: IRequestConfig<any>) => Promise<unknown>>

Parameters

Name	Type
map	IApiMap

Returns

Record<string, (data?: unknown, opts?: IRequestConfig<any>) => Promise<unknown>>

Defined in

packages/utils/src/request.ts:498

---

createRequest

▸ createRequest(options?): IStaticRequest

Parameters

Name	Type
options	IRequestOptions

Returns

IStaticRequest

Defined in

packages/utils/src/request.ts:461

---

downloadBlob

▸ downloadBlob(data, filename?): void

Parameters

Name	Type	Default value
data	any	undefined
filename	string	''

Returns

void

Defined in

packages/utils/src/download.ts:9

---

downloadRemoteFile

▸ downloadRemoteFile(url, filename?): Promise<Blob>

Parameters

Name	Type	Default value
url	string	undefined
filename	string	''

Returns

Promise<Blob>

Defined in

packages/utils/src/download.ts:19

---

downloadUrl

▸ downloadUrl(url, filename?): void

Parameters

Name	Type	Default value
url	string	undefined
filename	string	''

Returns

void

Defined in

packages/utils/src/download.ts:1

---

fileToBase64

▸ fileToBase64(file): Promise<string>

文件对象 File 转换为 base64

Parameters

Name	Type
file	File

Returns

Promise<string>

Defined in

packages/utils/src/util.ts:11

---

formDataToJson

▸ formDataToJson(data): Record<string, any>

FormData 转换为json

Parameters

Name	Type
data	FormData

Returns

Record<string, any>

Defined in

packages/utils/src/util.ts:29

---

getLogger

▸ getLogger(config): Logger

Parameters

Name	Type
config	Object
config.bizName	string
config.level	LoggerLevel

Returns

Logger

Defined in

packages/utils/src/logger.ts:106

---

jsonp

▸ jsonp<T>(url, options?): Promise<T>

Type parameters

Name	Type
T	any

Parameters

Name	Type
url	string
options	FetchJsonpOptions

Returns

Promise<T>

Defined in

packages/utils/src/jsonp.ts:20

---

loadScript

▸ loadScript<T>(src, options?): Promise<T | undefined>

Type parameters

Name	Type
T	any

Parameters

Name	Type
src	string
options	LoadScriptOptions

Returns

Promise<T | undefined>

Defined in

packages/utils/src/loadScript.ts:22

---

rAF

▸ rAF(fn): number

Parameters

Name	Type
fn	() => void

Returns

number

Defined in

packages/utils/src/raf.ts:3

---

request

▸ request(options): Promise<AxiosResponse<any, any>>

Parameters

Name	Type
options	IRequestConfig<any>

Returns

Promise<AxiosResponse<any, any>>

Defined in

packages/utils/src/request.ts:479

---

useApi

▸ useApi<R>(api, transform?): Object

Type parameters

Name	Type
R	any

Parameters

Name	Type
api	Promise<R>
transform?	(res: any) => R

Returns

Object

Name	Type
data	Ref<null | UnwrapRef<R>>
error	Ref<any>
loading	Ref<boolean>

Defined in

packages/utils/src/request.ts:506