JSV.RNS (jsv v0.7.2)

A namespace for a schema ID or reference.

In the JSV library, each schema or subschema belongs to a namespace. Sub-schemas with an $id property define a new namespace.

A namespace can be :root if there is no URI or $id to identify a schema or an URI without a query string or fragment.

Summary

t()

Returns a new string namespace by appending a relative path to a base namespace. If the relative is absolute or :root, returns the relative.

parse(uri)

Parses the given URL or URN and returns an internal representation of its namespace.

to_ns(uri)

Returns the string value of the namespace, or :root.

@type t() :: URI.t() | :root

@spec derive(binary() | :root, binary() | :root) ::
  {:ok, binary() | :roo} | {:error, term()}

Returns a new string namespace by appending a relative path to a base namespace. If the relative is absolute or :root, returns the relative.

@spec parse(binary() | :root) :: t()

Parses the given URL or URN and returns an internal representation of its namespace.

Also accepts :root for root schemas without $id.

@spec to_ns(t()) :: binary() | :root

Returns the string value of the namespace, or :root.