Embedded

Notice

This was a fork from mandarineorg/embedded.

Unfortunately I think the project is now dead, two years since a pull request and any releases. I think the project has potential.

Description

embedded is a fake file system for Deno binaries. This means, you can save your files along with the binary generated by deno compile, this way, you can put all your files together in a single executable which leads to easier deployments and a more compacted deliverable output.

Usage

Using embedded in your application is very simple, you just use the regular Deno APIs after you ran a ‘embedded compile’. More on this below.

embedded compile step.

The embedded.compile() method is responsible for creating a typescript file with your resources in it. This file is then compiled into your binary.

embedded.compile() takes one argument containing the options to include.

// File: compile.ts
import { embedded } from "https://deno.land/x/embedded/mod.ts";

embedded.compile({
    modulePath: "./myEntryPoint.ts",
    contentFolders: ["./resources"],
    // flags: [],
    // output: ''
})

modulePath and contentFolders are necessary.

• modulePath: File to be compiled into a binary.
• contentFolders: Folders to be attached to the binary.
• flags optional: the Deno flags normally used for deno compile.
• output optional: Replaces the --output flags option.

readFileSync

Synchronously reads and returns the entire contents of a file as an array of bytes. TextDecoder can be used to transform the bytes to string if required. Reading a directory returns an empty data array.

const decoder = new TextDecoder("utf-8");
const data = Deno.readFileSync("hello.txt");
console.log(decoder.decode(data));

readFile

Reads and returns the entire contents of a file as an array of bytes. TextDecoder can be used to transform the bytes to string if required. Reading a directory returns an empty data array.

const decoder = new TextDecoder("utf-8");
const data = await Deno.readFile("hello.txt");
console.log(decoder.decode(data));

readTextFileSync

Synchronously reads and returns the entire contents of a file as utf8 encoded string.

const data = Deno.readTextFileSync("hello.txt");
console.log(data);

readTextFile

Reads and returns the entire contents of a file as utf8 encoded string.

const data = await Deno.readTextFile("hello.txt");
console.log(data);

Example

Compile the binary

We run the compile.ts script which creates the file system .ts which then runs deno compile to build the final binary.

// compile.ts
import { Embedded } from "https://deno.land/x/embedded/mod.ts";

Embedded.compile({
    modulePath: "./myEntryPoint.ts",
    contentFolders: ["./resources"]
})

./resources/hello.txt

Hello World

myEntryPoint.ts:

console.log(Deno.readTextFileSync("./resources/hello.txt"));

deno run --allow-all --unstable compile.ts

./myEntryPoint (.exe if windows)
# output: Hello World