@breautek/storm 8.4.0 → 8.6.0

package/lib/TransactionAccessLevel.js

@@ -0,0 +1,27 @@
+"use strict";
+/*
+   Copyright 2017-2025 Norman Breau
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionAccessLevel = void 0;
+/**
+ * @since 8.6.0
+ */
+var TransactionAccessLevel;
+(function (TransactionAccessLevel) {
+    TransactionAccessLevel[TransactionAccessLevel["RW"] = 0] = "RW";
+    TransactionAccessLevel[TransactionAccessLevel["RO"] = 1] = "RO";
+})(TransactionAccessLevel || (exports.TransactionAccessLevel = TransactionAccessLevel = {}));
+//# sourceMappingURL=TransactionAccessLevel.js.map

package/lib/TransactionAccessLevel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionAccessLevel.js","sourceRoot":"","sources":["../src/TransactionAccessLevel.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;EAcE;;;AAEF;;GAEG;AACH,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAC9B,+DAAE,CAAA;IACF,+DAAE,CAAA;AACN,CAAC,EAHW,sBAAsB,sCAAtB,sBAAsB,QAGjC"}

package/lib/api.d.ts

@@ -18,6 +18,7 @@ export { IsolationLevel } from './IsolationLevel';
 export { Transaction } from './Transaction';
 export { IOKPacket } from './IOKPacket';
 export { IStoredProcedureResult } from './IStoredProcedureResult';
+export { TransactionAccessLevel } from './TransactionAccessLevel';
 export { ErrorCode } from './ErrorCode';
 export { RawError } from './RawError';
 export { StormError, IErrorResponse, IAdditionalErrorDetails } from './StormError';

package/lib/api.js

@@ -15,8 +15,8 @@
    limitations under the License.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Point = exports.DatabaseCastObject = exports.ExitCode = exports.TokenManager = exports.Token = exports.BackendAuthenticationMiddleware = exports.ServiceResponse = exports.HTTPMethod = exports.ServiceProvider = exports.CORSMiddleware = exports.Handler = exports.ResponseData = exports.Response = exports.Request = exports.Middleware = exports.StatusCode = exports.LockWaitTimeoutError = exports.DeadLockError = exports.NotImplementedError = exports.DatabaseQueryError = exports.MissingConfigError = exports.DuplicateEntryError = exports.DiskSpaceError = exports.EntityNotFoundError = exports.UnauthorizedAccessError = exports.InvalidValueError = exports.ExpiredTokenError = exports.InternalError = exports.InvalidCredentialsError = exports.MissingParameterError = exports.JWTError = exports.TimeoutError = exports.StormError = exports.RawError = exports.ErrorCode = exports.Transaction = exports.IsolationLevel = exports.SetSessionVariableQuery = exports.RawQuery = exports.DropTemporaryTableQuery = exports.TemporaryTableQuery = exports.Query = exports.ManagedDatabaseConnection = exports.MySQLConnection = exports.MySQLDatabase = exports.DatabaseConnection = exports.Database = exports.ConfigLoader = exports.Application = exports.getInstance = void 0;
-exports.formidable = exports.Polygon = exports.LineString = void 0;
+exports.DatabaseCastObject = exports.ExitCode = exports.TokenManager = exports.Token = exports.BackendAuthenticationMiddleware = exports.ServiceResponse = exports.HTTPMethod = exports.ServiceProvider = exports.CORSMiddleware = exports.Handler = exports.ResponseData = exports.Response = exports.Request = exports.Middleware = exports.StatusCode = exports.LockWaitTimeoutError = exports.DeadLockError = exports.NotImplementedError = exports.DatabaseQueryError = exports.MissingConfigError = exports.DuplicateEntryError = exports.DiskSpaceError = exports.EntityNotFoundError = exports.UnauthorizedAccessError = exports.InvalidValueError = exports.ExpiredTokenError = exports.InternalError = exports.InvalidCredentialsError = exports.MissingParameterError = exports.JWTError = exports.TimeoutError = exports.StormError = exports.RawError = exports.ErrorCode = exports.TransactionAccessLevel = exports.Transaction = exports.IsolationLevel = exports.SetSessionVariableQuery = exports.RawQuery = exports.DropTemporaryTableQuery = exports.TemporaryTableQuery = exports.Query = exports.ManagedDatabaseConnection = exports.MySQLConnection = exports.MySQLDatabase = exports.DatabaseConnection = exports.Database = exports.ConfigLoader = exports.Application = exports.getInstance = void 0;
+exports.formidable = exports.Polygon = exports.LineString = exports.Point = void 0;
 const tslib_1 = require("tslib");
 // Application
 var instance_1 = require("./instance");
