@sqlpm/types-ts - npm Package Compare versions

Comparing version 1.2.4 to 1.3.0

package.json

 {
   "name": "@sqlpm/types-ts",
-  "version": "1.2.4",
+  "version": "1.3.0",
   "description": "Types shared between packages in the @sqlpm mono-repo",
@@ -33,3 +33,3 @@ "keywords": [
   },
-  "gitHead": "278c4bd6c9a820a5e0039c2096e67ea6a85ce421"
+  "gitHead": "55b1b35e98e179a32873d83beeaab88248ccc57f"
 }

src/index.ts

@@ -103,5 +103,5 @@ /**
 /**
- * Supported database platforms. The name of the database platform is also
- * the name of the directory for that platform. For postgresql sql script would
- * be in a directory {project_root}/schemas/postgresql/*
+ * Supported database systems. The name of the database system is also
+ * the name of the directory for that database system. For postgresql sql script
+ * would be in a directory {project_root}/schemas/postgresql/*
  *
@@ -112,4 +112,4 @@ * **@remarks**
  * **@remarks**
- * When adding a new DatabasePlatform, be sure to updated the root
- * package.json to include the new database platform schema directory.
+ * When adding a new DatabaseSystem, be sure to updated the root
+ * package.json to include the new database system schema directory.
  *
@@ -127,13 +127,13 @@ * **@example**
  */
-export enum DatabasePlatform {
+export enum DatabaseSystem {
   Postgresql = 'postgresql',
 }
 
-export const databasePlatformVerify = (
+export const databaseSystemVerify = (
   value: string,
-): boolean => Object.values<string>(DatabasePlatform).includes(value);
+): boolean => Object.values<string>(DatabaseSystem).includes(value);
 
 /**
   * Provides information about the database schemas defined in a module such
-  * as the database platform the sql script is written for.
+  * as the database system the sql script is written for.
   *
@@ -145,3 +145,3 @@ * **@remarks**
   * **@interface**
-  * **@member {@link DatabaseInformation.platform}**
+  * **@member {@link DatabaseInformation.databaseSystem}**
   */
@@ -151,9 +151,9 @@ export interface DatabaseInformation {
   /**
-   * The database platform(s) of all sql scripts for a given package are
-   * written for. In cases where the database platforms are compatible,
-   * one of the {@link DatabasePlatform}s will be chosen to represent all
-   * compatible database platforms.
+   * The database system(s) of all sql scripts for a given package are
+   * written for. In cases where the database systems are compatible,
+   * one of the {@link DatabaseSystem}s will be chosen to represent all
+   * compatible database systems.
    */
   // eslint-disable-next-line no-use-before-define
-  platform: DatabasePlatform | DatabasePlatforms
+  databaseSystem: DatabaseSystem | DatabaseSystems
 
@@ -184,5 +184,5 @@ /**
 /**
- * An array of {@link DatabasePlatform}.
+ * An array of {@link DatabaseSystem}.
  */
-export type DatabasePlatforms = DatabasePlatform[];
+export type DatabaseSystems = DatabaseSystem[];
 
@@ -194,6 +194,6 @@ /**
  * **@enum**
- * * **@members - {@link DatabasePurpose.Readonly}**
- * * **@members - {@link DatabasePurpose.Readwrite}**
+ * * **@members - {@link DatabaseAccessMode.Readonly}**
+ * * **@members - {@link DatabaseAccessMode.ReadWrite}**
  */
-export enum DatabasePurpose {
+export enum DatabaseAccessMode {
 
@@ -211,6 +211,6 @@ /**
    */
-  Readwrite = 'readwrite',
+  ReadWrite = 'readwrite',
 }
 
-export type DatabasePurposes = DatabasePurpose[];
+export type DatabaseAccessModes = DatabaseAccessMode[];
 
@@ -217,0 +217,0 @@ /**

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No metric changes

No dependency changes