nodejs-notebook

nodejs-notebook

Automate editing and managing any file type in the world

Links

Discord

Documentation

Installation

# with npm
npm install nodejs-notebook

Usage

Nodebook

Nodebook has a default class in case you want to edit files that do not have their own custom formatting.

Setup

const Nodebook = require('nodejs-notebook');

const myNotebook = new Nodebook.Nodebook('file name', 'txt');

fileName(options)

object options:

• options.lower - Whether or not the name should be turned to lower case.

Return: The file name.

myNotebook.fileName({ lower: false });
// returns "file_name.txt"

clearLog()

Clears .booklog.txt

Nodebook.clearLog();
// clears .booklog.txt

resetFile()

Resets the file.

myNotebook.resetFile();
// resets file_name.txt

deleteFile(delay)

Deletes the file

number delay: Sets how many seconds before deleting the file.

myNotebook.deleteFile();
// Deletes the file instantly

myNotebook.deleteFile(3);
// Deletes the file in 3 seconds

fetchLine(line)

Fetches an existing line's content.

number line: The line number to get the information from.

myNootebook.fetchLine(1);
// fetches the first line

myNotebook.fetchLine(5);
// fetches the fifth line

Return: The line content.

deleteLine(line)

Sets an existing line in the file to empty.

number line: The line number to make empty.

myNotebook.deleteLine(1);
// sets the first line empty

editLine(line, key)

Replaces an existing lin ewith a new string.

number line: The line number to set it to.

string key: The string that will replace the line.

myNotebook.editLine(1, 'Welcome!');
// sets the first line to 'Welcome!'

addLine(key)

Adds a string at the next available line in the file.

string key: The string to add at the next available line.

myNotebook.addLine('Yippi Ki Yay!');
// adds 'Yippi Ki Yay!' to the next line

content()

Returns the file's content into a string.

console.log(myNotebook.content());
// should log the file's content