@breautek/storm 7.1.2 → 8.1.0-beta.0

package/src/DatabaseConnection.ts

@@ -22,6 +22,7 @@ import {IDatabaseConnection} from './IDatabaseConnection';
 import {IQueryable} from './IQueryable';
 import { IConfig } from './IConfig';
 import { IsolationLevel } from './IsolationLevel';
+import { IDatabasePosition } from './IDatabasePosition';
 
 export const LINGER_WARNING: number = 10000;
 export const DEFAULT_QUERY_TIMEOUT: number = 3600000;
@@ -260,4 +261,9 @@ export abstract class DatabaseConnection<TAPI> implements IDatabaseConnection {
      */
     // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     protected abstract _stream(query: string, params?: any, streamOptions?: any): Readable;
+
+    /**
+     * @since 8.1.0
+     */
+    public abstract getCurrentDatabasePosition(): Promise<IDatabasePosition>;
 }

package/src/IDatabaseConnection.ts

@@ -17,6 +17,7 @@
 import { Readable } from 'stream';
 import { IQueryable } from './IQueryable';
 import { IsolationLevel } from './IsolationLevel';
+import { IDatabasePosition } from './IDatabasePosition';
 
 export interface IDatabaseConnection {
     setInstantiationStack(stack: string): void;
@@ -33,4 +34,9 @@ export interface IDatabaseConnection {
     isTransaction(): boolean;
     commit(): Promise<void>;
     rollback(): Promise<void>;
+
+    /**
+     * @since 8.1.0
+     */
+    getCurrentDatabasePosition(): Promise<IDatabasePosition>;
 }

package/src/IDatabasePosition.ts

@@ -0,0 +1,23 @@
+/*
+   Copyright 2017-2024 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.1.0
+ */
+export interface IDatabasePosition {
+    page: number;
+    position: number;
+}

package/src/ManagedDatabaseConnection.ts

@@ -19,6 +19,7 @@ import {getInstance} from './instance';
 import {Readable} from 'stream';
 import { Query } from './Query';
 import { IsolationLevel } from './IsolationLevel';
+import { IDatabasePosition } from './IDatabasePosition';
 
 const TAG: string = 'ManagedDatabaseConnection';
 
@@ -81,6 +82,11 @@ export class ManagedDatabaseConnection implements IDatabaseConnection {
         }
     }
 
+    public async getCurrentDatabasePosition(): Promise<IDatabasePosition> {
+        let conn: IDatabaseConnection = await this.$getConnection();
+        return await conn.getCurrentDatabasePosition();
+    }
+
     public isWriteRequired(): boolean {
         return this.$requiresWrite;
     }

package/src/MySQLConnection.ts

@@ -31,6 +31,10 @@ import { DeadLockError } from './DeadLockError';
 import { IsolationLevel } from './IsolationLevel';
 import {SetIsolationLevelQuery} from './private/SetIsolationLevelQuery';
 import { LockWaitTimeoutError } from './LockWaitTimeoutError';
+import { IDatabasePosition } from './IDatabasePosition';
+import { GetBinLogPositionQuery } from './private/GetBinLogPositionQuery';
+import { GetSlavePositionQuery } from './private/GetSlavePositionQuery';
+import { GetMasterPositionQuery } from './private/GetMasterPositionQuery';
 
 const DEFAULT_HIGH_WATERMARK: number = 512; // in number of result objects
 const TAG: string = 'MySQLConnection';
@@ -45,7 +49,9 @@ const SQL_FORMATTING_OPTIONS: SQLFormatter.FormatOptions = {
     linesBetweenQueries: 1,
     denseOperators: false,
     newlineBeforeSemicolon: false,
-    expressionWidth: 4
+    expressionWidth: 4,
+    dataTypeCase: 'upper',
+    functionCase: 'upper'
 };
 
 let startTransactionQuery: Query = new StartTransactionQuery();
@@ -55,12 +61,14 @@ let rollbackQuery: Query = new RollbackQuery();
 export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
     private $transaction: boolean;
     private $opened: boolean;
+    private $isMasterConnection: boolean;
 
     public constructor(connection: MySQL.PoolConnection, instantiationStack: string, isReadOnly: boolean = true) {
         super(connection, isReadOnly, instantiationStack);
 
         this.$opened = true;
         this.$transaction = false;
+        this.$isMasterConnection = null;
 
         connection.config.queryFormat = function(query: string, values: any) {
             if (!values) return query;
@@ -75,6 +83,22 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
         };
     }
 
