Skip to content
Raoul de Heer edited this page Sep 25, 2022 · 6 revisions

The file object consists of:

loadS

Loads string data from file synchronous.

Parameters:

  • path {string} path to load from.

Call signature:

loadS: (path: string) => string;

Examples:

Using imported File object.
Loading textfile content.

import { File } from "mylas";

const loadedText = File.loadS("./example.txt");

console.log(loadedText);

Using imported default mylas object.

import mylas from "mylas";

const loadedText = mylas.file.loadS("./file.txt");

console.log(loadedText);

saveS

Saves string data to file synchronous.

Parameters:

  • path {string} path to save to.
  • data {string} data to save.

Call signature:

saveS: (path: string, data: string) => void;

Examples:

Using imported File object.

import { File } from "mylas";

const data = "hello: world";
File.saveS("./file.txt", data);

Using imported default mylas object.

import mylas from "mylas";

const data = "hello: world";
mylas.file.saveS("./file.txt", data);

Using String object.

import "mylas/register";;

const data = "hello: world";
data.saveS("./file.txt");
// Or
String.saveS("./file.txt", data);

load

Loads string data from file asynchronous.

Parameters:

  • path {string} path to load from.
  • callback {stringCallback} callback to call.

Call signature:

load: (path: string, callback?: stringCallback | undefined) => Promise<string>;

Examples:

Using imported File object.
Using Await.

import { File } from "mylas";

const loadedText = await File.load("./file.txt");

console.log(loadedText);

Using imported default mylas object.
Using callback.

import mylas from "mylas";

mylas.file.load("./file.txt", data => {
    console.log(data);
});

save

Saves string data to file asynchronous.

Parameters:

  • path {string} path to save to.
  • data {string} data to save.
  • callback {voidCallback} callback to call.

Call signature:

save: (path: string, data: string, callback?: voidCallback | undefined) => Promise<void>;

Examples:

Using imported File object.
Using callback.

import { File } from "mylas";

const data = "hello: world";
File.save("./file.txt", data, () => {
    console.log("Saved!");
});

Using imported default mylas object.
Using Await.

import mylas from "mylas";

const data = "hello: world";
await mylas.file.save("./file.txt", data);

Using String object.

import "mylas/register";;

const data = "hello: world";
await data.save("./file.txt");
// Or
await String.save("./file.txt", data);

loadW

Loads string data from file multithreaded.

Parameters:

  • path {string} path to load from.
  • callback {stringCallback} callback to call.

Call signature:

loadW: (path: string, callback?: stringCallback | undefined) => Promise<string>;

Examples:

Using imported File object.
Without callback.
Using Await.

import { File } from "mylas";

const loadedText = await File.loadW("./file.txt", undefined);

console.log(loadedText);

Using imported default mylas object.
Using callback.

import mylas from "mylas";

mylas.file.loadW("./file.txt", data => {
    console.log(data);
});

saveW

Saves string data to file multithreaded.

Parameters:

  • path {string} path to save to.
  • data {string} data to save.
  • callback {voidCallback} callback to call.

Call signature:

saveW: (path: string, data: string, callback?: voidCallback | undefined) => Promise<void>;

Examples:

Using imported File object.
Using callback.

import { File } from "mylas";

const data = "hello: world";
File.saveW("./file.txt", data, () => {
    console.log("Saved!");
});

Using imported default mylas object.
Using Await.

import mylas from "mylas";

const data = "hello: world";
await mylas.file.saveW("./file.txt", data);

Using String object.

import "mylas/register";;

const data = "hello: world";
await data.saveW("./file.txt");
// Or
await String.saveW("./file.txt", data);