Setu-TS
    Preparing search index...

    Interface MongoDatabaseOptions

    The arm selecting the Mongo adapter over the native mongodb driver.

    options.url is required by the union unless options.client is supplied, so a registration that forgets both is a compile error instead of a connect() throw — the same guarantee the 'custom' arm gives adapter. The client is supplied inject-or-lazy (§12.2 of AI_GUIDELINES): client is an already-constructed structural IMongoClient, and absent it the adapter performs a literal import('mongodb') at connect time.

    import { DatabasePlugin } from '@setu-ts/database-plugin';

    DatabasePlugin({
      type: 'mongodb',
      options: { url: 'mongodb://localhost:27017/mydb' },
    });

    0.2.0

    interface MongoDatabaseOptions {
        name?: string;
        options: MongoAdapterOptions;
        readiness?: DatabaseReadinessOptions;
        type: "mongodb";
    }

    Hierarchy (View Summary)

    Index
    name? options readiness? type
    name?: string

    Named connection for multi-database support. Defaults to 'default'.

    When a name is provided, the service registers under database.<name> (e.g. database.primary); otherwise it uses the canonical CAPABILITIES.DATABASE token. Dot notation, not a colon: createCapabilityToken rejects colons.

    0.1.0

    options: MongoAdapterOptions

    Mongo adapter configuration; url (or client) is required.

    readiness?: DatabaseReadinessOptions

    Optional schema readiness, evaluated by this connection's health indicator.

    0.10.0

    type: "mongodb"

    Selects the Mongo arm.

    Settings
    Member Visibility

    On This Page
    Properties