Warp/node_modules/@vueuse/integrations/useJwt.d.mts

29 lines
909 B
TypeScript
Raw Permalink Normal View History

2024-01-05 12:14:38 +00:00
import { ComputedRef } from 'vue-demi';
import { MaybeRefOrGetter } from '@vueuse/shared';
import { JwtPayload, JwtHeader } from 'jwt-decode';
interface UseJwtOptions<Fallback> {
/**
* Value returned when encounter error on decoding
*
* @default null
*/
fallbackValue?: Fallback;
/**
* Error callback for decoding
*/
onError?: (error: unknown) => void;
}
interface UseJwtReturn<Payload, Header, Fallback> {
header: ComputedRef<Header | Fallback>;
payload: ComputedRef<Payload | Fallback>;
}
/**
* Reactive decoded jwt token.
*
* @see https://vueuse.org/useJwt
*/
declare function useJwt<Payload extends object = JwtPayload, Header extends object = JwtHeader, Fallback = null>(encodedJwt: MaybeRefOrGetter<string>, options?: UseJwtOptions<Fallback>): UseJwtReturn<Payload, Header, Fallback>;
export { type UseJwtOptions, type UseJwtReturn, useJwt };