+    /**
+     * @internal - Do not use in application code
+     */
+    public async __internal_init(): Promise<void> {
+        let result = await new GetSlavePositionQuery().execute(this);
+        this.$isMasterConnection = result === null;
+    }
+
+    public isMaster(): boolean {
+        return this.$isMasterConnection;
+    }
+
+    public isReplication(): boolean {
+        return !this.isMaster();
+    }
+
     public isTransaction(): boolean {
         return this.$transaction;
     }
@@ -83,6 +107,11 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
         return this.$opened;
     }
 
+    public override async getCurrentDatabasePosition(): Promise<IDatabasePosition> {
+        let statusQuery: GetBinLogPositionQuery = this.isReplication() ? new GetSlavePositionQuery() : new GetMasterPositionQuery();
+        return await statusQuery.execute(this);
+    }
+
     // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     protected _query(query: string, params?: any): Promise<any> {
         let logger: BaseLogger = getInstance().getLogger();

package/src/MySQLDatabase.ts

@@ -18,6 +18,8 @@ import {Database} from './Database';
 import {MySQLConnection} from './MySQLConnection';
 import * as MySQL from 'mysql';
 import {getInstance} from './instance';
+import { IDatabasePosition } from './IDatabasePosition';
+import { ConnectionReplicationWaiter } from './private/ConnectionReplicationWaiter';
 
 const TAG: string = 'MySQLDatabase';
 
@@ -69,18 +71,44 @@ export class MySQLDatabase extends Database<MySQL.PoolConfig, MySQL.PoolConnecti
         });
     }
 
-    protected _getConnection(query: string, requireWriteAccess: boolean): Promise<MySQLConnection> {
-        getInstance().getLogger().trace(TAG, `Querying connection pool for "${query}".`);
+    private $getConnectionFromPool(query: string, requireWriteAccess: boolean, instantationStack: string): Promise<MySQLConnection> {
         return new Promise<MySQLConnection>((resolve, reject) => {
-            let instantationStack: string = new Error().stack;
             this.$cluster.getConnection(query, (error: MySQL.MysqlError, connection: MySQL.PoolConnection) => {
                 if (error) {
                     reject(error);
                     return;
                 }
-
+    
                 resolve(new MySQLConnection(connection, instantationStack, !requireWriteAccess));
             });
         });
     }
+
+    protected override async _getConnection(query: string, requireWriteAccess: boolean, position?: IDatabasePosition): Promise<MySQLConnection> {
+        getInstance().getLogger().trace(TAG, `Querying connection pool for "${query}".`);
+        let instantationStack: string = new Error().stack;
+
+        let conn: MySQLConnection = await this.$getConnectionFromPool(query, requireWriteAccess, instantationStack);
+        await conn.__internal_init();
+
+        if (conn.isReplication()) {
+            // master connections will not wait on database positions
+            // they are guarenteed to be at the tip.
+            // readonly, or otherwise known as replication connections
+            // may have replication lag. If we have a desired position target,
+            // then await for the connection to catch up to that target.
+            if (position && position.page && position.position) {
+                let waiter: ConnectionReplicationWaiter = new ConnectionReplicationWaiter(conn);
+                try {
+                    await waiter.wait(position);
+                }
+                catch (ex) {
+                    conn.close(true);
+                    throw ex;
+                }
+            }
+        }
+
+        return conn;
+    }
 }

package/src/Request.ts

@@ -21,7 +21,7 @@ import {
     Fields,
     Files
 } from 'formidable';
-import formidable = require('formidable');
+import formidable from 'formidable';
 import {IFormData} from './IFormData';
 import { IAuthTokenData } from './IAuthTokenData';
 import { getInstance } from './instance';
