codehooks-js 1.1.11 → 1.2.1

package/types/index.d.ts

@@ -0,0 +1,681 @@
+/**
+ * Built-in persistent datastore.
+ * - Datastore is capable of serving NoSQL object data and Key-Value data.
+ */
+export type Datastore = {
+    /**
+     * - Connect to Datastore
+     */
+    open: () => Promise<DatastoreAPI>;
+};
+/**
+ * @type {Datastore}
+ */
+export const Datastore: Datastore;
+/**
+ * @type {Datastore}
+ */
+export const datastore: Datastore;
+export const aggregation: typeof agg;
+export const crudlify: typeof crud;
+/**
+ * Express style API
+ * @type {Codehooks}
+ */
+export const coho: Codehooks;
+export const app: Codehooks;
+export const coderunner: any;
+export namespace schedule {
+    function runAt(date: any, payload: any, worker: string): Promise<any>;
+    function run(payload: any, worker: string): Promise<any>;
+}
+/**
+ * Virtual filesystem
+ */
+export namespace filestore {
+    /**
+     * Raad file content as stream
+     * @param path Absolute path til file
+     * @param options Not in use
+     */
+    function getReadStream(path: string, options?: any): any;
+    function readFile(path: string, options?: any): any;
+    function saveFile(path: string, buffer: any, options?: any): any;
+    function deleteFile(path: string, options?: any): any;
+    function list(path: string, options?: any): any;
+    function readFileAsBuffer(path: any): Promise<any>;
+}
+export default _coho;
+/**
+ * keyvalOptions
+ */
+export type keyvalOptions = {
+    /**
+     * - Time to live in milliseconds
+     */
+    ttl: number;
+    /**
+     * - Name of isolated keyspace
+     */
+    keyspace: string;
+};
+/**
+ * NoSQL API
+ */
+export type NoSQLAPI = {
+    /**
+     * - Get object by ID, returns a Promise with the object
+     */
+    getOne: (query: string | object) => Promise<object>;
+    /**
+     * - Get stream of objects by query
+     * https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options
+     */
+    getMany: (query: object, options?: object) => DataStream;
+    /**
+     * - Get stream of objects by query, alias for getMany
+     */
+    find: (query: object, options?: object) => DataStream;
+    /**
+     * - Insert a new data object into a collection in the current Datastore
+     */
+    insertOne: (document: object) => Promise<object>;
+    /**
+     * - Update one data object by ID in a datastore collection.
+     * - Input document is patched with the matched database object
+     */
+    updateOne: (query: string | object, document: object, options?: object) => Promise<object>;
+    /**
+     * - Update multiple data objects in a datastore collection.
+     * - Input document is patched with the matched database objects
+     */
+    updateMany: (query: object, document: object, options?: object) => Promise<object>;
+    /**
+     * - Replace one data object by ID in a datastore collection.
+     * - Input document overwrites the matched database object, the _id value is not overwritten.
+     */
+    replaceOne: (query: string | object, document: object, options?: object) => Promise<object>;
+    /**
+     * - Replace multiple data objects in a datastore collection.
+     * - Input document overwrites the matched database objects. The _id value is not overwritten
+     */
+    replaceMany: (query: object, document: object, options?: object) => Promise<object>;
+    /**
+     * - Remove one data object by ID in a collection in the current Datastore
+     */
+    removeOne: (query: string | object) => Promise<object>;
+    /**
+     * - Remove multiple data objects in a collection in the current Datastore
+     */
+    removeMany: (query: object) => Promise<object>;
+};
+/**
+ * Database API
+ */
+export type DatastoreAPI = {
+    /**
+     * - Get database collection by string name, returns an NoSQL API object
+     */
+    collection: (collection: string) => NoSQLAPI;
+    /**
+     * - Get object by ID, returns a Promise with the object
+     */
+    getOne: (collection: string, query: string | object) => Promise<any>;
+    /**
+     * - Get stream of objects by query
+     * * https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options
+     */
+    getMany: (collection: string, query?: object, options?: object) => DataStream;
+    /**
+     * - Alias for getMany
+     * https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options
+     */
+    find: (collection: string, query?: object, options?: object) => DataStream;
+    /**
+     * - Insert a new data object into a collection in the current Datastore
+     */
+    insertOne: (collection: string, document: object) => Promise<object>;
+    /**
+     * - Update one data object by ID in a datastore collection.
+     * - Input document is patched with the matched database object
+     */
+    updateOne: (collection: string, query: string|object, options?: object) => Promise<any>;
+    /**
+     * - Update multiple data objects in a datastore collection.
+     * - Input document is patched with the matched database objects
+     */
+    updateMany: (collection: string, query: object, document: object, options?: object) => Promise<any>;
+    /**
+     * - Replace one data object by ID in a datastore collection.
+     * - Input document overwrites the matched database object, the _id value is not overwritten.
+     */
+    replaceOne: (collection: string, query: string|object, options?: object) => Promise<any>;
+    /**
+     * - Replace multiple data objects in a datastore collection.
+     * - Input document overwrites the matched database objects. The _id value is not overwritten
+     */
+    replaceMany: (collection: string, query: object, options?: object) => Promise<any>;
+    /**
+     * - Remove one data object by ID in a collection in the current Datastore
+     */
+    removeOne: (collection: string, query: string|object) => Promise<any>;
+    /**
+     * - Remove multiple data objects in a collection in the current Datastore
+     */
+    removeMany: (collection: string, query: object) => Promise<any>;
+    /**
+     * - Set a key-value pair in the current Datastore
+     */
+    set: (key: string, value: string, options?: object) => Promise<any>;
+    /**
+     * - Get a key-value pair in the current Datastore
+     */
+    get: (key: string, options?: object) => Promise<any>;
+    /**
+     * - Get all key-value pair that matches keypattern in the current Datastore
+     */
+    getAll: (keypattern: string, options?: object) => DataStream;
+    /**
+     * - Increment a key-value pair in the current Datastore
+     */
+    incr: (key: string, value: number, options?: object) => Promise<any>;
+    /**
+     * - Decrement a key-value pair in the current Datastore
+     */
+    decr: (key: string, value: number, options?: object) => Promise<any>;
+    /**
+     * - Delete a key-value pair in the current Datastore
+     */
+    del: (key: string, value: object) => Promise<any>;
+    /**
+     * - Delete a range of key-value pairs in the current Datastore
+     */
+    delAll: (keypattern: string, options?: object) => Promise<any>;
+    /**
+     * - Add a queued job in a datastore.
+     * - Jobs in the queue are processed by your worker function.
+     */
+    enqueue: (topic: string, document: object, options?: object) => Promise<any>;
+    
+    /**
+     * Queue each item from the result of a database query to a worker function
+     * @see {@link https://codehooks.io/docs/queueapi#enqueuefromquerycollection-query-topic-options Codehooks docs}
+     * @param collection Collection name
+     * @param query Database Query
+     * @param topic Worker function topic string
+     * @param options Query options
+     * @returns Promise     
+     * @example
+     * async function someFunction() {
+     *   const query = {"Market Category": "G"};
+     *   const topic = 'stockWorker';
+     *   const qres = await conn.enqueueFromQuery('stocks', query, topic);
+     * }
+     * 
+     * app.worker('stockWorker', (req: httpRequest, res: httpResponse) => {
+     *   const { body } = req;
+     *   console.log('Working on', body.payload)
+     *   // do stuff with body.payload
+     *   res.end()
+     * })     
+     */
+    enqueueFromQuery: (collection: string, query: object, topic: string, options?: object) => Promise<object>;
+};
+/**
+ * Persistent NoSql and Kev-Value datastore
+ */
+export type DataStream = {
+    /**
+     * - Emits data, stream.on('data', (data) => //console.debug(data))
+     */
+    on: (event: string, callback: (data: any) => any) => void;
+    /**
+     * - Pipe datastream to JSON output
+     */
+    json: (response: httpResponse) => void;
+    /**
+     * - Return an array of objects
+     */
+    toArray: () => Promise<object[]>;
+    /**
+     * Return an iterator
+     * @param data 
+     * @returns Promise with iterator
+     */
+    forEach: (data: object) => Promise<object>;
+};
+export type httpRequest = {
+    /**
+     * - HTTP header key value pairs, e.g. req.headers['content-type']
+     */
+    headers: any;
+    /**
+     * - Get the URL query parameters as key-value pairs
+     */
+    query: any;
+    /**
+     * - Get the URL route variables as key-value pairs
+     */
+    params: any;
+    /**
+     * - Get the request body
+     * - JSON payload
+     */
+    body: any;
+    /**
+     * - Get the URL full path, e.g. /dev/myroute
+     */
+    path: string;
+    /**
+     * - Get the URL api path, e.g. /myroute
+     */
+    apiPath: string;
+    /**
+     * - Get the URL full path and query parameter string
+     */
+    originalUrl: string;
+    /**
+     * - Get the HTTP request verb
+     */
+    method: string;
+    /**
+     * - Get the project URL domain name
+     */
+    hostname: string;
+};
+export type httpResponse = {
+    /**
+     * - End request (optional: send text|JSON data to client)
+     */
+    end: (data: string | object | void) => void;
+    /**
+     * - Send text|JSON data to client and end request
+     */
+    send: (data: string | object) => void;
+    /**
+     * - End request and send JSON data to client
+     */
+    json: (document: object) => any;
+    /**
+     * - Write stream data to the client response.
+     * - Content-type must be set before any write operations
+     */
+    write: (data: string) => any;
+    /**
+     * - Set a response header value,
+     * - e.g. res.set('Content-Type', 'text/html; charset=UTF-8');
+     */
+    set: (header: string, value: string) => any;
+    /**
+     * - Set multiple response header values,
+     * - e.g. res.headers({'Content-Type': 'text/html; charset=UTF-8','X-myheader': '123456890'});
+     */
+    headers: (headers: object) => any;
+    /**
+     * - Return a HTTP response status code for a client request,
+     * - e.g. res.status(401);
+     */
+    status: (code: number) => any;
+    /**
+     * - Render template with object data
+     * - example: res.render('services', {title: "Services page"})
+     */
+    render: (template: string, context: object) => void;
+};
+export type Filesystem = {
+    /**
+     * - Get binary file input stream. Takes a path (string) to file (e.g. /static/logo.png) and an options object (Object) for future use. Returns a Promise resolving to a binary data stream emitter.
+     */
+    getReadStream: (arg0: string, arg1: any) => Promise<ReadableStream>;
+    /**
+     * - Get file as text. Takes an absolute path (string) to file (e.g. /static/home.html) and an options object (Object) for future use. Returns a Promise resolving to the file content (string).
+     */
+    readFile: (arg0: string, arg1: any) => Promise<string>;
+    /**
+     * - Save file binary buffer. Takes an absolute path (string) to file (e.g. /static/home.html), a buffer (Buffer) to save, and file meta data (Object). Returns a Promise resolving to the save result.
+     */
+    saveFile: (arg0: string, arg1: Buffer, arg2: any) => Promise<any>;
+    /**
+     * - Delete a file. Takes an absolute path (string) to file and an options object (Object) for future use. Returns a Promise resolving to the result.
+     */
+    deleteFile: (arg0: string, arg1: any) => Promise<any>;
+    /**
+     * - List content of a file directory. Takes an absolute path (string) to file and an options object (Object) for future use. Returns a Promise resolving to the result.
+     */
+    list: (arg0: string, arg1: any) => Promise<any>;
+    /**
+     * - Read file into a Buffer. Takes an absolute path (*) to file. Returns a Promise resolving to a Buffer.
+     */
+    readFileAsBuffer: (arg0: any) => Promise<Buffer>;
+};
+import { agg } from './aggregation/index.mjs';
+import { crudlify as crud } from './crudlify/index.mjs';
+/**
+* keyvalOptions
+* @typedef {Object} keyvalOptions
+* @property {number} ttl - Time to live in milliseconds
+* @property {string} keyspace - Name of isolated keyspace
+*/
+/**
+ * NoSQL API
+ * @typedef {Object} NoSQLAPI
+ * @property {function(string|object):Promise.<object>} getOne - Get object by ID, returns a Promise with the object
+ * @property {function(object, object):DataStream} getMany - Get stream of objects by query
+ * https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options
+ * @property {function(object, object):DataStream} find - Get stream of objects by query, alias for getMany
+ * @property {function(object):Promise.<object>} insertOne - Insert a new data object into a collection in the current Datastore
+ * @property {function(string|object, object):Promise.<object>} updateOne - Update one data object by ID in a datastore collection.
+ * - Input document is patched with the matched database object
+ * @property {function(object, object):Promise.<object>} updateMany - Update multiple data objects in a datastore collection.
+ * - Input document is patched with the matched database objects
+ * @property {function(string|object, object):Promise.<object>} replaceOne - Replace one data object by ID in a datastore collection.
+ * - Input document overwrites the matched database object, the _id value is not overwritten.
+ * @property {function(object, object):Promise.<object>} replaceMany - Replace multiple data objects in a datastore collection.
+ * - Input document overwrites the matched database objects. The _id value is not overwritten
+ * @property {function(string|object):Promise.<object>} removeOne - Remove one data object by ID in a collection in the current Datastore
+ * @property {function(object):Promise.<object>} removeMany - Remove multiple data objects in a collection in the current Datastore
+ */
+/**
+ * Database API
+ * @typedef {Object} DatastoreAPI
+ * @property {function(string):NoSQLAPI} collection - Get database collection by string name, returns an NoSQL API object
+ * @property {function(string, string|object):Promise.<object>} getOne - Get object by Query or ObjectID, returns a Promise with the object
+ * @property {function(string, object, object):DataStream} getMany - Get stream of objects by query
+ * * https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options
+ * @property {function(string, object, object):DataStream} find - Alias for getMany
+ * https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options
+ * @property {function(string, object):Promise.<object>} insertOne - Insert a new data object into a collection in the current Datastore
+ * @property {function(string, string, object):Promise.<object>} updateOne - Update one data object by ID in a datastore collection.
+ * - Input document is patched with the matched database object
+ * @property {function(string, object, object):Promise.<object>} updateMany - Update multiple data objects in a datastore collection.
+ * - Input document is patched with the matched database objects
+ * @property {function(string, string, object):Promise.<object>} replaceOne - Replace one data object by ID in a datastore collection.
+ * - Input document overwrites the matched database object, the _id value is not overwritten.
+ * @property {function(string, object, object):Promise.<object>} replaceMany - Replace multiple data objects in a datastore collection.
+ * - Input document overwrites the matched database objects. The _id value is not overwritten
+ * @property {function(string, string):Promise.<object>} removeOne - Remove one data object by ID in a collection in the current Datastore
+ * @property {function(string, object):Promise.<object>} removeMany - Remove multiple data objects in a collection in the current Datastore
+ * @property {function(string, string, object):Promise.<object>} set - Set a key-value pair in the current Datastore
+ * @property {function(string, object):Promise.<object>} get - Get a key-value pair in the current Datastore
+ * @property {function(string, object):DataStream} getAll - Get all key-value pair that matches keypattern in the current Datastore
+ * @property {function(string, number, object):Promise.<object>} incr - Increment a key-value pair in the current Datastore
+ * @property {function(string, number, object):Promise.<object>} decr - Decrement a key-value pair in the current Datastore
+ * @property {function(string, object):Promise.<object>} del - Delete a key-value pair in the current Datastore
+ * @property {function(string, object):Promise.<object>} delAll - Delete a range of key-value pairs in the current Datastore
+ * @property {function(string, object, object):Promise.<object>} enqueue - Add a queued job in a datastore.
+ * - Jobs in the queue are processed by your worker function.
+ * @property {function(string, object, string, object):Promise.<object>} enqueueFromQuery - Add multiple queued jobs from the result of a database query in a datastore.
+ * - Each object from the collection in the query result will be processed by your worker function.
+ * - If your collection has 1000 items, a match all query ({}) will add 1000 items to the queue and call your worker function 1000 times.
+*/
+/**
+* Persistent NoSql and Kev-Value datastore
+* @typedef {Object} DataStream
+* @property {function(string, function(*)):void} on - Emits data, stream.on('data', (data) => //console.debug(data))
+* @property {function(httpResponse):void} json - Pipe datastream to JSON output
+* @property {function():Promise.<object[]>} toArray - Return an array of objects
+*/
+/**
+ * Built-in persistent datastore.
+ * - Datastore is capable of serving NoSQL object data and Key-Value data.
+ * @typedef {Object} Datastore
+ * @property {function():Promise.<DatastoreAPI>} open - Connect to Datastore
+ */
+/**
+ * @typedef {Object} httpRequest
+ * @property {*} headers - HTTP header key value pairs, e.g. req.headers['content-type']
+ * @property {*} query - Get the URL query parameters as key-value pairs
+ * @property {*} params - Get the URL route variables as key-value pairs
+ * @property {*} body - Get the request body
+ * - JSON payload
+ * @property {string} path - Get the URL full path, e.g. /dev/myroute
+ * @property {string} apiPath - Get the URL api path, e.g. /myroute
+ * @property {string} originalUrl - Get the URL full path and query parameter string
+ * @property {string} method - Get the HTTP request verb
+ * @property {string} hostname - Get the project URL domain name
+ */
+/**
+ * @typedef {Object} httpResponse
+ * @property {function(string|object|void): void} end - End request (optional: send text|JSON data to client)
+ * @property {function(string|object): void} send - Send text|JSON data to client and end request
+ * @property {function(object)} json - End request and send JSON data to client
+ * @property {function(string)} write - Write stream data to the client response.
+ * - Content-type must be set before any write operations
+ * @property {function(string, string)} set - Set a response header value,
+ * - e.g. res.set('Content-Type', 'text/html; charset=UTF-8');
+ * @property {function(object)} headers - Set multiple response header values,
+ * - e.g. res.headers({'Content-Type': 'text/html; charset=UTF-8','X-myheader': '123456890'});
+ * @property {function(number)} status - Return a HTTP response status code for a client request,
+ * - e.g. res.status(401);
+ * @property {function(string, object):void} render - Render template with object data
+ * - example: res.render('services', {title: "Services page"})
+ */
+/**
+ * @typedef {Object} Filesystem
+ *
+ * @property {function(string, Object): Promise<ReadableStream>} getReadStream
+ * - Get binary file input stream. Takes a path (string) to file (e.g. /static/logo.png) and an options object (Object) for future use. Returns a Promise resolving to a binary data stream emitter.
+ *
+ * @property {function(string, Object): Promise<string>} readFile
+ * - Get file as text. Takes an absolute path (string) to file (e.g. /static/home.html) and an options object (Object) for future use. Returns a Promise resolving to the file content (string).
+ *
+ * @property {function(string, Buffer, Object): Promise<any>} saveFile
+ * - Save file binary buffer. Takes an absolute path (string) to file (e.g. /static/home.html), a buffer (Buffer) to save, and file meta data (Object). Returns a Promise resolving to the save result.
+ *
+ * @property {function(string, Object): Promise<any>} deleteFile
+ * - Delete a file. Takes an absolute path (string) to file and an options object (Object) for future use. Returns a Promise resolving to the result.
+ *
+ * @property {function(string, Object): Promise<any>} list
+ * - List content of a file directory. Takes an absolute path (string) to file and an options object (Object) for future use. Returns a Promise resolving to the result.
+ *
+ * @property {function(*): Promise<Buffer>} readFileAsBuffer
+ * - Read file into a Buffer. Takes an absolute path (*) to file. Returns a Promise resolving to a Buffer.
+ */
+declare class Codehooks {
+    static getInstance(): Codehooks;
+    /**
+     * Express style api
+     */
+    settings: {};
+    routes: {};
+    queues: {};
+    jobs: {};
+    auths: {};
+    appmiddleware: any[];
+    datastore: any;
+    listeners: any[];
+    workers: {};
+    /**
+     * POST requests - e.g. app.post('/foo', callbackFunction)
+     * @example
+     * app.post('/myroute', (req, res) => {
+     *  //console.debug('Body', req.body)
+     *  res.json({"message": "thanks!"})
+     * })
+     * @param {string} path - API route, e.g. '/foo'
+     * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
+     */
+    post: (path: string, ...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => void) => any)[]) => void;
+    /**
+     * GET requests - e.g. app.get('/foo/:ID', callbackFunction)
+     * @example
+     * app.get('/myroute', (req, res) => {
+     *  //console.debug('Params', req.params)
+     *  res.json({"message": "thanks!"})
+     * })
+     * @param {string} path - API route, e.g. '/foo/:ID'
+     * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
+     */
+    get: (path: string, ...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => void) => any)[]) => void;
+    /**
+     * PUT requests
+     * @example
+     * app.put('/myroute', (req, res) => {
+     *  //console.debug('Body', req.body)
+     *  res.json({"message": "thanks!"})
+     * })
+     * @param {string} path - API route, e.g. '/foo/:ID'
+     * @param  {...function(httpRequest, httpResponse, function(string):void):void} hook - callback function(s) with parameters (req, res, [next])
+     */
+    put: (path: string, ...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => void) => void)[]) => void;
+    /**
+     * PATCH requests
+     * @example
+     * app.patch('/myroute', (req, res) => {
+     *  //console.debug('Body', req.body)
+     *  res.json({"message": "thanks!"})
+     * })
+     * @param {string} path - API route, e.g. '/foo/:ID'
+     * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
+     */
+    patch: (path: string, ...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => void) => any)[]) => void;
+    /**
+     * DELETE requests - app.delete('/foo', callbackFunction)
+     * @example
+     * app.delete('/myroute', (req, res) => {
+     *  res.json({"message": "thanks!"})
+     * })
+     * @param {string} path - API route, e.g. '/foo/:ID'
+     * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
+     */
+    delete: (path: string, ...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => void) => any)[]) => void;
+    /**
+     * All HTTP methods - app.all('/pets/cat', (req, res) => res.end('Mjau'))
+     * @example
+     * app.all('/myroute', (req, res) => {
+     *  //console.debug('Body', req.body || 'no body')
+     *  res.json({"message": "thanks!"})
+     * })
+     * @param {string} path - API route, e.g. '- API endpoint route, e.g. '/pets'
+     * @param  {...function(httpRequest, httpResponse, function(string)):void} hook - callback function(s) with parameters (req, res, [next])
+     */
+    all: (path: string, ...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => any) => void)[]) => void;
+    /**
+     * Allow custom authentication
+     * @example
+     * app.auth('/*', (req, res, next) => {
+     *  if (1 === 1) {
+     *    next()
+     *  } else {
+     *    res.status(403).end('No soup!')
+     *  }
+     * })
+     * @param {string|RegExp} path - API route, e.g. '/foo/*'
+     * @param  {...function(httpRequest, httpResponse, function(string):void):void} hook - callback function(s) with parameters (req, res, [next])
+     */
+    auth: (path: string | RegExp, ...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => void) => void)[]) => void;
+    /**
+     * Global middleware
+     * @example
+     * // global middleware
+     * app.use((req, res, next) => {
+     *  //console.debug("Global middleware was here!");
+     *  next(); // proceed
+     * })
+     * // middleware on a specific route
+     * app.useRoute('/myroute', (req, res, next) => {
+     *  //console.debug("Route middleware was here!");
+     *  next(); // proceed
+     * })
+     * @param {string} path - Optional API route, e.g. '/myroute/*'
+     * @param  {...function(httpRequest, httpResponse, function(string):void):void} hook - callback function(s) with parameters (req, res, next)
+     */
+    use: (...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => void) => void)[]) => void;
+    /**
+     * Global route middleware
+     * @example
+     * // Global middleware on a specific route
+     * app.use('/myroute', (req, res, next) => {
+     *  //console.debug("Route middleware was here!");
+     *  next(); // proceed
+     * })
+     * @param {string|RegExp} path - Optional API route, e.g. '/myroute/*'
+     * @param  {...function(httpRequest, httpResponse, function(string):void):void} hook - callback function(s) with parameters (req, res, next)
+     */
+    useRoute: (path: string | RegExp, ...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => void) => void)[]) => void;
+    /**
+     * Process queue job items for topic
+     * @param {string} topic
+     * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
+     */
+    queue: (topic: string, ...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => void) => any)[]) => void;
+    /**
+     * Add application worker function
+     * @param {string} name a unique worker name
+     * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
+     * @example
+     * app.worker('myworker', (data, job) => {
+     *  const {body:{payload}} = data
+     *  //console.debug('worker payload data', payload)
+     *  // do stuff with payload data
+     *  job.end()
+     *})
+     */
+    worker: (name: string, ...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => void) => any)[]) => void;
+    /**
+     * Create cron background jobs
+     * @example
+     * // call function each minute
+     * app.job('* * * * *', (req, res) => {
+     *  //console.debug('tick each minute')
+     *  res.end()
+     * })
+     * @param {string} cronExpression - cron expression
+     * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
+     */
+    job: (cronExpression: string, ...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => void) => any)[]) => void;
+    /**
+     * @description Serve static file content
+     * @param {Object} options - {route: "/", default: "index.html", directory: "/static"}
+     * @returns void
+     */
+    static: (options: any) => void;
+    /**
+     * Configuration settings
+     * @param {String} key
+     * @param {*} val
+     * @example
+     * app.set('views', '/views')
+     * app.set('view engine', {"hbs": handlebars})
+     */
+    set: (key: string, val: any) => void;
+    /**
+     *
+     * @param {string} view
+     * @param {object} data
+     * @param {function(string):void)} cb
+     */
+    render: (view: string, data: object, cb: any) => Promise<void>;
+    /**
+     * @description Create CRUD REST API for database
+     * @param {object} schema
+     * @param {object} options
+     * @returns Promise - Eventhooks
+     */
+    crudlify: (schema?: object, options?: object) => Promise<import("./crudlify/lib/eventhooks.mjs").EventHooks>;
+    /**
+     * Returns the Codehooks serverless definitions used by a serverless runtime engine
+     * @example
+     * export default app.init();
+     * @returns {Object} App instance
+     */
+    init: () => any;
+    /**
+     * Use Node Express app to run standalone
+     * All Codehooks routes will be applied as Express Routes
+     * @param {Object} express app instance
+     * @param {Object} options for Datastore and routing space
+     */
+    useExpress: (express: any, options: any) => Promise<void>;
+    /**
+     * Set Datastore interface
+     * @param {*} ds
+     */
+    setDatastore: (ds: any) => void;
+    getDatastore: () => {
+        open: () => Promise<any>;
+    };
+    addListener: (observer: any) => void;
+}
+declare const _coho: Codehooks;
+//# sourceMappingURL=index.d.ts.map