Function warn

warn(message: string, options?: Deprecate.Options): void

Displays a deprecation warning message.

Parameters

message: string
The deprecation message to display
options: Deprecate.Options = {}
Configuration options for the warning

Returns void

Example

// Basic usage
deprecationWarning("oldFunction() is deprecated. Use newFunction() instead.");

// With removal version
deprecationWarning("TerrainArea is deprecated.", {
  removeInVersion: "v0.3.0"
});

// Allow multiple warnings
deprecationWarning("Repeated warning", { once: false });