Installations

npm install @robertaboukhalil/aioli

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

13.11.0

NPM Version

6.13.7 Score

71.6

Supply Chain

84.1

Quality

75.4

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

1

Total

31

Closed

2

Merged

28

Issues

Open

0

Total

19

Closed

19

Releases

21

Aioli 3.2.1

v3.2.1

Published on 14 Oct 2024

Aioli 3.2.0

v3.2.0

Published on 15 Aug 2024

Aioli 3.1.0

v3.1.0

Published on 17 Sept 2022

Aioli 3.0.0

v3.0.0

Published on 19 Aug 2022

Aioli 2.4.1

v2.4.1

Published on 09 Aug 2022

Aioli 2.4.0

v2.4.0

Published on 16 Sept 2021

View all 21 releases

Contributors

3

Unable to fetch Contributors

View all 3 contributors

Languages

2

JavaScript

HTML

JavaScript (96.41%)

HTML (3.59%)

Developer

robertaboukhalil

Download Statistics

Total Downloads

2,318

Last Day

1

Last Week

2

Last Month

31

Last Year

167

GitHub Statistics

111 Stars

260 Commits

10 Forks

4 Watching

3 Branches

3 Contributors

Maintainers

1

Package Meta Information

Latest Version

1.1.0

Package Id

@robertaboukhalil/aioli@1.1.0

Unpacked Size

19.51 kB

Size

6.20 kB

File Count

5

NPM Version

6.13.7

Node Version

13.11.0

Total Downloads

Cumulative downloads

Total Downloads

2,318

Last day

0%

1

Compared to previous day

Last week

-84.6%

2

Compared to previous week

Last month

933.3%

31

Compared to previous month

Last year

-51.9%

167

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

No dependencies detected.

Versions

Aioli

Aioli is a framework for building fast genomics web tools using WebAssembly and WebWorkers.

Tools that use Aioli

Getting Started

Here is a simple example of Aioli in action running the genomics tool samtools on a user-provided file:

1<input id="myfile" type="file" multiple>
2<script src="aioli.js"></script>
3
4<script>
5let samtools = new Aioli("samtools/1.10");
6
7// Initialize samtools and output the version
8samtools
9    .init()
10    .then(() => samtools.exec("--version"))
11    .then(d => console.log(d.stdout));
12
13// When a user selects a .sam file from their computer,
14// run `samtools view -q20` on the file
15function loadFile(event)
16{
17    Aioli
18        // First mount the file
19        .mount(event.target.files[0])
20        // Once it's mounted, run samtools view
21        .then(file => samtools.exec(`view -q20 ${file.path}`))
22        // Capture output
23        .then(d => console.log(d.stdout));
24}
25document.getElementById("myfile").addEventListener("change", loadFile, false);
26</script>

Background info

What is WebAssembly?

WebAssembly is a very fast, low-level, compiled binary instruction format that runs in all major browsers at near native speeds.

What is a WebWorker?

WebWorkers allow you to run JavaScript in the browser in a background thread, which keeps the browser responsive.

Compiling into WebAssembly

Download the Emscriptem SDK
Follow the Emscriptem tutorial for details on how to compile C/C++ files into app.js and app.wasm.
Use template.html as a starting point for building your app. Built on top of Aioli, this simple app allows users to specify a local file to parse (URLs + drag & drop supported), and will mount that file to a virtual file system inside a WebWorker, sample that file randomly, run a WebAssembly command on each chunk inside the WebWorker, track its output, and display progress throughout.
You can install Aioli as a JavaScript package through npm: npm install @robertaboukhalil/aioli.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

6

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

2.9

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More