SecretType
PackageReified.Refinements
Explicit creation and access for secret values.
Specification
createSignature
Secret.create value
revealSignature
Secret.reveal secret
ToJsonSignature
this.ToJson
Summary
| Name | Signature | Synopsis |
|---|
| Operations |
| create | Secret.create value | Seals a value without inspecting it. |
| reveal | Secret.reveal secret | Explicitly accesses the sealed value. |
| ToJson | this.ToJson | Returns the redacted JSON representation, including for JavaScript JSON.stringify. |
Operations
kind:member
Secret.create value
MemberSeals a value without inspecting it.
Parameters
| Name | Type | Description |
|---|
| value | 'a | |
Verification Examples
let password = Secret.create "credential"
kind:member
Secret.reveal secret
MemberExplicitly accesses the sealed value.
Parameters
| Name | Type | Description |
|---|
| secret | Secret<'value> | |
Verification Examples
let plain = Secret.create "credential" |> Secret.reveal
kind:member
Returns the redacted JSON representation, including for JavaScript JSON.stringify.
Verification Examples
let shown = (Secret.create "credential").ToJson() // <redacted>
