package codex

  1. Overview
  2. Docs
package codex
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module File_to_htmlSource

This file allows to put binary files in HTML documents (by base64 encoding), so that the binary file is accessible by javascript as a Uint8Array. Can be used e.g. for Marshalling OCaml data to the browser, which simplifies UI development (compared to using a webserver, with asynchronous requests following some protocols etc.)

Warning:

  • Chrome does not support files > 2GB (Firefox works fine)
  • Performance is OK, but loading a 2GB file requires ~30s on my machine, i.e. we can load 67MB per second. The benefit of binary files is that is is compact and make it easy to share data...
Sourceval file_to_html : out_channel -> filename:string -> varid:string -> unit

Generate HTML <script>...<script> node in outc such that the content of filename will be placed in the Javascript variable varid, which is a Uint8Array.

Note: this require preamble (which is also a <script>...<script>) to be placed before.

Sourceval preamble : string

A preamble string to be placed in the HTML file before the sequence of file_to_html calls start.