Module

Node.URL

Package: purescript-node-url
Repository: purescript-node/purescript-node-url

#URL Source

data URL

Instances

Show URL

#new Source

new :: String -> Effect URL

#new' Source

new' :: String -> String -> Effect URL

#pathToFileURL Source

pathToFileURL :: String -> Effect URL

#hash Source

hash :: URL -> Effect String

#setHash Source

setHash :: String -> URL -> Effect Unit

#host Source

host :: URL -> Effect String

#setHost Source

setHost :: String -> URL -> Effect Unit

#hostname Source

hostname :: URL -> Effect String

#setHostname Source

setHostname :: String -> URL -> Effect Unit

#href Source

href :: URL -> Effect String

#setHref Source

setHref :: String -> URL -> Effect Unit

#origin Source

origin :: URL -> String

#password Source

password :: URL -> Effect String

#setPassword Source

setPassword :: String -> URL -> Effect Unit

#pathname Source

pathname :: URL -> Effect String

#setPathname Source

setPathname :: String -> URL -> Effect Unit

#port Source

port :: URL -> Effect String

#setPort Source

setPort :: String -> URL -> Effect Unit

#protocol Source

protocol :: URL -> Effect String

#setProtocol Source

setProtocol :: String -> URL -> Effect Unit

#search Source

search :: URL -> Effect String

#setSearch Source

setSearch :: String -> URL -> Effect Unit

#searchParams Source

searchParams :: URL -> Effect URLSearchParams

#username Source

username :: URL -> Effect String

#setUsername Source

setUsername :: String -> URL -> Effect Unit

#canParse Source

canParse :: String -> String -> Boolean

#domainToAscii Source

domainToAscii :: String -> Effect String

#domainToUnicode Source

domainToUnicode :: String -> Effect String

#fileURLToPath Source

fileURLToPath :: String -> Effect String

#fileURLToPath' Source

fileURLToPath' :: URL -> Effect String

#UrlFormatOptions Source

type UrlFormatOptions :: Row Typetype UrlFormatOptions = (auth :: Boolean, fragment :: Boolean, search :: Boolean, unicode :: Boolean)

auth <boolean> true if the serialized URL string should include the username and password, false otherwise. Default: true.
fragment <boolean> true if the serialized URL string should include the fragment, false otherwise. Default: true.
search <boolean> true if the serialized URL string should include the search query, false otherwise. Default: true.
unicode <boolean> true if Unicode characters appearing in the host component of the URL string should be encoded directly as opposed to being Punycode encoded. Default: false.

#format Source

format :: URL -> Effect String

#format' Source

format' :: forall r trash. Union r trash UrlFormatOptions => URL -> Record r -> Effect String

#pathToFileUrl Source

pathToFileUrl :: String -> Effect URL

#HttpOptions Source

type HttpOptions = { auth :: String, hash :: String, hostname :: String, href :: String, path :: String, pathname :: String, port :: Int, protocol :: String, search :: String }

protocol <string> Protocol to use.
hostname <string> A domain name or IP address of the server to issue the request to.
hash <string> The fragment portion of the URL.
search <string> The serialized query portion of the URL.
pathname <string> The path portion of the URL.
path <string> Request path. Should include query string if any. E.G. '/index.html?page=12'. An exception is thrown when the request path contains illegal characters. Currently, only spaces are rejected but that may change in the future.
href <string> The serialized URL.
port <number> Port of remote server.
auth <string> Basic authentication i.e. 'user:password' to compute an Authorization header.

#urlToHTTPOptions Source

urlToHTTPOptions :: URL -> Effect HttpOptions

Modules: Node.URL; Node.URL.URLSearchParams