nuxt-csurf/dist/runtime/composables.d.ts

Nuxt Cross-Site Request Forgery (CSRF) Prevention

import { useFetch, type useLazyFetch } from 'nuxt/app';
type UseCsrfFetch = typeof useFetch;
type UseLazyCsrfFetch = typeof useLazyFetch;
/**
 * Fetch data from an API endpoint protected by a CSRF token. SSR-friendly composable.
 * See {@link https://nuxt.com/docs/api/composables/use-fetch}
 * @param url The URL to fetch
 * @param options extends $fetch options and useAsyncData options
 */
export declare const useCsrfFetch: UseCsrfFetch;
export declare const useLazyCsrfFetch: UseLazyCsrfFetch;
/**
 * Retrieves the CSRF token from either the server or the client-side context.
 * See {@link https://github.com/Morgbn/nuxt-csurf#usecsrf}
 * @returns
 * - `csrf`: The CSRF token, either retrieved from the server or from the meta tag in the client.
 * - `headerName`: The name of the CSRF header, as configured in the public runtime configuration. Defaults to an empty string if not set.
 */
export declare function useCsrf(): {
    csrf: any;
    headerName: any;
};
export {};