# easynodes

> This is a Node.js module that allows you to do things really easily

Latest version **1.0.1** (published 2023-10-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install easynodes
pnpm add easynodes
yarn add easynodes
bun add easynodes
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-10-13 |
| First published | 2023-10-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 87.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | willmil11 |
| Maintainers | willmil11 |
| Keywords | easy, nodejs, node.js, easynode, easynodejs, easynodes, nodes, node, easily |

## Links

- npm: https://www.npmjs.com/package/easynodes
- Repository: https://github.com/willmil11/easynodes
- Homepage: https://github.com/willmil11/easynodes#readme
- Issues: https://github.com/willmil11/easynodes/issues
- npm.io page: https://npm.io/package/easynodes

## Dependencies (4)

- [ws](https://npm.io/package/ws.md) ^8.14.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.1.1
- [dataquest](https://npm.io/package/dataquest.md) ^1.0.0
- [line-current](https://npm.io/package/line-current.md) ^1.0.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2023-10-13
- 1.0.0 — 2023-10-13

## README

# Easynodes 1.0.1

## Installation
```bash
npm install easynodes
```

## Usage
First require the package
```js
var easynodes = require('easynodes');
```
Then init the package if you don't everything else that you do will throw an error. The syntax is as below
```js
easynodes.init(verbose, custom-prefix)
//Verbose must be boolean
//Custom-prefix must be a string or not defined
```
Then here's how to use the package.
### Logging
Here's how to change the custom prefix:
```js
easynodes.logging.changeprefix(new-prefix)
```
Here's how to disable verbose
```js
easynodes.logging.disableverbose()
```
Here's how to enable verbose
```js
easynodes.logging.enableverbose()
```
### HTTP
Here's how to make an http request syncronously.
<br>
<br>
For this you'll be required to use an async function in order to use await to wait for the request to finish.
```js
var run = async function() {
    //Get response
    var response = await easynodes.http.get.sync("url");
    console.log(response);
}
//Launch that
run();
```
Here's how to make an http request asyncronously.
```js
easynodes.http.get.async("url", function(request) {
    //Defining a variable to receive the data
    var data = "";
    //Set an event for when data is received
    request.on("data", function(chunk) {
        //Add the chunk to the data variable
        data += chunk;
    });
    //Set an event for when the request is finished
    request.on("end", function() {
        console.log(data);
    });
    
    //You could also abort the request like this
    request.abort();
    //
    //Or you can get the http code as this
    console.log(request.statusCode);
    //
    //And you can remove all set events for the request like this
    request.removeEvents();
});
```
You can also create an http server like this
```js
easynodes.http.newServer(function(requestHandler){
    //You are not required to specify the authorised ip but you're required to specify the port
    //
    //You can get the ip of the client as this:
    console.log(requestHandler.ip);
    //You can get the url of the request as this:
    console.log(requestHandler.url);
    //You can get the method of the request as this:
    console.log(requestHandler.method);
    //You can get the headers of the request as this:
    console.log(requestHandler.headers);
    //You can write text to request as this (Note that the httpCode and writeHead are optional and can only be set once per request)
    requestHandler.write("Hello ", 200, {"Content-Type": "text/plain", "Access-Control-Allow-Origin": "*"});
    //You can end the request as this (You can also set httpcode and writeHead here but we already did that above also you can just end the request without any data)
    requestHandler.end("World!");

}, port, ip)
```
### Websocket
Here's how to create a websocket client
```js
easynodes.websocket.newClient("adress", function(client){
    //When this code is ran it means that the client is opened
    //You can send data to the server like this
    client.send("Hello");
    //You can set an event for when the client receives data like this
    client.onmessage(function(data){
        //You can get the data like this
        console.log(data);
    });
    //You can set an event for when the client is closed like this
    client.onclose(function(){
        console.log("Client closed");
    });
    //You can close the client like this
    client.close();
    //You can remove all events for the client like this
    client.removeEvents();
})
```
Here's how to create a websocket server
```js
easynodes.websocket.newServer(port, function(client){
    //When this code is ran it means that a new client connected
    //You can send data to the client like this
    client.send("Hello");
    //You can set an event for when the client receives data like this
    client.onmessage(function(data){
        //You can get the data like this
        console.log(data);
    });
    //You can set an event for when the client is closed like this
    client.onclose(function(){
        console.log("Client closed");
    });
    //You can close the client like this
    client.close();
    //You can remove all events for the client like this
    client.removeEvents();
})
```
### Filesystem
Here's how to read a file syncronously
```js
var data = easynodes.files.read.sync("path");
console.log(data);
```
Here's how to read a file asyncronously
```js
easynodes.files.read.async("path", function(data){
    console.log(data);
});
```
Here's how to write to a file syncronously
```js
easynodes.files.write.write.sync("path", "data");
```
Here's how to write to a file asyncronously
```js
easynodes.files.write.write.async("path", "data", function(){
    console.log("Done");
});
```
Here's how to append to a file syncronously
```js
easynodes.files.write.add.sync("path", "data");
```
Here's how to append to a file asyncronously
```js
easynodes.files.write.add.async("path", "data", function(){
    console.log("Done");
});
```
Here's how to get the path of the current directory
```js
var path = easynodes.files.getDirname();
console.log(path);
```
Here's how to delete a file/folder syncronously
```js
easynodes.files.delete.sync("path");
```
Here's how to delete a file/folder asyncronously
```js
easynodes.files.delete.async("path", function(){
    console.log("Done");
});
```
Here's how to copy a file/folder syncronously
```js
easynodes.files.copy.sync("path", "new-path");
```
Here's how to copy a file/folder asyncronously
```js
easynodes.files.copy.async("path", "new-path", function(){
    console.log("Done");
});
```
Here's how to move a file/folder syncronously
```js
easynodes.files.move.sync("path", "new-path");
```
Here's how to move a file/folder asyncronously
```js
easynodes.files.move.async("path", "new-path", function(){
    console.log("Done");
});
```
Here's how to create a folder syncronously
```js
easynodes.files.create.folder.sync("path");
```
Here's how to create a folder asyncronously
```js
easynodes.files.create.folder.async("path", function(){
    console.log("Done");
});
```
Here's how to create a file syncronously
```js
easynodes.files.create.file.sync("path", "optional-data");
```
Here's how to create a file asyncronously
```js
easynodes.files.create.file.async("path", "optional-data", function(){
    console.log("Done");
});
```
Here's how to rename a file/folder syncronously
```js
easynodes.files.rename.sync("path", "new-path");
```
Here's how to rename a file/folder asyncronously
```js
easynodes.files.rename.async("path", "new-path", function(){
    console.log("Done");
});
```
Here's how to check if a file/folder exists syncronously
```js
var exists = easynodes.files.exists.sync("path");
console.log(exists);
```
Here's how to check if a file/folder exists asyncronously
```js
easynodes.files.exists.async("path", function(exists){
    console.log(exists);
});
```
Here's how to get the type of the path (file or folder) syncronously
```js
var type = easynodes.files.getTypeOf.sync("path");
console.log(type);
```
Here's how to get the type of the path (file or folder) asyncronously
```js
easynodes.files.getTypeOf.async("path", function(type){
    console.log(type);
});
```
Here's how to get the size of a file/folder in the most humman readable format possible syncronously
```js
var size = easynodes.files.getSize.sync("path");
console.log(size);
```
Here's how to get the size of a file/folder in the most humman readable format possible asyncronously
```js
easynodes.files.getSize.async("path", function(size){
    console.log(size);
});
```
Here's how to get the permissions of a file/folder as a number syncronously
```js
var permissions = easynodes.files.getPermissions.asNumber.sync("path");
console.log(permissions);
```
Here's how to get the permissions of a file/folder as a number asyncronously
```js
easynodes.files.getPermissions.asNumber.async("path", function(permissions){
    console.log(permissions);
});
```
Here's how to get the permissions of a file/folder as a string syncronously
```js
var permissions = easynodes.files.getPermissions.asString.sync("path");
console.log(permissions);
```
Here's how to get the permissions of a file/folder as a string asyncronously
```js
easynodes.files.getPermissions.asString.async("path", function(permissions){
    console.log(permissions);
});
```
Here's how to set the permissions of a file/folder syncronously
```js
//The permissions must be a number
easynodes.files.setPermissions.sync("path", permissions);
```
Here's how to set the permissions of a file/folder asyncronously
```js
//The permissions must be a number
easynodes.files.setPermissions.async("path", permissions, function(){
    console.log("Done");
});
```

### Dataquest
My database module dataquest is integrated in easynodes you can use it as this:
<br>
To create a database use this:
```js
var database = easynodes.dataquest.createDatabase();
```
To load a database use this:
```js
var database = easynodes.dataquest.load("path");
```
To save a database use this:
```js
easynodes.dataquest.save("path", database);
```
To set an item in the database use this:
```js
database.set("item", "value");
```
To get an item in the database use this:
```js
var value = database.get("item");
```
To delete an item in the database use this:
```js
database.delete("item");
```
<strong>This is for dataquest 1.0.0</strong>

### Line-current
My module line-current which is for getting the current line in the terminal is integrated in easynodes you can use it as this:
<br><br>
To get the current line use this (an async function is required for that in order to use await to wait for the current line to be gotten):
```js
var run = async function() {
    var currentLine = await easynodes.line_current.get();
    console.log(currentLine);
    //Will return {"current-line": %current line%, "processtime": %time it took to get current line%}
}
run();
//If you put any code that edits the console here everything will fall appart.
```
To get the current line formatted use this (async function is also required for that):
```js
var run = async function() {
    var currentLine = await easynodes.line_current.get(true);
    console.log(currentLine);
    //Will return:
    //{
    //    "current-line": %current line%,
    //    "processtime": %time it took to get current line%,
    //}
}
run();
//If you put any code that edits the console here everything will fall appart.
```
To just get the current line use this (async function is also required for that):
```js
var run = async function() {
    var currentLine = await easynodes.line_current.get();
    console.log(JSON.parse(currentLine)["current-line"]);
    //Will return %current line%
}
run();
//If you put any code that edits the console here everything will fall appart.
```
<strong>This is for line-current 1.0.0</strong>

## Credits
- Credit to me (willmil11)
- Credit to the ws module creator(s) used for easynodes websocket features
- Credit to the fs-extra module creator(s) used for easynodes filesystem features

## Goals
- [ ] Add encryption features

## Suggestions
If you have any suggestions please open an issue on github.

## Bugs
If you find any bugs please open an issue on github.

## Changelog
### 1.0.1
- Little fix in the readme
### 1.0.0
- Initial release

---
_Source: https://npm.io/package/easynodes · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._