Skip to content
Raoul de Heer edited this page Dec 17, 2021 · 2 revisions

The buf object consists of:

load

Loads buffer data from file asynchronous.

Parameters:

  • path {string} path to load from.
  • callback {objectCallback<Buffer} callback to call.

Call signature:

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

Examples:

Using imported Buf object.
Using Await.

import { Buf } from "mylas";

const loadedBuffer = await Buf.load("./file.txt");

console.log(loadedBuffer);

Using imported default mylas object.
Using callback.

import mylas from "mylas";

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

save

Saves buffer data to file asynchronous.

Parameters:

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

Call signature:

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

Examples:

Using imported Buf object.
Using callback.

import { Buf } from "mylas";

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

Using imported default mylas object.
Using Await.

import mylas from "mylas";

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

loadW

Loads buffer data from file multithreaded.

Parameters:

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

Call signature:

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

Examples:

Using imported Buf object.
Using Await.

import { Buf } from "mylas";

const loadedBuffer = await Buf.loadW("./file.txt");

console.log(loadedBuffer);

Using imported default mylas object.
Using callback.

import mylas from "mylas";

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

saveW

Saves buffer data to file multithreaded.

Parameters:

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

Call signature:

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

Examples:

Using imported Buf object.
Using callback.

import { Buf } from "mylas";

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

Using imported default mylas object.
Using Await.

import mylas from "mylas";

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

Links

All functions Mylas has are at exports
To get started have a look at our getting started page
Find Mylas on npm
Find Mylas on github


Resources

Clone this wiki locally