@twin.org/blob-storage-connector-file 0.0.1-next.17 → 0.0.1-next.18

package/dist/cjs/index.cjs

@@ -33,7 +33,6 @@ class FileBlobStorageConnector {
     /**
      * Create a new instance of FileBlobStorageConnector.
      * @param options The options for the connector.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         core.Guards.object(this.CLASS_NAME, "options", options);

package/dist/esm/index.mjs

@@ -31,7 +31,6 @@ class FileBlobStorageConnector {
     /**
      * Create a new instance of FileBlobStorageConnector.
      * @param options The options for the connector.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         Guards.object(this.CLASS_NAME, "options", options);

package/dist/types/fileBlobStorageConnector.d.ts

@@ -1,5 +1,5 @@
 import type { IBlobStorageConnector } from "@twin.org/blob-storage-models";
-import type { IFileBlobStorageConnectorConfig } from "./models/IFileBlobStorageConnectorConfig";
+import type { IFileBlobStorageConnectorConstructorOptions } from "./models/IFileBlobStorageConnectorConstructorOptions";
 /**
  * Class for performing blob storage operations in file.
  */
@@ -15,11 +15,8 @@ export declare class FileBlobStorageConnector implements IBlobStorageConnector {
     /**
      * Create a new instance of FileBlobStorageConnector.
      * @param options The options for the connector.
-     * @param options.config The configuration for the connector.
      */
-    constructor(options: {
-        config: IFileBlobStorageConnectorConfig;
-    });
+    constructor(options: IFileBlobStorageConnectorConstructorOptions);
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./fileBlobStorageConnector";
 export * from "./models/IFileBlobStorageConnectorConfig";
+export * from "./models/IFileBlobStorageConnectorConstructorOptions";

package/dist/types/models/IFileBlobStorageConnectorConstructorOptions.d.ts

@@ -0,0 +1,10 @@
+import type { IFileBlobStorageConnectorConfig } from "./IFileBlobStorageConnectorConfig";
+/**
+ * Options for the File Blob Storage Connector constructor.
+ */
+export interface IFileBlobStorageConnectorConstructorOptions {
+    /**
+     * The configuration for the connector.
+     */
+    config: IFileBlobStorageConnectorConfig;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/blob-storage-connector-file - Changelog
 
-## v0.0.1-next.17
+## v0.0.1-next.18
 
 - Initial Release

package/docs/reference/classes/FileBlobStorageConnector.md

@@ -16,13 +16,11 @@ Create a new instance of FileBlobStorageConnector.
 
 #### Parameters
 
-• **options**
+##### options
 
-The options for the connector.
-
-• **options.config**: [`IFileBlobStorageConnectorConfig`](../interfaces/IFileBlobStorageConnectorConfig.md)
+[`IFileBlobStorageConnectorConstructorOptions`](../interfaces/IFileBlobStorageConnectorConstructorOptions.md)
 
-The configuration for the connector.
+The options for the connector.
 
 #### Returns
 
@@ -58,7 +56,9 @@ Bootstrap the component by creating and initializing any resources it needs.
 
 #### Parameters
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType?
+
+`string`
 
 The node logging connector type, defaults to "node-logging".
 
@@ -82,7 +82,9 @@ Set the blob.
 
 #### Parameters
 
-• **blob**: `Uint8Array`
+##### blob
+
+`Uint8Array`
 
 The data for the blob.
 
@@ -106,7 +108,9 @@ Get the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to get in urn format.
 
@@ -130,7 +134,9 @@ Remove the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to remove in urn format.
 

package/docs/reference/index.md

@@ -7,3 +7,4 @@
 ## Interfaces
 
 - [IFileBlobStorageConnectorConfig](interfaces/IFileBlobStorageConnectorConfig.md)
+- [IFileBlobStorageConnectorConstructorOptions](interfaces/IFileBlobStorageConnectorConstructorOptions.md)

package/docs/reference/interfaces/IFileBlobStorageConnectorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IFileBlobStorageConnectorConstructorOptions
+
+Options for the File Blob Storage Connector constructor.
+
+## Properties
+
+### config
+
+> **config**: [`IFileBlobStorageConnectorConfig`](IFileBlobStorageConnectorConfig.md)
+
+The configuration for the connector.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-connector-file",
-	"version": "0.0.1-next.17",
+	"version": "0.0.1-next.18",
 	"description": "Blob Storage connector implementation using file storage",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/blob-storage-models": "0.0.1-next.17",
+		"@twin.org/blob-storage-models": "0.0.1-next.18",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/logging-models": "next",