Registry / database / sqlite-express-folders

sqlite-express-folders

JSON →
library4.0.4jsnpmunverified

sqlite-express-folders v4.0.4 is a utility package that organizes sqlite-express methods into a nested folder structure. It reads methods from methods.js files inside directories specified by a route, automatically creating a tree of SQL handlers. Released actively, it depends on sqlite-express and optionally on lek-dir-object. It provides a getTree function and a sqlite_express_instance, with local folderDefaultOptions overriding defaults.

npm install sqlite-express-folders
INSTALL
IMPORT
SIG · SQLITE-EXPRESS-FOL
S
sqlite-express-folders
databasejavascriptv4.0.4
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

default
import sqliteExpressFolders from 'sqlite-express-folders'
import { default } from 'sqlite-express-folders'
Default export is a function; named exports also available.
getTree
import { getTree } from 'sqlite-express-folders'
One of the return values from the call.
sqlite_express_instance
import { sqlite_express_instance } from 'sqlite-express-folders'
Returned from the function call.
createTree
import { createTree } from 'sqlite-express-folders'
import createTree from 'sqlite-express-folders'
Named export, not default; only available if using lek-dir-object option.

Shows basic setup: import the package, call with rootPath and routeFolder, define a methods.js file in the route folder, then use getTree to access methods.

const sqliteExpressFolders = require('sqlite-express-folders'); const { sqlite_express_instance, getTree } = sqliteExpressFolders({ rootPath: __dirname, routeFolder: './my_methods' }); // Example methods.js inside './my_methods/methods.js': // const methods = async sqliteExpress => { // const getAll = () => sqliteExpress.query('SELECT * FROM users'); // return { getAll }; // }; // module.exports = methods; (async () => { const tree = await getTree(); const result = await tree.getAll(); console.log(result); })();
Debug
Known issues
gotcharouteFolder must be a relative path; absolute paths will cause errors.
fix
Ensure routeFolder is relative to rootPath.
affects: >=1.0
gotchaOnly files named 'methods.js' are read; other files inside routeFolder are ignored.
fix
Rename your JS files to methods.js or nest them in subdirectories with their own methods.js.
affects: >=1.0
deprecatedThe parameter 'route' in v3 is replaced by 'routeFolder' in v4.
fix
Use 'routeFolder' instead of 'route' in the options object.
affects: >=4.0
gotchaThe function provided in methods.js must be async and export via module.exports.
fix
Declare as 'async sqliteExpress => { ... }' and use 'module.exports = methods'.
affects: >=1.0
Errors
Common errors & fixes
TypeError: sqliteExpressFolders is not a function
Using named import for default export in CommonJS.
fix
Use 'const sqliteExpressFolders = require('sqlite-express-folders');' instead of destructured import.
Error: routeFolder must be a relative path
Passing an absolute path to routeFolder.
fix
Ensure routeFolder is relative to rootPath (e.g., './my_methods').
TypeError: methods is not a function
methods.js exports something else (e.g., an object) instead of an async function.
fix
Export 'module.exports = async sqliteExpress => { return { yourMethods }; };'.
Upgrade
Version history
4.0.4latest on npm
Audit
Dependencies
sqlite-expressrequiredCore peer dependency for SQLite operations
lek-dir-objectoptionalUsed to create tree from nested directories
Agent activity
38 hits · last 30 days
node
35
OpenAI (training)
2
Meta
1
Resources
sqlite-express-folders — npm install sqlite-express-folders · libregistry