@@ -51,7 +51,7 @@ export class Request<TBody = any, TAuthToken extends IAuthTokenData = IAuthToken
         return new Promise<IFormData>((resolve, reject) => {
             let r: express.Request = this.getRequestSource();
             let form: IncomingForm = formidable({
-                hash: 'md5'
+                hashAlgorithm: 'md5'
             });
 
             form.parse(r, (error: any, fields: Fields, files: Files): any => {

package/src/TimeoutError.ts

@@ -0,0 +1,44 @@
+/*
+   Copyright 2017-2024 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.
+*/
+
+import {StormError} from './StormError';
+import {ErrorCode} from './ErrorCode';
+import {StatusCode} from './StatusCode';
+
+/**
+ * @since 8.1.0
+ */
+export class TimeoutError extends StormError {
+    public constructor() {
+        super();
+    }
+
+    public getMessage(): string {
+        return `The requested resource could not be reached in time.`;
+    }
+
+    public getCode(): ErrorCode {
+        return ErrorCode.INTERNAL;
+    }
+
+    public getHTTPCode(): StatusCode {
+        return StatusCode.ERR_REQUEST_TIMEOUT;
+    }
+
+    public override getLocaleCode(): string {
+        return '@breautek/storm/TimeoutError/message';
+    }
+}

package/src/api.ts

@@ -51,6 +51,7 @@ export {
     IErrorResponse,
     IAdditionalErrorDetails
 } from './StormError';
+export {TimeoutError} from './TimeoutError';
 export {JWTError} from './JWTError';
 export {MissingParameterError} from './MissingParameterError';
 export {InvalidCredentialsError} from './InvalidCredentialsError';
@@ -96,6 +97,7 @@ export {IDatabaseConnection} from './IDatabaseConnection';
 export {IServiceHeaders} from './IServiceHeaders';
 export {IAuthTokenData} from './IAuthTokenData';
 export {IQueryable} from './IQueryable';
+export {IDatabasePosition} from './IDatabasePosition';
 
 // Token
 export {Token} from './Token';

package/src/private/ConnectionReplicationWaiter.ts

@@ -0,0 +1,110 @@
+
+/*
+   Copyright 2017-2024 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.
+*/
+
+import { IDatabaseConnection } from '../IDatabaseConnection';
+import { IDatabasePosition } from '../IDatabasePosition';
+import { InternalError } from '../InternalError';
+import { TimeoutError } from '../TimeoutError';
+
+export class ConnectionReplicationWaiter {
+    /**
+     * The default retry delay in milliseconds.
+     * Defaults to 1 second.
+     * 
+     * This is the value used in between status query iterations.
+     */
+    public static readonly DEFAULT_RETRY_DELAY: number = 1000;
+
+    /**
+     * The default timeout delay. Defaults to 120 seconds.
+     * If the connection could not reach the target position in time,
+     * then the wait will timeout
+     * 
+     * Using `Infinity` will disable the timeout
+     */
+    public static readonly DEFAULT_TIMEOUT = 120 * 1000; // 120 seconds in ms
+
+    private $conn: IDatabaseConnection;
+    private $retryDelay: number;
+
+    public constructor(conn: IDatabaseConnection, retryDelay: number = ConnectionReplicationWaiter.DEFAULT_RETRY_DELAY) {
+        this.$conn = conn;
+        this.$retryDelay = retryDelay;
+    }
+
+    private $sleep(timeout: number): Promise<void> {
+        return new Promise((resolve, reject) => {
+            setTimeout(() => {
+                resolve();
+            }, timeout);
+        });
+    }
+
+    public async wait(target: IDatabasePosition, timeout: number = ConnectionReplicationWaiter.DEFAULT_TIMEOUT): Promise<void> {
+        if (!this.$conn.isReadOnly()) {
+            return;
+        }
+
+        let shouldTimeout: boolean = false;
+        let didTimeout: boolean = false;
+
+        let timeoutTimer = setTimeout(() => {
+            shouldTimeout = true;
+        }, timeout);
+
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+            if (shouldTimeout) {
+                didTimeout = true;
+                break;
+            }
+
+            let currentPos: IDatabasePosition = await this.$conn.getCurrentDatabasePosition();
+
+            if (currentPos === null || (currentPos && !currentPos.page === null) || (currentPos && !currentPos.position === null)) {
+                throw new InternalError('Database Position not supported');
+            }
+
+            // If the current page is greater than the target page,
+            // then the position doesn't matter, we are ahead of the
+            // desired target position.
+            if (currentPos.page > target.page) {
+                break;
+            }
+
+            // If the pages are equal, we need to check the position
+            // and ensure we are at or greater than the target.
+            if (currentPos.page === target.page && currentPos.position >= target.position) {
+                break;
+            }
+
+            // If we made it here, it means the position state checks failed
+            // so wait a short while and then re-iterate
+            await this.$sleep(this.$retryDelay);
+        }
+
+        if (didTimeout) {
+            // If the while loop exited due to the timeout,
+            // then throw a timeout error
+            throw new TimeoutError();
+        }
+
+        // Otherwise we are good to go!
+        clearTimeout(timeoutTimer);
+    }
+}
+

package/src/private/GetBinLogPositionQuery.ts

@@ -0,0 +1,59 @@
+/*
+   Copyright 2017-2024 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.
+*/
+
+import {Query} from '../Query';
+import {IDatabasePosition} from '../IDatabasePosition';
+import { IDatabaseConnection } from '../IDatabaseConnection';
+
+/**
+ * @since 8.1.0
+ */
+export abstract class GetBinLogPositionQuery<TStatusRow = unknown> extends Query<void, TStatusRow[], IDatabasePosition> {
+    protected abstract _getQuery(): string;
+
+    protected abstract _getFile(row: TStatusRow): string;
+    protected abstract _getPosition(row: TStatusRow): string;
+    
+    public async onPostProcess(connection: IDatabaseConnection, resultSet: TStatusRow[]): Promise<IDatabasePosition> {
+        let row: TStatusRow = null;
+        if (resultSet.length > 0) {
+            row = resultSet[0];
+        }
+
+        if (!row) {
+            return null;
+        }
+
+        let pageParts: string[] = this._getFile(row).split('.');
+        let strPage: string = pageParts[pageParts.length - 1];
+
+        let page: number = parseInt(strPage);
+
+        if (isNaN(page)) {
+            return null;
+        }
+
+        let position: number = parseInt(this._getPosition(row));
+        if (isNaN(position)) {
+            return null;
+        }
+
+        return {
+            page: page,
+            position: position
+        };
+    }
+}

package/src/private/GetMasterPositionQuery.ts

@@ -0,0 +1,37 @@
+/*
+   Copyright 2017-2024 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.
+*/
+
+import { GetBinLogPositionQuery } from './GetBinLogPositionQuery';
+
+interface IStatus {
+    File: string;
+    Position: string;
+}
+
+export class GetMasterPositionQuery extends GetBinLogPositionQuery<IStatus> {
+
+    protected override _getQuery(): string {
+        return 'SHOW MASTER STATUS';
+    }
+
+    protected override _getFile(row: IStatus): string {
+        return row.File;
+    }
+
+    protected override _getPosition(row: IStatus): string {
+        return row.Position;
+    }
+}

package/src/private/GetSlavePositionQuery.ts

@@ -0,0 +1,37 @@
+/*
+   Copyright 2017-2024 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.
+*/
+
+import { GetBinLogPositionQuery } from './GetBinLogPositionQuery';
+
+interface IStatus {
+    Master_Log_File: string;
+    Read_Master_Log_Pos: string;
+}
+
+export class GetSlavePositionQuery extends GetBinLogPositionQuery<IStatus> {
+
+    protected override _getQuery(): string {
+        return 'SHOW SLAVE STATUS';
+    }
+
+    protected override _getFile(row: IStatus): string {
+        return row.Master_Log_File;
+    }
+
+    protected override _getPosition(row: IStatus): string {
+        return row.Read_Master_Log_Pos;
+    }
+}

package/tsconfig.json

@@ -10,6 +10,7 @@
         "noImplicitThis": true,
         "alwaysStrict": true,
         "noImplicitReturns": true,
+        "esModuleInterop": true,
         "moduleResolution": "node"
     },
     "exclude": [

package/docs/functions/formidable-1.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><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></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" data-base=".."><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"><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"><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>Function formidable</h1></div><section class="tsd-panel"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="formidable" class="tsd-anchor"></a><span class="tsd-kind-call-signature">formidable</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IncomingForm</span><a href="#formidable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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 ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/formidable.Options.html" 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:282</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@breautek/storm</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>

package/docs/interfaces/formidable.EmitData.html

@@ -1,5 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EmitData | @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></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" data-base=".."><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"><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"><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="../modules/formidable.html">formidable</a></li><li><a href="formidable.EmitData.html">EmitData</a></li></ul><h1>Interface EmitData</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">EmitData</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="formidable.EmitData.html#formname">formname</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="formidable.EmitData.html#key">key</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="formidable.EmitData.html#name">name</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;file&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;fileBegin&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="formidable.EmitData.html#value">value</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="formidable.File.html" class="tsd-signature-type tsd-kind-interface">File</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/formidable/index.d.ts:245</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="formidable.EmitData.html#formname" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>formname</span></a>
-<a href="formidable.EmitData.html#key" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key?</span></a>
-<a href="formidable.EmitData.html#name" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
-<a href="formidable.EmitData.html#value" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a>
-</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="formname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>formname</span><a href="#formname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">formname</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/formidable/index.d.ts:246</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>key</span><a href="#key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/formidable/index.d.ts:247</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;file&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;fileBegin&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/formidable/index.d.ts:248</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="formidable.File.html" class="tsd-signature-type tsd-kind-interface">File</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/formidable/index.d.ts:249</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#formname" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>formname</span></a><a href="#key" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a><a href="#name" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#value" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@breautek/storm</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>