Skip to content

A node toolkit for doing async api calls, writing to file system, starting up express-js servers and more coming soon.

Notifications You must be signed in to change notification settings

NicmeisteR/Node-Essentials

Repository files navigation

Node-Essentials

A node toolkit for doing async api calls, writing to file system, starting up express-js servers and more coming soon.

Issues Forks Stars Size NPM Tweet

Community

Community

Donate, Support or Fund

If you love this project please consider donating or support the development by means of coffee. You may also fund this project to maintain active and close more issues. Just a cup of coffee is enough to appreciate our hardwork.

Donate Support


Setup

Run:

npm install node-essentials

And include it in your app:

const node = require('node-essentials');

or

import * as node from 'node-essentials';


Methods

  • http - REST Requests.

    • get - Simple REST "GET" request.
    • post - Simple REST "POST" request.
    • put - Simple REST "PUT" request.
    • delete - Simple REST "DELETE" request.
  • helpers - Helper functions.

  • server - Express server.

    • start - Set-up a express-js server on the specified port and directory.
  • fileManager - Manage files.

    • writeToFile - Writes anything passed through to storage as any file.
executeGet(url: string, options?: any): Promise<any>

Implementation:

import http from 'node-essentials';

async function getData() {
    const data = await http.executeGet("https://my-json-server.typicode.com/typicode/demo/db").then();
    console.log(data); 
}

Response:

{
  posts: [
    { id: 1, title: 'Post 1' },
    { id: 2, title: 'Post 2' },
    { id: 3, title: 'Post 3' }
  ],
  comments: [
    { id: 1, body: 'some comment', postId: 1 },
    { id: 2, body: 'some comment', postId: 1 }
  ],
  profile: { name: 'typicode' }
}
executePost(url: string, options?: any): Promise<any>

Implementation:

import http from 'node-essentials';

async function postData() {
    const data = await http.executePost("https://my-json-server.typicode.com/typicode/demo/posts", {
        body: {
            "id": 4,
            "title": "Post 4"
        }
    }).then();
    console.log(data); 
}

Response:

{
    id: 4
}
executePut(url: string, options?: any): Promise<any>

Implementation:

import http from 'node-essentials';

async function putData() {
    const data = await http.executePut("https://my-json-server.typicode.com/typicode/demo/posts", {
        body: {
            "id": 4,
            "title": "Post 4"
        }
    }).then();
    console.log(data); 
}

Response:

{
    id: 4
}
executePut(url: string, options?: any): Promise<any>

Implementation:

import http from 'node-essentials';

async function deleteData() {
    const data = await http.executeDelete("https://my-json-server.typicode.com/typicode/demo/posts", {
        body: {
            "id": 4,
            "title": "Post 4"
        }
    }).then();
    console.log(data); 
}

Response:

{
    id: null
}
distinct(array: Array[any]);

Implementation:

import * as node from 'node-essentials';

const nonDistinct = [1,1,1,2,3];

function getDistinct(){
    const distinct = node.helpers.distinct(nonDistinct);
    console.log(distinct);
}

Response:

[1,2,3]
start(port: number, directory: string);

Implementation:

import server from 'node-essentials';

server.start(3000, __dirname) // The "__dirname" is the relative path for the directory used by node. This would serve the current root directory.

Response:

Listening on 3000
writeToFile(folder: string, fileName: string, extension: string, data: any);

Implementation:

import fileManager from 'node-essentials';

const data = {
    sample: "Sample Data"
}

fileManager.writeToFile("./", "fileName", "json", JSON.stringify(data));

Author

Node Essentials is Developed and Maintained by Nicolaas Nel

Facebook Twitter LinkedIn YouTube DEV


Made with 💙 and ☕ by Nicolaas Nel.