docs: document that connect privileges are only granted when the data…

…base exists
berenddeboer · Sep 29, 2022 · b3c03c6 · b3c03c6
1 parent 366d42a
commit b3c03c6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/src/role.custom-resource.ts b/src/role.custom-resource.ts
@@ -32,7 +32,7 @@ export interface RoleProps {
   readonly database?: IDatabase
 
   /**
-   * Ootional database name this user is expected to use.
+   * Optional database name this user is expected to use.
    *
    * Specify none of `database` or `databaseName` or only one of them.
    *

diff --git a/src/role.ts b/src/role.ts
@@ -21,14 +21,18 @@ export interface RoleProps {
   /**
    * Optional database this user is expected to use.
    *
+   * If the database exists, connect privileges are granted.
+   *
    * Specify none of `database` or `databaseName` or only one of them.
    *
    * @default no connection to any database is granted
    */
   readonly database?: IDatabase
 
   /**
-   * Ootional database name this user is expected to use.
+   * Optional database name this user is expected to use.
+   *
+   * If the database exists, connect privileges are granted.
    *
    * Specify none of `database` or `databaseName` or only one of them.
    *