codehooks-js 1.2.2 → 1.2.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codehooks-js",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "type": "module",
   "description": "Codehooks.io official library - provides express.JS like syntax",
   "main": "index.js",

package/types/index.d.ts

@@ -1,3 +1,4 @@
+
 /**
  * Built-in persistent datastore.
  * - Datastore is capable of serving NoSQL object data and Key-Value data.
@@ -36,14 +37,74 @@ export namespace schedule {
 export namespace filestore {
     /**
      * Raad file content as stream
-     * @param path Absolute path til file
+     * @see {@link https://codehooks.io/docs/fileapi#filestoregetreadstreampath API docs}
+     * @param path Absolute path to file
      * @param options Not in use
+     * @returns Promise EventEmitter with chunks on data
+     * @example
+     * app.get('/image', async (req: httpRequest, res: httpResponse) => {
+     *   const bufStream = await filestore.getReadStream('/img/logo.png');
+     *   res.set('content-type', 'image/png')
+     *   bufStream.on('data', (buf) => {
+     *     res.write(buf, 'buffer')
+     *   })
+     *   .on('end', () => {
+     *     res.end()
+     *   })
+     * })
+     */
+    function getReadStream(path: string, options?: any): Promise<any>;
+    /**
+     * Read file content as string
+     * @see {@link https://codehooks.io/docs/fileapi#filestorereadfilepath API docs}
+     * @param path Absolute path to file
+     * @param options 
+     * @returns Promise File content as string
      */
-    function getReadStream(path: string, options?: any): Promise<ReadableStream>;
     function readFile(path: string, options?: any): Promise<String>;
+    /**
+     * Save file binary buffer
+     * @see {@link https://codehooks.io/docs/fileapi#filestoresavefilepath-filestream API docs}
+     * @param path Abolute path to file, e.g. /static/home.html 
+     * @param buffer Stream data
+     * @param options Not in use
+     * @returns Promise with save result
+     * @example
+     * import {PassThrough} from 'stream';
+     * app.post('/file', async (req, res) => {
+     *   try {
+     *     const stream = new PassThrough();
+     *     req.pipe(stream);
+     *     const result = await filestore.saveFile('/static.html', stream);
+     *     res.end(result)    
+     *   } catch (error) {
+     *     console.error(error)
+     *     res.status(404).end('Bad upload')
+     *   }
+     * })
+     */
     function saveFile(path: string, buffer: any, options?: any): Promise<any>;
+    /**
+     * Delete file
+     * @see {@link https://codehooks.io/docs/fileapi#filestoredeletefilepath API docs}
+     * @param path 
+     * @param options 
+     */
     function deleteFile(path: string, options?: any): Promise<any>;
+    /**
+     * List file directories and files
+     * @see {@link https://codehooks.io/docs/fileapi#filestorelistpath API docs}
+     * @param path 
+     * @param options 
+     */
     function list(path: string, options?: any): Promise<Array<Object>>;
+    /**
+     * Read binary buffer from file
+     * @param path Path to file 
+     * @returns Promise with Buffer
+     * @example
+     * const myBuf = await filestore.getFileAsBuffer('/images/logo.png');
+     */
     function readFileAsBuffer(path: any): Promise<any>;
 }
 export default _coho;
@@ -283,6 +344,12 @@ export type httpRequest = {
      * - Get the project URL domain name
      */
     hostname: string;
+    /**
+     * Pipe data to stream
+     * @param data 
+     * @returns 
+     */
+    pipe: (data: any) => void;
 };
 export type httpResponse = {
     /**
@@ -300,8 +367,9 @@ export type httpResponse = {
     /**
      * - Write stream data to the client response.
      * - Content-type must be set before any write operations
+     * - set optional type to 'buffer' for binary write operations
      */
-    write: (data: string) => any;
+    write: (data: any, type?: string) => any;
     /**
      * - Set a response header value,
      * - e.g. res.set('Content-Type', 'text/html; charset=UTF-8');
@@ -327,7 +395,7 @@ 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: (filePath: string, options?: any) => Promise<ReadableStream>;
+    getReadStream: (filePath: string, options?: any) => Promise<any>;
     /**
      * - 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).
      */
@@ -454,7 +522,7 @@ import * as crud from './crudlify/index.mjs';
 /**
  * @typedef {Object} Filesystem
  *
- * @property {function(string, Object): Promise<ReadableStream>} getReadStream
+ * @property {function(string, Object): Promise<ReadableStream>} any
  * - 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