Skip to content

Instance Method

user(percentEncoded:)

iOS 16.0+ iPadOS 16.0+ Mac Catalyst 16.0+ macOS 13.0+ tvOS 16.0+ watchOS 9.0+
Returns the user component of the URL, optionally removing any percent-encoding.
func user(percentEncoded: Bool = true) -> String?

Parameters

percentEncoded

Whether the user should be percent encoded, defaults to true.

Return Value

The user component of the URL.

Discussion

The system doesn’t allow certain characters in the URL user component, so URL percent-encodes those characters to create a valid URL. Calling this function with percentEncoded = false removes any percent-encoding and returns the unencoded user.

If the URL doesn’t contain a user component according to RFC 3986, this function returns nil.