Search code examples
swiftversioningswift-package-managerdeprecation-warning

Swift - how to deprecate a function in SPM library

We are maintaining a private SPM library, and I want to introduce a function that should be use instead of an existing function. The end result should be some kind of deprecation.

So far I found that functions can be deprecated relative to the OS versions, But I need to deprecate it relative to the Library version.

For example:

//how do I deprecate this function as of version `1.1.0` of my library?
func oldFunc() {
    ...
}

//It will be awesome if I could also mention that this function is the newer alternative to `oldFunc`
func newFunc() {
    ...
}
Solution

  • You could use the something like this:

    @available(*, deprecated, renamed: "newFunction")
func sampleFunction() { }