import { MaybeComputedRef, MaybeRef, ConfigurableFlush, RemovableRef } from '@vueuse/shared'; import { ValidateError, ValidateOption, Rules } from 'async-validator'; import * as vue_demi from 'vue-demi'; import { Ref, ShallowRef, WritableComputedRef, ComputedRef } from 'vue-demi'; import { AxiosResponse, AxiosError, RawAxiosRequestConfig, AxiosInstance } from 'axios'; import { camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, Options } from 'change-case'; import * as universal_cookie from 'universal-cookie'; import universal_cookie__default from 'universal-cookie'; import { IncomingMessage } from 'http'; import { Options as Options$1, Drauu, Brush } from 'drauu'; import { EventHookOn, MaybeComputedElementRef, Fn, MaybeElementRef } from '@vueuse/core'; import { Options as Options$2, ActivateOptions, DeactivateOptions } from 'focus-trap'; import Fuse from 'fuse.js'; import { JwtPayload, JwtHeader } from 'jwt-decode'; import nprogress, { NProgressOptions } from 'nprogress'; import QRCode from 'qrcode'; type AsyncValidatorError = Error & { errors: ValidateError[]; fields: Record; }; interface UseAsyncValidatorReturn { pass: Ref; errorInfo: Ref; isFinished: Ref; errors: Ref; errorFields: Ref; } interface UseAsyncValidatorOptions { /** * @see https://github.com/yiminghe/async-validator#options */ validateOption?: ValidateOption; } /** * Wrapper for async-validator. * * @see https://vueuse.org/useAsyncValidator * @see https://github.com/yiminghe/async-validator */ declare function useAsyncValidator(value: MaybeComputedRef>, rules: MaybeComputedRef, options?: UseAsyncValidatorOptions): UseAsyncValidatorReturn & PromiseLike; interface UseAxiosReturn, D = any> { /** * Axios Response */ response: ShallowRef; /** * Axios response data */ data: Ref; /** * Indicates if the request has finished */ isFinished: Ref; /** * Indicates if the request is currently loading */ isLoading: Ref; /** * Indicates if the request was canceled */ isAborted: Ref; /** * Any errors that may have occurred */ error: ShallowRef | undefined>; /** * Aborts the current request */ abort: (message?: string | undefined) => void; /** * isFinished alias * @deprecated use `isFinished` instead */ finished: Ref; /** * isLoading alias * @deprecated use `isLoading` instead */ loading: Ref; /** * isAborted alias * @deprecated use `isAborted` instead */ aborted: Ref; /** * abort alias */ cancel: (message?: string | undefined) => void; /** * isAborted alias * @deprecated use `isCanceled` instead */ canceled: Ref; /** * isAborted alias */ isCanceled: Ref; } interface StrictUseAxiosReturn extends UseAxiosReturn { /** * Manually call the axios request */ execute: (url?: string | RawAxiosRequestConfig, config?: RawAxiosRequestConfig) => PromiseLike>; } interface EasyUseAxiosReturn extends UseAxiosReturn { /** * Manually call the axios request */ execute: (url: string, config?: RawAxiosRequestConfig) => PromiseLike>; } interface UseAxiosOptions { /** * Will automatically run axios request when `useAxios` is used * */ immediate?: boolean; /** * Use shallowRef. * * @default true */ shallow?: boolean; /** * Callback when error is caught. */ onError?: (e: unknown) => void; /** * Callback when success is caught. */ onSuccess?: (data: T) => void; } declare function useAxios, D = any>(url: string, config?: RawAxiosRequestConfig, options?: UseAxiosOptions): StrictUseAxiosReturn & PromiseLike>; declare function useAxios, D = any>(url: string, instance?: AxiosInstance, options?: UseAxiosOptions): StrictUseAxiosReturn & PromiseLike>; declare function useAxios, D = any>(url: string, config: RawAxiosRequestConfig, instance: AxiosInstance, options?: UseAxiosOptions): StrictUseAxiosReturn & PromiseLike>; declare function useAxios, D = any>(config?: RawAxiosRequestConfig): EasyUseAxiosReturn & PromiseLike>; declare function useAxios, D = any>(instance?: AxiosInstance): EasyUseAxiosReturn & PromiseLike>; declare function useAxios, D = any>(config?: RawAxiosRequestConfig, instance?: AxiosInstance): EasyUseAxiosReturn & PromiseLike>; declare const changeCase_camelCase: typeof camelCase; declare const changeCase_capitalCase: typeof capitalCase; declare const changeCase_constantCase: typeof constantCase; declare const changeCase_dotCase: typeof dotCase; declare const changeCase_headerCase: typeof headerCase; declare const changeCase_noCase: typeof noCase; declare const changeCase_paramCase: typeof paramCase; declare const changeCase_pascalCase: typeof pascalCase; declare const changeCase_pathCase: typeof pathCase; declare const changeCase_sentenceCase: typeof sentenceCase; declare const changeCase_snakeCase: typeof snakeCase; declare namespace changeCase { export { changeCase_camelCase as camelCase, changeCase_capitalCase as capitalCase, changeCase_constantCase as constantCase, changeCase_dotCase as dotCase, changeCase_headerCase as headerCase, changeCase_noCase as noCase, changeCase_paramCase as paramCase, changeCase_pascalCase as pascalCase, changeCase_pathCase as pathCase, changeCase_sentenceCase as sentenceCase, changeCase_snakeCase as snakeCase, }; } type ChangeCaseType = keyof typeof changeCase; declare function useChangeCase(input: MaybeRef, type: ChangeCaseType, options?: Options | undefined): WritableComputedRef; declare function useChangeCase(input: MaybeComputedRef, type: ChangeCaseType, options?: Options | undefined): ComputedRef; /** * Creates a new {@link useCookies} function * @param {Object} req - incoming http request (for SSR) * @see https://github.com/reactivestack/cookies/tree/master/packages/universal-cookie universal-cookie * @description Creates universal-cookie instance using request (default is window.document.cookie) and returns {@link useCookies} function with provided universal-cookie instance */ declare function createCookies(req?: IncomingMessage): (dependencies?: string[] | null, { doNotParse, autoUpdateDependencies }?: { doNotParse?: boolean | undefined; autoUpdateDependencies?: boolean | undefined; }) => { /** * Reactive get cookie by name. If **autoUpdateDependencies = true** then it will update watching dependencies */ get: (name: string, options?: universal_cookie.CookieGetOptions | undefined) => T; /** * Reactive get all cookies */ getAll: (options?: universal_cookie.CookieGetOptions | undefined) => T_1; set: (name: string, value: any, options?: universal_cookie.CookieSetOptions | undefined) => void; remove: (name: string, options?: universal_cookie.CookieSetOptions | undefined) => void; addChangeListener: (callback: universal_cookie.CookieChangeListener) => void; removeChangeListener: (callback: universal_cookie.CookieChangeListener) => void; }; /** * Reactive methods to work with cookies (use {@link createCookies} method instead if you are using SSR) * @param {string[]|null|undefined} dependencies - array of watching cookie's names. Pass empty array if don't want to watch cookies changes. * @param {Object} options * @param {boolean} options.doNotParse - don't try parse value as JSON * @param {boolean} options.autoUpdateDependencies - automatically update watching dependencies * @param {Object} cookies - universal-cookie instance */ declare function useCookies(dependencies?: string[] | null, { doNotParse, autoUpdateDependencies }?: { doNotParse?: boolean | undefined; autoUpdateDependencies?: boolean | undefined; }, cookies?: universal_cookie__default): { /** * Reactive get cookie by name. If **autoUpdateDependencies = true** then it will update watching dependencies */ get: (name: string, options?: universal_cookie.CookieGetOptions | undefined) => T; /** * Reactive get all cookies */ getAll: (options?: universal_cookie.CookieGetOptions | undefined) => T_1; set: (name: string, value: any, options?: universal_cookie.CookieSetOptions | undefined) => void; remove: (name: string, options?: universal_cookie.CookieSetOptions | undefined) => void; addChangeListener: (callback: universal_cookie.CookieChangeListener) => void; removeChangeListener: (callback: universal_cookie.CookieChangeListener) => void; }; type UseDrauuOptions = Omit; interface UseDrauuReturn { drauuInstance: Ref; load: (svg: string) => void; dump: () => string | undefined; clear: () => void; cancel: () => void; undo: () => boolean | undefined; redo: () => boolean | undefined; canUndo: Ref; canRedo: Ref; brush: Ref; onChanged: EventHookOn; onCommitted: EventHookOn; onStart: EventHookOn; onEnd: EventHookOn; onCanceled: EventHookOn; } /** * Reactive drauu * * @see https://vueuse.org/useDrauu * @param target The target svg element * @param options Drauu Options */ declare function useDrauu(target: MaybeComputedElementRef, options?: UseDrauuOptions): UseDrauuReturn; interface UseFocusTrapOptions extends Options$2 { /** * Immediately activate the trap */ immediate?: boolean; } interface UseFocusTrapReturn { /** * Indicates if the focus trap is currently active */ hasFocus: Ref; /** * Indicates if the focus trap is currently paused */ isPaused: Ref; /** * Activate the focus trap * * @see https://github.com/focus-trap/focus-trap#trapactivateactivateoptions * @param opts Activate focus trap options */ activate: (opts?: ActivateOptions) => void; /** * Deactivate the focus trap * * @see https://github.com/focus-trap/focus-trap#trapdeactivatedeactivateoptions * @param opts Deactivate focus trap options */ deactivate: (opts?: DeactivateOptions) => void; /** * Pause the focus trap * * @see https://github.com/focus-trap/focus-trap#trappause */ pause: Fn; /** * Unpauses the focus trap * * @see https://github.com/focus-trap/focus-trap#trapunpause */ unpause: Fn; } /** * Reactive focus-trap * * @see https://vueuse.org/useFocusTrap * @param target The target element to trap focus within * @param options Focus trap options * @param autoFocus Focus trap automatically when mounted */ declare function useFocusTrap(target: MaybeElementRef, options?: UseFocusTrapOptions): UseFocusTrapReturn; type FuseOptions = Fuse.IFuseOptions; interface UseFuseOptions { fuseOptions?: FuseOptions; resultLimit?: number; matchAllWhenSearchEmpty?: boolean; } declare function useFuse(search: MaybeComputedRef, data: MaybeComputedRef, options?: MaybeComputedRef>): { fuse: vue_demi.Ref<{ search: (pattern: string | Fuse.Expression, options?: Fuse.FuseSearchOptions | undefined) => Fuse.FuseResult[]; setCollection: (docs: readonly DataItem[], index?: Fuse.FuseIndex | undefined) => void; add: (doc: DataItem) => void; remove: (predicate: (doc: DataItem, idx: number) => boolean) => DataItem[]; removeAt: (idx: number) => void; getIndex: () => Fuse.FuseIndex; }>; results: ComputedRef[]>; }; type UseFuseReturn = ReturnType; interface UseIDBOptions extends ConfigurableFlush { /** * Watch for deep changes * * @default true */ deep?: boolean; /** * On error callback * * Default log error to `console.error` */ onError?: (error: unknown) => void; /** * Use shallow ref as reference * * @default false */ shallow?: boolean; } /** * * @param key * @param initialValue * @param options */ declare function useIDBKeyval(key: IDBValidKey, initialValue: MaybeComputedRef, options?: UseIDBOptions): RemovableRef; interface UseJwtOptions { /** * Value returned when encounter error on decoding * * @default null */ fallbackValue?: Fallback; /** * Error callback for decoding */ onError?: (error: unknown) => void; } interface UseJwtReturn { header: ComputedRef
; payload: ComputedRef; } /** * Reactive decoded jwt token. * * @see https://vueuse.org/useJwt * @param jwt */ declare function useJwt(encodedJwt: MaybeComputedRef, options?: UseJwtOptions): UseJwtReturn; type UseNProgressOptions = Partial; /** * Reactive progress bar. * * @see https://vueuse.org/useNProgress */ declare function useNProgress(currentProgress?: MaybeComputedRef, options?: UseNProgressOptions): { isLoading: vue_demi.WritableComputedRef; progress: vue_demi.Ref number | null | undefined) | null | undefined>; start: () => nprogress.NProgress; done: (force?: boolean | undefined) => nprogress.NProgress; remove: () => void; }; type UseNProgressReturn = ReturnType; /** * Wrapper for qrcode. * * @see https://vueuse.org/useQRCode * @param text * @param options */ declare function useQRCode(text: MaybeComputedRef, options?: QRCode.QRCodeToDataURLOptions): vue_demi.Ref; export { AsyncValidatorError, ChangeCaseType, EasyUseAxiosReturn, FuseOptions, StrictUseAxiosReturn, UseAsyncValidatorOptions, UseAsyncValidatorReturn, UseAxiosOptions, UseAxiosReturn, UseDrauuOptions, UseDrauuReturn, UseFocusTrapOptions, UseFocusTrapReturn, UseFuseOptions, UseFuseReturn, UseIDBOptions, UseJwtOptions, UseJwtReturn, UseNProgressOptions, UseNProgressReturn, createCookies, useAsyncValidator, useAxios, useChangeCase, useCookies, useDrauu, useFocusTrap, useFuse, useIDBKeyval, useJwt, useNProgress, useQRCode };