Commit d4dfd31e authored by 郑磊's avatar 郑磊

更新d.ts

parent 0876cde6
Pipeline #830 failed with stages
This source diff could not be displayed because it is too large. You can view the blob instead.
This diff is collapsed.
import { PropType } from 'vue';
declare const _default: import("vue").DefineComponent<{
requestCaptchaDataUrl: {
type: StringConstructor;
required: true;
};
validCaptchaUrl: {
type: StringConstructor;
required: true;
};
showClose: {
type: BooleanConstructor;
default: boolean;
};
radius: {
type: NumberConstructor;
};
shadow: {
type: BooleanConstructor;
default: boolean;
};
locale: {
type: StringConstructor;
};
extra: {
type: PropType<Record<string, any>>;
default: () => {};
};
}, {
containerRef: import("vue").Ref<HTMLDivElement | undefined>;
refresh: () => void;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
close: () => void;
success: (id: string) => void;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
requestCaptchaDataUrl: {
type: StringConstructor;
required: true;
};
validCaptchaUrl: {
type: StringConstructor;
required: true;
};
showClose: {
type: BooleanConstructor;
default: boolean;
};
radius: {
type: NumberConstructor;
};
shadow: {
type: BooleanConstructor;
default: boolean;
};
locale: {
type: StringConstructor;
};
extra: {
type: PropType<Record<string, any>>;
default: () => {};
};
}>> & {
onSuccess?: ((id: string) => any) | undefined;
onClose?: (() => any) | undefined;
}, {
showClose: boolean;
shadow: boolean;
extra: Record<string, any>;
}, {}>;
export default _default;
import { PropType } from 'vue';
import { CaptchaDisplayData } from '../core';
import { VerifyStatus } from '../types';
declare const _default: import("vue").DefineComponent<{
captcha: {
type: PropType<CaptchaDisplayData>;
required: true;
};
verifyStatus: {
type: PropType<VerifyStatus>;
};
}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
verify: (data: object) => void;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
captcha: {
type: PropType<CaptchaDisplayData>;
required: true;
};
verifyStatus: {
type: PropType<VerifyStatus>;
};
}>> & {
onVerify?: ((data: object) => any) | undefined;
}, {}, {}>;
export default _default;
import { PropType } from 'vue';
import { CaptchaDisplayData } from '../core';
import { VerifyStatus } from '../types';
declare const _default: import("vue").DefineComponent<{
captcha: {
type: PropType<CaptchaDisplayData>;
required: true;
};
verifyStatus: {
type: PropType<VerifyStatus>;
};
}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
verify: (data: object) => void;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
captcha: {
type: PropType<CaptchaDisplayData>;
required: true;
};
verifyStatus: {
type: PropType<VerifyStatus>;
};
}>> & {
onVerify?: ((data: object) => any) | undefined;
}, {}, {}>;
export default _default;
import { PropType } from 'vue';
import { CaptchaDisplayData } from '../core';
import { VerifyStatus } from '../types';
declare const _default: import("vue").DefineComponent<{
captcha: {
type: PropType<CaptchaDisplayData>;
required: true;
};
verifyStatus: {
type: PropType<VerifyStatus>;
};
}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
verify: (data: object) => void;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
captcha: {
type: PropType<CaptchaDisplayData>;
required: true;
};
verifyStatus: {
type: PropType<VerifyStatus>;
};
}>> & {
onVerify?: ((data: object) => any) | undefined;
}, {}, {}>;
export default _default;
import { PropType } from 'vue';
import { VerifyStatus } from '../types';
declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
verifyStatus: {
type: PropType<VerifyStatus>;
};
x: {
type: NumberConstructor;
default: number;
};
}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
verifyStatus: {
type: PropType<VerifyStatus>;
};
x: {
type: NumberConstructor;
default: number;
};
}>>, {
x: number;
}, {}>, {
default?(_: {}): any;
}>;
export default _default;
type __VLS_WithTemplateSlots<T, S> = T & {
new (): {
$slots: S;
};
};
declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
click: (event: MouseEvent) => void;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>> & {
onClick?: ((event: MouseEvent) => any) | undefined;
}, {}, {}>;
export default _default;
declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
export default _default;
declare const _default: import("vue").DefineComponent<{
x: {
type: NumberConstructor;
default: number;
};
}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
x: {
type: NumberConstructor;
default: number;
};
}>>, {
x: number;
}, {}>;
export default _default;
declare const _default: import("vue").DefineComponent<{
status: {
type: BooleanConstructor;
required: true;
};
message: {
type: StringConstructor;
};
}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
status: {
type: BooleanConstructor;
required: true;
};
message: {
type: StringConstructor;
};
}>>, {}, {}>;
export default _default;
import { CaptchaDisplayData } from './types';
/**
* 创建验证码实例的配置项
*/
interface CreateCaptchaOptions {
/**
* 自动绑定开始拖动事件的元素
*/
triggers?: HTMLElement[];
/**
* 验证码显示数据
*/
captcha: CaptchaDisplayData;
/**
* 允许拖动的最大距离
*/
max: number;
/**
* 当进行拖动时触发的回调
* @param x 拖动的距离
*/
onDrag: (x: number) => void;
/**
* 当拖动完成需要校验数据时触发的回调
* @param data 待校验的数据
* @returns
*/
onVerify: (data: object) => void;
}
/**
* 验证码实例
*/
export interface CaptchaInstance {
/**
* 当开始拖动时调用的方法
* @param event
* @returns
*/
onDragStart: (event: MouseEvent | TouchEvent) => void;
/**
* 销毁验证码实例,解除所有的事件绑定
*/
destroy(): void;
}
/**
* 创建拖动填充型验证码的配置项
*/
export interface CreateSliderCaptchaOptions extends Omit<CreateCaptchaOptions, 'max'> {
/**
* 实际显示尺寸与原始图片的比例
*/
ratio: number;
}
/**
* 创建拖动填充型验证码实例
* @param options
*/
export declare function createSliderCaptcha(options: CreateSliderCaptchaOptions): CaptchaInstance;
/**
* 创建旋转型验证码的配置项
*/
export interface CreateRotateCaptchaOptions extends Omit<CreateCaptchaOptions, 'onDrag'> {
/**
* 实际显示尺寸与原始图片的比例
*/
ratio: number;
/**
* 当进行拖动时触发的回调
* @param x 拖动的距离
* @param deg 旋转的角度
*/
onDrag: (x: number, deg: number) => void;
}
/**
* 创建旋转型验证码实例
*/
export declare function createRotateCaptcha(options: CreateRotateCaptchaOptions): CaptchaInstance;
/**
* 创建上下拼接型验证码的配置项
*/
export interface CreateConcatCaptchaOptions extends CreateCaptchaOptions {
/**
* 实际显示尺寸与原始图片的比例
*/
ratio: number;
}
/**
* 获取上下拼接型验证码的滑块高度
*/
export declare function getConcatTrackHeight(captcha: CaptchaDisplayData, ratio: number): number;
/**
* 创建上下拼接型验证码实例
*/
export declare function createConcatCaptcha(options: CreateConcatCaptchaOptions): CaptchaInstance;
export {};
import { ApiResp, CaptchaData } from './types';
/**
* HTTP请求配置项
*/
export interface HttpRequestOptions {
/**
* 请求地址
*/
url: string;
/**
* 基地址
*/
baseURL?: string;
/**
* 请求方法
*/
method?: string;
/**
* 请求参数
*/
params?: Record<string, string>;
/**
* 请求头
*/
headers?: Record<string, string>;
/**
* 请求体
*/
data?: any;
/**
* 请求超时时间
*/
timeout?: number;
/**
* 跨域时是否包含身份信息
*/
withCredentials?: boolean;
}
export interface HttpResponse<T = any> {
/**
* 响应码
*/
status: number;
/**
* 响应头
*/
headers: Record<string, string>;
/**
* 响应体
*/
data: T;
}
/**
* 加载验证码数据
* @param options 获取验证码数据的配置项
*/
export declare function loadCaptcha(options: HttpRequestOptions): Promise<ApiResp<CaptchaData>>;
export interface ValidCaptchaOptions extends Omit<HttpRequestOptions, 'method' | 'data'> {
data: {
key: string;
data: any;
};
}
/**
* 校验验证码数据,校验成功返回undefined,校验失败返回失败文字
* @param options
*/
export declare function validCaptcha(options: ValidCaptchaOptions): Promise<string | void>;
export * from './locales';
export * from './http';
export * from './types';
export * from './captcha';
/**
* 根据输入值,返回可用的语言
* @param language
*/
export declare function getLanguage(language?: string): string;
/**
* 获取翻译字典
* @param language
*/
export declare function getTranslations(language?: string): Record<string, string>;
/**
* 获取翻译函数
* @param language
*/
export declare function getTranslator(language?: string): (id: string) => string;
/**
* 验证码类型
*/
export type CaptchaType = 'SLIDER' | 'ROTATE' | 'CONCAT';
/**
* 接口响应数据格式
*/
export interface ApiResp<T = any> {
code: number;
msg: string;
data: T;
}
/**
* 验证码显示数据
*/
export interface CaptchaDisplayData {
/**
* 验证码类型
*/
type: CaptchaType;
templateImage: string;
templateImageHeight: number;
templateImageTag: string;
templateImageWidth: number;
backgroundImage: string;
backgroundImageHeight: number;
backgroundImageTag: string;
backgroundImageWidth: number;
data: {
randomY: number;
};
}
/**
* 验证码数据
*/
export interface CaptchaData {
key: string;
captcha: CaptchaDisplayData;
}
export { default as Captcha } from './Captcha.vue';
import { Ref } from 'vue';
export declare function provideLocale(ref: Ref<string | undefined>): void;
export declare function useTranslator(locale?: Ref<string | undefined>): import("vue").ComputedRef<(id: string) => string>;
import { CaptchaData } from './core';
/**
* 验证码的校验状态
*/
export interface VerifyStatus {
/**
* 是否校验成功
*/
status: boolean;
/**
* 失败的消息
*/
message?: string;
}
/**
* 包含校验状态数据的验证码数据
*/
export interface CurrentCaptchaData extends CaptchaData {
/**
* 校验状态
*/
verifyStatus?: VerifyStatus;
}
{ {
"name": "fj-captcha-vue", "name": "fj-captcha-vue",
"version": "1.0.0", "version": "1.0.1",
"type": "module", "type": "module",
"main": "./esm/index.js", "main": "./esm/index.js",
"typings": "./esm/index.d.ts", "typings": "./esm/index.d.ts",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment