TypeScript (#109)

Author: gx0r

.travis.yml

@@ -1,7 +1,7 @@
 language: node_js
 node_js:
-  - "10"
-  - "12"
+  - "18"
+  - "20"
 
 env:
   - IN_TRAVIS=yes

Changelog.md

@@ -6,14 +6,12 @@ The format is based on Keep a Changelog and this project adheres to Semantic Ver
 
 ## 5.0.0
 
-- Updated code for modern Node 18+
-- Class syntax instead of prototype
-- async/await
+- Rewritten in TypeScript (with class syntax and async/await) targeting modern Node 18+
+- Tests rewritten to use Node test runner
 - eslint
 - prettier
-- Node test runner
-- ES Modules (.mjs)
-- ES Module example
+- ES Module examples (.mjs)
+- Configuation options improved
 
 ## 4.0.2
 

Readme.md

@@ -25,16 +25,15 @@ See [Changelog.md](Changelog.md)
 
 ## Options
 
-- `tablename='sessions'` Tablename to use. Defaults to 'sessions'.
-- `sidfieldname='sid'` Field name in table to use for storing session ids. Defaults to 'sid'.
+- `cleanupInterval` milliseconds between clearing expired sessions. Defaults to 60000. 0 disables the automatic clearing of expired sessions.
+- `createTable` if the table for sessions should be created automatically or not.
 - `knex` knex instance to use. Defaults to a new knex instance, using sqlite3 with a file named 'connect-session-knex.sqlite'
-- `createtable` if the table for sessions should be created automatically or not.
-- `clearInterval` milliseconds between clearing expired sessions. Defaults to 60000.
-- `disableDbCleanup` disables the automatic clearing of expired sessions. Defaults to false.
+- `tableName='sessions'` Tablename to use. Defaults to 'sessions'.
+- `sidFieldName='sid'` Field name in table to use for storing session ids. Defaults to 'sid'.
 
-If the table does not exist in the schema, this module will attempt to create it unless the 'createtable' option is false.
+If the table does not exist in the schema, this module will attempt to create it unless the `createTable` option is false.
 
-If a knex instance is not provided, this module will attempt to create a sqlite3 database, with a file named 'connect-session-knex.sqlite', in the working directory of the process.
+If a knex instance is not provided, this module will attempt to create a sqlite3 database, with a file named `connect-session-knex.sqlite`, in the working directory of the process.
 
 ## Schema
 

dist/index.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="node" />
+import { Knex } from "knex";
+import { SessionData, Store } from "express-session";
+interface Options {
+    cleanupInterval: number;
+    createTable: boolean;
+    knex: Knex;
+    onDbCleanupError: (err: unknown) => void;
+    tableName: string;
+    sidFieldName: string;
+}
+export declare class ConnectSessionKnexStore extends Store {
+    options: Options;
+    nextDbCleanup: NodeJS.Timeout | undefined;
+    ready: Promise<unknown>;
+    constructor(incomingOptions: Partial<Options>);
+    get(sid: string, callback: (err: any, session?: SessionData | null) => void): Promise<SessionData | null>;
+    set(sid: string, session: SessionData, callback?: (err?: any) => void): Promise<void>;
+    touch(sid: string, session: SessionData, callback?: () => void): Promise<void>;
+    destroy(sid: string, callback?: (err?: any) => void): Promise<number>;
+    length(callback: (err: any, length?: number) => void): Promise<number | undefined>;
+    clear(callback?: (err?: any) => void): Promise<number>;
+    all(callback: (err: any, obj?: SessionData[] | {
+        [sid: string]: SessionData;
+    } | null) => void): Promise<any[]>;
+    private dbCleanup;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map