WebOrigin

On this page

Shape
Example
Good to know
In JSON
Details

A web origin: the scheme, the host and any port, https://example.com.

Use it for browser-security lists, such as which sites may call your API. For a whole address, use Url.

Shape

One value, held as text in one set form, with no parts: http://192.0.2.1:3000.

Example

example

WebOrigin("https://example.com")

WebOrigin(raw) checks the text, and text that isn't one breaks the format rule.

text.parse(raw, as: WebOrigin) reads one from text that comes from outside. Text that isn't one at all fails malformed, such as https://example.com/, https://example.com:443 or http://example.com:80.

Good to know

It has no path, so no trailing /. The default port is left out, so https://example.com:443 is refused.
== tells you whether two are the same. < and list.sort_by don't take it.

In JSON

A string, in a request, a response or json.write:

json

"https://example.com""http://localhost:8080""https://[2001:db8::1]"

Details

Text form, storage, how it is shown, and operations

WebOrigin is in the group Web and network, and has been in Jadpo since 0.1.0.

Text form

text.from writes one standard text form, the same form text.parse reads back: https://example.com, http://localhost:8080 and https://[2001:db8::1].

How it is stored

It is stored in one column named for the field, of type text. https://[2001:db8::1] is stored as 'https://[2001:db8::1]'.

How it is shown to people

text.format(value, locale:) shows it to people in their locale.

With locale: Locale.en_gb:

Value	Shown
`https://example.com`	`https://example.com`
`http://localhost:8080`	`http://localhost:8080`
`https://[2001:db8::1]`	`https://[2001:db8::1]`
`http://192.0.2.1:3000`	`http://192.0.2.1:3000`

Operations

It also takes text.parse, text.from, text.format, json.read, json.write and ==. How every standard type behaves says how they work.

Markdown for agents: /docs/types/type-web-origin.md.Built from Jadpo main at aee2e8f.