/** * Options for customizing deprecation warning messages. */ export interface DeprecationOptions { package?: string; until?: string; url?: string; predicate?: boolean; } /** * Logs a deprecation warning to the console. * Used to notify developers when they use deprecated APIs. * * @param message - The deprecation message explaining what is deprecated and what to use instead * @param options - Optional configuration for the deprecation warning * * @example * ```typescript * // Simple deprecation warning * deprecate('myOldFunction is deprecated. Use myNewFunction instead.'); * * // With package and version information * deprecate('myOldFunction is deprecated.', { * package: 'q2-tecton-sdk', * until: '3.0.0', * url: 'https://docs.example.com/migration' * }); * * // Conditional deprecation (only warn in certain conditions) * deprecate('Using string IDs is deprecated.', { * predicate: typeof id === 'number' // Only warn if id is not a number * }); * ``` */ export default function deprecate(message: string, options?: DeprecationOptions): void; //# sourceMappingURL=deprecate.d.ts.map