Interface CreateNotificationDefaultAdapterDependencies

interface CreateNotificationDefaultAdapterDependencies {
    db: string | Db;
    mailService?: SendGridMailService | {
        sendGridApiKey: string;
    };
    socketAPI?: "socketIO" | SocketAPI<defaultNotification.Message & {
        isPublicMessage: boolean;
    }, Transmission>;
    userAPI: {
        admin: string | Pick<UserDefaultAdapterAPI, "isAdminUser">;
        expand: string | Pick<UserDefaultAdapterAPI, "getUserById" | "getUsers">;
    };
}

Properties

db mailService? socketAPI? userAPI

Properties

db

db: string | Db

Database connector or connection string

Optional mailService

mailService?: SendGridMailService | {
    sendGridApiKey: string;
}

Optional mail service for external communication, or a sendGrid key if using sendgrid

Type declaration

  • sendGridApiKey: string

Optional socketAPI

socketAPI?: "socketIO" | SocketAPI<defaultNotification.Message & {
    isPublicMessage: boolean;
}, Transmission>

Socket API connector, or 'socketIO' to create a default socket IO api

userAPI

userAPI: {
    admin: string | Pick<UserDefaultAdapterAPI, "isAdminUser">;
    expand: string | Pick<UserDefaultAdapterAPI, "getUserById" | "getUsers">;
}

User API connector, or a string if using default adapter connection

Type declaration

  • admin: string | Pick<UserDefaultAdapterAPI, "isAdminUser">
  • expand: string | Pick<UserDefaultAdapterAPI, "getUserById" | "getUsers">

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc