Backtrace node readme (#93)

* Backtrace node readme

* Fit 'n finish on node readme (#96)

* Fit 'n finish on node readme

* Modify enabled option to enable

* Fix tests

---------

Co-authored-by: Konrad Dysput <konrad.dysput@gmail.com>

---------

Co-authored-by: Rick Foster <115846221+rick-bt@users.noreply.github.com>

Author: konraddysput

examples/sdk/node/src/index.ts

@@ -21,7 +21,7 @@ const client = BacktraceClient.initialize({
         },
     },
     database: {
-        enabled: true,
+        enable: true,
         path: path.join(process.cwd(), 'database'),
         captureNativeCrashes: true,
         createDatabaseDirectory: true,

packages/node/README.md

@@ -195,7 +195,7 @@ export class BacktraceClient extends BacktraceCoreClient {
             return;
         }
 
-        if (!this.options.database?.enabled) {
+        if (!this.options.database?.enable) {
             return;
         }
 

packages/node/src/BacktraceClient.ts

@@ -25,11 +25,11 @@ export class BacktraceDatabaseFileStorageProvider implements BacktraceDatabaseSt
         if (!options) {
             return undefined;
         }
-        if (!options.enabled) {
+        if (!options.enable) {
             return undefined;
         }
 
-        if (options.enabled && !options.path) {
+        if (options.enable && !options.path) {
             throw new Error(
                 'Missing mandatory path to the database. Please define the database.path option in the configuration.',
             );

packages/node/src/database/BacktraceDatabaseFileStorageProvider.ts

@@ -117,7 +117,7 @@ export abstract class BacktraceCoreClient {
         ]);
         this.attachments = options.attachments ?? [];
 
-        if (databaseStorageProvider && options?.database?.enabled === true) {
+        if (databaseStorageProvider && options?.database?.enable === true) {
             this._database = new BacktraceDatabase(
                 this.options.database,
                 databaseStorageProvider,

packages/sdk-core/src/BacktraceCoreClient.ts

@@ -2,7 +2,7 @@ export interface EnabledBacktraceDatabaseConfiguration {
     /**
      * Determine if the Database is enabled
      */
-    enabled: true;
+    enable: true;
     /**
      * Path where the SDK can store data.
      */
@@ -46,11 +46,11 @@ export interface EnabledBacktraceDatabaseConfiguration {
 }
 
 export interface DisabledBacktraceDatabaseConfiguration
-    extends Omit<Partial<EnabledBacktraceDatabaseConfiguration>, 'enabled'> {
+    extends Omit<Partial<EnabledBacktraceDatabaseConfiguration>, 'enable'> {
     /**
-     * Determine if the Database is enabled
+     * Determine if the Database is enable
      */
-    enabled?: false;
+    enable?: false;
 }
 
 export type BacktraceDatabaseConfiguration =

packages/sdk-core/src/model/configuration/BacktraceDatabaseConfiguration.ts

@@ -43,7 +43,7 @@ export class BacktraceDatabase {
             return this._enabled;
         }
 
-        if (this._options?.enabled === false) {
+        if (this._options?.enable === false) {
             return false;
         }
 

packages/sdk-core/src/modules/database/BacktraceDatabase.ts

@@ -7,7 +7,7 @@ import { testStorageProvider } from '../mocks/testStorageProvider';
 
 describe('Database context memory storage tests', () => {
     const testDatabaseSettings = {
-        enabled: true,
+        enable: true,
         autoSend: false,
         // this option doesn't matter because we mock the database provider
         // interface. However, if bug happen we want to be sure to not create

packages/sdk-core/tests/database/databaseContextMemoryStorageTests.spec.ts

@@ -7,7 +7,7 @@ import { testStorageProvider } from '../mocks/testStorageProvider';
 describe('Database context validation tests', () => {
     describe('Record overflow tests', () => {
         const testDatabaseSettings: BacktraceDatabaseConfiguration = {
-            enabled: true,
+            enable: true,
             autoSend: false,
             // this option doesn't matter because we mock the database provider
             // interface. However, if bug happen we want to be sure to not create

packages/sdk-core/tests/database/databaseContextValidationTests.spec.ts

@@ -23,7 +23,7 @@ describe('Database record batch tests', () => {
         const client = BacktraceTestClient.buildFakeClient(
             {
                 database: {
-                    enabled: true,
+                    enable: true,
                     autoSend: true,
                     path: path.join(__dirname, 'database'),
                     maximumRetries,
@@ -56,7 +56,7 @@ describe('Database record batch tests', () => {
         const client = BacktraceTestClient.buildFakeClient(
             {
                 database: {
-                    enabled: true,
+                    enable: true,
                     autoSend: true,
                     path: path.join(__dirname, 'database'),
                     maximumRetries,