@@ -51,6 +51,8 @@ var IsolationLevel_1 = require("./IsolationLevel");
 Object.defineProperty(exports, "IsolationLevel", { enumerable: true, get: function () { return IsolationLevel_1.IsolationLevel; } });
 var Transaction_1 = require("./Transaction");
 Object.defineProperty(exports, "Transaction", { enumerable: true, get: function () { return Transaction_1.Transaction; } });
+var TransactionAccessLevel_1 = require("./TransactionAccessLevel");
+Object.defineProperty(exports, "TransactionAccessLevel", { enumerable: true, get: function () { return TransactionAccessLevel_1.TransactionAccessLevel; } });
 // Errors
 var ErrorCode_1 = require("./ErrorCode");
 Object.defineProperty(exports, "ErrorCode", { enumerable: true, get: function () { return ErrorCode_1.ErrorCode; } });

package/lib/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;EAcE;;;;;AAEF,cAAc;AACd,uCAAuC;AAA/B,uGAAA,WAAW,OAAA;AACnB,6CAGuB;AAFnB,0GAAA,WAAW,OAAA;AAIf,SAAS;AACT,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AAEpB,WAAW;AACX,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAC1B,iDAA8C;AAAtC,8GAAA,aAAa,OAAA;AACrB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,yEAAsE;AAA9D,sIAAA,yBAAyB,OAAA;AACjC,iCAA8B;AAAtB,8FAAA,KAAK,OAAA;AACb,6DAAqF;AAA7E,0HAAA,mBAAmB,OAAA;AAC3B,qEAAkE;AAA1D,kIAAA,uBAAuB,OAAA;AAC/B,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAIhB,qEAAiG;AAAzF,kIAAA,uBAAuB,OAAA;AAC/B,mDAAgD;AAAxC,gHAAA,cAAc,OAAA;AACtB,6CAA0C;AAAlC,0GAAA,WAAW,OAAA;AAInB,SAAS;AACT,yCAAsC;AAA9B,sGAAA,SAAS,OAAA;AACjB,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,2CAIsB;AAHlB,wGAAA,UAAU,OAAA;AAId,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AACpB,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,iEAA8D;AAAtD,8HAAA,qBAAqB,OAAA;AAC7B,qEAAkE;AAA1D,kIAAA,uBAAuB,OAAA;AAC/B,iDAA8C;AAAtC,8GAAA,aAAa,OAAA;AACrB,yDAAsD;AAA9C,sHAAA,iBAAiB,OAAA;AACzB,yDAAsD;AAA9C,sHAAA,iBAAiB,OAAA;AACzB,qEAAkE;AAA1D,kIAAA,uBAAuB,OAAA;AAC/B,6DAA0D;AAAlD,0HAAA,mBAAmB,OAAA;AAC3B,mDAAgD;AAAxC,gHAAA,cAAc,OAAA;AACtB,6DAA0D;AAAlD,0HAAA,mBAAmB,OAAA;AAC3B,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAC1B,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAC1B,6DAA0D;AAAlD,0HAAA,mBAAmB,OAAA;AAC3B,iDAA8C;AAAtC,8GAAA,aAAa,OAAA;AACrB,+DAA4D;AAApD,4HAAA,oBAAoB,OAAA;AAE5B,OAAO;AACP,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,qCAAiD;AAAzC,kGAAA,OAAO,OAAA;AACf,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AACpB,qCAAmE;AAA3D,kGAAA,OAAO,OAAA;AACf,mDAAgD;AAAxC,gHAAA,cAAc,OAAA;AACtB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,qFAAkF;AAA1E,kJAAA,+BAA+B,OAAA;AAoBvC,QAAQ;AACR,iCAA8B;AAAtB,8FAAA,KAAK,OAAA;AACb,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AAEpB,QAAQ;AACR,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAIhB,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAC1B,iCAA8B;AAAtB,8FAAA,KAAK,OAAA;AACb,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,qCAAkC;AAA1B,kGAAA,OAAO,OAAA;AAEf,cAAc;AACd,+DAAyC;AACjC,gCAAU"}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;EAcE;;;;;AAEF,cAAc;AACd,uCAAuC;AAA/B,uGAAA,WAAW,OAAA;AACnB,6CAGuB;AAFnB,0GAAA,WAAW,OAAA;AAIf,SAAS;AACT,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AAEpB,WAAW;AACX,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAC1B,iDAA8C;AAAtC,8GAAA,aAAa,OAAA;AACrB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,yEAAsE;AAA9D,sIAAA,yBAAyB,OAAA;AACjC,iCAA8B;AAAtB,8FAAA,KAAK,OAAA;AACb,6DAAqF;AAA7E,0HAAA,mBAAmB,OAAA;AAC3B,qEAAkE;AAA1D,kIAAA,uBAAuB,OAAA;AAC/B,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAIhB,qEAAiG;AAAzF,kIAAA,uBAAuB,OAAA;AAC/B,mDAAgD;AAAxC,gHAAA,cAAc,OAAA;AACtB,6CAA0C;AAAlC,0GAAA,WAAW,OAAA;AAGnB,mEAAgE;AAAxD,gIAAA,sBAAsB,OAAA;AAE9B,SAAS;AACT,yCAAsC;AAA9B,sGAAA,SAAS,OAAA;AACjB,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,2CAIsB;AAHlB,wGAAA,UAAU,OAAA;AAId,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AACpB,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,iEAA8D;AAAtD,8HAAA,qBAAqB,OAAA;AAC7B,qEAAkE;AAA1D,kIAAA,uBAAuB,OAAA;AAC/B,iDAA8C;AAAtC,8GAAA,aAAa,OAAA;AACrB,yDAAsD;AAA9C,sHAAA,iBAAiB,OAAA;AACzB,yDAAsD;AAA9C,sHAAA,iBAAiB,OAAA;AACzB,qEAAkE;AAA1D,kIAAA,uBAAuB,OAAA;AAC/B,6DAA0D;AAAlD,0HAAA,mBAAmB,OAAA;AAC3B,mDAAgD;AAAxC,gHAAA,cAAc,OAAA;AACtB,6DAA0D;AAAlD,0HAAA,mBAAmB,OAAA;AAC3B,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAC1B,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAC1B,6DAA0D;AAAlD,0HAAA,mBAAmB,OAAA;AAC3B,iDAA8C;AAAtC,8GAAA,aAAa,OAAA;AACrB,+DAA4D;AAApD,4HAAA,oBAAoB,OAAA;AAE5B,OAAO;AACP,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,qCAAiD;AAAzC,kGAAA,OAAO,OAAA;AACf,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AACpB,qCAAmE;AAA3D,kGAAA,OAAO,OAAA;AACf,mDAAgD;AAAxC,gHAAA,cAAc,OAAA;AACtB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,qFAAkF;AAA1E,kJAAA,+BAA+B,OAAA;AAoBvC,QAAQ;AACR,iCAA8B;AAAtB,8FAAA,KAAK,OAAA;AACb,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AAEpB,QAAQ;AACR,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAIhB,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAC1B,iCAA8B;AAAtB,8FAAA,KAAK,OAAA;AACb,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,qCAAkC;AAA1B,kGAAA,OAAO,OAAA;AAEf,cAAc;AACd,+DAAyC;AACjC,gCAAU"}

