next-facebook-tracking
Version:
A simple package to help you integrate Facebook Pixel and Conversions API with Next.js
24 lines (21 loc) • 958 B
text/typescript
export * from 'parse-full-name';
import { Facebook } from './types.cjs';
/**
* Retrieves the client IP address from the request headers.
* If the IP address is not available, it falls back to '0.0.0.0'.
* @returns The client IP address.
*/
declare function getIp(): Promise<string>;
/**
* Retrieves request-related data including user cookies and headers.
*
* @returns An object containing user data and event source URL.
* @property {Object} user_data - Contains user-specific information.
* @property {string} user_data.fbp - Facebook pixel cookie value.
* @property {string} user_data.fbc - Facebook click cookie value.
* @property {string} user_data.client_ip_address - Client's IP address.
* @property {string} user_data.client_user_agent - Client's user agent string.
* @property {string} event_source_url - The referring URL.
*/
declare function getRequestData(): Promise<Facebook.Event.RequestData>;
export { getIp, getRequestData };