vies-checker/dist/cjs/index.d.ts

Modern European VIES VAT number validator with full TypeScript support

import { ViesCheckResult, ViesCheckOptions, EuropeanMemberState, ViesResponse, ViesApproximateMatch, ViesUserError, ViesMatchCode } from './interfaces.js';
import { ViesError } from './errors.js';
/**
 * Comprehensive VAT validation with full response data
 *
 * @param country - Two-letter EU country code (e.g., 'LU', 'DE', 'FR')
 * @param vatNumber - VAT number to validate (spaces and separators will be removed)
 * @param options - Optional request configuration (timeout, retries)
 * @returns Full validation result with company details
 * @throws {ViesError} When VIES service returns an error state
 *
 * @example
 * ```typescript
 * // Basic usage
 * const result = await checkVAT('LU', '26375245');
 * console.log(result.name); // "AMAZON EUROPE CORE S.A R.L."
 * console.log(result.address); // Full address
 * console.log(result.isValid); // true
 *
 * // With timeout
 * const result = await checkVAT('LU', '26375245', { timeout: 5000 });
 *
 * // With retries
 * const result = await checkVAT('LU', '26375245', { retries: 2 });
 * ```
 */
export declare function checkVAT(country: string | EuropeanMemberState, vatNumber: string, options?: ViesCheckOptions): Promise<ViesCheckResult>;
/**
 * Simple boolean VAT validation check
 *
 * @deprecated Consider using checkVAT() for richer response data including company name and address
 * @param country - Two-letter EU country code
 * @param number - VAT number to validate
 * @returns true if valid, false if invalid or on network errors
 * @throws {ViesError} When VIES service returns an error state (rate limits, service unavailable, etc.)
 *
 * @example
 * ```typescript
 * const valid = await isValid('LU', '26375245');
 * console.log(valid); // true
 * ```
 */
export declare function isValid(country: EuropeanMemberState, number: string): Promise<boolean | null>;
export type { ViesCheckResult, ViesCheckOptions, ViesResponse, ViesApproximateMatch, ViesUserError, ViesMatchCode, EuropeanMemberState, };
export { ViesError };
export default isValid;