package/lib/private/StartTransactionQuery.d.ts

@@ -1,4 +1,11 @@
 import { Query } from '../Query';
-export declare class StartTransactionQuery extends Query<void, void> {
+import { TransactionAccessLevel } from '../TransactionAccessLevel';
+/**
+ * @since 8.6.0
+ */
+export interface IStartTransactionQueryInput {
+    accessLevel?: TransactionAccessLevel;
+}
+export declare class StartTransactionQuery extends Query<IStartTransactionQueryInput, void> {
     protected _getQuery(): string;
 }

package/lib/private/StartTransactionQuery.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
-   Copyright 2017-2021 Norman Breau
+   Copyright 2017-2025 Norman Breau
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -17,9 +17,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StartTransactionQuery = void 0;
 const Query_1 = require("../Query");
+const TransactionAccessLevel_1 = require("../TransactionAccessLevel");
 class StartTransactionQuery extends Query_1.Query {
     _getQuery() {
-        return 'START TRANSACTION';
+        let params = this.getParameters();
+        let accessString;
+        if (params?.accessLevel === TransactionAccessLevel_1.TransactionAccessLevel.RO) {
+            accessString = 'READ ONLY';
+        }
+        else {
+            accessString = 'READ WRITE';
+        }
+        return `START TRANSACTION ${accessString}`;
     }
 }
 exports.StartTransactionQuery = StartTransactionQuery;

package/lib/private/StartTransactionQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"StartTransactionQuery.js","sourceRoot":"","sources":["../../src/private/StartTransactionQuery.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;EAcE;;;AAEF,oCAA+B;AAE/B,MAAa,qBAAsB,SAAQ,aAAiB;IAC9C,SAAS;QACf,OAAO,mBAAmB,CAAC;IAC/B,CAAC;CACJ;AAJD,sDAIC"}
+{"version":3,"file":"StartTransactionQuery.js","sourceRoot":"","sources":["../../src/private/StartTransactionQuery.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;EAcE;;;AAEF,oCAA+B;AAC/B,sEAAmE;AASnE,MAAa,qBAAsB,SAAQ,aAAwC;IAC5D,SAAS;QACxB,IAAI,MAAM,GAAgC,IAAI,CAAC,aAAa,EAAE,CAAC;QAE/D,IAAI,YAAoB,CAAC;QACzB,IAAI,MAAM,EAAE,WAAW,KAAK,+CAAsB,CAAC,EAAE,EAAE,CAAC;YACpD,YAAY,GAAG,WAAW,CAAC;QAC/B,CAAC;aACI,CAAC;YACF,YAAY,GAAG,YAAY,CAAC;QAChC,CAAC;QAED,OAAO,qBAAqB,YAAY,EAAE,CAAC;IAC/C,CAAC;CACJ;AAdD,sDAcC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breautek/storm",
-  "version": "8.4.0",
+  "version": "8.6.0",
   "description": "Object-Oriented REST API framework",
   "main": "lib/api.js",
   "types": "lib/api.d.ts",
@@ -46,22 +46,22 @@
   "dependencies": {
     "@arashi/token": "1.0.1",
     "@breautek/merge-change": "1.0.0",
-    "@types/body-parser": "1.19.5",
-    "@types/express": "4.17.21",
+    "@types/body-parser": "1.19.6",
+    "@types/express": "4.17.23",
     "@types/formidable": "3.4.5",
     "@types/jsonwebtoken": "9.0.7",
-    "@types/mysql": "2.15.26",
+    "@types/mysql": "2.15.27",
     "@types/node": "22.13.10",
     "@types/uuid": "10.0.0",
     "ajv": "8.17.1",
     "body-parser": "1.20.3",
     "commander": "13.1.0",
     "express": "4.21.2",
-    "form-data": "4.0.2",
-    "formidable": "3.5.2",
+    "form-data": "4.0.3",
+    "formidable": "3.5.4",
     "jsonwebtoken": "9.0.2",
     "mysql": "2.18.1",
-    "sql-formatter": "15.4.11",
+    "sql-formatter": "15.6.6",
     "tslib": "2.8.1",
     "uuid": "11.1.0"
   },
@@ -72,15 +72,15 @@
   "devDependencies": {
     "@arashi/interfaces": "1.2.1",
     "@arashi/logger": "4.1.3",
-    "@totalpave/eslint-plugin": "7.0.10",
-    "@types/jest": "29.5.14",
+    "@totalpave/eslint-plugin": "7.0.11",
+    "@types/jest": "30.0.0",
     "auto-changelog": "2.5.0",
-    "jest": "29.7.0",
-    "jest-jasmine2": "29.7.0",
-    "ts-jest": "29.2.6",
+    "jest": "30.0.3",
+    "jest-jasmine2": "30.0.3",
+    "ts-jest": "29.4.0",
     "ts-node": "10.9.2",
-    "typedoc": "0.27.9",
-    "typedoc-plugin-markdown": "4.4.2",
-    "typescript": "5.8.2"
+    "typedoc": "0.28.7",
+    "typedoc-plugin-markdown": "4.7.0",
+    "typescript": "5.8.3"
   }
 }

package/src/DatabaseQueryError.ts

@@ -36,6 +36,15 @@ export class DatabaseQueryError extends StormError<{
         return 0;
     }
 
+    /**
+     * If the underlying error is a database error, then
+     * returns the database error code as sting.
+     * @since 8.5.0
+     */
+    public getDBErrorCode(): string | null {
+        return this.getPrivateDetails()?.error?.code || null;
+    }
+
     public getHTTPCode(): StatusCode {
         return StatusCode.INTERNAL_ERROR;
     }

package/src/IDatabaseConnection.ts

@@ -18,6 +18,7 @@ import { Readable } from 'stream';
 import { IQueryable } from './IQueryable';
 import { IsolationLevel } from './IsolationLevel';
 import { IDatabasePosition } from './IDatabasePosition';
+import { TransactionAccessLevel } from './TransactionAccessLevel';
 
 export interface IDatabaseConnection {
     setInstantiationStack(stack: string): void;
@@ -27,10 +28,14 @@ export interface IDatabaseConnection {
     setTimeout(timeout: number): void;
     getTimeout(): number;
     query(query: IQueryable<any>, params?: any): Promise<any>;
+
+    /**
+     * @deprecated - Streaming queries does not support post processing, creating a confusing API
+     */
     stream(query: IQueryable<any>, params?: any, streamOptions?: any): Readable;
     close(forceClose?: boolean): Promise<void>;
     isClosed(): boolean;
-    startTransaction(level?: IsolationLevel): Promise<void>;
+    startTransaction(level?: IsolationLevel, accessLevel?: TransactionAccessLevel): Promise<void>;
     isTransaction(): boolean;
     commit(): Promise<void>;
     rollback(): Promise<void>;

package/src/ManagedDatabaseConnection.ts

@@ -21,6 +21,7 @@ import { Query } from './Query';
 import { IsolationLevel } from './IsolationLevel';
 import { IDatabasePosition } from './IDatabasePosition';
 import { IQueryable } from './IQueryable';
+import { TransactionAccessLevel } from './TransactionAccessLevel';
 
 const TAG: string = 'ManagedDatabaseConnection';
 
@@ -176,11 +177,11 @@ export class ManagedDatabaseConnection implements IDatabaseConnection {
         });
     }
 
-    public startTransaction(isolationLevel?: IsolationLevel): Promise<void> {
+    public startTransaction(isolationLevel?: IsolationLevel, accessLevel?: TransactionAccessLevel): Promise<void> {
         return new Promise<void>((resolve, reject) => {
             this.$getConnection().then((connection: IDatabaseConnection) => {
                 if (!this.isManaged()) {
-                    connection.startTransaction(isolationLevel).then(resolve).catch(reject);
+                    connection.startTransaction(isolationLevel, accessLevel).then(resolve).catch(reject);
                 }
                 else {
                     resolve();

package/src/MySQLConnection.ts

@@ -19,7 +19,6 @@ import {DatabaseQueryError} from './DatabaseQueryError';
 import {getInstance} from './instance';
 import * as MySQL from 'mysql';
 import {Readable} from 'stream';
-import {Query} from './Query';
 import { StartTransactionQuery } from './private/StartTransactionQuery';
 import { CommitQuery } from './private/CommitQuery';
 import { RollbackQuery } from './private/RollbackQuery';
@@ -37,6 +36,7 @@ import { GetSlavePositionQuery } from './private/GetSlavePositionQuery';
 import { GetMasterPositionQuery } from './private/GetMasterPositionQuery';
 import { IQueryable } from './IQueryable';
 import { queryFormatter } from './mysql/queryFormatter';
+import { TransactionAccessLevel } from './TransactionAccessLevel';
 
 const DEFAULT_HIGH_WATERMARK: number = 512; // in number of result objects
 const TAG: string = 'MySQLConnection';
@@ -56,9 +56,8 @@ const SQL_FORMATTING_OPTIONS: SQLFormatter.FormatOptions = {
     functionCase: 'upper'
 };
 
-let startTransactionQuery: Query = new StartTransactionQuery();
-let commitQuery: Query = new CommitQuery();
-let rollbackQuery: Query = new RollbackQuery();
+let commitQuery: CommitQuery = new CommitQuery();
+let rollbackQuery: RollbackQuery = new RollbackQuery();
 
 export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
     private $transaction: boolean;
@@ -196,9 +195,9 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
         return queryObject.stream(streamOptions);
     }
 
-    public override async startTransaction(isolationLevel?: IsolationLevel): Promise<void> {
-        if (this.isReadOnly()) {
-            throw new Error('A readonly connection cannot start a transaction.')
+    public override async startTransaction(isolationLevel?: IsolationLevel, accessLevel: TransactionAccessLevel = TransactionAccessLevel.RW): Promise<void> {
+        if (this.isReadOnly() && accessLevel === TransactionAccessLevel.RW) {
+            throw new Error('A readonly connection cannot start a read/write transaction.')
         }
 
         if (this.isTransaction()) {
@@ -211,7 +210,9 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
             if (isolationLevel) {
                 await new SetIsolationLevelQuery(isolationLevel).execute(this);
             }
-            await startTransactionQuery.execute(this);
+            await new StartTransactionQuery({
+                accessLevel: accessLevel
+            }).execute(this);
         }
         catch (ex) {
             this.$transaction = false;

package/src/Query.ts

@@ -76,6 +76,8 @@ export abstract class Query<TQueryParameters = any, TQueryResultSet = any, TQuer
     /**
      * Override to augment/manipulate the returned result set.
      * 
+     * @deprecated - Streaming queries does not support post processing, creating a confusing API
+     * 
      * @param connection The connection object used for this query execution. Useful if further queries are required.
      * @param resultset The original result set
      */

package/src/Transaction.ts

@@ -22,6 +22,7 @@ import { InternalError } from './InternalError';
 import { DeadLockError } from './DeadLockError';
 import { InvalidValueError } from './InvalidValueError';
 import { LockWaitTimeoutError } from './LockWaitTimeoutError';
+import { TransactionAccessLevel } from './TransactionAccessLevel';
 
 const TAG: string = 'Transaction';
 
@@ -43,8 +44,9 @@ export class Transaction implements IQueryable<void> {
     private $application: Application;
     private $isolationLevel: IsolationLevel;
     private $executor: ITransactionExecutor;
+    private $accessLevel: TransactionAccessLevel;
 
-    public constructor(app: Application, executor: ITransactionExecutor, retryLimit: number = Infinity, isolationLevel: IsolationLevel = IsolationLevel.REPEATABLE_READ) {
+    public constructor(app: Application, executor: ITransactionExecutor, retryLimit: number = Infinity, isolationLevel: IsolationLevel = IsolationLevel.REPEATABLE_READ, accessLevel: TransactionAccessLevel = TransactionAccessLevel.RW) {
         this.$application = app;
         this.$executor = executor;
 
@@ -57,6 +59,7 @@ export class Transaction implements IQueryable<void> {
 
         this.$retryLimit = retryLimit;
         this.$isolationLevel = isolationLevel;
+        this.$accessLevel = accessLevel;
     }
     
     public async onPreQuery(connection: IDatabaseConnection): Promise<void> {}
@@ -81,7 +84,7 @@ export class Transaction implements IQueryable<void> {
         do {
             attemptCount++;
             this.$application.getLogger().info(TAG, `Starting transaction attempt ${attemptCount} of ${this.$retryLimit === Infinity ? 'Infinity' : this.$retryLimit.toString()}`);
-            await connection.startTransaction(this.$isolationLevel);
+            await connection.startTransaction(this.$isolationLevel, this.$accessLevel);
             try {
                 await this.$executor(connection);
                 await connection.commit();

package/src/TransactionAccessLevel.ts

@@ -0,0 +1,23 @@
+/*
+   Copyright 2017-2025 Norman Breau
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+/**
+ * @since 8.6.0
+ */
+export enum TransactionAccessLevel {
+    RW,
+    RO
+}

package/src/api.ts

@@ -42,6 +42,7 @@ export {IsolationLevel} from './IsolationLevel';
 export {Transaction} from './Transaction';
 export {IOKPacket} from './IOKPacket';
 export {IStoredProcedureResult} from './IStoredProcedureResult';
+export {TransactionAccessLevel} from './TransactionAccessLevel';
 
 // Errors
 export {ErrorCode} from './ErrorCode';

package/src/private/StartTransactionQuery.ts

@@ -1,5 +1,5 @@
 /*
-   Copyright 2017-2021 Norman Breau
+   Copyright 2017-2025 Norman Breau
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -15,9 +15,27 @@
 */
 
 import {Query} from '../Query';
+import { TransactionAccessLevel } from '../TransactionAccessLevel';
 
-export class StartTransactionQuery extends Query<void, void> {
-    protected _getQuery(): string {
-        return 'START TRANSACTION';
+/**
+ * @since 8.6.0
+ */
+export interface IStartTransactionQueryInput {
+    accessLevel?: TransactionAccessLevel;
+}
+
+export class StartTransactionQuery extends Query<IStartTransactionQueryInput, void> {
+    protected override _getQuery(): string {
+        let params: IStartTransactionQueryInput = this.getParameters();
+
+        let accessString: string;
+        if (params?.accessLevel === TransactionAccessLevel.RO) {
+            accessString = 'READ ONLY';
+        }
+        else {
+            accessString = 'READ WRITE';
+        }
+
+        return `START TRANSACTION ${accessString}`;
     }
 }

package/docs/variables/formidable-1.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>formidable | @breautek/storm</title><meta name="description" content="Documentation for @breautek/storm"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@breautek/storm</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@breautek/storm</a></li><li><a href="formidable-1.html">formidable</a></li></ul><h1>Variable formidable</h1></div><div class="tsd-signature"><span class="tsd-kind-variable">formidable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-namespace">default</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">defaultOptions</span><span class="tsd-signature-symbol">:</span> <a href="formidable-1.html#__typedefault" class="tsd-signature-type tsd-kind-namespace">default</a><span class="tsd-signature-symbol">.</span><a href="formidable-1.html#__typedefaultdefaultoptions" class="tsd-signature-type tsd-kind-type-alias">DefaultOptions</a><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">DummyParser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">DummyParser</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">enabledPlugins</span><span class="tsd-signature-symbol">:</span> <a href="formidable-1.html#__typedefault" class="tsd-signature-type tsd-kind-namespace">default</a><span class="tsd-signature-symbol">.</span><a href="formidable-1.html#__typedefaultenabledplugins" class="tsd-signature-type tsd-kind-type-alias">EnabledPlugins</a><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">errors</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">FormidableError</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">FormidableError</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;aborted&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;missingPlugin&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;pluginFunction&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;noParser&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;uninitializedParser&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;filenameNotString&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;maxFieldsSizeExceeded&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;maxFieldsExceeded&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;smallerThanMinFileSize&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;biggerThanMaxFileSize&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;noEmptyFiles&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;missingContentType&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;malformedMultipart&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;missingMultipartBoundary&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;unknownTransferEncoding&quot;</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">File</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">PersistentFile</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">formidable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="formidable-1.html#__typedefault" class="tsd-signature-type tsd-kind-namespace">default</a><span class="tsd-signature-symbol">.</span><a href="formidable-1.html#__typedefaultoptions" class="tsd-signature-type tsd-kind-interface">Options</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">IncomingForm</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">Formidable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">IncomingForm</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">IncomingForm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">IncomingForm</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">JSONParser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">JSONParser</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">MultipartParser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">MultipartParser</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">OctetStreamParser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">OctetStreamParser</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">parsers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">__module</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">PersistentFile</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">PersistentFile</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">plugins</span><span class="tsd-signature-symbol">:</span> <a href="formidable-1.html#__typedefault" class="tsd-signature-type tsd-kind-namespace">default</a><span class="tsd-signature-symbol">.</span><a href="formidable-1.html#__typedefaultenabledplugins" class="tsd-signature-type tsd-kind-type-alias">EnabledPlugins</a><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">QuerystringParser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">QuerystringParser</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">StreamingQuerystring</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">StreamingQuerystring</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">VolatileFile</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">VolatileFile</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="formidable-1.html#__typedefault" class="tsd-signature-type tsd-kind-namespace">default</a><span class="tsd-signature-symbol">.</span><a href="formidable-1.html#__typedefaultoptions" class="tsd-signature-type tsd-kind-interface">Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IncomingForm</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">defaultOptions</span><a id="__typedefaultoptions-1" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><a href="formidable-1.html#__typedefault" class="tsd-signature-type tsd-kind-namespace">default</a><span class="tsd-signature-symbol">.</span><a href="formidable-1.html#__typedefaultdefaultoptions" class="tsd-signature-type tsd-kind-type-alias">DefaultOptions</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">DummyParser</span><a id="__typedummyparser" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">DummyParser</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">enabledPlugins</span><a id="__typeenabledplugins" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><a href="formidable-1.html#__typedefault" class="tsd-signature-type tsd-kind-namespace">default</a><span class="tsd-signature-symbol">.</span><a href="formidable-1.html#__typedefaultenabledplugins" class="tsd-signature-type tsd-kind-type-alias">EnabledPlugins</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">errors</span><a id="__typeerrors" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">FormidableError</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">FormidableError</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;aborted&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;missingPlugin&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;pluginFunction&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;noParser&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;uninitializedParser&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;filenameNotString&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;maxFieldsSizeExceeded&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;maxFieldsExceeded&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;smallerThanMinFileSize&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;biggerThanMaxFileSize&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;noEmptyFiles&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;missingContentType&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;malformedMultipart&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;missingMultipartBoundary&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;unknownTransferEncoding&quot;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">File</span><a id="__typefile" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">PersistentFile</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">formidable</span><a id="__typeformidable" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="formidable-1.html#__typedefault" class="tsd-signature-type tsd-kind-namespace">default</a><span class="tsd-signature-symbol">.</span><a href="formidable-1.html#__typedefaultoptions" class="tsd-signature-type tsd-kind-interface">Options</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">IncomingForm</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Formidable</span><a id="__typeformidable-1" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">IncomingForm</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">IncomingForm</span><a id="__typeincomingform" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">IncomingForm</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">JSONParser</span><a id="__typejsonparser" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">JSONParser</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">MultipartParser</span><a id="__typemultipartparser" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">MultipartParser</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">OctetStreamParser</span><a id="__typeoctetstreamparser" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">OctetStreamParser</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">parsers</span><a id="__typeparsers" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">__module</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">PersistentFile</span><a id="__typepersistentfile" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">PersistentFile</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">plugins</span><a id="__typeplugins" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><a href="formidable-1.html#__typedefault" class="tsd-signature-type tsd-kind-namespace">default</a><span class="tsd-signature-symbol">.</span><a href="formidable-1.html#__typedefaultenabledplugins" class="tsd-signature-type tsd-kind-type-alias">EnabledPlugins</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">QuerystringParser</span><a id="__typequerystringparser" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">QuerystringParser</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">StreamingQuerystring</span><a id="__typestreamingquerystring" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">StreamingQuerystring</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">VolatileFile</span><a id="__typevolatilefile" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">VolatileFile</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">default</span><a id="__typedefault-1" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link"><a id="__typedefault-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="formidable-1.html#__typedefault" class="tsd-signature-type tsd-kind-namespace">default</a><span class="tsd-signature-symbol">.</span><a href="formidable-1.html#__typedefaultoptions" class="tsd-signature-type tsd-kind-interface">Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IncomingForm</span><a href="#__typedefault-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="formidable-1.html#__typedefault" class="tsd-signature-type tsd-kind-namespace">default</a><span class="tsd-signature-symbol">.</span><a href="formidable-1.html#__typedefaultoptions" class="tsd-signature-type tsd-kind-interface">Options</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IncomingForm</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/formidable/index.d.ts:315</li></ul></aside></div></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/formidable/index.d.ts:10</li><li>Defined in node_modules/@types/formidable/index.d.ts:314</li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">@breautek/storm</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>