LanguageValues and typesStandard typesSecurity
SecretText
On this page
Any other secret text, up to 8,192 characters.
Use it for a secret no other type fits, such as a webhook's signing secret. For a password, use Password, and for a key, use ApiKey.
Shape
One secret value, with no parts.
Example
SecretText("whsec_example")In a real app it arrives from outside, such as in a request, rather than as text you write in your code.
text.parse(raw, as: SecretText) reads one from text that comes from outside. Text that isn't one at all fails malformed.
Good to know
- It is never sent, logged, stored or shown.
==tells you whether two are the same.<andlist.sort_bydon't take it.
In JSON
A string when it arrives, and written redacted when it leaves, in a request, a response or json.write:
"<redacted SecretText>"Details
Text form, storage, how it is shown, and operations
SecretText is in the group Security, and has been in Jadpo since 0.1.0.
Text form
text.parse reads one from its text as it is typed. text.from and text.format don't take it, so nothing writes it.
How it is stored
It is never stored.
How it is shown to people
text.format doesn't take it: a SecretText is never shown.
Operations
It also takes text.parse, json.read, json.write and ==. How every standard type behaves says how they work.
Markdown for agents: /docs/types/type-secret-text.md.Built from Jadpo main at aee2e8f.