LanguageValues and typesStandard typesPeople and contact
GivenName
On this page
The name a person goes by, one line as they write it.
Use it for a first name on its own, such as in "Hello, Mary". When you hold a person's whole name, use PersonName, which contains one. For your own kind of name, such as a product's, declare a type on Text.
Shape
One value, held as text in one set form, with no parts: 太郎.
Example
GivenName("Mary")GivenName(raw) checks the text, and text that isn't one breaks the format rule.
text.parse(raw, as: GivenName) reads one from text that comes from outside. Text that isn't one at all fails malformed, such as Mary or Mary .
Good to know
- It takes any script and spaces inside, such as "José María" or "太郎", up to 200 characters. It refuses an empty name, spaces at either end and line breaks.
==tells you whether two are the same.<andlist.sort_bydon't take it.- A field that holds one counts as personal data (
identifying), so you don't mark it yourself.
In JSON
A string, in a request, a response or json.write:
"Mary""José María""太郎"
Details
Text form, storage, how it is shown, and operations
GivenName is in the group People and contact, 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: Mary, José María and 太郎.
How it is stored
It is stored in one column named for the field, of type text. José María is stored as 'José María'.
How it is shown to people
text.format(value, locale:) shows it to people in their locale.
With locale: Locale.en_gb:
| Value | Shown |
|---|---|
Mary |
Mary |
José María |
José María |
太郎 |
太郎 |
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-given-name.md.Built from Jadpo main at aee2e8f.