Interface SecretDefinition<T>

A declared secret, whose accessor is injectable under token. The host owns the accessor's change subscription and releases it with the container.

interface SecretDefinition<T> {
    key: string;
    schema?: StandardSchemaV1<unknown, T>;
    token: ServiceToken<SecretAccessor<T>>;
}

Type Parameters

T

Hierarchy (View Summary)

DefineSecretOptions<T>
- SecretDefinition

Index

Properties

key schema? token

Properties

`Readonly`key

key: string

Secret key the value lives under.

`Optional` `Readonly`schema

schema?: StandardSchemaV1<unknown, T>

Validates the deserialized value. Present: values are JSON with this schema's output type. Absent: values are plain strings.

`Readonly`token

token: ServiceToken<SecretAccessor<T>>

Token the SecretAccessor is registered under.