Creating a Typescript Library that Relies on Web Assembly?

Question

Creating a Typescript Library that Relies on Web Assembly?

I'm considering developing a TypeScript library for distributions that will rely on cephes.

To enable the use of web assembly in browsers, we need to compile it in the following way:

const cephes = require('cephes'); // Browser
await cephes.compiled;

I'm unsure about how to implement this for a Typescript library that wraps cephes.

For instance, the library will provide a NormalDistribution that can be imported like this:

import { NormalDistrbution } from 'cephesdistributions';

If tree shaking is performed, NormalDistribution may be the only import included from the package. Should we then include await cephes.compiled in all modules offered by cephesdistributions?

javascript typescript browser webassembly

Answer 1

Answer №1

It is important to be direct and clear with your approach when it comes to handling asynchronous operations in your code. One suggestion is to let consumers handle the await for `cephes.compiled` themselves.

If you are packaging `cephes`, consider exporting `cephes.compiled` so that users of your library can easily access it:

const cephes = require('cephes');

export const compiled = cephes.compiled;

export class NormalDistribution {
  public mean: number;
  public sd: number;

  constructor(mean = 0, sd = 1) {
    this.mean = mean;
    this.sd = 1;
  }

  cdf(x: number): number {
    // Make sure 'compiled' has been awaited before calling
    return cephes.ndtr(x);
  }
}

This way, the types of your exported classes will be readily available, even though they rely on `cephes.compiled`. To ensure proper handling of dependencies, you could track the compilation state and include appropriate guard clauses:

const cephes = require('cephes');
  
let isCompiled = false;
export function assertIsCompiled() {
  if (isCompiled) {
    return;
  }

  throw new Error('Please wait for `cephesdistributions.compiled` to resolve');
}

export const compiled = cephes.compiled.then(() => { isCompiled = true });

export class NormalDistribution {
  public mean: number;
  public sd: number;

  constructor(mean = 0, sd = 1) {
    assertIsCompiled();

    this.mean = mean;
    this.sd = 1;
  }

  cdf(x: number): number {
    return cephes.ndtr(x);
  }
}

Answer 2

It is important to be direct and clear with your approach when it comes to handling asynchronous operations in your code. One suggestion is to let consumers handle the await for `cephes.compiled` themselves.

If you are packaging `cephes`, consider exporting `cephes.compiled` so that users of your library can easily access it:

const cephes = require('cephes');

export const compiled = cephes.compiled;

export class NormalDistribution {
  public mean: number;
  public sd: number;

  constructor(mean = 0, sd = 1) {
    this.mean = mean;
    this.sd = 1;
  }

  cdf(x: number): number {
    // Make sure 'compiled' has been awaited before calling
    return cephes.ndtr(x);
  }
}

This way, the types of your exported classes will be readily available, even though they rely on `cephes.compiled`. To ensure proper handling of dependencies, you could track the compilation state and include appropriate guard clauses:

const cephes = require('cephes');
  
let isCompiled = false;
export function assertIsCompiled() {
  if (isCompiled) {
    return;
  }

  throw new Error('Please wait for `cephesdistributions.compiled` to resolve');
}

export const compiled = cephes.compiled.then(() => { isCompiled = true });

export class NormalDistribution {
  public mean: number;
  public sd: number;

  constructor(mean = 0, sd = 1) {
    assertIsCompiled();

    this.mean = mean;
    this.sd = 1;
  }

  cdf(x: number): number {
    return cephes.ndtr(x);
  }
}

Creating a Typescript Library that Relies on Web Assembly?

Answer №1

Similar questions

Is it feasible to retrieve information within a behavior in Drupal?

Having trouble extracting data from a particular cell within an HTML table using jQuery

Sharing various data from Express to Jade is quite simple and can be done

Inject the JSON data fetched through AJAX into Datatables

Obtaining JSON Data Using WinJS.xhr():

Tips for exporting data to a JSON file using the Google Play Scraper in NodeJS

Use checkboxes to switch specific divs on and off based on their two assigned classes

Performing a map or foreach function on an array of objects limited to the first 5 objects

Creating a dynamic search bar using Ajax with support for multiple keywords

Searching for a specific value in various Json files: A guide

Enabling individuals to transfer their content to Amazon S3

Is Ember CLI experiencing issues due to the latest Ember Data update?

Conceal a specific character within a jQuery input field

Using d3.xml() within a React application

Retrieving Information from JSON File Using a Variable (JavaScript/Discord.js)

What could be the significance behind these sudden pop-ups of console error messages?

The style of the button label does not persist when onChange occurs

Utilize the reducer from another slice in Redux Toolkit

Guide to modifying CSS properties of an individual element by manipulating class names with JavaScript

Utilizing Jquery to extract a specific string from a URL and fetch a remote element