docs/ts/runtime/config.mdx
Secret represents a single secret value that is loaded into the application. It is strongly typed for that secret, so that you can write functions which expect a specific one.
You can use AnySecret to represent any secret without knowing it's name.
function doFoo(s: Secret<"foo">): void {
const foo = s();
}
Name extends string
Secret(): string
Returns the current value of the secret.
Encore will periodically refresh the value of the secret, so this
value may change over time and could be stale for upto a couple of
minutes. If you need to ensure you have the latest value, use
latest.
string
readonly name: Name
The name of the secret.
<!-- symbol-end -->type AnySecret = Secret<string>
AnySecret is a type which can be used to represent any Secret without knowing its name.
<!-- symbol-end -->function secret<Name>(name): Secret<Name>
secret is used to load a single Secret into the application.
If you wish to load multiple secrets at once, see secrets.
Name extends string
StringLiteral<Name>
Secret<Name>
loading a single secret
import {secret} from "encore.dev/config/secrets";
const foo = secret<"foo">();