Skip to main content
Version: 57.2.0

ConfigurationModel

Convenience type for a Mongoose model with configurationPlugin applied.

Use this when declaring your configuration model to get full type safety:

export const AppConfig = mongoose.model<AppConfigDocument, ConfigurationModel<AppConfigDocument>>(
  "AppConfig",
  appConfigSchema,
);
// Then call:
const name = await AppConfig.getConfig("general.appName"); // typed as string
const full = await AppConfig.getConfig(); // typed as AppConfigDocument

Extends​

Type Parameters​

T​

T extends object

Constructors​

Constructor​

new ConfigurationModel<DocType>(doc?, fields?, options?): Document<unknown, { }, T, { }, DefaultSchemaOptions> & Require_id<T> & object & AddDefaultId<T, { }, DefaultSchemaOptions>

Parameters​

doc?​

DocType

fields?​

any

options?​

AnyObject

Returns​

Document<unknown, { }, T, { }, DefaultSchemaOptions> & Require_id<T> & object & AddDefaultId<T, { }, DefaultSchemaOptions>

Inherited from​

Model<T>.constructor

Methods​

getConfig()​

Call Signature​

getConfig(): Promise<T & Document<ObjectId, any, any, Record<string, any>, { }>>

Get the full singleton configuration document.

Returns​

Promise<T & Document<ObjectId, any, any, Record<string, any>, { }>>

Inherited from​

ConfigurationStatics.getConfig

Call Signature​

getConfig<P>(key): Promise<PathValue<T, P>>

Get a specific value by dot-notation key.

Type Parameters​
P​

P extends string

Parameters​
key​

P

Returns​

Promise<PathValue<T, P>>

Inherited from​

ConfigurationStatics.getConfig

getSecretFields()​

getSecretFields(): SecretFieldMeta[]

Get secret field metadata discovered from the schema.

Returns​

SecretFieldMeta[]

Inherited from​

ConfigurationStatics.getSecretFields

resolveSecrets()​

resolveSecrets(provider?): Promise<Map<string, string>>

Resolve all secret field values from a provider. Uses the provider passed here, or falls back to the one configured in the plugin options. Returns an in-memory map of path -> value for programmatic use (startup self-checks, request-time resolution).

This method never persists resolved values. Secret material must never be written to the configuration document.

Parameters​

provider?​

SecretProvider

Returns​

Promise<Map<string, string>>

Inherited from​

ConfigurationStatics.resolveSecrets

updateConfig()​

updateConfig(updates): Promise<T & Document<ObjectId, any, any, Record<string, any>, { }>>

Update the singleton configuration document.

The patch is flattened into MongoDB dotted paths and applied with findOneAndUpdate({$set}). This preserves sibling fields inside nested subdocuments when a partial nested patch is supplied, and tolerates legacy / out-of-schema fields already persisted on the document (unlike a full doc.save(), which throws under strict: "throw").

Parameters​

updates​

DeepPartial<T>

Returns​

Promise<T & Document<ObjectId, any, any, Record<string, any>, { }>>

Inherited from​

ConfigurationStatics.updateConfig