NPM.RegistryUrl (NPM v0.6.0)

Copy Markdown View Source

Constructs registry API URLs for package operations.

Summary

Functions

abbreviated_url(name, registry \\ "https://registry.npmjs.org")

Returns the abbreviated (corgi) metadata URL.

default_registry()

Returns the default registry URL.

default_registry?(url)

Checks if a URL points to the default npm registry.

package_url(name, registry \\ "https://registry.npmjs.org")

Returns the package metadata URL.

search_url(query, opts \\ [])

Returns the search API URL.

tarball_url(name, version, registry \\ "https://registry.npmjs.org")

Returns the tarball URL.

version_url(name, version, registry \\ "https://registry.npmjs.org")

Returns the URL for a specific version.

Functions

abbreviated_url(name, registry \\ "https://registry.npmjs.org")

@spec abbreviated_url(String.t(), String.t()) :: String.t()

Returns the abbreviated (corgi) metadata URL.

default_registry()

@spec default_registry() :: String.t()

Returns the default registry URL.

default_registry?(url)

@spec default_registry?(String.t()) :: boolean()

Checks if a URL points to the default npm registry.

package_url(name, registry \\ "https://registry.npmjs.org")

@spec package_url(String.t(), String.t()) :: String.t()

Returns the package metadata URL.

search_url(query, opts \\ [])

@spec search_url(
  String.t(),
  keyword()
) :: String.t()

Returns the search API URL.

tarball_url(name, version, registry \\ "https://registry.npmjs.org")

@spec tarball_url(String.t(), String.t(), String.t()) :: String.t()

Returns the tarball URL.

version_url(name, version, registry \\ "https://registry.npmjs.org")

@spec version_url(String.t(), String.t(), String.t()) :: String.t()

Returns the URL for a specific version.